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 a8c72cc5..218ee1fe 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/accessapproval.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/accessapproval.yaml @@ -8,7 +8,7 @@ info: description: An API for controlling access to data by Google personnel. version: v1 x-discovery-doc-revision: '20240524' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/assured-workloads/access-approval/docs servers: @@ -609,7 +609,7 @@ components: - '2' x-stackQL-resources: access_approval_settings: - id: accessapproval.access_approval_settings + id: google.accessapproval.access_approval_settings name: access_approval_settings title: Access_approval_settings methods: @@ -689,7 +689,7 @@ components: - $ref: >- #/components/x-stackQL-resources/access_approval_settings/methods/organizations_delete_access_approval_settings service_account: - id: accessapproval.service_account + id: google.accessapproval.service_account name: service_account title: Service_account methods: @@ -723,7 +723,7 @@ components: update: [] delete: [] approval_requests: - id: accessapproval.approval_requests + id: google.accessapproval.approval_requests name: approval_requests title: Approval_requests methods: @@ -844,18 +844,18 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/approval_requests/methods/projects_approval_requests_list - $ref: >- #/components/x-stackQL-resources/approval_requests/methods/projects_approval_requests_get - - $ref: >- - #/components/x-stackQL-resources/approval_requests/methods/folders_approval_requests_list - $ref: >- #/components/x-stackQL-resources/approval_requests/methods/folders_approval_requests_get - - $ref: >- - #/components/x-stackQL-resources/approval_requests/methods/organizations_approval_requests_list - $ref: >- #/components/x-stackQL-resources/approval_requests/methods/organizations_approval_requests_get + - $ref: >- + #/components/x-stackQL-resources/approval_requests/methods/projects_approval_requests_list + - $ref: >- + #/components/x-stackQL-resources/approval_requests/methods/folders_approval_requests_list + - $ref: >- + #/components/x-stackQL-resources/approval_requests/methods/organizations_approval_requests_list insert: [] update: [] delete: [] 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 7b07a73f..91946546 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/accesscontextmanager.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/accesscontextmanager.yaml @@ -18,7 +18,7 @@ info: non-production/non-critical service perimeters. version: v1 x-discovery-doc-revision: '20240527' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/access-context-manager/docs/reference/rest/ servers: @@ -1834,7 +1834,7 @@ components: - '2' x-stackQL-resources: operations: - id: accesscontextmanager.operations + id: google.accesscontextmanager.operations name: operations title: Operations methods: @@ -1868,14 +1868,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' access_policies: - id: accesscontextmanager.access_policies + id: google.accesscontextmanager.access_policies name: access_policies title: Access_policies methods: @@ -1915,15 +1915,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/access_policies/methods/list' - $ref: '#/components/x-stackQL-resources/access_policies/methods/get' + - $ref: '#/components/x-stackQL-resources/access_policies/methods/list' insert: - $ref: '#/components/x-stackQL-resources/access_policies/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/access_policies/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/access_policies/methods/delete' access_policies_iam_policies: - id: accesscontextmanager.access_policies_iam_policies + id: google.accesscontextmanager.access_policies_iam_policies name: access_policies_iam_policies title: Access_policies_iam_policies methods: @@ -1958,7 +1959,7 @@ components: update: [] delete: [] access_levels: - id: accesscontextmanager.access_levels + id: google.accesscontextmanager.access_levels name: access_levels title: Access_levels methods: @@ -2009,15 +2010,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/access_levels/methods/list' - $ref: '#/components/x-stackQL-resources/access_levels/methods/get' + - $ref: '#/components/x-stackQL-resources/access_levels/methods/list' insert: - $ref: '#/components/x-stackQL-resources/access_levels/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/access_levels/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/access_levels/methods/delete' access_levels_iam_policies: - id: accesscontextmanager.access_levels_iam_policies + id: google.accesscontextmanager.access_levels_iam_policies name: access_levels_iam_policies title: Access_levels_iam_policies methods: @@ -2034,7 +2036,7 @@ components: update: [] delete: [] service_perimeters: - id: accesscontextmanager.service_perimeters + id: google.accesscontextmanager.service_perimeters name: service_perimeters title: Service_perimeters methods: @@ -2093,15 +2095,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/service_perimeters/methods/list' - $ref: '#/components/x-stackQL-resources/service_perimeters/methods/get' + - $ref: '#/components/x-stackQL-resources/service_perimeters/methods/list' insert: - $ref: '#/components/x-stackQL-resources/service_perimeters/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/service_perimeters/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/service_perimeters/methods/delete' service_perimeters_iam_policies: - id: accesscontextmanager.service_perimeters_iam_policies + id: google.accesscontextmanager.service_perimeters_iam_policies name: service_perimeters_iam_policies title: Service_perimeters_iam_policies methods: @@ -2118,7 +2121,7 @@ components: update: [] delete: [] authorized_orgs_descs: - id: accesscontextmanager.authorized_orgs_descs + id: google.accesscontextmanager.authorized_orgs_descs name: authorized_orgs_descs title: Authorized_orgs_descs methods: @@ -2163,18 +2166,20 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/authorized_orgs_descs/methods/get' - $ref: >- #/components/x-stackQL-resources/authorized_orgs_descs/methods/list - - $ref: '#/components/x-stackQL-resources/authorized_orgs_descs/methods/get' insert: - $ref: >- #/components/x-stackQL-resources/authorized_orgs_descs/methods/create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/authorized_orgs_descs/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/authorized_orgs_descs/methods/delete services: - id: accesscontextmanager.services + id: google.accesscontextmanager.services name: services title: Services methods: @@ -2196,13 +2201,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/services/methods/list' - $ref: '#/components/x-stackQL-resources/services/methods/get' + - $ref: '#/components/x-stackQL-resources/services/methods/list' insert: [] update: [] delete: [] gcp_user_access_bindings: - id: accesscontextmanager.gcp_user_access_bindings + id: google.accesscontextmanager.gcp_user_access_bindings name: gcp_user_access_bindings title: Gcp_user_access_bindings methods: @@ -2247,14 +2252,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/gcp_user_access_bindings/methods/list - $ref: >- #/components/x-stackQL-resources/gcp_user_access_bindings/methods/get + - $ref: >- + #/components/x-stackQL-resources/gcp_user_access_bindings/methods/list insert: - $ref: >- #/components/x-stackQL-resources/gcp_user_access_bindings/methods/create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/gcp_user_access_bindings/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/gcp_user_access_bindings/methods/delete 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 f192f7ec..4666fd88 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/addressvalidation.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/addressvalidation.yaml @@ -12,7 +12,7 @@ info: deliverability of the parsed address. version: v1 x-discovery-doc-revision: '20240529' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://developers.google.com/maps/documentation/addressvalidation servers: @@ -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,164 +41,172 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleTypeLatLng: + GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse: + type: object + id: GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse + properties: {} 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. + The response for validation feedback. The response is empty if the + feedback is sent successfully. + 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 } } properties: - latitude: - format: double - type: number - description: The latitude in degrees. It must be in the range [-90.0, +90.0]. - longitude: - format: double - description: The longitude in degrees. It must be in the range [-180.0, +180.0]. - type: number + 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' + id: GoogleGeoTypeViewport type: object - id: GoogleTypeLatLng - 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 + GoogleMapsAddressvalidationV1AddressComponent: + id: GoogleMapsAddressvalidationV1AddressComponent properties: - 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. - addressLines: + spellCorrected: + type: boolean 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 - languageCode: + 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". + confirmationLevel: + enum: + - CONFIRMATION_LEVEL_UNSPECIFIED + - CONFIRMED + - UNCONFIRMED_BUT_PLAUSIBLE + - UNCONFIRMED_AND_SUSPICIOUS + 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. 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 - organization: + Indicates the level of certainty that we have that the component is + correct. type: string - description: Optional. The name of the organization at the address. - recipients: + inferred: + type: boolean 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 - regionCode: + 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. + replaced: 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: - type: string + 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 + unexpected: + type: boolean 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.). - administrativeArea: + 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: + description: The name for this component. + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1ComponentName' + 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 + type: object + description: Represents an address component, such as a street, city, or state. + GoogleMapsAddressvalidationV1AddressMetadata: + id: GoogleMapsAddressvalidationV1AddressMetadata + properties: + residential: + type: boolean 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. - revision: - type: integer + Indicates that this is the address of a residence. If unset, + indicates that the value is unknown. + poBox: + type: boolean 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: - type: string + Indicates that the address of a PO box. If unset, indicates that the + value is unknown. + business: + type: boolean 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). - sublocality: + 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 + GoogleMapsAddressvalidationV1PlusCode: + 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. + properties: + compoundCode: description: >- - Optional. Sublocality of the address. For example, this can be - neighborhoods, boroughs, districts. + 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 - type: object - id: GoogleTypePostalAddress + 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). + id: GoogleMapsAddressvalidationV1PlusCode GoogleMapsAddressvalidationV1ValidationResult: - id: GoogleMapsAddressvalidationV1ValidationResult + description: The result of validating an address. type: object + id: GoogleMapsAddressvalidationV1ValidationResult properties: + uspsData: + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1UspsData' + description: >- + Extra deliverability flags provided by USPS. Only provided in region + `US` and `PR`. verdict: $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Verdict' description: Overall verdict flags - geocode: - description: >- - Information about the location and place that the address geocoded - to. - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Geocode' - uspsData: - description: >- - Extra deliverability flags provided by USPS. Only provided in region - `US` and `PR`. - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1UspsData' 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. + geocode: + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Geocode' + description: >- + Information about the location and place that the address geocoded + to. englishLatinAddress: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Address' description: >- Preview: This feature is in Preview (pre-GA). Pre-GA products and features might have limited support, and changes to pre-GA products @@ -227,222 +235,13 @@ components: [google.maps.addressvalidation.v1.AddressComponent.confirmation_level] fields in `english_latin_address.address_components` are not populated. - address: $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Address' + address: description: Information about the address itself as opposed to the geocode. - description: The result of validating an address. - GoogleMapsAddressvalidationV1Address: - properties: - unresolvedTokens: - type: array - 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. - items: - type: string - 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 - 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: >- - 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 - addressComponents: - items: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1AddressComponent' - type: array - 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. - postalAddress: - $ref: '#/components/schemas/GoogleTypePostalAddress' - description: The post-processed address represented as a postal address. - 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. - 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 - type: object - GoogleMapsAddressvalidationV1PlusCode: - type: object - properties: - 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 - compoundCode: - 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 - 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. - id: GoogleMapsAddressvalidationV1PlusCode - GoogleMapsAddressvalidationV1ValidateAddressResponse: - description: The response to an address validation request. - id: GoogleMapsAddressvalidationV1ValidateAddressResponse - properties: - 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. - result: - description: The result of the address validation. - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1ValidationResult' - type: object - GoogleMapsAddressvalidationV1UspsAddress: - type: object - description: USPS representation of a US address. - id: GoogleMapsAddressvalidationV1UspsAddress - properties: - zipCodeExtension: - type: string - description: 4-digit postal code extension e.g. 5023. - urbanization: - type: string - description: Puerto Rican urbanization name. - firstAddressLine: - type: string - description: First address line. - firm: - description: Firm name. - type: string - cityStateZipAddressLine: - type: string - description: City + state + postal code. - city: - type: string - description: City name. - secondAddressLine: - type: string - description: Second address line. - zipCode: - type: string - description: Postal code e.g. 10009. - state: - description: 2 letter state code. - type: string - GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest: - id: GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest - type: object - properties: - responseId: - type: string - 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: - 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. - 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. - enum: - - VALIDATION_CONCLUSION_UNSPECIFIED - - VALIDATED_VERSION_USED - - USER_VERSION_USED - - UNVALIDATED_VERSION_USED - - UNUSED - type: string - description: The request for sending validation feedback. + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Address' GoogleMapsAddressvalidationV1ValidateAddressRequest: - description: The request for validating an address. properties: - 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. - 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. - type: string 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 @@ -462,7 +261,9 @@ components: API, not the Autocomplete API. See https://developers.google.com/maps/documentation/places/web-service/session-pricing for more details. + 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 @@ -474,195 +275,73 @@ components: descriptions](https://developers.google.com/maps/launch-stages). Enables the Address Validation API to include additional information in the response. - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1LanguageOptions' - type: object - id: GoogleMapsAddressvalidationV1ValidateAddressRequest - GoogleMapsAddressvalidationV1AddressComponent: - id: GoogleMapsAddressvalidationV1AddressComponent - properties: - replaced: + previousResponseId: 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 - componentType: + 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 + address: + $ref: '#/components/schemas/GoogleTypePostalAddress' 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. - 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. - confirmationLevel: - description: >- - Indicates the level of certainty that we have that the component is - correct. - 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. - type: string - enum: - - CONFIRMATION_LEVEL_UNSPECIFIED - - CONFIRMED - - UNCONFIRMED_BUT_PLAUSIBLE - - UNCONFIRMED_AND_SUSPICIOUS - componentName: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1ComponentName' - description: The name for this component. - 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 - type: object - description: Represents an address component, such as a street, city, or state. - 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 - id: 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. - GoogleMapsAddressvalidationV1AddressMetadata: - id: GoogleMapsAddressvalidationV1AddressMetadata - type: object - properties: - poBox: - description: >- - Indicates that the address of a PO box. If unset, indicates that the - value is unknown. - type: boolean - business: - 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. + enableUspsCass: description: >- - Indicates that this is the address of a business. If unset, - indicates that the value is unknown. - residential: + 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 - description: >- - Indicates that this is the address of a residence. 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. - GoogleMapsAddressvalidationV1ComponentName: - description: A wrapper for the name of the component. - id: GoogleMapsAddressvalidationV1ComponentName - type: object - properties: - languageCode: - 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. - type: string - text: - type: string - description: >- - The name text. For example, "5th Avenue" for a street name or "1253" - for a street number. - GoogleGeoTypeViewport: - id: GoogleGeoTypeViewport - 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' - 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 } } - GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse: - properties: {} - id: GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse + id: GoogleMapsAddressvalidationV1ValidateAddressRequest + description: The request for validating an address. type: object - description: >- - The response for validation feedback. The response is empty if the - feedback is sent successfully. GoogleMapsAddressvalidationV1Verdict: - type: object description: High level overview of the address validation result and geocode. id: GoogleMapsAddressvalidationV1Verdict + type: object properties: 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. - type: boolean 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 - inputGranularity: + validationGranularity: 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 + 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]. enumDescriptions: - Default value. This value is unused. - Below-building level result, such as an apartment. @@ -687,15 +366,65 @@ components: - BLOCK - ROUTE - OTHER - validationGranularity: type: string + hasInferredComponents: 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]. + At least one address component was inferred (added) that wasn't in + the input, see + [google.maps.addressvalidation.v1.Address.address_components] for + details. + type: boolean + hasReplacedComponents: + type: boolean + description: >- + At least one address component was replaced, see + [google.maps.addressvalidation.v1.Address.address_components] for + details. + inputGranularity: + 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. + - >- + 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: >- + 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 + enum: + - GRANULARITY_UNSPECIFIED + - SUB_PREMISE + - PREMISE + - PREMISE_PROXIMITY + - BLOCK + - ROUTE + - OTHER + 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`. enum: - GRANULARITY_UNSPECIFIED - SUB_PREMISE @@ -720,62 +449,427 @@ components: - >- All other granularities, which are bucketed together since they are not deliverable. - hasReplacedComponents: - type: boolean + type: string + GoogleMapsAddressvalidationV1UspsData: + type: object + id: GoogleMapsAddressvalidationV1UspsData + properties: + 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 + postOfficeCity: + type: string + description: Main post office city. + lacsLinkIndicator: + type: string + description: LACSLink indicator. + cassProcessed: + description: Indicator that the request has been CASS processed. + type: boolean + dpvFootnote: + type: string + 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 + 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 + 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 + suitelinkFootnote: + type: string + 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. + carrierRouteIndicator: + description: Carrier route rate sort indicator. + type: string + addressRecordType: + type: string + 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. + dpvVacant: + description: >- + Is this place vacant? Returns a single character. * `Y`: The address + is vacant * `N`: The address is not vacant + type: string + errorMessage: + type: string + 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. + deliveryPointCode: + type: string + description: 2 digit delivery point code + deliveryPointCheckDigit: + type: string + 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. + elotFlag: + type: string + description: eLOT Ascending/Descending Flag (A/D). + 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 + dpvNoSecureLocation: + 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. + pmbDesignator: + type: string + description: PMB (Private Mail Box) unit designator. + dpvNoStat: + 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 + standardizedAddress: + description: USPS standardized address. + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1UspsAddress' + postOfficeState: + description: Main post office state. + type: string + fipsCountyCode: + description: FIPS county code. + type: string + county: + description: County name. + type: string + elotNumber: + description: Enhanced Line of Travel (eLOT) number. + type: string + lacsLinkReturnCode: + description: LACSLink return code. + 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 by 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 + pmbNumber: + type: string + description: PMB (Private Mail Box) number; + abbreviatedCity: + description: Abbreviated city. + type: string + ewsNoMatch: + description: >- + The delivery address is matchable, but the EWS file indicates that + an exact match will be available soon. + type: boolean + 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. + 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 + 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 + dpvNoStatReasonCode: + 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. + type: integer + format: int32 + 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. + defaultAddress: + type: boolean + description: >- + Indicator that a default address was found, but more specific + addresses exists. + poBoxOnlyPostalCode: + description: PO Box only postal code. + type: boolean + 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. + 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. + GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest: + type: object + id: GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest + description: The request for sending validation feedback. + properties: + responseId: + 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. + type: string + conclusion: + 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. + type: string + enum: + - VALIDATION_CONCLUSION_UNSPECIFIED + - VALIDATED_VERSION_USED + - USER_VERSION_USED + - UNVALIDATED_VERSION_USED + - UNUSED + 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. + 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 + format: double + description: The longitude in degrees. It must be in the range [-180.0, +180.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: GoogleTypeLatLng + type: object + 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 + id: GoogleTypePostalAddress + properties: + 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. + sublocality: + description: >- + Optional. Sublocality of the address. For example, this can be + neighborhoods, boroughs, districts. + type: string + organization: + type: string + description: Optional. The name of the organization at the address. + 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 + 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 + 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 + 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. + 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). + sortingCode: description: >- - At least one address component was replaced, see - [google.maps.addressvalidation.v1.Address.address_components] for - details. - geocodeGranularity: - enum: - - GRANULARITY_UNSPECIFIED - - SUB_PREMISE - - PREMISE - - PREMISE_PROXIMITY - - BLOCK - - ROUTE - - OTHER + 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: type: string - 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. - - >- - 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: >- - 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`. - hasInferredComponents: + 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.). + locality: + type: string 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. - type: boolean + 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. GoogleMapsAddressvalidationV1Geocode: - type: object - id: GoogleMapsAddressvalidationV1Geocode properties: - bounds: - $ref: '#/components/schemas/GoogleGeoTypeViewport' - description: The bounds of the geocoded place. + plusCode: + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1PlusCode' + description: The plus code corresponding to the `location`. 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. @@ -786,305 +880,205 @@ components: to the property. Additionally, when a location is reverse geocoded, there is no guarantee that the returned address will match the original. - $ref: '#/components/schemas/GoogleTypeLatLng' - plusCode: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1PlusCode' - description: The plus code corresponding to the `location`. - featureSizeMeters: - 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. - type: number - format: float 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). + type: string placeTypes: - type: array items: type: string 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 + featureSizeMeters: + type: number + format: float + 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. + bounds: + description: The bounds of the geocoded place. + $ref: '#/components/schemas/GoogleGeoTypeViewport' + type: object description: Contains information about the place the input was geocoded to. - GoogleMapsAddressvalidationV1UspsData: + id: GoogleMapsAddressvalidationV1Geocode + GoogleMapsAddressvalidationV1ComponentName: + id: GoogleMapsAddressvalidationV1ComponentName + description: A wrapper for the name of the component. + type: object properties: - deliveryPointCode: - description: 2 digit delivery point code - type: string - postOfficeCity: - description: Main post office city. - 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 - 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 - carrierRouteIndicator: - description: Carrier route rate sort indicator. - type: string - elotFlag: - description: eLOT Ascending/Descending Flag (A/D). - 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. - dpvFootnote: - type: string - 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 - dpvNoStatReasonCode: - 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. - format: int32 - type: integer - dpvNoSecureLocation: - 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. - elotNumber: - type: string - description: Enhanced Line of Travel (eLOT) number. - dpvDrop: - type: string - 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. - 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 - carrierRoute: + languageCode: 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 - dpvNonDeliveryDays: + 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. type: string + text: 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. - dpvNoStat: + The name text. For example, "5th Avenue" for a street name or "1253" + for a street number. type: string + GoogleMapsAddressvalidationV1Address: + id: GoogleMapsAddressvalidationV1Address + properties: + missingComponentTypes: + type: array + items: + 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 - dpvVacant: - description: >- - Is this place vacant? Returns a single character. * `Y`: The address - is vacant * `N`: The address is not vacant - type: string - poBoxOnlyPostalCode: - description: PO Box only postal code. - type: boolean - dpvNonDeliveryDaysValues: - format: int32 - type: integer + 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). + unresolvedTokens: + items: + type: string + type: array 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 - fipsCountyCode: + 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. + formattedAddress: type: string - description: FIPS county code. - defaultAddress: - type: boolean description: >- - Indicator that a default address was found, but more specific - addresses exists. - deliveryPointCheckDigit: + The post-processed address, formatted as a single-line address + following the address formatting rules of the region where the + address is located. + postalAddress: + $ref: '#/components/schemas/GoogleTypePostalAddress' + description: The post-processed address represented as a postal address. + addressComponents: + type: array + items: + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1AddressComponent' 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. - type: string - dpvDoorNotAccessible: - type: string + 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. + unconfirmedComponentTypes: 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. - addressRecordType: - type: string + 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 + 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. + GoogleMapsAddressvalidationV1ValidateAddressResponse: + type: object + properties: + responseId: 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. - abbreviatedCity: + The UUID that identifies this response. If the address needs to be + re-validated, this UUID *must* accompany the new request. type: string - description: Abbreviated city. - lacsLinkReturnCode: + result: + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1ValidationResult' + description: The result of the address validation. + id: GoogleMapsAddressvalidationV1ValidateAddressResponse + description: The response to an address validation request. + GoogleMapsAddressvalidationV1LanguageOptions: + type: object + id: GoogleMapsAddressvalidationV1LanguageOptions + properties: + returnEnglishLatinAddress: + description: >- + Preview: Return a [google.maps.addressvalidation.v1.Address] in + English. See + [google.maps.addressvalidation.v1.ValidationResult.english_latin_address] + for details. + type: boolean + 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. + GoogleMapsAddressvalidationV1UspsAddress: + description: USPS representation of a US address. + id: GoogleMapsAddressvalidationV1UspsAddress + properties: + urbanization: type: string - description: LACSLink return code. - county: + description: Puerto Rican urbanization name. + firstAddressLine: type: string - description: County name. - cassProcessed: - type: boolean - description: Indicator that the request has been CASS processed. - pmbDesignator: - description: PMB (Private Mail Box) unit designator. + description: First address line. + state: + description: 2 letter state code. type: string - standardizedAddress: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1UspsAddress' - description: USPS standardized address. - dpvEnhancedDeliveryCode: + city: + description: City name. 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 by 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. - suitelinkFootnote: + firm: type: string - 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. - ewsNoMatch: - description: >- - The delivery address is matchable, but the EWS file indicates that - an exact match will be available soon. - type: boolean - postOfficeState: + description: Firm name. + zipCode: + description: Postal code e.g. 10009. type: string - description: Main post office state. - lacsLinkIndicator: - description: LACSLink indicator. + secondAddressLine: type: string - dpvCmra: - 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 + description: Second address line. + cityStateZipAddressLine: + description: City + state + postal code. type: string - pmbNumber: - description: PMB (Private Mail Box) number; + zipCodeExtension: type: string - 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 + description: 4-digit postal code extension e.g. 5023. type: object parameters: - 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. + alt: + description: Data format for response. in: query - name: key + 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 - 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 - 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 callback: @@ -1093,10 +1087,13 @@ components: 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 access_token: @@ -1105,16 +1102,19 @@ components: 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 - 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 _.xgafv: @@ -1134,7 +1134,7 @@ components: type: string x-stackQL-resources: addressvalidation: - id: addressvalidation.addressvalidation + id: google.addressvalidation.addressvalidation name: addressvalidation title: Addressvalidation methods: @@ -1158,15 +1158,15 @@ components: paths: /v1:validateAddress: parameters: &ref_1 - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/uploadType' post: 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 3569b21c..49a9b680 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/advisorynotifications.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/advisorynotifications.yaml @@ -8,7 +8,7 @@ info: description: An API for accessing Advisory Notifications in Google Cloud version: v1 x-discovery-doc-revision: '20240526' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/advisory-notifications servers: @@ -34,227 +34,215 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudAdvisorynotificationsV1MessageBody: - description: A message body containing text. + GoogleCloudAdvisorynotificationsV1Notification: + properties: + notificationType: + enumDescriptions: + - Default type + - Security and privacy advisory notifications + - Sensitive action notifications + - 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 + subject: + description: The subject line of the notification. + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Subject' + name: + description: >- + The resource name of the notification. Format: + organizations/{organization}/locations/{location}/notifications/{notification} + or + projects/{project}/locations/{location}/notifications/{notification}. + type: string + createTime: + description: Output only. Time the notification was created. + type: string + readOnly: true + format: google-datetime + messages: + description: A list of messages in the notification. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Message' + id: GoogleCloudAdvisorynotificationsV1Notification + description: >- + A notification object for notifying customers about security and privacy + issues. type: object - id: GoogleCloudAdvisorynotificationsV1MessageBody + GoogleCloudAdvisorynotificationsV1Attachment: + type: object + description: Attachment with specific information about the issue. + id: GoogleCloudAdvisorynotificationsV1Attachment properties: - text: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Text' - description: The text content of the message body. - GoogleCloudAdvisorynotificationsV1Subject: + csv: + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Csv' + description: A CSV file attachment. Max size is 10 MB. + displayName: + type: string + description: The title of the attachment. + GoogleCloudAdvisorynotificationsV1Text: + description: A text object containing the English text and its localized copies. + id: GoogleCloudAdvisorynotificationsV1Text properties: - text: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Text' - description: The text content. + localizedText: + type: string + description: The requested localized copy (if applicable). + enText: + type: string + description: The English copy. + localizationState: + type: string + 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: object + GoogleCloudAdvisorynotificationsV1NotificationSettings: + description: Settings for each NotificationType. + id: GoogleCloudAdvisorynotificationsV1NotificationSettings + properties: + enabled: + type: boolean + description: Whether the associated NotificationType is enabled. type: object - description: A subject line of a notification. - id: GoogleCloudAdvisorynotificationsV1Subject GoogleCloudAdvisorynotificationsV1Csv: + type: object + id: GoogleCloudAdvisorynotificationsV1Csv description: >- A representation of a CSV file attachment, as a list of column headers and a list of data rows. - type: object properties: + headers: + type: array + description: The list of headers for data columns in a CSV file. + items: + type: string dataRows: + type: array description: >- The list of data rows in a CSV file, as string arrays rather than as a single comma-separated string. - type: array items: $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1CsvCsvRow' - headers: - description: The list of headers for data columns in a CSV file. - items: - type: string - type: array - id: GoogleCloudAdvisorynotificationsV1Csv - GoogleCloudAdvisorynotificationsV1Message: + GoogleCloudAdvisorynotificationsV1CsvCsvRow: type: object - description: A message which contains notification details. - id: GoogleCloudAdvisorynotificationsV1Message + description: A representation of a single data row in a CSV file. properties: - localizationTime: - format: google-datetime - description: Time when Message was localized - type: string - body: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1MessageBody' - description: The message content. - attachments: - description: The attachments to download. + entries: type: array items: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Attachment' - createTime: - description: The Message creation timestamp. - format: google-datetime - type: string - GoogleCloudAdvisorynotificationsV1NotificationSettings: + type: string + description: >- + The data entries in a CSV file row, as a string array rather than a + single comma-separated string. + id: GoogleCloudAdvisorynotificationsV1CsvCsvRow + GoogleCloudAdvisorynotificationsV1Subject: + description: A subject line of a notification. properties: - enabled: - type: boolean - description: Whether the associated NotificationType is enabled. - description: Settings for each NotificationType. - id: GoogleCloudAdvisorynotificationsV1NotificationSettings + text: + description: The text content. + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Text' type: object + id: GoogleCloudAdvisorynotificationsV1Subject GoogleCloudAdvisorynotificationsV1Settings: id: GoogleCloudAdvisorynotificationsV1Settings 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. name: + type: string 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: 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: object + type: object description: Settings for Advisory Notifications. - GoogleCloudAdvisorynotificationsV1Notification: + type: object + GoogleCloudAdvisorynotificationsV1MessageBody: properties: - notificationType: - description: Type of notification - type: string - enum: - - NOTIFICATION_TYPE_UNSPECIFIED - - NOTIFICATION_TYPE_SECURITY_PRIVACY_ADVISORY - - NOTIFICATION_TYPE_SENSITIVE_ACTIONS - - NOTIFICATION_TYPE_SECURITY_MSA - - NOTIFICATION_TYPE_THREAT_HORIZONS - enumDescriptions: - - Default type - - Security and privacy advisory notifications - - Sensitive action notifications - - General security MSA - - Threat horizons MSA - messages: + text: + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Text' + description: The text content of the message body. + type: object + id: GoogleCloudAdvisorynotificationsV1MessageBody + description: A message body containing text. + GoogleCloudAdvisorynotificationsV1Message: + description: A message which contains notification details. + id: GoogleCloudAdvisorynotificationsV1Message + properties: + attachments: items: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Message' - description: A list of messages in the notification. + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Attachment' type: array - subject: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Subject' - description: The subject line of the notification. + description: The attachments to download. + body: + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1MessageBody' + description: The message content. + localizationTime: + type: string + description: Time when Message was localized + format: google-datetime createTime: + description: The Message creation timestamp. format: google-datetime type: string - description: Output only. Time the notification was created. - readOnly: true - name: - description: >- - The resource name of the notification. Format: - organizations/{organization}/locations/{location}/notifications/{notification} - or - projects/{project}/locations/{location}/notifications/{notification}. - type: string - description: >- - A notification object for notifying customers about security and privacy - issues. - id: GoogleCloudAdvisorynotificationsV1Notification - type: object - GoogleCloudAdvisorynotificationsV1CsvCsvRow: - properties: - entries: - type: array - items: - type: string - description: >- - The data entries in a CSV file row, as a string array rather than a - single comma-separated string. type: object - description: A representation of a single data row in a CSV file. - id: GoogleCloudAdvisorynotificationsV1CsvCsvRow GoogleCloudAdvisorynotificationsV1ListNotificationsResponse: type: object id: 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. - totalSize: - type: integer - description: Estimation of a total number of notifications. - format: int32 notifications: + type: array items: $ref: >- #/components/schemas/GoogleCloudAdvisorynotificationsV1Notification description: List of notifications under a given parent. - type: array - description: Response of ListNotifications endpoint. - GoogleCloudAdvisorynotificationsV1Text: - description: A text object containing the English text and its localized copies. - id: GoogleCloudAdvisorynotificationsV1Text - properties: - localizationState: - 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 - description: Status of the localization. - enum: - - LOCALIZATION_STATE_UNSPECIFIED - - LOCALIZATION_STATE_NOT_APPLICABLE - - LOCALIZATION_STATE_PENDING - - LOCALIZATION_STATE_COMPLETED - localizedText: - type: string - description: The requested localized copy (if applicable). - enText: - description: The English copy. - type: string - type: object - GoogleCloudAdvisorynotificationsV1Attachment: - properties: - displayName: - description: The title of the attachment. + totalSize: + description: Estimation of a total number of notifications. + format: int32 + type: integer + nextPageToken: type: string - csv: - description: A CSV file attachment. Max size is 10 MB. - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Csv' - description: Attachment with specific information about the issue. - type: object - id: GoogleCloudAdvisorynotificationsV1Attachment + 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: - 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"). - in: query - name: uploadType - schema: - type: string key: description: >- API key. Your API key identifies your project and provides you with API @@ -264,12 +252,36 @@ 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 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' alt: description: Data format for response. in: query @@ -286,123 +298,106 @@ components: 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. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: quotaUser + 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 - _.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' - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + callback: + description: JSONP in: query - name: upload_protocol + name: callback schema: type: string x-stackQL-resources: - settings: - id: advisorynotifications.settings - name: settings - title: Settings + notifications: + id: google.advisorynotifications.notifications + name: notifications + title: Notifications methods: - update_settings: - operation: + _list: + operation: &ref_1 $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1settings/patch - response: + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1notifications/get + response: &ref_2 mediaType: application/json openAPIDocKey: '200' - get_settings: + objectKey: $.notifications + list: + operation: *ref_1 + response: *ref_2 + get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1settings/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1notifications~1{notificationsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/settings/methods/get_settings' - - $ref: '#/components/x-stackQL-resources/settings/methods/get_settings' + - $ref: '#/components/x-stackQL-resources/notifications/methods/get' + - $ref: '#/components/x-stackQL-resources/notifications/methods/get' + - $ref: '#/components/x-stackQL-resources/notifications/methods/list' + - $ref: '#/components/x-stackQL-resources/notifications/methods/list' insert: [] update: [] delete: [] - notifications: - id: advisorynotifications.notifications - name: notifications - title: Notifications + settings: + id: google.advisorynotifications.settings + name: settings + title: Settings methods: - get: + get_settings: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1notifications~1{notificationsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1settings/get response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + update_settings: + operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1notifications/get - response: &ref_2 + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1settings/patch + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.notifications - list: - operation: *ref_1 - response: *ref_2 sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/notifications/methods/get' - - $ref: '#/components/x-stackQL-resources/notifications/methods/list' - - $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' + - $ref: '#/components/x-stackQL-resources/settings/methods/get_settings' insert: [] update: [] delete: [] paths: - /v1/projects/{projectsId}/locations/{locationsId}/settings: + /v1/projects/{projectsId}/locations/{locationsId}/notifications: parameters: &ref_3 - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/upload_protocol' - patch: - description: Update notification settings. - operationId: advisorynotifications.projects.locations.updateSettings - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Settings' + get: + description: Lists notifications under a given parent. + operationId: advisorynotifications.projects.locations.notifications.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -415,7 +410,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1Settings + #/components/schemas/GoogleCloudAdvisorynotificationsV1ListNotificationsResponse parameters: - in: path name: projectsId @@ -427,33 +422,23 @@ 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 - required: true + - in: query + name: languageCode schema: type: string - - in: path - name: locationsId - required: true + - 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}/notifications/{notificationsId}: parameters: *ref_3 get: @@ -492,11 +477,11 @@ paths: name: languageCode schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notifications: + /v1/projects/{projectsId}/locations/{locationsId}/settings: parameters: *ref_3 get: - description: Lists notifications under a given parent. - operationId: advisorynotifications.projects.locations.notifications.list + description: Get notification settings. + operationId: advisorynotifications.projects.locations.getSettings security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -509,7 +494,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1ListNotificationsResponse + #/components/schemas/GoogleCloudAdvisorynotificationsV1Settings parameters: - in: path name: projectsId @@ -521,28 +506,14 @@ 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: languageCode - schema: - type: string - - in: query - name: view - schema: - type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/notifications/{notificationsId}: - parameters: *ref_3 - get: - description: Gets a notification. - operationId: advisorynotifications.organizations.locations.notifications.get + patch: + description: Update notification settings. + operationId: advisorynotifications.projects.locations.updateSettings + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Settings' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -555,10 +526,10 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1Notification + #/components/schemas/GoogleCloudAdvisorynotificationsV1Settings parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -567,15 +538,6 @@ 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_3 get: @@ -606,7 +568,7 @@ paths: schema: type: string - in: query - name: languageCode + name: view schema: type: string - in: query @@ -614,7 +576,7 @@ paths: schema: type: string - in: query - name: view + name: languageCode schema: type: string - in: query @@ -622,11 +584,11 @@ paths: schema: type: integer format: int32 - /v1/organizations/{organizationsId}/locations/{locationsId}/settings: + /v1/organizations/{organizationsId}/locations/{locationsId}/notifications/{notificationsId}: parameters: *ref_3 get: - description: Get notification settings. - operationId: advisorynotifications.organizations.locations.getSettings + description: Gets a notification. + operationId: advisorynotifications.organizations.locations.notifications.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -639,7 +601,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1Settings + #/components/schemas/GoogleCloudAdvisorynotificationsV1Notification parameters: - in: path name: organizationsId @@ -651,6 +613,17 @@ 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}/settings: + parameters: *ref_3 patch: description: Update notification settings. operationId: advisorynotifications.organizations.locations.updateSettings @@ -683,3 +656,30 @@ paths: required: true schema: type: string + get: + description: Get notification settings. + operationId: advisorynotifications.organizations.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: organizationsId + 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/aiplatform.yaml b/providers/src/googleapis.com/v00.00.00000/services/aiplatform.yaml index 78b61d96..055d29ad 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/aiplatform.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/aiplatform.yaml @@ -10,7 +10,7 @@ info: learning expertise and effort. version: v1 x-discovery-doc-revision: '20240529' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' 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.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,7340 +39,7107 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudAiplatformV1SchemaPredictPredictionClassificationPredictionResult: + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation + type: object properties: - displayNames: + 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. + GoogleCloudAiplatformV1PipelineTaskDetail: + type: object + description: The runtime detail of a task execution. + properties: + executorDetail: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PipelineTaskExecutorDetail + description: Output only. The detailed execution info. + readOnly: true + taskId: + format: int64 + type: string + readOnly: true + description: Output only. The system generated ID of the task. + outputs: + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetailArtifactList + readOnly: true + description: Output only. The runtime output artifacts of the task. + inputs: + readOnly: true + description: Output only. The runtime input artifacts of the task. + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetailArtifactList + type: object + execution: + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + description: Output only. The execution metadata of the task. + pipelineTaskStatus: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus + description: >- + Output only. A list of task status. This field keeps a record of + task status evolving over time. + readOnly: true + createTime: + type: string + readOnly: true + format: google-datetime + description: Output only. Task create time. + error: + readOnly: true + description: >- + Output only. The error that occurred during task execution. Only + populated when the task's state is FAILED or CANCELLED. + $ref: '#/components/schemas/GoogleRpcStatus' + taskName: + description: >- + Output only. The user specified name of the task that is defined in + pipeline_spec. + type: string + readOnly: true + startTime: + description: Output only. Task start time. + format: google-datetime + type: string + readOnly: true + state: + 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 + endTime: + readOnly: true + type: string + description: Output only. Task end time. + format: google-datetime + parentTaskId: + format: int64 + type: string + 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 + id: GoogleCloudAiplatformV1PipelineTaskDetail + GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest: + description: Request message for JobService.CancelHyperparameterTuningJob. + type: object + properties: {} + id: GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest + GoogleCloudAiplatformV1CreateFeatureViewOperationMetadata: + description: Details of operations that perform create FeatureView. + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for FeatureView Create. + id: GoogleCloudAiplatformV1CreateFeatureViewOperationMetadata + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs: + properties: + windowConfig: + description: Config containing strategy for generating sliding windows. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig + 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 + additionalExperiments: + description: Additional experiment flags for the time series forcasting training. items: type: string type: array + forecastHorizon: description: >- - The display names of the AnnotationSpecs that had been identified, - order matches the IDs. - confidences: - items: - type: number - format: float + 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 + unavailableAtForecastColumns: type: array description: >- - The Model's confidences in correctness of the predicted IDs, higher - value means higher confidence. Order matches the Ids. - ids: + 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 + 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. items: - format: int64 type: string - description: The resource IDs of the AnnotationSpecs that had been identified. type: array - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionClassificationPredictionResult - description: Prediction output format for Image and Text Classification. - type: object - GoogleCloudAiplatformV1IndexDatapointSparseEmbedding: - type: object - properties: - values: + targetColumn: + description: >- + The name of the column that the Model is to predict values for. This + column must be unavailable at forecast. + type: string + 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. + 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 + availableAtForecastColumns: type: array - description: Required. The list of embedding values of the sparse vector. items: - format: float - type: number - dimensions: - items: - format: int64 type: string description: >- - Required. The list of indexes for the embedding values of the sparse - vector. + 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. + 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. + quantiles: + 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 - description: >- - Feature embedding vector for sparse index. An array of numbers whose - values are located in the specified dimensions. - id: GoogleCloudAiplatformV1IndexDatapointSparseEmbedding - GoogleCloudAiplatformV1ListModelEvaluationsResponse: - description: Response message for ModelService.ListModelEvaluations. - type: object - id: GoogleCloudAiplatformV1ListModelEvaluationsResponse - properties: - modelEvaluations: - description: List of ModelEvaluations in the requested page. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' - type: array - nextPageToken: - type: string + type: number + format: double + hierarchyConfig: description: >- - A token to retrieve next page of results. Pass to - ListModelEvaluationsRequest.page_token to obtain that page. - GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective: - properties: - 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. + Configuration that defines the hierarchical relationship of time + series and parameters for hierarchical forecasting strategies. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig + trainBudgetMilliNodeHours: + format: int64 type: string - enum: - - MODEL_DEPLOYMENT_MONITORING_OBJECTIVE_TYPE_UNSPECIFIED - - RAW_FEATURE_SKEW - - RAW_FEATURE_DRIFT - - FEATURE_ATTRIBUTION_SKEW - - FEATURE_ATTRIBUTION_DRIFT - topFeatureCount: 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 - description: Stats requested for specific objective. - type: object - id: >- - GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective - GoogleCloudAiplatformV1SafetySetting: - description: Safety settings. - type: object - properties: - 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. - 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. - method: - enum: - - HARM_BLOCK_METHOD_UNSPECIFIED - - SEVERITY - - PROBABILITY + 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. + timeColumn: description: >- - Optional. Specify if the threshold is used for probability or - severity score. If not specified, the threshold is used for - probability score. - 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. + The name of the column that identifies time order in the time + series. This column must be available at forecast. type: string - 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. - enum: - - HARM_CATEGORY_UNSPECIFIED - - HARM_CATEGORY_HATE_SPEECH - - HARM_CATEGORY_DANGEROUS_CONTENT - - HARM_CATEGORY_HARASSMENT - - HARM_CATEGORY_SEXUALLY_EXPLICIT + timeSeriesIdentifierColumn: + description: The name of the column that identifies the time series. type: string - id: GoogleCloudAiplatformV1SafetySetting - GoogleCloudAiplatformV1FeatureOnlineStoreBigtable: - type: object - properties: - autoScaling: - description: Required. Autoscaling config applied to Bigtable Instance. + 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 + transformations: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation + 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. + dataGranularity: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling - id: GoogleCloudAiplatformV1FeatureOnlineStoreBigtable - GoogleCloudAiplatformV1SchemaModelevaluationMetricsSummarizationEvaluationMetrics: - type: object + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity + description: Expected difference in time granularity between rows in the data. + 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. + items: + type: string + type: array id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsSummarizationEvaluationMetrics - properties: - rougeLSum: - type: number - format: float - description: ROUGE-L (Longest Common Subsequence) scoring at summary level. - GoogleCloudAiplatformV1BoolArray: - id: GoogleCloudAiplatformV1BoolArray + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs + type: object + GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider: type: object + id: GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider properties: - values: + allowedIssuers: + 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` type: array - description: A list of bool values. items: - type: boolean - description: A list of boolean values. - GoogleCloudAiplatformV1ShieldedVmConfig: + type: string + 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 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 - id: GoogleCloudAiplatformV1ShieldedVmConfig + Configuration for an authentication provider, including support for + [JSON Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact: properties: - enableSecureBoot: - type: boolean + artifactId: + type: string 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. - GoogleCloudAiplatformV1DeployIndexRequest: - id: GoogleCloudAiplatformV1DeployIndexRequest - properties: - deployedIndex: - description: Required. The DeployedIndex to be created within the IndexEndpoint. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' + 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: object - description: Request message for IndexEndpointService.DeployIndex. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation + id: GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact + description: The type of an input artifact. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation: type: object - properties: - columnName: - type: string + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation 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. - GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec: + 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: - defaultValue: + invalidValuesAllowed: 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. + 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 + columnName: type: string - values: - type: array - description: Required. The list of possible categories. - items: - type: string - type: object - description: Value specification for a parameter in `CATEGORICAL` type. - id: GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec - GoogleCloudAiplatformV1ExportFeatureValuesOperationMetadata: - id: GoogleCloudAiplatformV1ExportFeatureValuesOperationMetadata - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Featurestore export Feature values. - type: object - description: Details of operations that exports Features values. - GoogleCloudAiplatformV1SchemaTextExtractionAnnotation: + GoogleCloudAiplatformV1XraiAttribution: type: object 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: + stepCount: description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. - type: string - description: Annotation details specific to text extraction. - id: GoogleCloudAiplatformV1SchemaTextExtractionAnnotation - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec - type: object - properties: - parallelTrialCount: - description: The desired number of Trials to run in parallel. - type: integer - format: int32 - maxTrialCount: - description: The desired total number of Trials. + 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 - studySpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' - description: Study configuration of the HyperparameterTuningJob. - trialJobSpec: + smoothGradConfig: description: >- - The spec of a trial job. The same spec applies to the CustomJobs - created in all the trials. - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' - maxFailedTrialCount: + 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' + blurBaselineConfig: 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 - type: integer - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetection: - type: object + 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' + id: GoogleCloudAiplatformV1XraiAttribution description: >- - A TrainingJob that trains and uploads an AutoML Image Object Detection - Model. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetection - properties: - inputs: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs - description: The input parameters of this TrainingJob. - metadata: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata - description: The metadata information - GoogleTypeInterval: + 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. + GoogleCloudAiplatformV1MetadataStoreMetadataStoreState: 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: + diskUtilizationBytes: + description: The disk utilization of the MetadataStore in bytes. 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 - 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 - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation: + format: int64 type: object - properties: - columnName: - type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation + description: Represents state information for a MetadataStore. + id: GoogleCloudAiplatformV1MetadataStoreMetadataStoreState + GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig: 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. - GoogleCloudAiplatformV1SchemaPredictParamsVideoClassificationPredictionParams: - id: >- - GoogleCloudAiplatformV1SchemaPredictParamsVideoClassificationPredictionParams + Config for migrating Dataset in automl.googleapis.com to Vertex AI's + Dataset. properties: - 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: - 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 - type: boolean - maxPredictions: - 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. - type: integer - confidenceThreshold: - type: number - format: float + dataset: description: >- - The Model only returns predictions with at least this confidence - score. Default value is 0.0 - segmentClassification: + Required. Full resource name of automl Dataset. Format: + `projects/{project}/locations/{location}/datasets/{dataset}`. + type: string + datasetDisplayName: 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 - type: boolean + Required. Display name of the Dataset in Vertex AI. System will pick + a display name if unspecified. + type: string type: object - description: Prediction model parameters for Video Classification. - GoogleCloudAiplatformV1PipelineJobDetail: - id: GoogleCloudAiplatformV1PipelineJobDetail + id: GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig + CloudAiLargeModelsVisionRaiInfoDetectedLabels: type: object + description: Filters returning list of deteceted labels, scores, and bounding boxes. + id: CloudAiLargeModelsVisionRaiInfoDetectedLabels properties: - pipelineContext: - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' - description: Output only. The context of the pipeline. - pipelineRunContext: - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' - description: Output only. The context of the current pipeline run. - taskDetails: + raiCategory: + description: The RAI category for the deteceted labels. + type: string + entities: type: array - readOnly: true items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetail' - description: Output only. The runtime details of the tasks under the pipeline. - description: The runtime detail of PipelineJob. - GoogleCloudAiplatformV1PurgeExecutionsRequest: + $ref: >- + #/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity + description: The list of detected entities for the rai signal. + GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec: + description: Specification for how the data should be sliced. + id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec type: object properties: - 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 - force: + configs: + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecSliceConfig 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: boolean - id: GoogleCloudAiplatformV1PurgeExecutionsRequest - description: Request message for MetadataService.PurgeExecutions. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics: + 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. + GoogleCloudAiplatformV1CancelPipelineJobRequest: + id: GoogleCloudAiplatformV1CancelPipelineJobRequest + properties: {} + description: Request message for PipelineService.CancelPipelineJob. + type: object + GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization: + id: GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization + description: Visualization configurations for image explanation. type: object - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics properties: - precision: - type: number - description: Output only. Precision for the given confidence threshold. - format: float - f1Score: - description: Output only. The harmonic mean of recall and precision. - format: float - type: number - recall: - type: number - description: Output only. Recall for the given confidence threshold. - format: float - confidenceThreshold: + clipPercentLowerbound: format: float + description: >- + Excludes attributions below the specified percentile, from the + highlighted areas. Defaults to 62. type: number + 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: >- - Output only. The confidence threshold value used to compute the - metrics. - description: Metrics for a single confidence threshold. - GoogleCloudAiplatformV1NetworkSpec: - properties: - network: + 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. + overlayType: type: string + enum: + - OVERLAY_TYPE_UNSPECIFIED + - NONE + - ORIGINAL + - GRAYSCALE + - MASK_BLACK description: >- - The full name of the Google Compute Engine - [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) - subnetwork: + 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. + 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: description: >- - The name of the subnet that this instance is in. Format: - `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}` + 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 - enableInternetAccess: - type: boolean - description: Whether to enable public internet access. Default false. - description: Network spec. - id: GoogleCloudAiplatformV1NetworkSpec - type: object - GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig: - id: >- - GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig + 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. + enum: + - POLARITY_UNSPECIFIED + - POSITIVE + - NEGATIVE + - BOTH + description: >- + Whether to only highlight pixels with positive contributions, + negative or both. Defaults to POSITIVE. + type: string + clipPercentUpperbound: + 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. + type: number + GoogleCloudAiplatformV1ImportDataResponse: + description: Response message for DatasetService.ImportData. + properties: {} type: object - description: >- - Config for migrating Dataset in datalabeling.googleapis.com to Vertex - AI's Dataset. + id: GoogleCloudAiplatformV1ImportDataResponse + GoogleCloudAiplatformV1SearchMigratableResourcesResponse: + description: Response message for MigrationService.SearchMigratableResources. properties: - dataset: + nextPageToken: type: string description: >- - Required. Full resource name of data labeling Dataset. Format: - `projects/{project}/datasets/{dataset}`. - migrateDataLabelingAnnotatedDatasetConfigs: - 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/GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig + The standard next-page token. The migratable_resources may not fill + page_size in SearchMigratableResourcesRequest even when there are + subsequent pages. + migratableResources: type: array - datasetDisplayName: - type: string description: >- - Optional. Display name of the Dataset in Vertex AI. System will pick - a display name if unspecified. - GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList: + All migratable resources that can be migrated to the location + specified in the request. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MigratableResource' type: object - id: >- - GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList + id: GoogleCloudAiplatformV1SearchMigratableResourcesResponse + GoogleCloudAiplatformV1ListOptimalTrialsRequest: + type: object + description: Request message for VizierService.ListOptimalTrials. + properties: {} + id: GoogleCloudAiplatformV1ListOptimalTrialsRequest + GoogleCloudAiplatformV1ListTensorboardExperimentsResponse: properties: - features: - description: List of feature names and values. + nextPageToken: + 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: type: array + description: The TensorboardExperiments mathching the request. items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair - description: >- - Response structure in the format of key (feature name) and (feature) - value pair. - GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment' + description: Response message for TensorboardService.ListTensorboardExperiments. + id: GoogleCloudAiplatformV1ListTensorboardExperimentsResponse + type: object + GoogleCloudAiplatformV1DataItem: + type: object properties: - logType: + updateTime: + readOnly: true + description: Output only. Timestamp when this DataItem was last updated. type: string - enum: - - LOG_TYPE_UNSPECIFIED - - PREDICT - - EXPLAIN - description: The type of log. - enumDescriptions: - - Unspecified type. - - Predict logs. - - Explain logs. - logSource: - enumDescriptions: - - Unspecified source. - - Logs coming from Training dataset. - - Logs coming from Serving traffic. + format: google-datetime + 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. + name: + readOnly: true + description: Output only. The resource name of the DataItem. type: string - description: The source of log. - enum: - - LOG_SOURCE_UNSPECIFIED - - TRAINING - - SERVING - bigqueryTablePath: + etag: type: string description: >- - The created BigQuery table to store logs. Customer could do their - own query & analysis. Format: `bq://.model_deployment_monitoring_._` - requestResponseLoggingSchemaVersion: - readOnly: true + Optional. Used to perform consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. + createTime: + format: google-datetime type: string + readOnly: true + description: Output only. Timestamp when this DataItem was created. + labels: description: >- - Output only. The schema version of the request/response logging - BigQuery table. Default to v1 if unset. + 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 + type: object description: >- - ModelDeploymentMonitoringBigQueryTable specifies the BigQuery table name - as well as some information of the logs stored in this table. + A piece of data in a Dataset. Could be an image, a video, a document or + plain text. + id: GoogleCloudAiplatformV1DataItem + GoogleCloudAiplatformV1ListTensorboardRunsResponse: + id: GoogleCloudAiplatformV1ListTensorboardRunsResponse type: object - id: GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable - GoogleCloudAiplatformV1DeployModelRequest: + description: Response message for TensorboardService.ListTensorboardRuns. properties: - trafficSplit: + nextPageToken: + type: string 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 - 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' - id: GoogleCloudAiplatformV1DeployModelRequest - description: Request message for EndpointService.DeployModel. + 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. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics: + id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics type: object - GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies: + description: >- + UNIMPLEMENTED. Track matching model metrics for a single track match + threshold and multiple label match confidence thresholds. properties: - deployedModelId: - description: Deployed Model ID. - type: string - anomalyCount: - format: int32 - description: Number of anomalies within all stats. - type: integer - featureStats: - description: A list of historical Stats and Anomalies generated for all Features. + meanMismatchRate: + type: number + description: The mean mismatch rate over all confidence thresholds. + format: float + iouThreshold: + format: float + type: number + description: >- + The intersection-over-union threshold value between bounding boxes + across frames used to compute this metric entry. + meanBoundingBoxIou: + description: The mean bounding box iou over all confidence thresholds. + type: number + format: float + meanTrackingAveragePrecision: + type: number + description: The mean average precision over all confidence thresholds. + format: float + confidenceMetrics: + type: array + 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. items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies - type: array - 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 - 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 - id: GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies - description: Statistics and anomalies generated by Model Monitoring. + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics + GoogleCloudAiplatformV1CancelCustomJobRequest: + description: Request message for JobService.CancelCustomJob. + properties: {} + id: GoogleCloudAiplatformV1CancelCustomJobRequest type: object - GoogleCloudAiplatformV1ImportFeatureValuesRequest: + 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); } + properties: {} + GoogleCloudAiplatformV1SchemaVideoClassificationAnnotation: type: object properties: - disableOnlineServing: + displayName: 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. - type: boolean - bigquerySource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' - csvSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvSource' - disableIngestionAnalysis: - type: boolean - description: If true, API doesn't start ingestion analysis pipeline. - entityIdField: + The display name of the AnnotationSpec that this Annotation pertains + to. type: string - description: >- - Source column that holds entity IDs. If not provided, entity IDs are - extracted from the column named entity_id. - featureTime: - format: google-datetime - description: >- - Single Feature timestamp for all entities being imported. The - timestamp must not have higher than millisecond precision. + annotationSpecId: type: string - avroSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1AvroSource' - workerCount: 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 - format: int32 - featureTimeField: - type: string + The resource Id of the AnnotationSpec that this Annotation pertains + to. + timeSegment: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaTimeSegment' description: >- - Source column that holds the Feature timestamp for all Feature - values in each entity. - featureSpecs: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec + This Annotation applies to the time period represented by the + TimeSegment. If it's not set, the Annotation applies to the whole + video. + description: Annotation details specific to video classification. + id: GoogleCloudAiplatformV1SchemaVideoClassificationAnnotation + GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata: + properties: + contentValidationStats: 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. - id: GoogleCloudAiplatformV1ImportFeatureValuesRequest - description: Request message for FeaturestoreService.ImportFeatureValues. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentiment: - description: A TrainingJob that trains and uploads an AutoML Text Sentiment Model. - properties: - inputs: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs - description: The input parameters of this TrainingJob. - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentiment - type: object - GoogleCloudAiplatformV1CreateTensorboardOperationMetadata: - id: GoogleCloudAiplatformV1CreateTensorboardOperationMetadata + 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. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats + dataBytesCount: + description: The ingested data size in bytes. + format: int64 + type: string type: object + description: Runtime operation metadata with regard to Matching Engine Index. + id: GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata + GoogleCloudAiplatformV1UpdateExplanationDatasetOperationMetadata: + description: Runtime operation information for ModelService.UpdateExplanationDataset. properties: genericMetadata: - description: Operation metadata for Tensorboard. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Details of operations that perform create Tensorboard. - GoogleIamV1SetIamPolicyRequest: + description: The common part of the operation metadata. + type: object + id: GoogleCloudAiplatformV1UpdateExplanationDatasetOperationMetadata + GoogleCloudAiplatformV1ResourceRuntime: + id: GoogleCloudAiplatformV1ResourceRuntime + description: Persistent Cluster runtime information as output properties: - policy: + accessUris: 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 - description: Request message for `SetIamPolicy` method. - type: object - GoogleCloudAiplatformV1AddExecutionEventsRequest: + 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 + readOnly: true type: object - properties: - events: - type: array - description: The Events to create and add. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Event' - description: Request message for MetadataService.AddExecutionEvents. - id: GoogleCloudAiplatformV1AddExecutionEventsRequest - GoogleCloudAiplatformV1AutoscalingMetricSpec: - id: GoogleCloudAiplatformV1AutoscalingMetricSpec + GoogleCloudAiplatformV1NasTrialDetail: + id: GoogleCloudAiplatformV1NasTrialDetail 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. + Represents a NasTrial details along with its parameters. If there is a + corresponding train NasTrial, the train NasTrial is also returned. properties: - target: - type: integer + trainTrial: 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 - metricName: + The train NasTrial corresponding to search_trial. Only populated if + search_trial is used for training. + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' + parameters: + description: The parameters for the NasJob NasTrial. 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` + name: + description: Output only. Resource name of the NasTrialDetail. + readOnly: true + type: string + searchTrial: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' + description: The requested search NasTrial. type: object - GoogleCloudAiplatformV1SearchMigratableResourcesResponse: - description: Response message for MigrationService.SearchMigratableResources. + GoogleCloudAiplatformV1ComputeTokensResponse: type: object + description: Response message for ComputeTokens RPC call. + id: GoogleCloudAiplatformV1ComputeTokensResponse properties: - nextPageToken: - type: string - 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 - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MigratableResource' - description: >- - All migratable resources that can be migrated to the location - specified in the request. - id: GoogleCloudAiplatformV1SearchMigratableResourcesResponse - GoogleCloudAiplatformV1ExplainResponse: - id: GoogleCloudAiplatformV1ExplainResponse - description: Response message for PredictionService.Explain. - properties: - explanations: + tokensInfo: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Explanation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TokensInfo' description: >- - The explanations of the Model's PredictResponse.predictions. It has - the same number of elements as instances to be explained. - type: array - deployedModelId: - type: string - description: ID of the Endpoint's DeployedModel that served this explanation. - predictions: + 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. type: array - description: >- - The predictions that are the output of the predictions call. Same as - PredictResponse.predictions. - items: - type: any - type: object - GoogleCloudAiplatformV1UnmanagedContainerModel: - id: GoogleCloudAiplatformV1UnmanagedContainerModel - description: >- - Contains model information necessary to perform batch prediction without - requiring a full model import. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics: type: object + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics properties: - artifactUri: + f1ScoreMicro: + format: float + type: number + description: Micro-averaged F1 Score. + f1Score: description: >- - The path to the directory containing the Model artifact and any of - its supporting files. - type: string - predictSchemata: - description: Contains the schemata used in Model's predictions and explanations - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictSchemata' - containerSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelContainerSpec' + The harmonic mean of recall and precision. For summary metrics, it + computes the micro-averaged F1 score. + type: number + format: float + maxPredictions: description: >- - Input only. The specification of the container that is to be used - when deploying this Model. - GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateResponse: - id: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateResponse - properties: - shouldStop: - description: True if the Trial should stop. - type: boolean - description: Response message for VizierService.CheckTrialEarlyStoppingState. - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata: - properties: - successfulStopReason: + 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 + type: integer + recall: + format: float + description: Recall (True Positive Rate) for the given confidence threshold. + type: number + confidenceThreshold: + type: number description: >- - For successful job completions, this is the reason why the job has - finished. - enum: - - SUCCESSFUL_STOP_REASON_UNSPECIFIED - - BUDGET_REACHED - - MODEL_CONVERGED + Metrics are computed with an assumption that the Model never returns + predictions with score lower than this value. + format: float + falseNegativeCount: 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. - 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. - type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata - type: object - GoogleCloudAiplatformV1VideoMetadata: - id: GoogleCloudAiplatformV1VideoMetadata - properties: - startOffset: - format: google-duration - type: string - description: Optional. The start offset of the video. - endOffset: + The number of ground truth labels that are not matched by a Model + created label. + falsePositiveRate: + type: number + format: float + description: False Positive Rate for the given confidence threshold. + truePositiveCount: type: string - description: Optional. The end offset of the video. - format: google-duration - type: object - description: Metadata describes the input video content. - GoogleCloudAiplatformV1SchemaPredictPredictionTabularRegressionPredictionResult: - properties: - upperBound: + description: The number of Model created labels that match a ground truth label. + format: int64 + f1ScoreAt1: + type: number + description: The harmonic mean of recallAt1 and precisionAt1. + format: float + precision: format: float - description: The upper bound of the prediction interval. type: number - lowerBound: - description: The lower bound of the prediction interval. + description: Precision for the given confidence threshold. + 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. type: number format: float - quantileValues: - items: - type: number - format: float - description: Quantile values. - type: array - quantilePredictions: - items: - format: float - type: number - description: Quantile predictions, in 1-1 correspondence with quantile_values. - type: array - value: + 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 + f1ScoreMacro: + description: Macro-averaged F1 Score. type: number format: float - description: The regression value. - type: object - description: Prediction output format for Tabular Regression. - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionTabularRegressionPredictionResult - GoogleCloudAiplatformV1SchemaPredictParamsImageClassificationPredictionParams: - description: Prediction model parameters for Image Classification. - id: >- - GoogleCloudAiplatformV1SchemaPredictParamsImageClassificationPredictionParams - type: object - properties: - confidenceThreshold: - format: float + confusionMatrix: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix + description: Confusion matrix of the evaluation for this confidence_threshold. + falsePositiveCount: + description: >- + The number of Model created labels that do not match a ground truth + label. + format: int64 + type: string + falsePositiveRateAt1: type: number + format: float description: >- - The Model only returns predictions with at least this confidence - score. Default value is 0.0 - maxPredictions: + The False Positive Rate when only considering the label that has the + highest prediction score and not below the confidence threshold for + each DataItem. + precisionAt1: + type: number 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. - format: int32 - type: integer - GoogleCloudAiplatformV1LineageSubgraph: + The precision when only considering the label that has the highest + prediction score and not below the confidence threshold for each + DataItem. + format: float + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningTask: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningTask + properties: + metadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata + description: The metadata information. + inputs: + description: The input parameters of this HyperparameterTuningTask. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec type: object + description: A TrainingJob that tunes Hypererparameters of a custom code Model. + GoogleCloudAiplatformV1CreateSpecialistPoolOperationMetadata: description: >- - A subgraph of the overall lineage graph. Event edges connect Artifact - and Execution nodes. + Runtime operation information for + SpecialistPoolService.CreateSpecialistPool. + type: object + id: GoogleCloudAiplatformV1CreateSpecialistPoolOperationMetadata properties: - events: - type: array - description: The Event edges between Artifacts and Executions in the subgraph. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Event' - executions: - type: array - description: The Execution nodes in the subgraph. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' - artifacts: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' - type: array - description: The Artifact nodes in the subgraph. - id: GoogleCloudAiplatformV1LineageSubgraph - GoogleCloudAiplatformV1TensorboardTensor: - description: One point viewable on a tensor metric plot. + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1ThresholdConfig: + description: The config for feature monitoring threshold. properties: value: - format: byte - description: >- - 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 - id: GoogleCloudAiplatformV1TensorboardTensor - type: object - GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo: - id: GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo - type: object - properties: - imageOutputUri: - 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. - readOnly: true - artifactOutputUri: - type: string + format: double 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 - description: >- - Further describes the output of the ExportModel. Supplements - ExportModelRequest.OutputConfig. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningTask: + 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 + id: GoogleCloudAiplatformV1ThresholdConfig type: object - properties: - inputs: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec - description: The input parameters of this HyperparameterTuningTask. - metadata: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata - description: The metadata information. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningTask - description: A TrainingJob that tunes Hypererparameters of a custom code Model. - GoogleCloudAiplatformV1DeployedIndexRef: + GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource: type: object - id: GoogleCloudAiplatformV1DeployedIndexRef - description: Points to a DeployedIndex. + id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource properties: - deployedIndexId: - type: string - description: Immutable. The ID of the DeployedIndex in the above IndexEndpoint. - indexEndpoint: - type: string - description: Immutable. A resource name of the IndexEndpoint. - displayName: - readOnly: true + uri: type: string - description: Output only. The display name of the DeployedIndex. - GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec: - id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec - properties: - maxParallelTrialCount: - description: Required. The maximum number of trials to run in parallel. - format: int32 - type: integer - trainTrialJobSpec: description: >- - Required. The spec of a train trial job. The same spec applies to - all train trials. - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' - frequency: - format: int32 - 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. - type: integer - type: object - description: Represent spec for train trials. - GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem: + The URI of a BigQuery table. e.g. + bq://projectId.bqDatasetId.bqTableId + GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse: + id: GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse type: object - properties: - distance: - type: number - format: double - description: The distance of this item to the annotation. - annotationResourceName: - type: string - description: >- - The unique ID for each annotation. Used by FE to allocate the - annotation in DB. - id: GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem description: >- - Attributed items for a given annotation, typically representing - neighbors from the training sets constrained by the query type. - CloudAiLargeModelsVisionImageRAIScores: - description: RAI scores for generated image returned. - properties: - agileWatermarkDetectionScore: - type: number - format: double - description: Agile watermark score for image. - type: object - id: CloudAiLargeModelsVisionImageRAIScores - GoogleCloudAiplatformV1CreateDatasetOperationMetadata: - type: object - id: GoogleCloudAiplatformV1CreateDatasetOperationMetadata - description: Runtime operation information for DatasetService.CreateDataset. - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - GoogleCloudAiplatformV1FindNeighborsResponse: + Response message for + TensorboardService.BatchCreateTensorboardTimeSeries. properties: - nearestNeighbors: + tensorboardTimeSeries: + description: The created TensorboardTimeSeries. type: array - description: The nearest neighbors of the query datapoints. items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors - description: The response message for MatchService.FindNeighbors. - id: GoogleCloudAiplatformV1FindNeighborsResponse - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries' + GoogleCloudAiplatformV1ModelGardenSource: properties: - columnName: + publicModelName: type: string + description: Required. The model garden source model resource name. 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. + Contains information about the source of the models generated from Model + Garden. + id: GoogleCloudAiplatformV1ModelGardenSource + type: object + 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. + id: GoogleCloudAiplatformV1BatchPredictionJob type: object - GoogleCloudAiplatformV1InputDataConfig: properties: - annotationSchemaUri: + startTime: 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. + Output only. Time when the BatchPredictionJob for the first time + entered the `JOB_STATE_RUNNING` state. type: string - filterSplit: - description: Split based on the provided filters for each set. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FilterSplit' - 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" - predefinedSplit: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredefinedSplit' - description: >- - Supported only for tabular Datasets. Split based on a predefined - key. - timestampSplit: + readOnly: true + format: google-datetime + generateExplanation: + type: boolean description: >- - Supported only for tabular Datasets. Split based on the timestamp of - the input data pieces. - $ref: '#/components/schemas/GoogleCloudAiplatformV1TimestampSplit' - fractionSplit: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FractionSplit' - description: Split based on fractions defining the size of each set. - datasetId: + 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. + outputInfo: + readOnly: true + description: Output only. Information further describing the output of this job. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchPredictionJobOutputInfo + outputConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchPredictionJobOutputConfig 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. + 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. + createTime: + format: google-datetime type: string - stratifiedSplit: - description: >- - Supported only for tabular Datasets. Split based on the distribution - of the specified column. - $ref: '#/components/schemas/GoogleCloudAiplatformV1StratifiedSplit' - gcsDestination: + description: Output only. Time when the BatchPredictionJob was created. + readOnly: true + explanationSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpec' 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}" - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' - savedQueryId: - type: string + 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. + instanceConfig: 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 - annotationsFilter: - type: string + Configuration for how to convert batch prediction input instances to + the prediction instances that are sent to the Model. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig + dedicatedResources: 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. - description: >- - Specifies Vertex AI owned input data to be used for training, and - possibly evaluating, the Model. - id: GoogleCloudAiplatformV1InputDataConfig - type: object - GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature: - description: >- - Response message if the request uses the SelectTimeRangeAndFeature - option. - type: object - id: >- - GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature - properties: - onlineStorageModifiedEntityCount: + 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' + updateTime: 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 + Output only. Time when the BatchPredictionJob was most recently + updated. + readOnly: true type: string - impactedFeatureCount: + format: google-datetime + manualBatchTuningParameters: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ManualBatchTuningParameters description: >- - The count of the features or columns impacted. This is the same as - the feature count in the request. - format: int64 + Immutable. Parameters configuring the batch behavior. Currently only + applicable when dedicated_resources are used (in other cases Vertex + AI does the tuning itself). + 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 - offlineStorageModifiedEntityRowCount: - format: int64 + serviceAccount: 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. + 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. type: string - GoogleCloudAiplatformV1PipelineTaskExecutorDetail: - id: GoogleCloudAiplatformV1PipelineTaskExecutorDetail - description: The runtime detail of a pipeline executor. - properties: - customJobDetail: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail - description: Output only. The detailed info for a custom job executor. - readOnly: true - containerDetail: + completionStats: readOnly: true - description: Output only. The detailed info for a container executor. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail - type: object - GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors: - properties: - id: - type: string - description: The ID of the query datapoint. - neighbors: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FindNeighborsResponseNeighbor - type: array - description: All its neighbors. - description: Nearest neighbors for one query. - id: GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors - type: object - GoogleCloudAiplatformV1Feature: - id: GoogleCloudAiplatformV1Feature - properties: - 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. + Output only. Statistics on completed and failed prediction + instances. + $ref: '#/components/schemas/GoogleCloudAiplatformV1CompletionStats' + endTime: + readOnly: true type: string - createTime: format: google-datetime - type: string description: >- - Output only. Only applicable for Vertex AI Feature Store (Legacy). - Timestamp when this EntityType was created. - readOnly: true - updateTime: + Output only. Time when the BatchPredictionJob entered any of the + following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, + `JOB_STATE_CANCELLED`. + 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 readOnly: true - format: google-datetime 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. + disableContainerLogging: + type: boolean description: >- - Output only. Only applicable for Vertex AI Feature Store (Legacy). - Timestamp when this EntityType was most recently updated. - pointOfContact: + 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. + error: + readOnly: true + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + Output only. Only populated when the job's state is JOB_STATE_FAILED + or JOB_STATE_CANCELLED. + modelVersionId: type: string description: >- - Entity responsible for maintaining this feature. Can be comma - separated list of email addresses or URIs. - monitoringStatsAnomalies: - type: array + Output only. The version ID of the Model that produces the + predictions via this job. + readOnly: true + unmanagedContainerModel: + $ref: '#/components/schemas/GoogleCloudAiplatformV1UnmanagedContainerModel' description: >- - Output only. Only applicable for Vertex AI Feature Store (Legacy). - The list of historical stats and anomalies with specified - objectives. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly - readOnly: true + 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. 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. - disableMonitoring: - type: boolean + 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. + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' 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: + 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. + inputConfig: description: >- - Used to perform a consistent read-modify-write updates. If not set, - a blind "overwrite" update happens. + 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 + name: + readOnly: true + description: Output only. Resource name of the BatchPredictionJob. type: string - versionColumnName: + resourcesConsumed: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourcesConsumed' 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. - type: string - 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. + readOnly: true + displayName: + description: Required. The user-defined name of this BatchPredictionJob. type: string - description: Description of the Feature. - 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. + partialFailures: + type: array + readOnly: true + items: + $ref: '#/components/schemas/GoogleRpcStatus' description: >- - Immutable. Only applicable for Vertex AI Feature Store (Legacy). - Type of Feature value. + 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: 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. + GoogleCloudAiplatformV1NotebookRuntimeTemplateRef: + properties: + notebookRuntimeTemplate: type: string - enum: - - VALUE_TYPE_UNSPECIFIED - - BOOL - - BOOL_ARRAY - - DOUBLE - - DOUBLE_ARRAY - - INT64 - - INT64_ARRAY - - STRING - - STRING_ARRAY - - BYTES - - STRUCT - description: >- - Feature Metadata information. For example, color is a feature that - describes an apple. - type: object - GoogleCloudAiplatformV1PersistentResource: - id: GoogleCloudAiplatformV1PersistentResource + description: Immutable. A resource name of the NotebookRuntimeTemplate. + id: GoogleCloudAiplatformV1NotebookRuntimeTemplateRef type: object - 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. + description: Points to a NotebookRuntimeTemplateRef. + GoogleCloudAiplatformV1ListModelsResponse: + description: Response message for ModelService.ListModels + id: GoogleCloudAiplatformV1ListModelsResponse properties: - reservedIpRanges: - 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']. + models: items: - type: string - resourceRuntimeSpec: - description: >- - Optional. Persistent Resource runtime spec. For example, used for - Ray cluster configuration. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourceRuntimeSpec' - 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' - resourceRuntime: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourceRuntime' - description: Output only. Runtime information of the Persistent Resource. - readOnly: true - error: - $ref: '#/components/schemas/GoogleRpcStatus' - readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + description: List of Models in the requested page. + type: array + nextPageToken: description: >- - Output only. Only populated when persistent resource's state is - `STOPPING` or `ERROR`. - displayName: + A token to retrieve next page of results. Pass to + ListModelsRequest.page_token to obtain that page. + type: string + type: object + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset: + properties: + gcsSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' 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. + The Google Cloud Storage uri of the unmanaged Dataset used to train + this Model. + dataset: + description: The resource name of the Dataset used to train this Model. type: string - name: + loggingSamplingStrategy: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SamplingStrategy' + description: >- + Strategy to sample data from Training Dataset. If not set, we + process the whole dataset. + dataFormat: type: string - description: Immutable. Resource name of a PersistentResource. - startTime: + 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: type: string - readOnly: true description: >- - Output only. Time when the PersistentResource for the first time - entered the `RUNNING` state. - format: google-datetime - labels: - type: object - additionalProperties: - type: string + The target field name the model is to predict. This field will be + excluded when doing Predict and (or) Explain for the training data. + bigquerySource: 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. - createTime: - type: string - readOnly: true - format: google-datetime - description: Output only. Time when the PersistentResource was created. - resourcePools: - description: Required. The spec of the pools of different resources. + The BigQuery table of the unmanaged Dataset used to train this + Model. + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' + description: Training Dataset information. + type: object + id: GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset + GoogleCloudAiplatformV1PredictRequest: + id: GoogleCloudAiplatformV1PredictRequest + type: object + description: Request message for PredictionService.Predict. + properties: + instances: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourcePool' + 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. type: array - network: - type: string + parameters: 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. - state: - readOnly: true - enum: - - STATE_UNSPECIFIED - - PROVISIONING - - RUNNING - - STOPPING - - ERROR - - REBOOTING - - UPDATING - 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. - description: Output only. The detailed state of a Study. + 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 + GoogleCloudAiplatformV1AddContextChildrenResponse: + description: Response message for MetadataService.AddContextChildren. + id: GoogleCloudAiplatformV1AddContextChildrenResponse + properties: {} + type: object + GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecMetricSpec: + type: object + description: Represents a metric to optimize. + id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecMetricSpec + properties: + goal: + description: Required. The optimization goal of the metric. type: string - updateTime: - readOnly: true + enumDescriptions: + - Goal Type will default to maximize. + - Maximize the goal metric. + - Minimize the goal metric. + enum: + - GOAL_TYPE_UNSPECIFIED + - MAXIMIZE + - MINIMIZE + metricId: type: string - description: >- - Output only. Time when the PersistentResource was most recently - updated. - format: google-datetime - GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource: + description: Required. The ID of the metric. Must not contain whitespaces. + GoogleCloudAiplatformV1FeatureViewBigQuerySource: + id: GoogleCloudAiplatformV1FeatureViewBigQuerySource + type: object 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. + Required. The BigQuery view URI that will be materialized on each + sync trigger based on FeatureView.SyncConfig. + type: string + entityIdColumns: + description: Required. Columns to construct entity_id / row keys. type: array items: type: string - id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource + GoogleCloudAiplatformV1SchemaTablesDatasetMetadata: type: object - GoogleCloudAiplatformV1SchemaVideoActionRecognitionAnnotation: - id: GoogleCloudAiplatformV1SchemaVideoActionRecognitionAnnotation properties: - 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 - 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 - description: Annotation details specific to video action recognition. - type: object - GoogleCloudAiplatformV1StopTrialRequest: - description: Request message for VizierService.StopTrial. - id: GoogleCloudAiplatformV1StopTrialRequest - type: object - properties: {} - GoogleCloudAiplatformV1UpdateIndexOperationMetadata: + inputConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig + id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadata + description: The metadata of Datasets that contain tables data. + GoogleCloudAiplatformV1SchemaPredictParamsVideoObjectTrackingPredictionParams: + id: >- + GoogleCloudAiplatformV1SchemaPredictParamsVideoObjectTrackingPredictionParams + description: Prediction model parameters for Video Object Tracking. type: object - id: GoogleCloudAiplatformV1UpdateIndexOperationMetadata properties: - nearestNeighborSearchOperationMetadata: + maxPredictions: + format: int32 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' - description: Runtime operation information for IndexService.UpdateIndex. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry: - properties: - confusionMatrix: - description: Confusion matrix for the given confidence threshold. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix - iouScore: + 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. + type: integer + minBoundingBoxSize: 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 - type: number - precision: - format: float - description: Precision for the given confidence threshold. - type: number - recall: - format: float - description: Recall (True Positive Rate) for the given confidence threshold. + 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 - diceScoreCoefficient: format: float - description: DSC or the F1 score, The harmonic mean of recall and precision. - type: number confidenceThreshold: + type: number description: >- - Metrics are computed with an assumption that the model never returns - predictions with score lower than this value. + The Model only returns predictions with at least this confidence + score. Default value is 0.0 format: float - type: number - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry - type: object - CloudAiLargeModelsVisionMedia: - type: object + GoogleCloudAiplatformV1CitationMetadata: properties: - image: - $ref: '#/components/schemas/CloudAiLargeModelsVisionImage' - description: Image. - video: - description: Video - $ref: '#/components/schemas/CloudAiLargeModelsVisionVideo' - id: CloudAiLargeModelsVisionMedia - description: Media. - GoogleCloudAiplatformV1RebootPersistentResourceRequest: + citations: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Citation' + type: array + readOnly: true + description: Output only. List of citations. + id: GoogleCloudAiplatformV1CitationMetadata type: object - description: Request message for PersistentResourceService.RebootPersistentResource. - id: GoogleCloudAiplatformV1RebootPersistentResourceRequest - properties: {} - GoogleCloudAiplatformV1UpgradeNotebookRuntimeOperationMetadata: - description: Metadata information for NotebookService.UpgradeNotebookRuntime. + description: A collection of source attributions for a piece of content. + GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec: properties: - progressMessage: + sourceField: + description: >- + Source column to get the Feature values from. If not set, uses the + column with the same name as the Feature ID. type: string + id: 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 + 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 type: object - GoogleCloudAiplatformV1DatasetStats: + description: Defines the Feature value(s) to import. + GoogleCloudAiplatformV1GenerateContentResponse: + type: object + description: Response message for [PredictionService.GenerateContent]. properties: - userOutputTokenDistribution: - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetDistribution' - description: Output only. Dataset distributions for the user output tokens. - userInputTokenDistribution: - readOnly: true - description: Output only. Dataset distributions for the user input tokens. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetDistribution' - tuningStepCount: - type: string - readOnly: true - format: int64 - description: Output only. Number of tuning steps for this Tuning Job. - userDatasetExamples: + candidates: readOnly: true + description: Output only. Generated candidates. type: array - description: Output only. Sample user messages in the training dataset uri. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' - totalBillableCharacterCount: - type: string - readOnly: true - format: int64 - description: Output only. Number of billable characters in the tuning dataset. - userMessagePerExampleDistribution: - description: Output only. Dataset distributions for the messages per example. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetDistribution' - readOnly: true - tuningDatasetExampleCount: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Candidate' + usageMetadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata + description: Usage metadata about the response(s). + promptFeedback: readOnly: true + $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. + id: GoogleCloudAiplatformV1GenerateContentResponse + GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData: + type: object + description: Per user usage data. + id: GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData + properties: + username: type: string - description: Output only. Number of examples in the tuning dataset. + description: User's username + viewCount: format: int64 - totalTuningCharacterCount: - readOnly: true type: string - description: Output only. Number of tuning characters in the tuning dataset. - format: int64 - type: object - id: GoogleCloudAiplatformV1DatasetStats - description: Statistics computed over a tuning dataset. - GoogleTypeMoney: + description: Number of times the user has read data within the Tensorboard. + GoogleCloudAiplatformV1Endpoint: + id: GoogleCloudAiplatformV1Endpoint type: object - description: Represents an amount of money with its currency type. + description: >- + Models are deployed into it, and afterwards Endpoint is called to obtain + predictions and explanations. properties: - units: - description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. + etag: type: string - format: int64 - 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 - 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 - currencyCode: - description: The three-letter currency code defined in ISO 4217. - type: string - id: GoogleTypeMoney - GoogleCloudAiplatformV1ExportDataConfig: - properties: - annotationsFilter: + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. + privateServiceConnectConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PrivateServiceConnectConfig 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. + Optional. Configuration for private service connect. network and + private_service_connect_config are mutually exclusive. + 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 - fractionSplit: - description: Split based on fractions defining the size of each set. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportFractionSplit' - filterSplit: - description: Split based on the provided filters for each set. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportFilterSplit' - annotationSchemaUri: + description: + type: string + description: The description of the Endpoint. + modelDeploymentMonitoringJob: type: string + readOnly: true 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. - exportUse: + 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}` + network: type: string - enum: - - EXPORT_USE_UNSPECIFIED - - CUSTOM_CODE_TRAINING - description: Indicates the usage of the exported files. - enumDescriptions: - - Regular user export. - - Export for custom code training. - 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. - savedQueryId: + 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. + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + 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. + deployedModels: + readOnly: true + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' + type: array + description: >- + Output only. The models deployed in this Endpoint. To add or remove + DeployedModels use EndpointService.DeployModel and + EndpointService.UndeployModel respectively. + 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 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. + additionalProperties: + format: int32 + type: integer + labels: + additionalProperties: + type: string + 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. + type: object + name: type: string + readOnly: true + description: Output only. The resource name of the Endpoint. + createTime: + type: string + readOnly: true + format: google-datetime + description: Output only. Timestamp when this Endpoint was created. + predictRequestResponseLoggingConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig + description: Configures the request-response logging for online prediction. + enablePrivateServiceConnect: + type: boolean + deprecated: true 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. - id: GoogleCloudAiplatformV1ExportDataConfig - type: object - description: >- - Describes what part of the Dataset is to be exported, the destination of - the export and how to export. - GoogleCloudAiplatformV1FileData: + Deprecated: If true, expose the Endpoint via private service + connect. Only one of the fields, network or + enable_private_service_connect, can be set. + updateTime: + readOnly: true + format: google-datetime + description: Output only. Timestamp when this Endpoint was last updated. + type: string + GoogleCloudAiplatformV1ListPipelineJobsResponse: + id: GoogleCloudAiplatformV1ListPipelineJobsResponse type: object properties: - fileUri: - description: Required. URI. - type: string - mimeType: + nextPageToken: + description: >- + A token to retrieve the next page of results. Pass to + ListPipelineJobsRequest.page_token to obtain that page. type: string - description: Required. The IANA standard MIME type of the source data. - description: URI based data. - id: GoogleCloudAiplatformV1FileData - GoogleCloudAiplatformV1Examples: + pipelineJobs: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' + description: List of PipelineJobs in the requested page. + type: array + description: Response message for PipelineService.ListPipelineJobs + GoogleCloudAiplatformV1GoogleSearchRetrieval: + description: Tool to retrieve public web data for grounding, powered by Google. type: object - description: >- - Example-based explainability that returns the nearest neighbors from the - provided dataset. + properties: {} + id: GoogleCloudAiplatformV1GoogleSearchRetrieval + GoogleCloudAiplatformV1SchemaPredictParamsImageClassificationPredictionParams: + description: Prediction model parameters for Image Classification. + type: object + id: >- + GoogleCloudAiplatformV1SchemaPredictParamsImageClassificationPredictionParams properties: - nearestNeighborSearchConfig: - type: any + confidenceThreshold: + format: float 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: - description: The Cloud Storage input instances. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExamplesExampleGcsSource' - presets: + The Model only returns predictions with at least this confidence + score. Default value is 0.0 + type: number + maxPredictions: description: >- - Simplified preset configuration, which automatically sets - configuration values based on the desired query speed-precision - trade-off and modality. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Presets' - neighborCount: - format: int32 - description: The number of neighbors to return when querying for examples. + 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 - id: GoogleCloudAiplatformV1Examples - GoogleCloudAiplatformV1SchemaAnnotationSpecColor: + format: int32 + GoogleCloudAiplatformV1PurgeArtifactsResponse: type: object - description: >- - An entry of mapping between color and AnnotationSpec. The mapping is - used in segmentation mask. properties: - displayName: + purgeCount: + format: int64 type: string description: >- - The display name of the AnnotationSpec represented by the color in - the segmentation mask. - color: - description: The color of the AnnotationSpec in a segmentation mask. - $ref: '#/components/schemas/GoogleTypeColor' - id: + 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. + purgeSample: + type: array + items: + type: string description: >- - The ID of the AnnotationSpec represented by the color in the - segmentation mask. - type: string - id: GoogleCloudAiplatformV1SchemaAnnotationSpecColor - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation: + 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). + description: Response message for MetadataService.PurgeArtifacts. + id: GoogleCloudAiplatformV1PurgeArtifactsResponse + GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec: properties: - timeFormat: - type: string + searchTrialJobSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' 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 - id: >- - 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. - type: object - GoogleCloudAiplatformV1FeatureOnlineStoreOptimized: - id: GoogleCloudAiplatformV1FeatureOnlineStoreOptimized - properties: {} - description: Optimized storage type - type: object - GoogleCloudAiplatformV1NearestNeighborQueryParameters: - properties: - approximateNeighborCandidates: - type: integer + Required. The spec of a search trial job. The same spec applies to + all search trials. + maxParallelTrialCount: format: int32 + description: Required. The maximum number of trials to run in parallel. + type: integer + maxTrialCount: description: >- - Optional. The number of neighbors to find via approximate search - before exact reordering is performed; if set, this value must be > - neighbor_count. - leafNodesSearchFraction: + Required. The maximum number of Neural Architecture Search (NAS) + trials to run. + type: integer + format: int32 + maxFailedTrialCount: + format: int32 + type: integer 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. - type: number - format: double - description: >- - Parameters that can be overrided in each query to tune query latency and - recall. + 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. + description: Represent spec for search trials. + id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec type: object - id: GoogleCloudAiplatformV1NearestNeighborQueryParameters - GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecSliceConfig: - id: 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. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation type: object + 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. properties: - 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}}` + columnName: + type: string + invalidValuesAllowed: 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 - value: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue description: >- - A unique specific value for a given feature. Example: `{ "value": { - "string_value": "12345" } }` - GoogleCloudAiplatformV1DataItemView: + 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. + GoogleCloudAiplatformV1IndexDatapoint: + id: GoogleCloudAiplatformV1IndexDatapoint + type: object + description: A datapoint of Index. properties: - dataItem: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataItem' - description: The DataItem. - hasTruncatedAnnotations: + featureVector: 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. - type: boolean - annotations: + Required. Feature embedding vector for dense index. An array of + numbers with the length of [NearestNeighborSearchConfig.dimensions]. + items: + type: number + format: float type: array + restricts: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1IndexDatapointRestriction 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. + 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 + datapointId: + description: Required. Unique identifier of the datapoint. + type: string + numericRestricts: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Annotation' - id: GoogleCloudAiplatformV1DataItemView + $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 + sparseEmbedding: + description: Optional. Feature embedding vector for sparse index. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1IndexDatapointSparseEmbedding + 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. + GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig: + id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig type: object - description: A container for a single DataItem and Annotations on it. - GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec: + description: >- + The time series Dataset's data source. The Dataset doesn't store the + data directly, but only pointer(s) to its data. + properties: + bigquerySource: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource + gcsSource: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource + GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult: type: object + id: >- + GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult + description: >- + Represents a partial result in batch migration operation for one + MigrateResourceRequest. properties: - learningRateParameterName: - 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. - minMeasurementCount: - format: int64 + error: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The error result of the migration request in case of failure. + request: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequest' 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. + It's the same as the value in + MigrateResourceRequest.migrate_resource_requests. + dataset: + description: Migrated dataset resource name. type: string - 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. - maxStepCount: - type: string - format: int64 - 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. - 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 - minStepCount: - 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. + model: + description: Migrated model resource name. type: string - format: int64 + GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity: 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. - id: GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata + 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: - backingHyperparameterTuningJob: - type: string - description: >- - The resource name of the HyperparameterTuningJob that has been - created to carry out this HyperparameterTuning task. - bestTrialBackingCustomJob: - type: string + entityIdSelector: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityIdSelector' description: >- - The resource name of the CustomJob that has been created to run the - best Trial of this HyperparameterTuning task. - GoogleCloudAiplatformV1FeatureViewSyncSyncSummary: + Required. Selectors choosing feature values of which entity id to be + deleted from the EntityType. + GoogleCloudAiplatformV1MeasurementMetric: + description: A message representing a metric in the measurement. + type: object + id: GoogleCloudAiplatformV1MeasurementMetric properties: - rowSynced: - format: int64 + value: + format: double readOnly: true - type: string - description: Output only. Total number of rows synced. - totalSlot: - type: string + description: Output only. The value for this metric. + type: number + metricId: readOnly: true - format: int64 - description: Output only. BigQuery slot milliseconds consumed for the sync job. - 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. - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata: - type: object - properties: - successfulStopReason: - 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. - type: string - description: >- - For successful job completions, this is the reason why the job has - finished. - 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. + Output only. The ID of the Metric. The Metric should be defined in + StudySpec's Metrics. type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata - GoogleCloudAiplatformV1ListStudiesResponse: - id: GoogleCloudAiplatformV1ListStudiesResponse + GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse: 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. + The page token that can be used by the next + JobService.SearchModelDeploymentMonitoringStatsAnomalies call. type: string - studies: - description: The studies associated with the project. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' - description: Response message for VizierService.ListStudies. - type: object - GoogleCloudAiplatformV1NearestNeighborQueryEmbedding: - type: object - description: The embedding vector. - id: GoogleCloudAiplatformV1NearestNeighborQueryEmbedding - properties: - value: - items: - format: float - type: number - description: Optional. Individual value in the embedding. + monitoringStats: type: array - GoogleCloudAiplatformV1PauseScheduleRequest: - id: GoogleCloudAiplatformV1PauseScheduleRequest - description: Request message for ScheduleService.PauseSchedule. - type: object - properties: {} - GoogleCloudAiplatformV1NasTrialDetail: - properties: - trainTrial: description: >- - The train NasTrial corresponding to search_trial. Only populated if - search_trial is used for training. - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' - searchTrial: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' - description: The requested search NasTrial. - name: - description: Output only. Resource name of the NasTrialDetail. - type: string - readOnly: true - parameters: - type: string - description: The parameters for the NasJob NasTrial. + Stats retrieved for requested objectives. There are at most 1000 + ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.prediction_stats + in the response. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies + id: >- + GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse description: >- - Represents a NasTrial details along with its parameters. If there is a - corresponding train NasTrial, the train NasTrial is also returned. - id: GoogleCloudAiplatformV1NasTrialDetail - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecasting: - type: object - description: A TrainingJob that trains and uploads an AutoML Forecasting Model. - properties: - metadata: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata - description: The metadata information. - inputs: - description: The input parameters of this TrainingJob. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecasting - GoogleCloudAiplatformV1UndeployModelRequest: + Response message for + JobService.SearchModelDeploymentMonitoringStatsAnomalies. type: object + GoogleCloudAiplatformV1DeployModelRequest: + description: Request message for EndpointService.DeployModel. + id: GoogleCloudAiplatformV1DeployModelRequest properties: + 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: type: integer format: int32 - type: object + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity + properties: + unit: 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: + The time granularity unit of this time period. The supported units + are: * "minute" * "hour" * "day" * "week" * "month" * "year" type: string + quantity: + format: int64 description: >- - Required. The ID of the DeployedModel to be undeployed from the - Endpoint. - id: GoogleCloudAiplatformV1UndeployModelRequest - description: Request message for EndpointService.UndeployModel. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics: + 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. type: object + GoogleCloudAiplatformV1ImportDataOperationMetadata: properties: - confidenceMetrics: - type: array - 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. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics - meanBoundingBoxIou: - description: The mean bounding box iou over all confidence thresholds. - format: float - type: number - iouThreshold: - type: number - format: float - description: >- - The intersection-over-union threshold value between bounding boxes - across frames used to compute this metric entry. - 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 - description: >- - UNIMPLEMENTED. Track matching model metrics for a single track match - threshold and multiple label match confidence thresholds. - id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics - GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec: - description: Defines the Feature value(s) to import. - id: GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec + genericMetadata: + description: The common part of the operation metadata. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' type: object + id: GoogleCloudAiplatformV1ImportDataOperationMetadata + description: Runtime operation information for DatasetService.ImportData. + GoogleCloudAiplatformV1PredictResponse: + id: GoogleCloudAiplatformV1PredictResponse + type: object + description: Response message for PredictionService.Predict. 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: + modelVersionId: description: >- - Required. ID of the Feature to import values of. This Feature must - exist in the target EntityType, or the request will fail. + Output only. The version ID of the Model which is deployed as the + DeployedModel that this prediction hits. type: string - GoogleCloudAiplatformV1SuggestTrialsResponse: - properties: - startTime: - description: The time at which the operation was started. + readOnly: true + 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 + model: type: string - format: google-datetime - trials: + readOnly: true + description: >- + Output only. The resource name of the Model which is deployed as the + DeployedModel that this prediction hits. + predictions: type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' - description: A list of Trials. - studyState: - 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 - description: The state of the Study. - type: string - endTime: + 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. + modelDisplayName: + description: >- + Output only. The display name of the Model which is deployed as the + DeployedModel that this prediction hits. type: string - description: The time at which operation processing completed. - format: google-datetime - id: GoogleCloudAiplatformV1SuggestTrialsResponse - type: object - description: Response message for VizierService.SuggestTrials. - GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata: - properties: - progressMessage: + readOnly: true + deployedModelId: type: string - description: Progress Message for Update LRO - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for PersistentResource. - type: object - description: Details of operations that perform update PersistentResource. - id: GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata - GoogleCloudAiplatformV1ListIndexEndpointsResponse: - description: Response message for IndexEndpointService.ListIndexEndpoints. + description: ID of the Endpoint's DeployedModel that served this prediction. + GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective: properties: - indexEndpoints: - description: List of IndexEndpoints in the requested page. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' - nextPageToken: + type: + enum: + - MODEL_DEPLOYMENT_MONITORING_OBJECTIVE_TYPE_UNSPECIFIED + - RAW_FEATURE_SKEW + - RAW_FEATURE_DRIFT + - FEATURE_ATTRIBUTION_SKEW + - FEATURE_ATTRIBUTION_DRIFT + 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 + topFeatureCount: + format: int32 + type: integer description: >- - A token to retrieve next page of results. Pass to - ListIndexEndpointsRequest.page_token to obtain that page. + 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. + id: >- + GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective + description: Stats requested for specific objective. type: object - id: GoogleCloudAiplatformV1ListIndexEndpointsResponse - GoogleIamV1TestIamPermissionsResponse: - description: Response message for `TestIamPermissions` method. + GoogleCloudAiplatformV1StreamingPredictResponse: type: object + description: Response message for PredictionService.StreamingPredict. properties: - permissions: - description: >- - A subset of `TestPermissionsRequest.permissions` that the caller is - allowed. + outputs: + description: The prediction output. items: - type: string + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' type: array - id: GoogleIamV1TestIamPermissionsResponse - GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadata: - id: GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadata + parameters: + description: The parameters that govern the prediction. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + id: GoogleCloudAiplatformV1StreamingPredictResponse + CloudAiLargeModelsVisionRaiInfo: properties: - partialResults: - description: >- - Partial results that reflect the latest migration operation - progress. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult + scores: type: array - genericMetadata: - description: The common part of the operation metadata. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - type: object - description: >- - Runtime operation information for - MigrationService.BatchMigrateResources. - GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse: - id: GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse - type: object - description: Response message for TensorboardService.WriteTensorboardExperimentData. - properties: {} - GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset: - type: object - id: GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset - properties: - dataset: - type: string - description: >- - 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 - dataLabelingAnnotatedDatasets: description: >- - The migratable AnnotatedDataset in datalabeling.googleapis.com - belongs to the data labeling Dataset. + List of rai scores mapping to the rai categories. Rounded to 1 + decimal place. items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset + format: float + type: number + detectedLabels: + description: The list of detected labels for different rai categories. + items: + $ref: '#/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabels' type: array - description: Represents one Dataset in datalabeling.googleapis.com. - GoogleCloudAiplatformV1TensorboardBlobSequence: - 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. - properties: - values: - description: List of blobs contained within the sequence. + raiCategories: type: array + description: List of rai categories' information to return items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardBlob' + type: string type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs + id: CloudAiLargeModelsVisionRaiInfo + GoogleCloudAiplatformV1FeatureView: type: object + id: GoogleCloudAiplatformV1FeatureView properties: - modelType: + name: 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 - GoogleCloudAiplatformV1UpdateTensorboardOperationMetadata: - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Tensorboard. - type: object - id: GoogleCloudAiplatformV1UpdateTensorboardOperationMetadata - description: Details of operations that perform update Tensorboard. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation - properties: - columnName: + description: >- + Identifier. Name of the FeatureView. Format: + `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` + 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 + createTime: + format: google-datetime + description: Output only. Timestamp when this FeatureView was created. + readOnly: true type: string - 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. - GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse: - description: Response message for JobService.ListHyperparameterTuningJobs - properties: - nextPageToken: + indexConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewIndexConfig' + 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. + etag: type: string description: >- - A token to retrieve the next page of results. Pass to - ListHyperparameterTuningJobsRequest.page_token to obtain that page. - hyperparameterTuningJobs: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob + Optional. Used to perform consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. + featureRegistrySource: description: >- - List of HyperparameterTuningJobs in the requested page. - HyperparameterTuningJob.trials of the jobs will be not be returned. - type: object - id: GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse - GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest: - id: GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest - description: Request message for TensorboardService.CreateTensorboardTimeSeries. - properties: - parent: + Optional. Configures the features from a Feature Registry source + that need to be loaded onto the FeatureOnlineStore. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource + syncConfig: description: >- - Required. The resource name of the TensorboardRun to create the - TensorboardTimeSeries in. Format: - `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` - type: string - tensorboardTimeSeriesId: + 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. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewSyncConfig' + labels: + type: object 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}" + 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 + updateTime: + format: google-datetime + readOnly: true + description: Output only. Timestamp when this FeatureView was last updated. type: string - tensorboardTimeSeries: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries' - description: Required. The TensorboardTimeSeries to create. - type: object - GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata: - description: Details of operations that perform create PersistentResource. + description: >- + FeatureView is representation of values that the FeatureOnlineStore will + serve based on its syncConfig. + GoogleCloudAiplatformV1ExplainResponse: type: object + description: Response message for PredictionService.Explain. + id: GoogleCloudAiplatformV1ExplainResponse properties: - progressMessage: - description: Progress Message for Create LRO + predictions: + description: >- + The predictions that are the output of the predictions call. Same as + PredictResponse.predictions. + items: + type: any + type: array + deployedModelId: type: string - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for PersistentResource. - id: GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassification: + description: ID of the Endpoint's DeployedModel that served this explanation. + explanations: + description: >- + 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' + type: array + GoogleCloudAiplatformV1FeatureOnlineStore: + type: object description: >- - A TrainingJob that trains and uploads an AutoML Image Classification - Model. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassification + 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. + id: GoogleCloudAiplatformV1FeatureOnlineStore properties: - inputs: + bigtable: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs - description: The input parameters of this TrainingJob. - metadata: + #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreBigtable + description: >- + Contains settings for the Cloud Bigtable instance that will be + created to serve featureValues for all FeatureViews under this + FeatureOnlineStore. + optimized: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata - description: The metadata information. - type: object - GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest: - description: >- - Request message for - JobService.SearchModelDeploymentMonitoringStatsAnomalies. - type: object - id: >- - GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest - properties: - pageToken: + #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreOptimized description: >- - A page token received from a previous - JobService.SearchModelDeploymentMonitoringStatsAnomalies call. + 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. + etag: + description: >- + Optional. Used to perform consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. type: string - pageSize: - format: int32 - description: The standard list page size. - type: integer - endTime: - format: google-datetime + labels: + type: object + additionalProperties: + type: string description: >- - The latest timestamp of stats being generated. If not set, indicates - feching stats till the latest possible one. + 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. + updateTime: type: string - deployedModelId: description: >- - Required. The DeployedModel ID of the - [ModelDeploymentMonitoringObjectiveConfig.deployed_model_id]. + Output only. Timestamp when this FeatureOnlineStore was last + updated. + readOnly: true + format: google-datetime + state: + 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. type: string - startTime: + readOnly: true + enum: + - STATE_UNSPECIFIED + - STABLE + - UPDATING + description: Output only. State of the featureOnlineStore. + dedicatedServingEndpoint: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint + description: >- + Optional. The dedicated serving endpoint for this + FeatureOnlineStore, which is different from common Vertex service + endpoint. + createTime: + type: string + readOnly: true format: google-datetime + description: Output only. Timestamp when this FeatureOnlineStore was created. + name: description: >- - The earliest timestamp of stats being generated. If not set, - indicates fetching stats till the earliest possible one. + Identifier. Name of the FeatureOnlineStore. Format: + `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}` type: string - featureDisplayName: + 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. + GoogleCloudAiplatformV1FunctionCallingConfig: + type: object + id: GoogleCloudAiplatformV1FunctionCallingConfig + description: Function calling config. + properties: + mode: + enumDescriptions: + - Unspecified function calling mode. This value should not be used. + - >- + Default model behavior, model decides to predict either a function + call or a natural language repspose. + - >- + Model is constrained to always predicting a function call only. If + "allowed_function_names" are set, the predicted function call will + be limited to any one of "allowed_function_names", else the + predicted function call will be any one of the provided + "function_declarations". + - >- + Model will not predict any function call. Model behavior is same + as when not passing any function declarations. + description: Optional. Function calling mode. + enum: + - MODE_UNSPECIFIED + - AUTO + - ANY + - NONE type: string + allowedFunctionNames: 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. + 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: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective - GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData: - type: object - id: GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData - description: >- - Container to hold value(s), successive in time, for one Feature from the - request. + type: string + GoogleCloudAiplatformV1ListNasJobsResponse: properties: - values: + nasJobs: + type: array 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. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueList' - value: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' - description: Feature value if a single value is requested. - GoogleCloudAiplatformV1ImportModelEvaluationRequest: + List of NasJobs in the requested page. NasJob.nas_job_output of the + jobs will not be returned. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' + nextPageToken: + type: string + description: >- + A token to retrieve the next page of results. Pass to + ListNasJobsRequest.page_token to obtain that page. + type: object + description: Response message for JobService.ListNasJobs + id: GoogleCloudAiplatformV1ListNasJobsResponse + GoogleCloudAiplatformV1TFRecordDestination: + id: GoogleCloudAiplatformV1TFRecordDestination properties: - modelEvaluation: - description: Required. Model evaluation resource to be imported. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' - description: Request message for ModelService.ImportModelEvaluation + gcsDestination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + description: Required. Google Cloud Storage location. type: object - id: GoogleCloudAiplatformV1ImportModelEvaluationRequest - GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageObjectDetectionEvaluationMetrics: - description: Metrics for image object detection evaluation results. + description: The storage details for TFRecord output content. + GoogleCloudAiplatformV1Probe: + id: GoogleCloudAiplatformV1Probe + 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: - evaluatedBoundingBoxCount: + exec: + description: ExecAction probes the health of a container by executing a command. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ProbeExecAction' + timeoutSeconds: 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 - 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. + 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'. + 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 + GoogleCloudAiplatformV1ProbeExecAction: + type: object + id: GoogleCloudAiplatformV1ProbeExecAction + description: ExecAction specifies a command to execute. + properties: + command: type: array items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics - boundingBoxMeanAveragePrecision: - format: float - type: number + type: string description: >- - The single metric for bounding boxes evaluation: the - `meanAveragePrecision` averaged over all - `boundingBoxMetricsEntries`. - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageObjectDetectionEvaluationMetrics - GoogleCloudAiplatformV1ImportDataResponse: - description: Response message for DatasetService.ImportData. - id: GoogleCloudAiplatformV1ImportDataResponse - properties: {} - type: object - GoogleCloudAiplatformV1ResourcesConsumed: - id: GoogleCloudAiplatformV1ResourcesConsumed - description: Statistics information about resource consumption. - type: object + 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. + GoogleCloudAiplatformV1ExportModelRequestOutputConfig: properties: - replicaHours: + artifactDestination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' 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. - format: double - readOnly: true - type: number - GoogleCloudAiplatformV1WriteTensorboardRunDataRequest: + 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: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ContainerRegistryDestination + 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`. + exportFormatId: + 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. + type: string + description: Output configuration for the Model export. type: object - id: GoogleCloudAiplatformV1WriteTensorboardRunDataRequest - description: Request message for TensorboardService.WriteTensorboardRunData. + id: GoogleCloudAiplatformV1ExportModelRequestOutputConfig + 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. properties: - tensorboardRun: + columnName: type: string + type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation + GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse: + properties: + nextPageToken: description: >- - Required. The resource name of the TensorboardRun to write data to. - Format: - `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` - timeSeriesData: + 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. + type: string + tensorboardTimeSeries: type: array - 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. + description: The TensorboardTimeSeries mathching the request. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesData' - GoogleCloudAiplatformV1CreateSpecialistPoolOperationMetadata: - properties: - genericMetadata: - description: The operation generic information. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries' + id: GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse type: object - description: >- - Runtime operation information for - SpecialistPoolService.CreateSpecialistPool. - id: GoogleCloudAiplatformV1CreateSpecialistPoolOperationMetadata - GoogleLongrunningOperation: + description: Response message for TensorboardService.ListTensorboardTimeSeries. + GoogleCloudAiplatformV1UploadModelRequest: + id: GoogleCloudAiplatformV1UploadModelRequest + description: Request message for ModelService.UploadModel. properties: - 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: + modelId: 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: + 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: 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}`. + 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.). + type: string + model: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + description: Required. The Model to create. + parentModel: type: string - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - The error result of the operation in case of failure or - cancellation. - 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`. - description: >- - This resource represents a long-running operation that is the result of - a network API call. + Optional. The resource name of the model into which to upload the + version. Only specify this field when uploading a new version. type: object - id: GoogleLongrunningOperation - GoogleCloudAiplatformV1ListFeatureViewSyncsResponse: - id: GoogleCloudAiplatformV1ListFeatureViewSyncsResponse + GoogleCloudAiplatformV1ListDatasetVersionsResponse: + id: GoogleCloudAiplatformV1ListDatasetVersionsResponse 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: + description: The standard List next-page token. + datasetVersions: type: array - description: The FeatureViewSyncs matching the request. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewSync' + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + description: >- + A list of DatasetVersions that matches the specified filter in the + request. + description: Response message for DatasetService.ListDatasetVersions. + type: object + GoogleCloudAiplatformV1CreateIndexEndpointOperationMetadata: + type: object + id: GoogleCloudAiplatformV1CreateIndexEndpointOperationMetadata description: >- - Response message for - FeatureOnlineStoreAdminService.ListFeatureViewSyncs. + Runtime operation information for + IndexEndpointService.CreateIndexEndpoint. + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. + GoogleCloudAiplatformV1ListDatasetsResponse: + description: Response message for DatasetService.ListDatasets. type: object - GoogleCloudAiplatformV1TensorboardTimeSeries: + id: GoogleCloudAiplatformV1ListDatasetsResponse 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. + datasets: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + description: A list of Datasets that matches the specified filter in the request. + type: array + nextPageToken: type: string - description: Required. Immutable. Type of TensorboardTimeSeries value. - enum: - - VALUE_TYPE_UNSPECIFIED - - SCALAR - - TENSOR - - BLOB_SEQUENCE - updateTime: - format: google-datetime - readOnly: true + description: The standard List next-page token. + GoogleCloudAiplatformV1ShieldedVmConfig: + properties: + enableSecureBoot: + type: boolean description: >- - Output only. Timestamp when this TensorboardTimeSeries was last - updated. - type: string - etag: + 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. + id: GoogleCloudAiplatformV1ShieldedVmConfig + type: object + description: >- + A set of Shielded Instance options. See [Images using supported Shielded + VM + features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). + GoogleCloudAiplatformV1CreateFeatureOnlineStoreOperationMetadata: + properties: + genericMetadata: + description: Operation metadata for FeatureOnlineStore. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + id: GoogleCloudAiplatformV1CreateFeatureOnlineStoreOperationMetadata + type: object + description: Details of operations that perform create FeatureOnlineStore. + GoogleCloudAiplatformV1UpdateFeatureGroupOperationMetadata: + description: Details of operations that perform update FeatureGroup. + properties: + genericMetadata: + description: Operation metadata for FeatureGroup. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + type: object + id: GoogleCloudAiplatformV1UpdateFeatureGroupOperationMetadata + GoogleCloudAiplatformV1MutateDeployedModelRequest: + description: Request message for EndpointService.MutateDeployedModel. + id: GoogleCloudAiplatformV1MutateDeployedModelRequest + properties: + updateMask: + description: >- + Required. The update mask applies to the resource. See + google.protobuf.FieldMask. type: string + format: google-fieldmask + deployedModel: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' description: >- - Used to perform a consistent read-modify-write updates. If not set, - a blind "overwrite" update happens. - pluginName: + 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) + type: object + GoogleCloudAiplatformV1Measurement: + 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 + properties: + stepCount: + readOnly: true description: >- - Immutable. Name of the plugin this time series pertain to. Such as - Scalar, Tensor, Blob + Output only. The number of steps the machine learning model has been + trained for. Must be non-negative. + format: int64 type: string - metadata: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata + elapsedDuration: + readOnly: true + format: google-duration description: >- - Output only. Scalar, Tensor, or Blob metadata for this - TensorboardTimeSeries. + Output only. Time that the Trial has been running at the point of + this Measurement. + type: string + metrics: + description: >- + Output only. A list of metrics got by evaluating the objective + functions using suggested Parameter values. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MeasurementMetric' readOnly: true - name: - description: Output only. Name of the TensorboardTimeSeries. + GoogleCloudAiplatformV1Study: + properties: + createTime: + description: Output only. Time at which the study was created. readOnly: true + format: google-datetime type: string - pluginData: - format: byte + name: + readOnly: true type: string - description: Data of the current plugin, with the size limited to 65KB. - displayName: + description: >- + Output only. The name of a study. The study's globally unique + identifier. Format: + `projects/{project}/locations/{location}/studies/{study}` + state: + readOnly: true type: string + 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 + description: Output only. The detailed state of a Study. + inactiveReason: 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: + Output only. A human readable reason why the Study is inactive. This + should be empty if a study is ACTIVE or COMPLETED. type: string - description: Description of this TensorboardTimeSeries. - createTime: readOnly: true - format: google-datetime - description: Output only. Timestamp when this TensorboardTimeSeries was created. + studySpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' + description: Required. Configuration of the Study. + displayName: type: string - description: TensorboardTimeSeries maps to times series produced in training runs + description: Required. Describes the Study, default value is empty string. + id: GoogleCloudAiplatformV1Study + description: A message representing a Study. + type: object + GoogleCloudAiplatformV1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics: + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics type: object - id: GoogleCloudAiplatformV1TensorboardTimeSeries - GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider: properties: - allowedIssuers: + exactMatch: 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 + The rate at which the input predicted strings exactly match their + references. + type: number + format: float + GoogleIamV1TestIamPermissionsResponse: + properties: + permissions: type: array - audiences: + description: >- + A subset of `TestPermissionsRequest.permissions` that the caller is + allowed. items: type: string - type: array - 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 + id: GoogleIamV1TestIamPermissionsResponse + description: Response message for `TestIamPermissions` method. + GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail: 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). - GoogleCloudAiplatformV1RaySpec: - id: GoogleCloudAiplatformV1RaySpec + The detail of a container execution. It contains the job names of the + lifecycle of a container execution. properties: - headNodeResourcePoolId: + failedMainJobs: + type: array + readOnly: true + items: + 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. + Output only. The names of the previously failed CustomJob for the + main container executions. The list includes the all attempts in + chronological order. + preCachingCheckJob: type: string - imageUri: 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. + 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. + readOnly: true + mainJob: type: string - resourcePoolImages: - type: object - additionalProperties: + description: >- + Output only. The name of the CustomJob for the main container + execution. + readOnly: true + failedPreCachingCheckJobs: + items: type: string + readOnly: true 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" } - rayMetricSpec: - description: Optional. Ray metrics configurations. - $ref: '#/components/schemas/GoogleCloudAiplatformV1RayMetricSpec' + 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 + type: object + id: GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail + GoogleCloudAiplatformV1NasTrial: + description: Represents a uCAIP NasJob trial. 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. - GoogleCloudAiplatformV1SchemaTimeSegment: properties: - startTimeOffset: - format: google-duration - description: >- - Start of the time segment (inclusive), represented as the duration - since the start of the DataItem. + state: + description: Output only. The detailed state of the NasTrial. + enum: + - STATE_UNSPECIFIED + - REQUESTED + - ACTIVE + - STOPPING + - SUCCEEDED + - INFEASIBLE + readOnly: true + 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 - endTimeOffset: - format: google-duration - description: >- - End of the time segment (exclusive), represented as the duration - since the start of the DataItem. + startTime: type: string - description: >- - A time period inside of a DataItem that has a time dimension (e.g. - video). - id: GoogleCloudAiplatformV1SchemaTimeSegment - type: object - GoogleCloudAiplatformV1SchemaImageBoundingBoxAnnotation: - properties: - annotationSpecId: - description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. + format: google-datetime + description: Output only. Time when the NasTrial was started. + readOnly: true + 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: + format: google-datetime type: string - xMax: - description: The rightmost coordinate of the bounding box. - format: double - type: number - yMin: - format: double - description: The topmost coordinate of the bounding box. - type: number - xMin: - description: The leftmost coordinate of the bounding box. - type: number - format: double - yMax: - description: The bottommost coordinate of the bounding box. - type: number - format: double - displayName: description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. + Output only. Time when the NasTrial's status changed to `SUCCEEDED` + or `INFEASIBLE`. + readOnly: true + id: GoogleCloudAiplatformV1NasTrial + GoogleCloudAiplatformV1IndexDatapointCrowdingTag: + 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 - id: GoogleCloudAiplatformV1SchemaImageBoundingBoxAnnotation - description: Annotation details specific to image object detection. + id: GoogleCloudAiplatformV1IndexDatapointCrowdingTag type: object - GoogleCloudAiplatformV1AnnotationSpec: - id: GoogleCloudAiplatformV1AnnotationSpec - description: Identifies a concept with which DataItems may be annotated with. + 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. + GoogleCloudAiplatformV1IndexPrivateEndpoints: 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. + id: GoogleCloudAiplatformV1IndexPrivateEndpoints properties: - createTime: - format: google-datetime + serviceAttachment: readOnly: true - description: Output only. Timestamp when this AnnotationSpec was created. - type: string - etag: type: string description: >- - Optional. Used to perform consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. - name: + Output only. The name of the service attachment resource. Populated + if private service connect is enabled. + matchGrpcAddress: readOnly: true type: string - description: Output only. Resource name of the AnnotationSpec. - displayName: - type: string + description: Output only. The ip address used to send match gRPC requests. + pscAutomatedEndpoints: + type: array 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. - updateTime: - description: Output only. Timestamp when AnnotationSpec was last updated. - format: google-datetime + Output only. PscAutomatedEndpoints is populated if private service + connect is enabled if PscAutomatedConfig is set. readOnly: true - type: string - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PscAutomatedEndpoints' + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity: + description: A duration of time expressed in time granularity units. properties: - trainCostMilliNodeHours: + unit: 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. + The time granularity unit of this time period. The supported units + are: * "minute" * "hour" * "day" * "week" * "month" * "year" type: string + quantity: + 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 - evaluatedDataItemsBigqueryUri: type: string - description: BigQuery destination uri for exported evaluated examples. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity type: object - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata - description: Model metadata specific to AutoML Tables. - GoogleCloudAiplatformV1StructValue: - properties: - values: - type: array - description: A list of field values. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StructFieldValue' - description: Struct (or object) type feature value. - id: GoogleCloudAiplatformV1StructValue + GoogleCloudAiplatformV1SafetySetting: type: object - GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation: - type: object - id: >- - GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation - description: Represents a polygon in image. + id: GoogleCloudAiplatformV1SafetySetting + description: Safety settings. properties: - displayName: - description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. + threshold: type: string - annotationSpecId: - description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. + enum: + - HARM_BLOCK_THRESHOLD_UNSPECIFIED + - BLOCK_LOW_AND_ABOVE + - BLOCK_MEDIUM_AND_ABOVE + - BLOCK_ONLY_HIGH + - BLOCK_NONE + 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. + description: Required. The harm block threshold. + category: + description: Required. Harm 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. + enum: + - HARM_CATEGORY_UNSPECIFIED + - HARM_CATEGORY_HATE_SPEECH + - HARM_CATEGORY_DANGEROUS_CONTENT + - HARM_CATEGORY_HARASSMENT + - HARM_CATEGORY_SEXUALLY_EXPLICIT + 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 - 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. - GoogleCloudLocationListLocationsResponse: - id: GoogleCloudLocationListLocationsResponse + Optional. Specify if the threshold is used for probability or + severity score. If not specified, the threshold is used for + probability score. + CloudAiLargeModelsVisionGenerateVideoResponse: type: object - description: The response message for Locations.ListLocations. + description: Generate video response. properties: - nextPageToken: - description: The standard List next-page token. - type: string - locations: - description: >- - A list of locations that matches the specified filter in the - request. + raiMediaFilteredCount: + description: Returns if any videos were filtered due to RAI policies. + format: int32 + type: integer + generatedSamples: + type: array + description: The generates samples. items: - $ref: '#/components/schemas/GoogleCloudLocationLocation' + $ref: '#/components/schemas/CloudAiLargeModelsVisionMedia' + raiMediaFilteredReasons: + items: + type: string type: array - GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences: - description: >- - The regional resource name or the URI. Key is region, e.g., us-central1, - europe-west2, global, etc.. + description: Returns rai failure reasons if any. + id: CloudAiLargeModelsVisionGenerateVideoResponse + GoogleCloudAiplatformV1TimeSeriesDataPoint: + type: object + description: A TensorboardTimeSeries data point. properties: - references: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelResourceReference - type: object - description: Required. - resourceUseCase: + wallTime: + format: google-datetime + description: >- + Wall clock timestamp when this data point is generated by the end + user. type: string - description: Optional. Use case (CUJ) of the resource. - resourceTitle: - description: Optional. Title of the resource. + tensor: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTensor' + description: A tensor value. + blobs: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardBlobSequence' + description: A blob sequence value. + scalar: + description: A scalar value. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Scalar' + step: + description: Step index of this data point within the run. + format: int64 type: string - resourceDescription: + id: GoogleCloudAiplatformV1TimeSeriesDataPoint + GoogleCloudAiplatformV1ScheduleRunResponse: + id: GoogleCloudAiplatformV1ScheduleRunResponse + description: Status of a scheduled run. + properties: + scheduledRunTime: + format: google-datetime type: string - description: Optional. Description of the resource. - title: + description: The scheduled run time based on the user-specified schedule. + runResponse: type: string - description: 'Required. ' - id: >- - GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + description: The response of the scheduled run. + type: object + GoogleCloudAiplatformV1SchemaPredictInstanceTextExtractionPredictionInstance: type: object - GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature: properties: - name: + key: type: string description: >- - The name of the input feature for which noise sigma is provided. The - features are defined in explanation metadata inputs. - sigma: + 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. + content: + type: string + description: The text snippet to make the predictions on. + mimeType: 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. + The MIME type of the text snippet. The supported MIME types are + listed below. - text/plain + type: string + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceTextExtractionPredictionInstance + description: Prediction input format for Text Extraction. + GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecRange: + description: A range of values for slice(s). `low` is inclusive, `high` is exclusive. + id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecRange + properties: + low: + description: Inclusive low value for the range. + format: float type: number + high: format: float - id: GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature + description: Exclusive high value for the range. + type: number type: object - description: Noise sigma for a single feature. - GoogleCloudAiplatformV1BatchReadFeatureValuesResponse: - properties: {} - description: Response message for FeaturestoreService.BatchReadFeatureValues. - id: GoogleCloudAiplatformV1BatchReadFeatureValuesResponse + GoogleCloudAiplatformV1FeatureViewSyncConfig: + description: Configuration for Sync. Only one option is set. + id: GoogleCloudAiplatformV1FeatureViewSyncConfig type: object - GoogleCloudAiplatformV1Explanation: - description: >- - Explanation of a prediction (provided in PredictResponse.predictions) - produced by the Model on a given instance. properties: - neighbors: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Neighbor' - readOnly: true + cron: + 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. - type: array - attributions: + 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 * * + * *". + GoogleCloudAiplatformV1ListNotebookRuntimesResponse: + properties: + nextPageToken: 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. - readOnly: true - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Attribution' + A token to retrieve next page of results. Pass to + ListNotebookRuntimesRequest.page_token to obtain that page. + type: string + notebookRuntimes: type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookRuntime' + description: List of NotebookRuntimes in the requested page. type: object - id: GoogleCloudAiplatformV1Explanation - GoogleCloudAiplatformV1FeatureView: - description: >- - FeatureView is representation of values that the FeatureOnlineStore will - serve based on its syncConfig. + description: Response message for NotebookService.ListNotebookRuntimes. + id: GoogleCloudAiplatformV1ListNotebookRuntimesResponse + GoogleCloudAiplatformV1SchemaImageBoundingBoxAnnotation: type: object + id: GoogleCloudAiplatformV1SchemaImageBoundingBoxAnnotation + description: Annotation details specific to image object detection. properties: - updateTime: - format: google-datetime - readOnly: true - type: string - description: Output only. Timestamp when this FeatureView was last updated. - name: - type: string - description: >- - Identifier. Name of the FeatureView. Format: - `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` - featureRegistrySource: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource - description: >- - Optional. Configures the features from a Feature Registry source - that need to be loaded onto the FeatureOnlineStore. - 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 - 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 - etag: + annotationSpecId: type: string description: >- - 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 FeatureView was created. + The resource Id of the AnnotationSpec that this Annotation pertains + to. + xMin: + description: The leftmost coordinate of the bounding box. + type: number + format: double + yMin: + type: number + description: The topmost coordinate of the bounding box. + format: double + yMax: + type: number + description: The bottommost coordinate of the bounding box. + format: double + xMax: + description: The rightmost coordinate of the bounding box. + format: double + type: number + displayName: type: string - format: google-datetime - syncConfig: - 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. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewSyncConfig' - 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' - id: GoogleCloudAiplatformV1FeatureView - GoogleCloudAiplatformV1DistillationDataStats: + The display name of the AnnotationSpec that this Annotation pertains + to. + GoogleCloudAiplatformV1MigratableResourceAutomlModel: + id: GoogleCloudAiplatformV1MigratableResourceAutomlModel + description: Represents one Model in automl.googleapis.com. type: object properties: - trainingDatasetStats: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetStats' - readOnly: true - description: Output only. Statistics computed for the training dataset. - id: GoogleCloudAiplatformV1DistillationDataStats - description: Statistics computed for datasets used for distillation. - GoogleCloudAiplatformV1ExportModelRequest: - properties: - outputConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExportModelRequestOutputConfig - description: Required. The desired output location and configuration. + 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: string + GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource: type: object - description: Request message for ModelService.ExportModel. - id: GoogleCloudAiplatformV1ExportModelRequest - GoogleCloudAiplatformV1RemoveDatapointsRequest: properties: - datapointIds: + uri: 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. type: array - description: A list of datapoint ids to be deleted. - id: GoogleCloudAiplatformV1RemoveDatapointsRequest - description: Request message for IndexService.RemoveDatapoints + id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource + GoogleCloudAiplatformV1SchemaTextSentimentAnnotation: type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata: - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata - description: Model metadata specific to TFT Forecasting. + id: GoogleCloudAiplatformV1SchemaTextSentimentAnnotation + description: Annotation details specific to text sentiment. properties: - evaluatedDataItemsBigqueryUri: + sentimentMax: + format: int32 + description: The sentiment max score for text. + type: integer + displayName: type: string - description: BigQuery destination uri for exported evaluated examples. - trainCostMilliNodeHours: + description: >- + The display name of the AnnotationSpec that this Annotation pertains + to. + sentiment: + description: The sentiment score for text. + format: int32 + type: integer + annotationSpecId: 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 - type: object - GoogleCloudAiplatformV1FeatureValueMetadata: - id: GoogleCloudAiplatformV1FeatureValueMetadata + The resource Id of the AnnotationSpec that this Annotation pertains + to. + GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateResponse: + id: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateResponse + description: Response message for VizierService.CheckTrialEarlyStoppingState. + properties: + shouldStop: + type: boolean + description: True if the Trial should stop. type: object - description: Metadata of feature value. + GoogleCloudAiplatformV1BatchReadFeatureValuesOperationMetadata: properties: - 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. - GoogleCloudAiplatformV1Attribution: - id: GoogleCloudAiplatformV1Attribution + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for Featurestore batch read Features values. type: object - description: Attribution that explains a particular prediction output. + description: Details of operations that batch reads Feature values. + id: GoogleCloudAiplatformV1BatchReadFeatureValuesOperationMetadata + 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). More fields may be + added in the future as needed. + id: GoogleCloudAiplatformV1Schema properties: - featureAttributions: - readOnly: true + minLength: + format: int64 + description: >- + Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the + Type.STRING + type: string + minItems: + description: Optional. Minimum number of the elements for Type.ARRAY. + type: string + format: int64 + example: 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). - baselineOutputValue: + Optional. Example of the object. Will only populated when the object + is the root. + description: + type: string + description: Optional. The description of the data. + items: 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. - type: number + Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of + Type.ARRAY. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' + maxItems: + description: Optional. Maximum number of the elements for Type.ARRAY. + format: int64 + type: string + minimum: format: double - 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. - readOnly: true + Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of + the Type.INTEGER and Type.NUMBER + type: number + nullable: + type: boolean + description: Optional. Indicates if the value may be null. + required: + description: Optional. Required properties of Type.OBJECT. type: array items: - type: integer - format: int32 - outputDisplayName: + type: string + maxLength: type: string - readOnly: true - 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. - outputName: - readOnly: true + description: Optional. Maximum length of the Type.STRING + format: int64 + default: + type: any + description: Optional. Default value of the data. + type: + enum: + - TYPE_UNSPECIFIED + - STRING + - NUMBER + - INTEGER + - BOOLEAN + - ARRAY + - OBJECT + 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 type: string - description: >- - Output only. Name of the explain output. Specified as the key in - ExplanationMetadata.outputs. - approximationError: - type: number + maximum: format: double - readOnly: true - 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. - instanceOutputValue: + description: Optional. Maximum value of the Type.INTEGER and Type.NUMBER type: number - readOnly: true + pattern: 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 - GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition: - description: Represents the spec to match categorical values from parent parameter. - type: object - id: >- - GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition - properties: - values: + Optional. Pattern of the Type.STRING to restrict a string to a + regular expression. + type: string + minProperties: + format: int64 + type: string + description: Optional. Minimum number of the properties for Type.OBJECT. + title: + type: string + description: Optional. The title of the Schema. + enum: type: array + 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"]} items: type: string + format: + type: string description: >- - Required. Matches values of the parent parameter of 'CATEGORICAL' - type. All values must exist in `categorical_value_spec` of parent - parameter. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation: - properties: - columnName: + 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: + format: int64 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. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognition: - description: >- - A TrainingJob that trains and uploads an AutoML Video Action Recognition - Model. + description: Optional. Maximum number of the properties for Type.OBJECT. + properties: + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' + description: Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. type: object - properties: - inputs: - description: The input parameters of this TrainingJob. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs + GoogleCloudAiplatformV1SchemaPredictInstanceVideoClassificationPredictionInstance: + description: Prediction input format for Video Classification. id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognition - GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition: - description: Represents the spec to match integer values from parent parameter. + GoogleCloudAiplatformV1SchemaPredictInstanceVideoClassificationPredictionInstance properties: - values: - type: array - items: - format: int64 - type: string + timeSegmentEnd: description: >- - Required. Matches values of the parent parameter of 'INTEGER' type. - All values must lie in `integer_value_spec` of parent parameter. + 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: + description: >- + The Google Cloud Storage location of the video on which to perform + the prediction. + type: string + mimeType: + type: string + description: >- + The MIME type of the content of the video. Only the following are + supported: video/mp4 video/avi video/quicktime + 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. + type: object + GoogleCloudAiplatformV1BatchPredictionJobInputConfig: type: object - id: >- - GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition - GoogleCloudAiplatformV1StreamingPredictRequest: description: >- - Request message for PredictionService.StreamingPredict. The first - message must contain endpoint field and optionally input. The subsequent - messages must contain input. + 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. + id: GoogleCloudAiplatformV1BatchPredictionJobInputConfig properties: - inputs: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - description: The prediction input. - parameters: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - description: The parameters that govern the prediction. + gcsSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' + description: The Cloud Storage location for the input instances. + bigquerySource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' + 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. + instancesFormat: + description: >- + Required. The format in which instances are given, must be one of + the Model's supported_input_storage_formats. + type: string + GoogleCloudAiplatformV1UpdateTensorboardOperationMetadata: + id: GoogleCloudAiplatformV1UpdateTensorboardOperationMetadata type: object - id: GoogleCloudAiplatformV1StreamingPredictRequest - GoogleCloudAiplatformV1SchemaPredictPredictionVideoActionRecognitionPredictionResult: + description: Details of operations that perform update Tensorboard. properties: - timeSegmentEnd: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for Tensorboard. + GoogleCloudAiplatformV1ExportFeatureValuesRequest: + description: Request message for FeaturestoreService.ExportFeatureValues. + id: GoogleCloudAiplatformV1ExportFeatureValuesRequest + 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. + snapshotExport: 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: + Exports the latest Feature values of all entities of the EntityType + within a time range. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport + featureSelector: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' + description: Required. Selects Features to export values of. + fullExport: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport 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. + Exports all historical values of all entities of the EntityType + within a time range + type: object + GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResult: + properties: + displayName: + description: The display name of the AnnotationSpec that had been identified. type: string - format: google-duration id: - description: The resource ID of the AnnotationSpec that had been identified. type: string - displayName: + description: The resource ID of the AnnotationSpec that had been identified. + timeSegmentEnd: type: string - description: The display name of the AnnotationSpec that had been identified. + 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. confidence: description: >- The Model's confidence in correction of this prediction, higher value means higher confidence. format: float type: number + frames: + type: array + 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. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame + 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. + type: object id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionVideoActionRecognitionPredictionResult - description: Prediction output format for Video Action Recognition. + GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResult + description: Prediction output format for Video Object Tracking. + GoogleCloudAiplatformV1ListFeatureViewsResponse: + id: GoogleCloudAiplatformV1ListFeatureViewsResponse type: object - GoogleCloudAiplatformV1PipelineTemplateMetadata: + description: Response message for FeatureOnlineStoreAdminService.ListFeatureViews. properties: - version: + featureViews: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' + type: array + description: The FeatureViews matching the request. + nextPageToken: type: string 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...". + 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. + GoogleCloudAiplatformV1CreateMetadataStoreOperationMetadata: + description: Details of operations that perform MetadataService.CreateMetadataStore. + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for creating a MetadataStore. + id: GoogleCloudAiplatformV1CreateMetadataStoreOperationMetadata type: object - id: GoogleCloudAiplatformV1PipelineTemplateMetadata - description: >- - Pipeline template metadata if PipelineJob.template_uri is from supported - template registry. Currently, the only supported registry is Artifact - Registry. - 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. + GoogleCloudAiplatformV1MigrateResourceResponse: properties: - columnName: + migratableResource: + description: >- + Before migration, the identifier in ml.googleapis.com, + automl.googleapis.com or datalabeling.googleapis.com. + $ref: '#/components/schemas/GoogleCloudAiplatformV1MigratableResource' + dataset: type: string + description: Migrated Dataset's resource name. + model: + description: Migrated Model's resource name. + type: string + description: Describes a successfully migrated resource. + type: object + id: GoogleCloudAiplatformV1MigrateResourceResponse + GoogleCloudAiplatformV1ModelOriginalModelInfo: type: object - GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig: - id: GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig properties: model: + readOnly: true description: >- - Required. Full resource name of automl Model. Format: - `projects/{project}/locations/{location}/models/{model}`. + 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 + description: Contains information about the original Model if this Model is a copy. + id: GoogleCloudAiplatformV1ModelOriginalModelInfo + GoogleCloudAiplatformV1PersistentDiskSpec: + properties: + diskType: type: string - modelDisplayName: description: >- - Optional. Display name of the model in Vertex AI. System will pick a - display name if unspecified. + 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) + diskSizeGb: + description: Size in GB of the disk (default is 100GB). + format: int64 type: string - description: >- - Config for migrating Model in automl.googleapis.com to Vertex AI's - Model. type: object - GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis: + description: Represents the spec of persistent disk options. + id: GoogleCloudAiplatformV1PersistentDiskSpec + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextSentimentEvaluationMetrics: type: object - 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. + description: Model evaluation metrics for text sentiment problems. id: >- - GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextSentimentEvaluationMetrics 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. - enum: - - BASELINE_UNSPECIFIED - - LATEST_STATS - - MOST_RECENT_SNAPSHOT_STATS - - PREVIOUS_IMPORT_FEATURES_STATS - type: string + meanSquaredError: + format: float + type: number description: >- - The baseline used to do anomaly detection for the statistics - generated by import features analysis. - state: + Mean squared error. Only set for ModelEvaluations, not for + ModelEvaluationSlices. + precision: + type: number + format: float + description: Precision. + meanAbsoluteError: + type: number description: >- - Whether to enable / disable / inherite default hebavior for import - features analysis. + Mean absolute error. Only set for ModelEvaluations, not for + ModelEvaluationSlices. + format: float + quadraticKappa: + type: number + description: >- + Quadratic weighted kappa. Only set for ModelEvaluations, not for + ModelEvaluationSlices. + format: float + f1Score: + format: float + type: number + description: The harmonic mean of recall and precision. + recall: + type: number + description: Recall. + format: float + linearKappa: + type: number + format: float + description: >- + Linear weighted kappa. Only set for ModelEvaluations, not for + ModelEvaluationSlices. + confusionMatrix: + description: >- + Confusion matrix of the evaluation. Only set for ModelEvaluations, + not for ModelEvaluationSlices. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata: + properties: + successfulStopReason: 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. + - Should not be set. + - The inputs.budgetMilliNodeHours had been reached. - >- - 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. + Further training of the Model ceased to increase its quality, + since it already has converged. + type: string enum: - - STATE_UNSPECIFIED - - DEFAULT - - ENABLED - - DISABLED + - SUCCESSFUL_STOP_REASON_UNSPECIFIED + - BUDGET_REACHED + - MODEL_CONVERGED + description: >- + For successful job completions, this is the reason why the job has + finished. + costMilliNodeHours: + format: int64 type: string - GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput: - id: GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput + 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 + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata + GoogleCloudAiplatformV1BatchPredictionJobOutputInfo: + id: GoogleCloudAiplatformV1BatchPredictionJobOutputInfo properties: - searchTrials: + gcsOutputDirectory: + readOnly: true description: >- - Output only. List of NasTrials that were started as part of search - stage. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' - type: array + Output only. The full path of the Cloud Storage directory created, + into which the prediction output is written. + type: string + bigqueryOutputDataset: + type: string readOnly: true - trainTrials: + description: >- + Output only. The path of the BigQuery dataset created, in + `bq://projectId.bqDatasetId` format, into which the prediction + output is written. + bigqueryOutputTable: + type: string readOnly: true - type: array description: >- - Output only. List of NasTrials that were started as part of train - stage. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' - description: The output of a multi-trial Neural Architecture Search (NAS) jobs. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsRegressionEvaluationMetrics: - description: Metrics for regression evaluation results. + 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: object + description: Further describes this job's output. Supplements output_config. + GoogleCloudAiplatformV1CreateIndexOperationMetadata: + description: Runtime operation information for IndexService.CreateIndex. type: object properties: - meanAbsoluteError: - description: Mean Absolute Error (MAE). - type: number - format: float - rootMeanSquaredLogError: - type: number - format: float - description: >- - Root mean squared log error. Undefined when there are negative - ground truth values or predictions. - rootMeanSquaredError: - description: Root Mean Squared Error (RMSE). - type: number - format: float - meanAbsolutePercentageError: - format: float - description: >- - Mean absolute percentage error. Infinity when there are zeros in the - ground truth. - type: number - rSquared: - format: float + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. + nearestNeighborSearchOperationMetadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata description: >- - Coefficient of determination as Pearson correlation coefficient. - Undefined when ground truth or predictions are constant or near - constant. - type: number - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsRegressionEvaluationMetrics - GoogleCloudAiplatformV1FeatureValueList: - properties: - values: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' - type: array - description: A list of feature values. All of them should be the same data type. - description: Container for list of values. + The operation metadata with regard to Matching Engine Index + operation. + id: GoogleCloudAiplatformV1CreateIndexOperationMetadata + GoogleCloudAiplatformV1ModelSourceInfo: + description: Detail description of the source information of the model. + id: GoogleCloudAiplatformV1ModelSourceInfo type: object - id: GoogleCloudAiplatformV1FeatureValueList - GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail: + properties: + copy: + type: boolean + description: >- + If this Model is copy of another Model. If true then source_type + pertains to the original. + sourceType: + type: string + enum: + - MODEL_SOURCE_TYPE_UNSPECIFIED + - AUTOML + - CUSTOM + - BQML + - MODEL_GARDEN + - GENIE + - CUSTOM_TEXT_EMBEDDING + - MARKETPLACE + description: Type of the model source. + 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. + GoogleCloudAiplatformV1CreateRegistryFeatureOperationMetadata: type: object properties: - failedJobs: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for Feature. + description: Details of operations that perform create FeatureGroup. + id: GoogleCloudAiplatformV1CreateRegistryFeatureOperationMetadata + GoogleCloudAiplatformV1NasJobSpec: + properties: + resumeNasJobId: description: >- - Output only. The names of the previously failed CustomJob. The list - includes the all attempts in chronological order. - type: array - readOnly: true - items: - type: string - job: + 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 - readOnly: true - description: Output only. The name of the CustomJob. - id: GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail - description: The detailed info for a custom job executor. - GoogleCloudAiplatformV1ContainerSpec: - id: GoogleCloudAiplatformV1ContainerSpec + 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). + type: object + description: Represents the spec of a NasJob. + id: GoogleCloudAiplatformV1NasJobSpec + GoogleCloudAiplatformV1FeatureOnlineStoreBigtable: + id: GoogleCloudAiplatformV1FeatureOnlineStoreBigtable type: object properties: - args: - items: - type: string + autoScaling: + description: Required. Autoscaling config applied to Bigtable Instance. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassification: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassification + type: object + description: >- + A TrainingJob that trains and uploads an AutoML Text Classification + Model. + properties: + inputs: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs + description: The input parameters of this TrainingJob. + GoogleCloudAiplatformV1ListTrainingPipelinesResponse: + id: GoogleCloudAiplatformV1ListTrainingPipelinesResponse + properties: + trainingPipelines: type: array - description: The arguments to be passed when starting the container. - 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. - imageUri: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' + description: List of TrainingPipelines in the requested page. + nextPageToken: type: string description: >- - Required. The URI of a container image in the Container Registry - that is to be run on each worker replica. - env: - description: >- - Environment variables to be passed to the container. Maximum limit - is 100. + A token to retrieve the next page of results. Pass to + ListTrainingPipelinesRequest.page_token to obtain that page. + description: Response message for PipelineService.ListTrainingPipelines + type: object + GoogleCloudAiplatformV1BatchCreateFeaturesResponse: + id: GoogleCloudAiplatformV1BatchCreateFeaturesResponse + properties: + features: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EnvVar' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + description: The Features created. type: array - description: The spec of a Container. - GoogleCloudAiplatformV1ListMetadataSchemasResponse: + description: Response message for FeaturestoreService.BatchCreateFeatures. + type: object + GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecSliceConfig: properties: - nextPageToken: - type: string + range: 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. - metadataSchemas: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' - description: The MetadataSchemas found for the MetadataStore. - description: Response message for MetadataService.ListMetadataSchemas. + 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 + 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 + value: + description: >- + A unique specific value for a given feature. Example: `{ "value": { + "string_value": "12345" } }` + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue type: object - id: GoogleCloudAiplatformV1ListMetadataSchemasResponse - GoogleCloudAiplatformV1SearchNearestEntitiesRequest: - description: The request message for FeatureOnlineStoreService.SearchNearestEntities. + 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 + GoogleCloudAiplatformV1ResumeScheduleRequest: properties: - returnFullEntity: - type: boolean + catchUp: 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. - query: - description: Required. The query. - $ref: '#/components/schemas/GoogleCloudAiplatformV1NearestNeighborQuery' + 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 + description: Request message for ScheduleService.ResumeSchedule. type: object - id: GoogleCloudAiplatformV1SearchNearestEntitiesRequest - GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF: - id: GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF + GoogleCloudAiplatformV1TimestampSplit: + id: GoogleCloudAiplatformV1TimestampSplit properties: - alpha: + testFraction: + description: >- + The fraction of the input data that is to be used to evaluate the + Model. + format: double + type: number + validationFraction: type: number 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: Parameters for RRF algorithm that combines search results. - type: object - GoogleCloudAiplatformV1ExportModelResponse: + The fraction of the input data that is to be used to validate the + Model. + format: double + 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 + trainingFraction: + description: >- + The fraction of the input data that is to be used to train the + Model. + type: number + format: double type: object - properties: {} - id: GoogleCloudAiplatformV1ExportModelResponse - description: Response message of ModelService.ExportModel operation. - 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. + 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. + GoogleCloudAiplatformV1ReadTensorboardUsageResponse: + properties: + monthlyUsageData: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData + type: object + description: Maps year-month (YYYYMM) string to per month usage data. + description: Response message for TensorboardService.ReadTensorboardUsage. type: object + id: GoogleCloudAiplatformV1ReadTensorboardUsageResponse + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata: properties: - metrics: - type: any + evaluatedDataItemsBigqueryUri: + type: string + description: BigQuery destination uri for exported evaluated examples. + trainCostMilliNodeHours: + format: int64 description: >- - Evaluation metrics of the Model. The schema of the metrics is stored - in metrics_schema_uri - displayName: + 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 - description: The display name of the ModelEvaluation. - dataItemSchemaUri: + description: Model metadata specific to Seq2Seq Plus Forecasting. + type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata + GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesRequest: + id: GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesRequest + properties: + modelEvaluationSlices: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSlice' + description: Required. Model evaluation slice resource to be imported. + type: array + type: object + description: Request message for ModelService.BatchImportModelEvaluationSlices + GoogleCloudAiplatformV1NotebookRuntimeTemplate: + 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. + properties: + machineSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' 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. + Optional. Immutable. The specification of a single machine for the + template. + updateTime: + description: >- + Output only. Timestamp when this NotebookRuntimeTemplate was most + recently updated. + format: google-datetime type: string - name: readOnly: true - description: Output only. The resource name of the ModelEvaluation. - type: string - 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 + networkTags: items: type: string - 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 - 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. - metricsSchemaUri: + Optional. The Compute Engine tags to add to runtime (see [Tagging + instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)). + description: + description: The description of the NotebookRuntimeTemplate. + type: string + isDefault: + description: Output only. The default template to use if not specified. + type: boolean + readOnly: true + encryptionSpec: + description: Customer-managed encryption key spec for the notebook runtime. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + name: + type: string + description: The resource name of the NotebookRuntimeTemplate. + etag: 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). + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. type: string - modelExplanation: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelExplanation' + 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. + description: Optional. Immutable. The type of the notebook runtime template. + type: string + enum: + - NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED + - USER_DEFINED + - ONE_CLICK + shieldedVmConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ShieldedVmConfig' + description: Optional. Immutable. Runtime Shielded VM spec. + networkSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NetworkSpec' + description: Optional. Network spec. + labels: + additionalProperties: + type: string + type: object 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. - createTime: - description: Output only. Timestamp when this ModelEvaluation was created. + 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. + displayName: 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. + eucConfig: + description: EUC configuration of the NotebookRuntimeTemplate. + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookEucConfig' + idleShutdownConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookIdleShutdownConfig + description: >- + The idle shutdown configuration of NotebookRuntimeTemplate. This + config will only be set when idle shutdown is enabled. + createTime: format: google-datetime readOnly: true - 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. - GoogleCloudAiplatformV1ListDataItemsResponse: - description: Response message for DatasetService.ListDataItems. - id: GoogleCloudAiplatformV1ListDataItemsResponse - properties: - dataItems: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataItem' + Output only. Timestamp when this NotebookRuntimeTemplate was + created. + dataPersistentDiskSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentDiskSpec' description: >- - A list of DataItems that matches the specified filter in the - request. - nextPageToken: - description: The standard List next-page token. + Optional. The specification of persistent disk attached to the + runtime as data disk storage. + 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. + type: object + GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature: + id: GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature + description: Noise sigma for a single feature. type: object - GoogleCloudAiplatformV1PrivateServiceConnectConfig: properties: - enablePrivateServiceConnect: - type: boolean + sigma: + format: float + type: number description: >- - Required. If true, expose the IndexEndpoint via private service - connect. - projectAllowlist: - items: - type: string - type: array + 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: >- - A list of Projects from which the forwarding rule will target the - service attachment. - id: GoogleCloudAiplatformV1PrivateServiceConnectConfig + The name of the input feature for which noise sigma is provided. The + features are defined in explanation metadata inputs. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix: type: object - description: Represents configuration for private service connect. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTracking: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTracking + id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix + 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: + 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. + items: + items: + type: any + type: array + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassification: description: >- - A TrainingJob that trains and uploads an AutoML Video ObjectTracking + A TrainingJob that trains and uploads an AutoML Video Classification Model. + type: object properties: inputs: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs description: The input parameters of this TrainingJob. - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation: id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation - 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. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassification + GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse: properties: - columnName: + nextPageToken: + description: >- + A token to retrieve the next page of results. Pass to + ListHyperparameterTuningJobsRequest.page_token to obtain that page. type: string - GoogleCloudAiplatformV1CancelPipelineJobRequest: + 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/GoogleCloudAiplatformV1HyperparameterTuningJob + description: Response message for JobService.ListHyperparameterTuningJobs + id: GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse type: object - properties: {} - id: GoogleCloudAiplatformV1CancelPipelineJobRequest - description: Request message for PipelineService.CancelPipelineJob. - GoogleCloudAiplatformV1SchemaTextDataItem: - description: Payload of Text DataItem. + GoogleCloudAiplatformV1ListIndexEndpointsResponse: + description: Response message for IndexEndpointService.ListIndexEndpoints. type: object properties: - gcsUri: + nextPageToken: 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 - GoogleCloudAiplatformV1CancelTuningJobRequest: - properties: {} - type: object - description: Request message for GenAiTuningService.CancelTuningJob. - id: GoogleCloudAiplatformV1CancelTuningJobRequest - GoogleCloudAiplatformV1MutateDeployedIndexOperationMetadata: - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - deployedIndexId: - description: The unique index id specified by user - type: string - type: object - description: >- - Runtime operation information for - IndexEndpointService.MutateDeployedIndex. - id: GoogleCloudAiplatformV1MutateDeployedIndexOperationMetadata - GoogleCloudAiplatformV1SyncFeatureViewRequest: - id: GoogleCloudAiplatformV1SyncFeatureViewRequest - type: object - properties: {} - description: Request message for FeatureOnlineStoreAdminService.SyncFeatureView. - GoogleCloudAiplatformV1WriteTensorboardRunDataResponse: - description: Response message for TensorboardService.WriteTensorboardRunData. - id: GoogleCloudAiplatformV1WriteTensorboardRunDataResponse + A token to retrieve next page of results. Pass to + ListIndexEndpointsRequest.page_token to obtain that page. + indexEndpoints: + description: List of IndexEndpoints in the requested page. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' + type: array + id: GoogleCloudAiplatformV1ListIndexEndpointsResponse + GoogleCloudAiplatformV1SchemaModelevaluationMetricsGeneralTextGenerationEvaluationMetrics: type: object - properties: {} - GoogleCloudAiplatformV1ReadFeatureValuesRequest: - description: Request message for FeaturestoreOnlineServingService.ReadFeatureValues. - id: GoogleCloudAiplatformV1ReadFeatureValuesRequest + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsGeneralTextGenerationEvaluationMetrics properties: - entityId: + bleu: + type: number 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`. + BLEU (bilingual evaluation understudy) scores based on sacrebleu + implementation. + format: float + rougeLSum: + description: ROUGE-L (Longest Common Subsequence) scoring at summary level. + format: float + type: number + GoogleCloudAiplatformV1FileData: + id: GoogleCloudAiplatformV1FileData + properties: + fileUri: + description: Required. URI. type: string - featureSelector: - description: Required. Selector choosing Features of the target EntityType. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' + mimeType: + description: Required. The IANA standard MIME type of the source data. + type: string + description: URI based data. type: object - GoogleCloudAiplatformV1ListFeaturestoresResponse: - description: Response message for FeaturestoreService.ListFeaturestores. + GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig: + description: The config for Featurestore Monitoring threshold. + id: GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig type: object properties: - nextPageToken: + value: + type: number + format: double 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. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' - type: array - id: GoogleCloudAiplatformV1ListFeaturestoresResponse - GoogleTypeDate: - type: object + 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. + GoogleCloudAiplatformV1Feature: 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 + Feature Metadata information. For example, color is a feature that + describes an apple. properties: - day: + disableMonitoring: 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 - year: - format: int32 + 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. + type: boolean + description: + type: string + description: Description of the Feature. + etag: description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - type: integer - month: + Used to perform a consistent read-modify-write updates. If not set, + a blind "overwrite" update happens. + type: string + name: + 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 - 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: - allowTokens: - type: array - items: - type: string - description: Optional. The allowed tokens. - denyTokens: - items: + 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. + 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: + format: google-datetime + readOnly: true + type: string + description: >- + Output only. Only applicable for Vertex AI Feature Store (Legacy). + Timestamp when this EntityType was most recently updated. + pointOfContact: + type: string + description: >- + Entity responsible for maintaining this feature. Can be comma + separated list of email addresses or URIs. + labels: + 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 - description: Optional. The denied tokens. - type: array - name: + type: object + createTime: + description: >- + Output only. Only applicable for Vertex AI Feature Store (Legacy). + Timestamp when this EntityType was created. + readOnly: true + format: google-datetime type: string - description: Required. Column names in BigQuery that used as filters. - GoogleCloudAiplatformV1ModelSourceInfo: - properties: - sourceType: + monitoringStatsAnomalies: + description: >- + Output only. Only applicable for Vertex AI Feature Store (Legacy). + The list of historical stats and anomalies with specified + objectives. + type: array + readOnly: true + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly + valueType: type: string - description: Type of the model source. 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 - copy: - type: boolean + - 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: >- - 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. + 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 type: object - id: GoogleCloudAiplatformV1ModelSourceInfo - GoogleCloudAiplatformV1ListTuningJobsResponse: + id: GoogleCloudAiplatformV1Feature + GoogleCloudAiplatformV1ListCustomJobsResponse: + id: GoogleCloudAiplatformV1ListCustomJobsResponse + description: Response message for JobService.ListCustomJobs type: object properties: + customJobs: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' + type: array + description: List of CustomJobs in the requested page. nextPageToken: + type: string description: >- A token to retrieve the next page of results. Pass to - ListTuningJobsRequest.page_token to obtain that page. - type: string - tuningJobs: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' - description: List of TuningJobs in the requested page. - id: GoogleCloudAiplatformV1ListTuningJobsResponse - description: Response message for GenAiTuningService.ListTuningJobs - GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity: + ListCustomJobsRequest.page_token to obtain that page. + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfig: + type: object + id: GoogleCloudAiplatformV1ModelMonitoringObjectiveConfig + properties: + explanationConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfig + description: The config for integrating with Vertex Explainable AI. + trainingPredictionSkewDetectionConfig: + description: The config for skew between training data and prediction data. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig + predictionDriftDetectionConfig: + description: The config for drift of prediction data. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig + trainingDataset: + description: >- + Training dataset for models. This field has to be set only if + TrainingPredictionSkewDetectionConfig is specified. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset 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. + The objective configuration for model monitoring, including the + information needed to detect anomalies for one particular model. + GoogleCloudAiplatformV1MigrateResourceRequest: + id: GoogleCloudAiplatformV1MigrateResourceRequest type: object - id: GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity + description: >- + Config of migrating one resource from automl.googleapis.com, + datalabeling.googleapis.com and ml.googleapis.com to Vertex AI. properties: - entityIdSelector: + migrateAutomlModelConfig: description: >- - Required. Selectors choosing feature values of which entity id to be - deleted from the EntityType. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityIdSelector' - GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus: - description: A single record of the task status. + Config for migrating Model in automl.googleapis.com to Vertex AI's + Model. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig + migrateAutomlDatasetConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig + description: >- + Config for migrating Dataset in automl.googleapis.com to Vertex AI's + Dataset. + migrateMlEngineModelVersionConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig + description: >- + Config for migrating Version in ml.googleapis.com to Vertex AI's + Model. + migrateDataLabelingDatasetConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig + description: >- + Config for migrating Dataset in datalabeling.googleapis.com to + Vertex AI's Dataset. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation: type: object properties: - state: - readOnly: true - enum: - - STATE_UNSPECIFIED - - PENDING - - RUNNING - - SUCCEEDED - - CANCEL_PENDING - - CANCELLING - - CANCELLED - - FAILED - - SKIPPED - - NOT_TRIGGERED - description: Output only. The state of the task. + columnName: type: string - 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. - error: + 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. + GoogleCloudAiplatformV1PipelineJobRuntimeConfig: + type: object + properties: + parameters: + deprecated: 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. - readOnly: true - $ref: '#/components/schemas/GoogleRpcStatus' - updateTime: + 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 + failurePolicy: type: string - format: google-datetime - readOnly: true - description: Output only. Update time of this status. - id: GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus - GoogleCloudAiplatformV1SchemaPredictionResultError: - id: GoogleCloudAiplatformV1SchemaPredictionResultError - properties: - status: + 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: - - 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 + - PIPELINE_FAILURE_POLICY_UNSPECIFIED + - PIPELINE_FAILURE_POLICY_FAIL_SLOW + - PIPELINE_FAILURE_POLICY_FAIL_FAST 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 + - Default value, and follows fail slow behavior. - >- - 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 + Indicates that the pipeline should continue to run until all + possible tasks have been scheduled and completed. - >- - Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal - Server Error - type: string + Indicates that the pipeline should stop scheduling new tasks after + a task has failed. + parameterValues: description: >- - Error status. This will be serialized into the enum name e.g. - "NOT_FOUND". - message: + 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. + additionalProperties: + type: any + 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: Error message with additional details. - type: object - GoogleCloudAiplatformV1PurgeArtifactsResponse: - id: GoogleCloudAiplatformV1PurgeArtifactsResponse - description: Response message for MetadataService.PurgeArtifacts. + 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 + description: The runtime config of a PipelineJob. + id: GoogleCloudAiplatformV1PipelineJobRuntimeConfig + GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature: properties: - purgeSample: - items: - type: string + impactedFeatureCount: + type: string + format: int64 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: array - purgeCount: + The count of the features or columns impacted. This is the same as + the feature count in the request. + onlineStorageModifiedEntityCount: 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. + 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. + type: string + format: int64 + offlineStorageModifiedEntityRowCount: format: int64 + 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. type: string + id: >- + GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature + description: >- + Response message if the request uses the SelectTimeRangeAndFeature + option. type: object - GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig: - description: The config for email alert. - id: GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig + GoogleCloudAiplatformV1GenerateContentRequest: + type: object + id: GoogleCloudAiplatformV1GenerateContentRequest properties: - userEmails: + toolConfig: + description: >- + Optional. Tool config. This config is shared for all tools provided + in the request. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolConfig' + generationConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenerationConfig' + description: Optional. Generation config. + tools: type: array - description: The email addresses to send the alert. + 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: - type: string - type: object - GoogleIamV1Policy: - properties: - bindings: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tool' + contents: items: - $ref: '#/components/schemas/GoogleIamV1Binding' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' 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`. - etag: - format: byte - 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. - version: - 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). - type: integer - 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 - GoogleCloudAiplatformV1PipelineTaskDetailArtifactList: - id: GoogleCloudAiplatformV1PipelineTaskDetailArtifactList - properties: - artifacts: - type: array - description: Output only. A list of artifact metadata. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' - readOnly: true - description: A list of artifact metadata. - type: object - GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecRange: - type: object - id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecRange - description: A range of values for slice(s). `low` is inclusive, `high` is exclusive. - properties: - low: - type: number - format: float - description: Inclusive low value for the range. - high: - type: number - description: Exclusive high value for the range. - format: float - GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse: - type: object - properties: - modelDeploymentMonitoringJobs: + 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. + safetySettings: type: array + description: >- + Optional. Per request settings for blocking unsafe content. Enforced + on GenerateContentResponse.candidates. items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob + $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetySetting' + systemInstruction: description: >- - A list of ModelDeploymentMonitoringJobs that matches the specified - filter in the request. - nextPageToken: - description: The standard List next-page token. - type: string - description: Response message for JobService.ListModelDeploymentMonitoringJobs. - id: GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse - GoogleCloudAiplatformV1Schedule: - id: GoogleCloudAiplatformV1Schedule - description: >- - An instance of a Schedule periodically schedules runs to make API calls - based on user specified time specification and API request type. + 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' + description: Request message for [PredictionService.GenerateContent]. + GoogleCloudAiplatformV1ModelEvaluationSlice: type: object + 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: - lastPauseTime: - type: string + metrics: + readOnly: true + type: any description: >- - Output only. Timestamp when this Schedule was last paused. Unset if - never paused. + Output only. Sliced evaluation metrics of the Model. The schema of + the metrics is stored in metrics_schema_uri + createTime: format: google-datetime + description: Output only. Timestamp when this ModelEvaluationSlice was created. + type: string readOnly: true - lastResumeTime: + metricsSchemaUri: type: string description: >- - Output only. Timestamp when this Schedule was last resumed. Unset if - never resumed from pause. + 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). readOnly: true - format: google-datetime - displayName: - 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. + name: + readOnly: true + description: Output only. The resource name of the ModelEvaluationSlice. type: string - lastScheduledRunResponse: + slice: 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. + Output only. The slice of the test data that is used to evaluate the + Model. readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1ScheduleRunResponse' - allowQueueing: - type: boolean + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSlice + modelExplanation: 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. - nextRunTime: - format: google-datetime + 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 + GoogleCloudAiplatformV1GcsSource: + description: The Google Cloud Storage location for the input content. + type: object + id: GoogleCloudAiplatformV1GcsSource + properties: + uris: + type: array + items: + type: string 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 - startedRunCount: - readOnly: true - format: int64 - type: string - description: Output only. The number of runs started by this schedule. - maxConcurrentRunCount: - format: int64 + 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. + GoogleCloudAiplatformV1NfsMount: + properties: + path: 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). - createPipelineJobRequest: + 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: >- - Request for PipelineService.CreatePipelineJob. - CreatePipelineJobRequest.parent field is required (format: - projects/{project}/locations/{location}). - $ref: '#/components/schemas/GoogleCloudAiplatformV1CreatePipelineJobRequest' - createTime: + Required. Destination mount path. The NFS will be mounted for the + user under /mnt/nfs/ type: string - format: google-datetime - description: Output only. Timestamp when this Schedule was created. - readOnly: true - state: - enum: - - STATE_UNSPECIFIED - - ACTIVE - - PAUSED - - COMPLETED + server: type: string - description: Output only. The state of this Schedule. - readOnly: true - 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. - catchUp: + description: Required. IP address of the NFS server. + type: object + description: Represents a mount configuration for Network File System (NFS) to mount. + id: GoogleCloudAiplatformV1NfsMount + GoogleCloudAiplatformV1NasJobOutput: + id: GoogleCloudAiplatformV1NasJobOutput + type: object + properties: + multiTrialJobOutput: 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: - format: int64 - 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. - type: string - cron: - 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 * * - * *". - updateTime: - readOnly: true - format: google-datetime - type: string - description: Output only. Timestamp when this Schedule was updated. - startTime: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput description: >- - Optional. Timestamp after which the first run can be scheduled. - Default to Schedule create time if not specified. - format: google-datetime - type: string - endTime: + Output only. The output of this multi-trial Neural Architecture + Search (NAS) job. + description: Represents a uCAIP NasJob output. + GoogleCloudAiplatformV1ListNasTrialDetailsResponse: + properties: + nextPageToken: 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 - name: + A token to retrieve the next page of results. Pass to + ListNasTrialDetailsRequest.page_token to obtain that page. type: string - description: Immutable. The resource name of the Schedule. - GoogleCloudAiplatformV1DeleteOperationMetadata: - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The common part of the operation metadata. - id: GoogleCloudAiplatformV1DeleteOperationMetadata + nasTrialDetails: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrialDetail' + type: array + description: List of top NasTrials in the requested page. + description: Response message for JobService.ListNasTrialDetails + id: GoogleCloudAiplatformV1ListNasTrialDetailsResponse type: object - description: Details of operations that perform deletes of any entities. - GoogleCloudAiplatformV1FunctionResponse: - id: GoogleCloudAiplatformV1FunctionResponse + GoogleCloudAiplatformV1TimeSeriesData: 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. properties: - name: + 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. The name of the function to call. Matches - [FunctionDeclaration.name] and [FunctionCall.name]. - response: - additionalProperties: - type: any - description: Properties of the object. - description: Required. The function response in JSON object format. - type: object - GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec: - description: Value specification for a parameter in `INTEGER` type. - id: GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec - type: object - properties: - maxValue: + Required. Immutable. The value type of this time series. All the + values in this time series data must match this value type. + tensorboardTimeSeriesId: + description: >- + Required. The ID of the TensorboardTimeSeries, which will become the + final component of the TensorboardTimeSeries' resource name type: string - format: int64 - description: Required. Inclusive maximum value of the parameter. - defaultValue: - format: int64 + values: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesDataPoint' + description: Required. Data points in this time series. + id: GoogleCloudAiplatformV1TimeSeriesData + description: All the data stored in a TensorboardTimeSeries. + GoogleCloudAiplatformV1Value: + id: GoogleCloudAiplatformV1Value + properties: + intValue: 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. - minValue: format: int64 + description: An integer value. + doubleValue: + description: A double value. + format: double + type: number + stringValue: type: string - description: Required. Inclusive minimum value of the parameter. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetrics: - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetrics - description: Metrics for text extraction evaluation results. + description: A string value. type: object + description: Value is the value of the field. + GoogleCloudAiplatformV1PipelineTemplateMetadata: + type: object + id: GoogleCloudAiplatformV1PipelineTemplateMetadata properties: - confidenceMetrics: - description: >- - Metrics that have confidence thresholds. Precision-recall curve can - be derived from them. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics - confusionMatrix: + version: + type: string 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 - GoogleCloudAiplatformV1ListContextsResponse: + 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...". + description: >- + Pipeline template metadata if PipelineJob.template_uri is from supported + template registry. Currently, the only supported registry is Artifact + Registry. + GoogleCloudAiplatformV1ListSpecialistPoolsResponse: + type: object properties: nextPageToken: - 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. + description: The standard List next-page token. type: string - contexts: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' - description: The Contexts retrieved from the MetadataStore. + specialistPools: type: array - description: Response message for MetadataService.ListContexts. - type: object - id: GoogleCloudAiplatformV1ListContextsResponse - GoogleCloudAiplatformV1StreamingPredictResponse: - properties: - outputs: - description: The prediction output. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - type: array - parameters: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - description: The parameters that govern the prediction. - id: GoogleCloudAiplatformV1StreamingPredictResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' + description: >- + A list of SpecialistPools that matches the specified filter in the + request. + id: GoogleCloudAiplatformV1ListSpecialistPoolsResponse + description: Response message for SpecialistPoolService.ListSpecialistPools. + GoogleCloudAiplatformV1SchemaPredictPredictionImageSegmentationPredictionResult: type: object - description: Response message for PredictionService.StreamingPredict. - GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport: - id: GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport + description: Prediction output format for Image Segmentation. properties: - endTime: + categoryMask: 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 + 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. type: string - 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. + confidenceMask: type: string - format: google-datetime - description: >- - Describes exporting all historical Feature values of all entities of the - EntityType between [start_time, end_time]. - type: object - GoogleCloudAiplatformV1ImportDataConfig: + 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. + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionImageSegmentationPredictionResult + GoogleCloudAiplatformV1Model: 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. - id: GoogleCloudAiplatformV1ImportDataConfig properties: - importSchemaUri: + dataStats: 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). + 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' + versionUpdateTime: type: string - gcsSource: - description: The Google Cloud Storage location for the input content. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' - annotationLabels: + format: google-datetime + readOnly: true + description: Output only. Timestamp when this version was most recently updated. + versionDescription: + type: string + description: The description of this version. + versionId: 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. + 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. + readOnly: true + type: string + labels: type: object additionalProperties: type: string - 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: + 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. + supportedInputStorageFormats: + type: array + 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 - GoogleCloudAiplatformV1Artifact: - type: object - properties: - displayName: - type: string + readOnly: true + metadata: + type: any description: >- - User provided display name of the Artifact. May be up to 128 Unicode - characters. - schemaVersion: + 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. + modelSourceInfo: 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. + 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' + 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. + displayName: type: string - name: + 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. + pipelineJob: type: string - description: Output only. The resource name of the Artifact. + description: >- + Optional. This field is populated if the model is produced by a + pipeline job. + originalModelInfo: readOnly: true + description: >- + Output only. If this Model is a copy of another Model, this contains + info about the original. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelOriginalModelInfo' + versionAliases: + type: array + 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 description: + description: The description of the Model. type: string - description: Description of the Artifact - updateTime: - description: Output only. Timestamp when this Artifact was last updated. - type: string - format: google-datetime - readOnly: true - uri: + metadataSchemaUri: type: string description: >- - The uniform resource identifier of the artifact file. May be empty - if there is no actual artifact file. - state: - 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. + 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. + predictSchemata: 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. - enum: - - STATE_UNSPECIFIED - - PENDING - - LIVE + 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' etag: type: string description: >- - An eTag used to perform consistent read-modify-write updates. If not - set, a blind "overwrite" update happens. - metadata: + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. + supportedOutputStorageFormats: 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 - type: object - createTime: - type: string - description: Output only. Timestamp when this Artifact was created. + 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 readOnly: true - format: google-datetime - 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. - labels: - additionalProperties: + items: 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). - description: Instance of a general artifact. - id: GoogleCloudAiplatformV1Artifact - GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse: - properties: - monitoringStats: - description: >- - Stats retrieved for requested objectives. There are at most 1000 - ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.prediction_stats - in the response. + deployedModels: items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModelRef' type: array - nextPageToken: - type: string description: >- - The page token that can be used by the next - JobService.SearchModelDeploymentMonitoringStatsAnomalies call. - id: >- - GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse - description: >- - Response message for - JobService.SearchModelDeploymentMonitoringStatsAnomalies. - type: object - GoogleCloudAiplatformV1ListNasJobsResponse: - type: object - id: GoogleCloudAiplatformV1ListNasJobsResponse - properties: - nextPageToken: - type: string + Output only. The pointers to DeployedModels created from this Model. + Note that Model could have been deployed to Endpoints in different + Locations. + readOnly: true + containerSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelContainerSpec' description: >- - A token to retrieve the next page of results. Pass to - ListNasJobsRequest.page_token to obtain that page. - nasJobs: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' + 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: >- - List of NasJobs in the requested page. NasJob.nas_job_output of the - jobs will not be returned. - description: Response message for JobService.ListNasJobs - GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry: - type: object - properties: - scaledPinballLoss: - description: The scaled pinball loss of this quantile. - type: number - format: float - quantile: - format: double - description: The quantile for this entry. - type: number - observedQuantile: + 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' + updateTime: + format: google-datetime + description: Output only. Timestamp when this Model was most recently updated. + type: string + readOnly: true + artifactUri: + 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. - type: number - format: double - description: Entry for the Quantiles loss type optimization objective. - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry - GoogleCloudAiplatformV1IndexDatapointCrowdingTag: - 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. - properties: - crowdingAttribute: + Immutable. The path to the directory containing the Model artifact + and any of its supporting files. Not required for AutoML Models. + versionCreateTime: + readOnly: true + format: google-datetime type: string + description: Output only. Timestamp when this version was created. + supportedExportFormats: + readOnly: true 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: object - id: GoogleCloudAiplatformV1IndexDatapointCrowdingTag - GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup: - id: GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup - type: object - 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 + Output only. The formats in which this Model may be exported. If + empty, this Model is not available for export. items: - type: string - featureGroupId: - type: string - description: Required. Identifier of the feature group. - GoogleCloudAiplatformV1MigratableResourceAutomlModel: - type: object - properties: - modelDisplayName: - description: The Model's display name in automl.googleapis.com. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelExportFormat' + type: array + name: type: string - model: + description: The resource name of the Model. + explanationSpec: description: >- - Full resource name of automl Model. Format: - `projects/{project}/locations/{location}/models/{model}`. + 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' + trainingPipeline: + readOnly: true type: string - description: Represents one Model in automl.googleapis.com. - id: GoogleCloudAiplatformV1MigratableResourceAutomlModel - GoogleCloudAiplatformV1GenerationConfig: - id: GoogleCloudAiplatformV1GenerationConfig - description: Generation config. - properties: - presencePenalty: - description: Optional. Positive penalties. - type: number - format: float - frequencyPenalty: - type: number - description: Optional. Frequency penalties. - format: float - maxOutputTokens: description: >- - Optional. The maximum number of output tokens to generate per - message. - format: int32 - type: integer - topP: - format: float - description: Optional. If specified, nucleus sampling will be used. - type: number - responseSchema: + Output only. The resource name of the TrainingPipeline that uploaded + this Model, if any. + createTime: + format: google-datetime + type: string + readOnly: true + description: Output only. Timestamp when this Model was uploaded into Vertex AI. + supportedDeploymentResourcesTypes: + readOnly: true 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' - topK: - format: float - type: number - description: Optional. If specified, top-k sampling will be used. - stopSequences: - description: Optional. Stop sequences. + 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. type: array 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 - candidateCount: - type: integer - description: Optional. Number of candidates to generate. - format: int32 - responseMimeType: - type: string + metadataArtifact: 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. - temperature: - format: float - description: Optional. Controls the randomness of predictions. - type: number + 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 + readOnly: true + description: A trained machine learning Model. + id: GoogleCloudAiplatformV1Model + GoogleCloudAiplatformV1UpdateFeatureOnlineStoreOperationMetadata: type: object - GoogleCloudAiplatformV1TrialContext: - description: 'Next ID: 3' properties: - description: - type: string - description: >- - A human-readable field which can store a description of this - context. This will become part of the resulting Trial's description - field. - parameters: - 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 - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrialParameter' - id: GoogleCloudAiplatformV1TrialContext + genericMetadata: + description: Operation metadata for FeatureOnlineStore. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + id: GoogleCloudAiplatformV1UpdateFeatureOnlineStoreOperationMetadata + description: Details of operations that perform update FeatureOnlineStore. + GoogleCloudAiplatformV1UpdateExplanationDatasetRequest: + id: GoogleCloudAiplatformV1UpdateExplanationDatasetRequest type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs: + description: Request message for ModelService.UpdateExplanationDataset. + properties: + examples: + description: The example config containing the location of the dataset. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Examples' + GoogleCloudAiplatformV1MigratableResource: + id: GoogleCloudAiplatformV1MigratableResource + description: >- + Represents one resource that exists in automl.googleapis.com, + datalabeling.googleapis.com or ml.googleapis.com. type: object properties: - 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. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation - holidayRegions: - type: array - items: - type: string - 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. - contextWindow: - format: int64 - 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. - 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. - timeColumn: - description: >- - The name of the column that identifies time order in the time - series. This column must be available at forecast. - type: string - timeSeriesAttributeColumns: - 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. - type: array - trainBudgetMilliNodeHours: - format: int64 - 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. - dataGranularity: + mlEngineModelVersion: + description: Output only. Represents one Version in ml.googleapis.com. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity - description: Expected difference in time granularity between rows in the data. - additionalExperiments: - description: Additional experiment flags for the time series forcasting training. - type: array - items: - type: string - windowConfig: - description: Config containing strategy for generating sliding windows. + #/components/schemas/GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion + readOnly: true + automlDataset: + description: Output only. Represents one Dataset in automl.googleapis.com. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig - hierarchyConfig: - description: >- - Configuration that defines the hierarchical relationship of time - series and parameters for hierarchical forecasting strategies. + #/components/schemas/GoogleCloudAiplatformV1MigratableResourceAutomlDataset + readOnly: true + dataLabelingDataset: + description: Output only. Represents one Dataset in datalabeling.googleapis.com. + readOnly: true $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig - exportEvaluatedDataItemsConfig: + #/components/schemas/GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset + automlModel: + description: Output only. Represents one Model in automl.googleapis.com. + readOnly: true $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig + #/components/schemas/GoogleCloudAiplatformV1MigratableResourceAutomlModel + lastUpdateTime: + type: string + format: google-datetime description: >- - Configuration for exporting test set predictions to a BigQuery - table. If this configuration is absent, then the export is not - performed. - unavailableAtForecastColumns: + Output only. Timestamp when this MigratableResource was last + updated. + readOnly: true + lastMigrateTime: + 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. + 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 + GoogleCloudAiplatformV1Trial: + id: GoogleCloudAiplatformV1Trial + type: object + properties: + parameters: + description: Output only. The parameters of the Trial. + readOnly: true type: array items: - type: string - optimizationObjective: - 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. + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrialParameter' + state: + 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. type: string - targetColumn: - description: >- - The name of the column that the Model is to predict values for. This - column must be unavailable at forecast. + description: Output only. The detailed state of the Trial. + readOnly: true + enum: + - STATE_UNSPECIFIED + - REQUESTED + - ACTIVE + - STOPPING + - SUCCEEDED + - INFEASIBLE + startTime: type: string - availableAtForecastColumns: + format: google-datetime + description: Output only. Time when the Trial was started. + readOnly: true + infeasibleReason: + type: string + description: >- + Output only. A human readable string describing why the Trial is + infeasible. This is set only if Trial state is `INFEASIBLE`. + readOnly: true + measurements: 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. + 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' + readOnly: true + 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. + type: object + additionalProperties: type: string - validationOptions: + readOnly: true + customJob: 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 - weightColumn: + Output only. The CustomJob name linked to the Trial. It's set for a + HyperparameterTuningJob's Trial. + readOnly: true + endTime: + format: google-datetime 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. This column must be available at forecast. - forecastHorizon: + Output only. Time when the Trial's status changed to `SUCCEEDED` or + `INFEASIBLE`. + readOnly: true + id: + description: Output only. The identifier of the Trial assigned by the service. + readOnly: true type: string - format: int64 + finalMeasurement: + readOnly: true + description: Output only. The final measurement containing the objective value. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' + clientId: 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. - timeSeriesIdentifierColumn: - description: The name of the column that identifies the time series. - type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs - GoogleCloudAiplatformV1ListExecutionsResponse: - type: object - description: Response message for MetadataService.ListExecutions. - properties: - executions: - type: array - description: The Executions retrieved from the MetadataStore. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' - nextPageToken: + 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 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 - GoogleCloudAiplatformV1ModelMonitoringAlertConfig: - id: GoogleCloudAiplatformV1ModelMonitoringAlertConfig - description: The alert config for model monitoring. + name: + description: Output only. Resource name of the Trial assigned by the service. + type: string + readOnly: true + 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. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs: type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs properties: - enableLogging: - type: boolean + budgetMilliNodeHours: + type: string + format: int64 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. - notificationChannels: + 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. + disableEarlyStopping: description: >- - Resource names of the NotificationChannels to send alert. Must be of - the format `projects//notificationChannels/` - type: array - items: - type: string - emailAlertConfig: - description: Email alert config. + 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: + description: Trainer type for Vision TrainRequest. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig - GoogleCloudAiplatformV1ExportFilterSplit: - 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 - properties: - trainingFilter: + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter + uptrainBaseModelId: 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. + 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 - testFilter: + 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 + 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 - 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. - validationFilter: + GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion: + properties: + endpoint: 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. + 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: >- + Full resource name of ml engine model Version. Format: + `projects/{project}/models/{model}/versions/{version}`. + type: string type: object - GoogleCloudAiplatformV1SchemaVisualInspectionClassificationLabelSavedQueryMetadata: - properties: - multiLabel: - type: boolean - description: Whether or not the classification label is multi_label. - id: >- - GoogleCloudAiplatformV1SchemaVisualInspectionClassificationLabelSavedQueryMetadata + description: Represents one model Version in ml.googleapis.com. + id: GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion + GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus: + id: GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus type: object - GoogleCloudAiplatformV1SupervisedTuningDataStats: - description: Tuning data statistics for Supervised Tuning. + description: A single record of the task status. properties: - tuningDatasetExampleCount: - description: Output only. Number of examples in the tuning dataset. + updateTime: + format: google-datetime readOnly: true type: string - format: int64 - userDatasetExamples: - type: array - description: Output only. Sample user messages in the training dataset uri. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' - readOnly: true - userOutputTokenDistribution: - description: Output only. Dataset distributions for the user output tokens. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution - readOnly: true - userInputTokenDistribution: + description: Output only. Update time of this status. + error: readOnly: true - description: Output only. Dataset distributions for the user input tokens. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution - totalBillableCharacterCount: - description: Output only. Number of billable characters in the tuning dataset. + $ref: '#/components/schemas/GoogleRpcStatus' + 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: + enum: + - STATE_UNSPECIFIED + - PENDING + - RUNNING + - SUCCEEDED + - CANCEL_PENDING + - CANCELLING + - CANCELLED + - FAILED + - SKIPPED + - NOT_TRIGGERED readOnly: true - format: int64 + 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 - totalTuningCharacterCount: + GoogleCloudAiplatformV1ImportFeatureValuesOperationMetadata: + description: Details of operations that perform import Feature values. + id: GoogleCloudAiplatformV1ImportFeatureValuesOperationMetadata + properties: + timestampOutsideRetentionRowsCount: + description: >- + The number rows that weren't ingested due to having timestamps + outside the retention boundary. format: int64 type: string - description: Output only. Number of tuning characters in the tuning dataset. - readOnly: true - userMessagePerExampleDistribution: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution - description: Output only. Dataset distributions for the messages per example. - readOnly: true - tuningStepCount: + importedFeatureValueCount: format: int64 - readOnly: true - description: Output only. Number of tuning steps for this Tuning Job. type: string - type: object - id: GoogleCloudAiplatformV1SupervisedTuningDataStats - GoogleCloudAiplatformV1WriteFeatureValuesResponse: - id: GoogleCloudAiplatformV1WriteFeatureValuesResponse - type: object - description: >- - Response message for - FeaturestoreOnlineServingService.WriteFeatureValues. - properties: {} - GoogleCloudAiplatformV1ListFeatureGroupsResponse: - properties: - nextPageToken: + description: Number of Feature values that have been imported by the operation. + importedEntityCount: + description: Number of entities that have been imported by the operation. + type: string + format: int64 + invalidRowCount: type: string + format: int64 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: + 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). + sourceUris: type: array - description: The FeatureGroups matching the request. + description: The source URI from where Feature values are imported. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' - description: Response message for FeatureRegistryService.ListFeatureGroups. - id: GoogleCloudAiplatformV1ListFeatureGroupsResponse - type: object - GoogleCloudAiplatformV1EvaluatedAnnotationExplanation: - id: GoogleCloudAiplatformV1EvaluatedAnnotationExplanation - properties: - explanation: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Explanation' - description: Explanation attribution response details. - explanationType: - type: string + type: string + genericMetadata: + description: Operation metadata for Featurestore import Feature values. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + blockingOperationIds: + items: + format: int64 + type: string + type: array description: >- - Explanation type. For AutoML Image Classification models, possible - values are: * `image-integrated-gradients` * `image-xrai` - description: Explanation result of the prediction produced by the Model. - type: object - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset: + List of ImportFeatureValues operations running under a single + EntityType that are blocking this operation. type: object + GoogleCloudAiplatformV1PscAutomatedEndpoints: properties: - gcsSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' - description: >- - The Google Cloud Storage uri of the unmanaged Dataset used to train - this Model. - bigquerySource: - description: >- - The BigQuery table of the unmanaged Dataset used to train this - Model. - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' - targetField: + network: + description: Corresponding network in pscAutomationConfigs. 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. - dataFormat: + matchAddress: 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. - dataset: - description: The resource name of the Dataset used to train this Model. + description: Ip Address created by the automated forwarding rule. + projectId: type: string - loggingSamplingStrategy: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SamplingStrategy' - description: >- - Strategy to sample data from Training Dataset. If not set, we - process the whole dataset. - description: Training Dataset information. - id: GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset - GoogleCloudAiplatformV1Trial: - id: 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. + description: Corresponding project_id in pscAutomationConfigs type: object + description: >- + PscAutomatedEndpoints defines the output of the forwarding rule + automatically created by each PscAutomationConfig. + id: GoogleCloudAiplatformV1PscAutomatedEndpoints + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs properties: - state: - readOnly: true + modelType: enum: - - STATE_UNSPECIFIED - - REQUESTED - - ACTIVE - - STOPPING - - SUCCEEDED - - INFEASIBLE - description: Output only. The detailed state of the Trial. + - MODEL_TYPE_UNSPECIFIED + - CLOUD + - MOBILE_VERSATILE_1 + - MOBILE_JETSON_VERSATILE_1 type: string enumDescriptions: - - The Trial state is unspecified. + - Should not be set. - >- - 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. + A model best tailored to be used within Google Cloud, and which + cannot be exported. Default. - >- - 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. - infeasibleReason: - type: string + 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: object + GoogleCloudAiplatformV1TunedModel: + description: >- + The Model Registry Model and Online Prediction Endpoint assiociated with + this TuningJob. + properties: + model: readOnly: true description: >- - Output only. A human readable string describing why the Trial is - infeasible. This is set only if Trial state is `INFEASIBLE`. - startTime: + Output only. The resource name of the TunedModel. Format: + `projects/{project}/locations/{location}/models/{model}`. + type: string + endpoint: + description: >- + Output only. A resource name of an Endpoint. Format: + `projects/{project}/locations/{location}/endpoints/{endpoint}`. + type: string readOnly: true + type: object + id: GoogleCloudAiplatformV1TunedModel + 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: + updateTime: format: google-datetime - description: Output only. Time when the Trial was started. type: string - id: - description: Output only. The identifier of the Trial assigned by the service. readOnly: true - type: string - measurements: + description: Output only. Timestamp when this Schedule was updated. + lastPauseTime: readOnly: true + format: google-datetime 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' - type: array - clientId: - readOnly: true + Output only. Timestamp when this Schedule was last paused. Unset if + never paused. + type: string + maxRunCount: + format: int64 + type: string 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. + 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. + startedRunCount: + format: int64 + description: Output only. The number of runs started by this schedule. type: string - finalMeasurement: - description: Output only. The final measurement containing the objective value. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' - readOnly: true - endTime: readOnly: true - description: >- - Output only. Time when the Trial's status changed to `SUCCEEDED` or - `INFEASIBLE`. + createTime: type: string + description: Output only. Timestamp when this Schedule was created. format: google-datetime - customJob: readOnly: true + catchUp: description: >- - Output only. The CustomJob name linked to the Trial. It's set for a - HyperparameterTuningJob's Trial. - type: string - name: - description: Output only. Resource name of the Trial assigned by the service. - type: string + 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 - parameters: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrialParameter' + nextRunTime: readOnly: true - description: Output only. The parameters of the Trial. - webAccessUris: + type: string + 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. + format: google-datetime + name: + description: Immutable. The resource name of the Schedule. + type: string + lastScheduledRunResponse: + 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. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ScheduleRunResponse' readOnly: true - additionalProperties: - type: string - type: object + createPipelineJobRequest: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CreatePipelineJobRequest' 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. - GoogleCloudAiplatformV1ListCustomJobsResponse: - properties: - customJobs: - description: List of CustomJobs in the requested page. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' - type: array - nextPageToken: + Request for PipelineService.CreatePipelineJob. + CreatePipelineJobRequest.parent field is required (format: + projects/{project}/locations/{location}). + lastResumeTime: + format: google-datetime description: >- - A token to retrieve the next page of results. Pass to - ListCustomJobsRequest.page_token to obtain that page. - type: string - type: object - id: GoogleCloudAiplatformV1ListCustomJobsResponse - description: Response message for JobService.ListCustomJobs - GoogleCloudAiplatformV1ImportFeatureValuesResponse: - type: object - id: GoogleCloudAiplatformV1ImportFeatureValuesResponse - description: Response message for FeaturestoreService.ImportFeatureValues. - properties: - importedFeatureValueCount: - description: Number of Feature values that have been imported by the operation. + Output only. Timestamp when this Schedule was last resumed. Unset if + never resumed from pause. + readOnly: true type: string - format: int64 - invalidRowCount: + displayName: + 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. type: string + allowQueueing: + type: boolean 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 - timestampOutsideRetentionRowsCount: + 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. + startTime: + format: google-datetime description: >- - The number rows that weren't ingested due to having feature - timestamps outside the retention boundary. - format: int64 + Optional. Timestamp after which the first run can be scheduled. + Default to Schedule create time if not specified. type: string - importedEntityCount: + state: + description: Output only. The state of this Schedule. type: string - description: Number of entities that have been imported by the operation. - format: int64 - GoogleCloudAiplatformV1ListFeaturesResponse: - description: >- - Response message for FeaturestoreService.ListFeatures. Response message - for FeatureRegistryService.ListFeatures. - id: GoogleCloudAiplatformV1ListFeaturesResponse - type: object - properties: - features: - description: The Features matching the request. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' - type: array - nextPageToken: - 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. + 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 + enum: + - STATE_UNSPECIFIED + - ACTIVE + - PAUSED + - COMPLETED + endTime: + format: google-datetime type: string - 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 - properties: - timeoutSeconds: 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'. - type: integer - format: int32 - exec: - description: ExecAction probes the health of a container by executing a command. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ProbeExecAction' - periodSeconds: + 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. + cron: + type: string 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 - type: integer - type: object - GoogleCloudAiplatformV1UpdateSpecialistPoolOperationMetadata: - id: GoogleCloudAiplatformV1UpdateSpecialistPoolOperationMetadata - properties: - genericMetadata: - description: The operation generic information. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - specialistPool: - readOnly: true + 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 * * + * *". + maxConcurrentRunCount: type: string + format: int64 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}` - description: >- - Runtime operation metadata for - SpecialistPoolService.UpdateSpecialistPool. - type: object - GoogleCloudAiplatformV1ExamplesOverride: - description: Overrides for example-based explanations. + 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: object - id: GoogleCloudAiplatformV1ExamplesOverride + id: GoogleCloudAiplatformV1Schedule + GoogleCloudAiplatformV1SchemaVideoDatasetMetadata: properties: - restrictions: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExamplesRestrictionsNamespace + gcsBucket: description: >- - Restrict the resulting nearest neighbors to respect these - constraints. - type: array - crowdingCount: - description: The number of neighbors to return that have the same crowding tag. - type: integer - format: int32 - dataFormat: - description: The format of the data being provided with each call. - enum: - - DATA_FORMAT_UNSPECIFIED - - INSTANCES - - EMBEDDINGS - type: string - enumDescriptions: - - Unspecified format. Must not be used. - - Provided data is a set of model inputs. - - Provided data is a set of embeddings. - returnEmbeddings: - type: boolean - description: If true, return the embeddings instead of neighbors. - neighborCount: - type: integer - format: int32 - description: The number of neighbors to return. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs - properties: - forecastHorizon: - format: int64 + Google Cloud Storage Bucket name that contains the blob data of this + Dataset. 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. - validationOptions: + dataItemSchemaUri: 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 - additionalExperiments: + 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 + description: The metadata of Datasets that contain Video DataItems. + GoogleCloudAiplatformV1NearestNeighborQueryStringFilter: + id: 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. + properties: + allowTokens: + description: Optional. The allowed tokens. type: array - description: Additional experiment flags for the time series forcasting training. items: 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 - 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. - windowConfig: - description: Config containing strategy for generating sliding windows. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig - hierarchyConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig - description: >- - Configuration that defines the hierarchical relationship of time - series and parameters for hierarchical forecasting strategies. - timeSeriesIdentifierColumn: - type: string - description: The name of the column that identifies the time series. - trainBudgetMilliNodeHours: - 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 - holidayRegions: + denyTokens: items: type: string - 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 - transformations: + description: Optional. The denied tokens. + name: + type: string + description: Required. Column names in BigQuery that used as filters. + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig: + type: object + properties: + groupColumns: items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation - type: array + type: string 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. - exportEvaluatedDataItemsConfig: + 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: + format: double 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 - timeSeriesAttributeColumns: + The weight of the loss for predictions aggregated over time series + in the same group. + type: number + temporalTotalWeight: + format: double + type: number 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 - timeColumn: + The weight of the loss for predictions aggregated over the horizon + for a single time series. + groupTemporalTotalWeight: + type: number + format: double description: >- - The name of the column that identifies time order in the time - series. This column must be available at forecast. + The weight of the loss for predictions aggregated over both the + horizon and time series in the same hierarchy group. + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig + description: >- + Configuration that defines the hierarchical relationship of time series + and parameters for hierarchical forecasting strategies. + GoogleCloudAiplatformV1GenieSource: + description: >- + Contains information about the source of the models generated from + Generative AI Studio. + type: object + properties: + baseModelUri: + description: Required. The public base model URI. type: string - weightColumn: + id: GoogleCloudAiplatformV1GenieSource + GoogleCloudAiplatformV1IndexDatapointRestriction: + description: >- + Restriction of a datapoint which describe its attributes(tokens) from + each of several attribute categories(namespaces). + properties: + namespace: + description: 'The namespace of this restriction. e.g.: color.' 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. - dataGranularity: - description: Expected difference in time granularity between rows in the data. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity - unavailableAtForecastColumns: + allowList: type: array + description: 'The attributes to allow in this namespace. e.g.: ''red''' 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. - quantiles: - type: array - 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. - enableProbabilisticInference: - 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 - 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. + denyList: + description: 'The attributes to deny in this namespace. e.g.: ''blue''' items: type: string type: array - contextWindow: + id: GoogleCloudAiplatformV1IndexDatapointRestriction + type: object + GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec: + type: object + description: Value specification for a parameter in `INTEGER` type. + id: GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec + properties: + minValue: + description: Required. Inclusive minimum value of the parameter. + type: string + format: int64 + maxValue: + description: Required. Inclusive maximum value of the parameter. type: string format: int64 + defaultValue: 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: object - GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse: + 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 + format: int64 + GoogleCloudAiplatformV1NearestNeighbors: + id: GoogleCloudAiplatformV1NearestNeighbors properties: - tensorboardTimeSeries: - description: The TensorboardTimeSeries mathching the request. + neighbors: + description: All its neighbors. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborsNeighbor type: array - nextPageToken: - 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. - type: string - description: Response message for TensorboardService.ListTensorboardTimeSeries. type: object - id: GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse - CloudAiLargeModelsVisionNamedBoundingBox: + description: Nearest neighbors for one query. + GoogleCloudAiplatformV1DoubleArray: type: object - id: CloudAiLargeModelsVisionNamedBoundingBox properties: - y2: - type: number - format: float - scores: + values: + description: A list of double values. items: + format: double type: number - format: float - type: array - y1: - format: float - type: number - entities: type: array - items: - type: string - x1: - type: number - format: float - x2: - type: number - format: float - classes: - items: - type: string - type: array - GoogleCloudAiplatformV1CancelCustomJobRequest: - id: GoogleCloudAiplatformV1CancelCustomJobRequest - properties: {} - type: object - description: Request message for JobService.CancelCustomJob. - GoogleCloudAiplatformV1ResourceRuntime: - id: GoogleCloudAiplatformV1ResourceRuntime + description: A list of double values. + id: GoogleCloudAiplatformV1DoubleArray + GoogleCloudAiplatformV1SchemaPredictInstanceImageSegmentationPredictionInstance: properties: - accessUris: - readOnly: true - additionalProperties: - type: string + content: + description: The image bytes to make the predictions on. + type: string + mimeType: + 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" } - type: object - description: Persistent Cluster runtime information as output + The MIME type of the content of the image. Only the images in below + listed MIME types are supported. - image/jpeg - image/png + description: Prediction input format for Image Segmentation. + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceImageSegmentationPredictionInstance type: object - GoogleCloudAiplatformV1StudySpecStudyStoppingConfig: + GoogleCloudAiplatformV1ManualBatchTuningParameters: properties: - maxNumTrialsNoProgress: - format: int32 - 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 - maxDurationNoProgress: - type: string - format: google-duration - description: >- - If the objective value has not improved for this much time, stop the - study. WARNING: Effective only for single-objective studies. - maxNumTrials: - description: If there are more than this many trials, stop the study. + batchSize: type: integer - format: int32 - 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. - minNumTrials: + 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. format: int32 - description: >- - If there are fewer than this many COMPLETED trials, do not stop the - study. - type: integer - maximumRuntimeConstraint: - description: If the specified time or duration has passed, stop the study. - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudyTimeConstraint' - shouldStopAsap: - 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 - description: >- - The configuration (stopping conditions) for automated stopping of a - Study. Conditions include trial budgets, time budgets, and convergence - detection. - type: object - id: GoogleCloudAiplatformV1StudySpecStudyStoppingConfig - GoogleCloudAiplatformV1PredefinedSplit: - id: GoogleCloudAiplatformV1PredefinedSplit + description: Manual batch tuning parameters. type: object - properties: - key: - 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: GoogleCloudAiplatformV1ManualBatchTuningParameters + GoogleCloudAiplatformV1SpecialistPool: description: >- - Assigns input data to training, validation, and test sets based on the - value of a provided key. Supported only for tabular Datasets. - GoogleCloudAiplatformV1SearchMigratableResourcesRequest: - description: Request message for MigrationService.SearchMigratableResources. + 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. properties: - pageSize: - description: The standard page size. The default and maximum value is 100. + name: + type: string + description: Required. The resource name of the SpecialistPool. + specialistManagersCount: + readOnly: true type: integer format: int32 - filter: - type: string + description: Output only. The number of managers in this SpecialistPool. + specialistManagerEmails: + description: The email addresses of the managers in the SpecialistPool. + items: + type: string + type: array + displayName: 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. - pageToken: - description: The standard page token. + 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 - id: GoogleCloudAiplatformV1SearchMigratableResourcesRequest + specialistWorkerEmails: + description: The email addresses of workers in the SpecialistPool. + type: array + items: + type: string + pendingDataLabelingJobs: + readOnly: true + items: + type: string + type: array + description: Output only. The resource name of the pending data labeling jobs. + id: GoogleCloudAiplatformV1SpecialistPool type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecasting: - description: A TrainingJob that trains and uploads an AutoML Forecasting Model. + GoogleCloudAiplatformV1DirectPredictRequest: + description: Request message for PredictionService.DirectPredict. + properties: + inputs: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + type: array + description: The prediction input. + parameters: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + description: The parameters that govern the prediction. type: object + id: GoogleCloudAiplatformV1DirectPredictRequest + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentiment: properties: - metadata: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata - description: The metadata information. inputs: - description: The input parameters of this TrainingJob. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecasting - GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse: - description: Response message for MetadataService.AddContextArtifactsAndExecutions. + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs + description: The input parameters of this TrainingJob. + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentiment + type: object + description: A TrainingJob that trains and uploads an AutoML Text Sentiment Model. + GoogleCloudAiplatformV1RemoveContextChildrenRequest: + id: GoogleCloudAiplatformV1RemoveContextChildrenRequest + properties: + childContexts: + items: + type: string + description: The resource names of the child Contexts. + type: array + type: object + description: Request message for MetadataService.DeleteContextChildrenRequest. + GoogleCloudAiplatformV1UpdateFeatureViewOperationMetadata: + type: object + properties: + genericMetadata: + description: Operation metadata for FeatureView Update. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Details of operations that perform update FeatureView. + id: GoogleCloudAiplatformV1UpdateFeatureViewOperationMetadata + GoogleCloudAiplatformV1UndeployIndexResponse: type: object + description: Response message for IndexEndpointService.UndeployIndex. properties: {} - id: GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline: + id: GoogleCloudAiplatformV1UndeployIndexResponse + GoogleCloudAiplatformV1SuggestTrialsMetadata: type: object + id: GoogleCloudAiplatformV1SuggestTrialsMetadata properties: - bigquery: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' - description: BigQuery location for BatchExplain output. - predictionFormat: - enumDescriptions: - - Should not be set. - - Predictions are in JSONL files. - - Predictions are in BigQuery. - enum: - - PREDICTION_FORMAT_UNSPECIFIED - - JSONL - - BIGQUERY + genericMetadata: + description: Operation metadata for suggesting Trials. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + clientId: type: string - description: The storage format of the predictions generated BatchPrediction job. - gcs: - description: Cloud Storage location for BatchExplain output. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' - id: >- - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline - description: >- - Output from BatchPredictionJob for Model Monitoring baseline dataset, - which can be used to generate baseline attribution scores. - GoogleCloudAiplatformV1UndeployIndexRequest: - id: GoogleCloudAiplatformV1UndeployIndexRequest - properties: - deployedIndexId: description: >- - Required. The ID of the DeployedIndex to be undeployed from the - IndexEndpoint. - type: string - description: Request message for IndexEndpointService.UndeployIndex. - type: object - GoogleCloudAiplatformV1Citation: - id: GoogleCloudAiplatformV1Citation + 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. + description: Details of operations that perform Trials suggestion. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation: properties: - startIndex: - readOnly: true - description: Output only. Start index into the content. - format: int32 - type: integer - uri: - type: string - description: Output only. Url reference of the attribution. - readOnly: true - endIndex: - format: int32 - type: integer - readOnly: true - description: Output only. End index into the content. - title: - readOnly: true + 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 - description: Output only. Title of the attribution. - publicationDate: - $ref: '#/components/schemas/GoogleTypeDate' - readOnly: true - description: Output only. Publication date of the attribution. - license: - description: Output only. License of the attribution. - readOnly: true + columnName: type: string - description: Source attributions for content. + 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 type: object - GoogleCloudAiplatformV1ContainerRegistryDestination: + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation: + type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation properties: - outputUri: + columnName: 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. - type: object - id: GoogleCloudAiplatformV1ContainerRegistryDestination - description: The Container Registry location for the container image. - GoogleCloudAiplatformV1DatasetDistribution: - id: GoogleCloudAiplatformV1DatasetDistribution - description: Distribution computed over a tuning dataset. + 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. + GoogleCloudAiplatformV1RayMetricSpec: type: object + id: GoogleCloudAiplatformV1RayMetricSpec + description: Configuration for the Ray metrics. properties: - p5: - type: number - description: Output only. The 5th percentile of the values in the population. - readOnly: true - format: double - max: - description: Output only. The maximum of the population values. - format: double - type: number - readOnly: true - buckets: - readOnly: true + disabled: + description: Optional. Flag to disable the Ray metrics collection. + type: boolean + GoogleCloudAiplatformV1BatchMigrateResourcesResponse: + properties: + migrateResourceResponses: items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DatasetDistributionDistributionBucket + #/components/schemas/GoogleCloudAiplatformV1MigrateResourceResponse type: array - description: Output only. Defines the histogram bucket. - median: - description: Output only. The median of the values in the population. - type: number - readOnly: true - format: double - sum: - type: number - readOnly: true - description: Output only. Sum of a given population of values. - format: double - p95: - type: number - format: double - description: Output only. The 95th percentile of the values in the population. - readOnly: true - mean: - type: number - format: double - readOnly: true - description: Output only. The arithmetic mean of the values in the population. - min: - format: double - readOnly: true - type: number - description: Output only. The minimum of the population values. - GoogleCloudAiplatformV1PurgeExecutionsMetadata: - id: GoogleCloudAiplatformV1PurgeExecutionsMetadata - description: Details of operations that perform MetadataService.PurgeExecutions. - properties: - genericMetadata: - description: Operation metadata for purging Executions. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Successfully migrated resources. + id: GoogleCloudAiplatformV1BatchMigrateResourcesResponse + description: Response message for MigrationService.BatchMigrateResources. type: object - GoogleCloudAiplatformV1FetchFeatureValuesRequest: + GoogleCloudAiplatformV1ImportDataRequest: + description: Request message for DatasetService.ImportData. + id: GoogleCloudAiplatformV1ImportDataRequest type: object - id: GoogleCloudAiplatformV1FetchFeatureValuesRequest - description: >- - Request message for FeatureOnlineStoreService.FetchFeatureValues. All - the features under the requested feature view will be returned. properties: - dataFormat: - type: string - enumDescriptions: - - Not set. Will be treated as the KeyValue format. - - Return response data in key-value format. - - Return response data in proto Struct format. + importConfigs: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ImportDataConfig' description: >- - Optional. Response data format. If not set, - FeatureViewDataFormat.KEY_VALUE will be used. - enum: - - FEATURE_VIEW_DATA_FORMAT_UNSPECIFIED - - KEY_VALUE - - PROTO_STRUCT - dataKey: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewDataKey' - description: Optional. The request key to fetch feature values for. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig: + Required. The desired input locations. The contents of all input + locations will be imported in one batch. + type: array + GoogleCloudAiplatformV1EvaluatedAnnotation: + type: object description: >- - Configuration that defines the hierarchical relationship of time series - and parameters for hierarchical forecasting strategies. + True positive, false positive, or false negative. EvaluatedAnnotation is + only available under ModelEvaluationSlice with slice of `annotationSpec` + dimension. properties: - groupTemporalTotalWeight: - description: >- - The weight of the loss for predictions aggregated over both the - horizon and time series in the same hierarchy group. - type: number - format: double - temporalTotalWeight: - format: double + type: + enum: + - EVALUATED_ANNOTATION_TYPE_UNSPECIFIED + - TRUE_POSITIVE + - FALSE_POSITIVE + - FALSE_NEGATIVE + 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. + description: Output only. Type of the EvaluatedAnnotation. + type: string + readOnly: true + dataItemPayload: description: >- - The weight of the loss for predictions aggregated over the horizon - for a single time series. - type: number - groupColumns: + Output only. The data item payload that the Model predicted this + EvaluatedAnnotation on. + type: any + readOnly: true + evaluatedDataItemViewId: 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. + Output only. ID of the EvaluatedDataItemView under the same ancestor + ModelEvaluation. The EvaluatedDataItemView consists of all ground + truths and predictions on data_item_payload. + type: string + readOnly: true + predictions: + readOnly: true type: array - items: - type: string - groupTotalWeight: - type: number description: >- - The weight of the loss for predictions aggregated over time series - in the same group. - format: double - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation - type: object - properties: - timestamp: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation - repeatedCategorical: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation - numeric: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation - auto: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation - repeatedText: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation - repeatedNumeric: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation - categorical: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation - text: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation - GoogleCloudAiplatformV1CsvSource: - description: The storage details for CSV input content. - properties: - gcsSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' - description: Required. Google Cloud Storage location. - id: GoogleCloudAiplatformV1CsvSource + 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 + 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. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1EvaluatedAnnotationExplanation + type: array + groundTruths: + 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 + readOnly: true + type: array + errorAnalysisAnnotations: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ErrorAnalysisAnnotation + description: Annotations of model error analysis results. + type: array + id: GoogleCloudAiplatformV1EvaluatedAnnotation + GoogleCloudAiplatformV1IntegratedGradientsAttribution: + id: GoogleCloudAiplatformV1IntegratedGradientsAttribution type: object - GoogleCloudAiplatformV1FeatureViewIndexConfig: - description: Configuration for vector indexing. + 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: - 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 - treeAhConfig: + smoothGradConfig: 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 - embeddingDimension: + 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: type: integer - format: int32 - description: Optional. The number of dimensions of the input embedding. - 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 - 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: - enum: - - DISTANCE_MEASURE_TYPE_UNSPECIFIED - - SQUARED_L2_DISTANCE - - COSINE_DISTANCE - - DOT_PRODUCT_DISTANCE - 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. - description: Optional. The distance measure used in nearest neighbor search. - filterColumns: - items: - type: string + 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 + blurBaselineConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BlurBaselineConfig' description: >- - Optional. Columns of features that're used to filter vector search - results. - type: array + 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 + GoogleCloudAiplatformV1ContainerSpec: type: object - id: GoogleCloudAiplatformV1FeatureViewIndexConfig - GoogleCloudAiplatformV1SchemaPredictPredictionImageObjectDetectionPredictionResult: - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionImageObjectDetectionPredictionResult - description: Prediction output format for Image Object Detection. properties: - bboxes: - type: array - items: - type: array - items: - type: any - 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: + env: type: array - description: >- - The Model's confidences in correctness of the predicted IDs, higher - value means higher confidence. Order matches the Ids. items: - type: number - format: float - displayNames: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EnvVar' description: >- - The display names of the AnnotationSpecs that had been identified, - order matches the IDs. + Environment variables to be passed to the container. Maximum limit + is 100. + command: type: array items: type: string - ids: description: >- - The resource IDs of the AnnotationSpecs that had been identified, - ordered by the confidence score descendingly. - type: array + 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 - format: int64 + type: array + imageUri: + type: string + description: >- + Required. The URI of a container image in the Container Registry + that is to be run on each worker replica. + id: GoogleCloudAiplatformV1ContainerSpec + description: The spec of a Container. + GoogleCloudAiplatformV1DeployModelResponse: + description: Response message for EndpointService.DeployModel. type: object - GoogleCloudAiplatformV1CreateMetadataStoreOperationMetadata: + id: GoogleCloudAiplatformV1DeployModelResponse properties: - genericMetadata: - description: Operation metadata for creating a MetadataStore. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + deployedModel: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' + description: The DeployedModel that had been deployed in the Endpoint. + GoogleCloudAiplatformV1StartNotebookRuntimeRequest: + properties: {} + description: Request message for NotebookService.StartNotebookRuntime. type: object - id: GoogleCloudAiplatformV1CreateMetadataStoreOperationMetadata - description: Details of operations that perform MetadataService.CreateMetadataStore. - GoogleCloudAiplatformV1FetchFeatureValuesResponse: + id: GoogleCloudAiplatformV1StartNotebookRuntimeRequest + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomTask: + description: A TrainingJob that trains a custom code Model. properties: - keyValues: - description: Feature values in KeyValue format. + metadata: + description: The metadata information. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList - dataKey: - description: >- - The data key associated with this response. Will only be populated - for FeatureOnlineStoreService.StreamingFetchFeatureValues RPCs. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewDataKey' - protoStruct: - description: Feature values in proto Struct format. - additionalProperties: - type: any - description: Properties of the object. - type: object + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata + inputs: + description: The input parameters of this CustomTask. + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomTask type: object - id: GoogleCloudAiplatformV1FetchFeatureValuesResponse - description: Response message for FeatureOnlineStoreService.FetchFeatureValues - GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest: - id: GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest + GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader: + id: GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader + properties: + featureDescriptors: + description: >- + List of Feature metadata corresponding to each piece of + ReadFeatureValuesResponse.EntityView.data. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor + type: array + entityType: + description: >- + The resource name of the EntityType from the + ReadFeatureValuesRequest. Value format: + `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. + type: string type: object - description: Request message for NotebookService.UpgradeNotebookRuntime. - properties: {} - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity: + description: >- + Response header with metadata for the requested + ReadFeatureValuesRequest.entity_type and Features. + GoogleCloudAiplatformV1ResourcePool: type: object - description: A duration of time expressed in time granularity units. + id: GoogleCloudAiplatformV1ResourcePool + description: >- + Represents the spec of a group of resources of the same type, for + example machine type, disk, and accelerators, in a PersistentResource. properties: - quantity: - type: string - format: int64 + replicaCount: 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: + Optional. The total number of machines to use for this resource + pool. type: string + format: int64 + autoscalingSpec: + description: Optional. Optional spec to configure GKE autoscaling + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec + diskSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DiskSpec' + description: Optional. Disk spec for the machine in this node pool. + usedReplicaCount: description: >- - The time granularity unit of this time period. The supported units - are: * "minute" * "hour" * "day" * "week" * "month" * "year" - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity - CloudAiPlatformCommonCreatePipelineJobApiErrorDetail: - properties: - publicMessage: - description: Public messages contains actionable items for the error cause. + Output only. The number of machines currently in use by training + jobs for this resource pool. Will replace idle_replica_count. type: string - errorCause: - 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. + readOnly: true + format: int64 + machineSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' + description: Required. Immutable. The specification of a single machine. + id: type: string - 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: 'Create API error message for Vertex Pipeline. Next Id: 3.' + 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. + GoogleCloudAiplatformV1CreateTensorboardOperationMetadata: + description: Details of operations that perform create Tensorboard. + id: GoogleCloudAiplatformV1CreateTensorboardOperationMetadata type: object - id: CloudAiPlatformCommonCreatePipelineJobApiErrorDetail - GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest: - properties: {} + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for Tensorboard. + 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. type: object - description: Request message for VizierService.CheckTrialEarlyStoppingState. - id: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest - GoogleCloudAiplatformV1SchemaImageDatasetMetadata: + properties: + xMin: + format: float + type: number + description: The leftmost coordinate of the bounding box. + yMax: + format: float + type: number + description: The bottommost coordinate of the bounding box. + xMax: + type: number + description: The rightmost coordinate of the bounding box. + format: float + yMin: + type: number + description: The topmost coordinate of the bounding box. + format: float + 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 + format: google-duration + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame + GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation: + description: The mask based segmentation annotation. type: object properties: - gcsBucket: + annotationSpecColors: + description: The mapping between color and AnnotationSpec for this Annotation. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaAnnotationSpecColor + type: array + maskGcsUri: type: string description: >- - Google Cloud Storage Bucket name that contains the blob data of this - Dataset. - dataItemSchemaUri: + 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. + id: GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation: + properties: + columnName: + type: string + timeFormat: description: >- - Points to a YAML file stored on Google Cloud Storage describing - payload of the Image DataItems that belong to this Dataset. + 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 - id: GoogleCloudAiplatformV1SchemaImageDatasetMetadata - description: The metadata of Datasets that contain Image DataItems. - 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. + 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: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation + type: object + 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 type: object properties: - initialBatchSamplePercentage: - format: int32 - description: The percentage of data needed to be labeled in the first batch. - type: integer - followingBatchSamplePercentage: - type: integer - format: int32 + useElapsedDuration: + type: boolean description: >- - The percentage of data needed to be labeled in each following batch - (except the first batch). - sampleStrategy: - enum: - - SAMPLE_STRATEGY_UNSPECIFIED - - UNCERTAINTY - enumDescriptions: - - Default will be treated as UNCERTAINTY. - - Sample the most uncertain data to label. + 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. + GoogleCloudAiplatformV1FeatureViewSync: + id: GoogleCloudAiplatformV1FeatureViewSync + properties: + name: description: >- - Field to choose sampling strategy. Sampling strategy will decide - which data should be selected for human labeling in every batch. + Identifier. Name of the FeatureViewSync. Format: + `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}` type: string - id: GoogleCloudAiplatformV1SampleConfig - GoogleCloudAiplatformV1FeaturestoreMonitoringConfigSnapshotAnalysis: - properties: - disabled: - 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. - type: boolean - monitoringIntervalDays: - type: integer - description: >- - Configuration of the snapshot analysis based monitoring pipeline - running interval. The value indicates number of days. - format: int32 - stalenessDays: - type: integer - format: int32 + syncSummary: + description: Output only. Summary of the sync job. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewSyncSyncSummary + readOnly: true + runTime: + $ref: '#/components/schemas/GoogleTypeInterval' + description: Output only. Time when this FeatureViewSync is finished. + readOnly: true + createTime: + type: string + format: google-datetime 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 - id: GoogleCloudAiplatformV1FeaturestoreMonitoringConfigSnapshotAnalysis + 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 + finalStatus: + description: Output only. Final status of the FeatureViewSync. + $ref: '#/components/schemas/GoogleRpcStatus' + readOnly: true 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. - GoogleCloudAiplatformV1Endpoint: + FeatureViewSync is a representation of sync operation which copies data + from data source to Feature View in Online Store. type: object + GoogleCloudAiplatformV1SchemaTextDataItem: + description: Payload of Text DataItem. properties: - privateServiceConnectConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PrivateServiceConnectConfig + gcsUri: description: >- - Optional. Configuration for private service connect. network and - private_service_connect_config are mutually exclusive. - etag: + 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: string - description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. - labels: - type: object - additionalProperties: - type: string - 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. - updateTime: readOnly: true + type: object + id: GoogleCloudAiplatformV1SchemaTextDataItem + GoogleCloudAiplatformV1CustomJobSpec: + description: Represents the spec of a CustomJob. + properties: + experiment: + description: >- + Optional. The Experiment associated with this job. Format: + `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}` type: string - format: google-datetime - description: Output only. Timestamp when this Endpoint was last updated. - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + reservedIpRanges: + items: + type: string + type: array 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. - displayName: + 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']. + experimentRun: 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 - name: - description: Output only. The resource name of the Endpoint. + Optional. The Experiment Run associated with this job. Format: + `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}` type: string - readOnly: true - deployedModels: - readOnly: true + models: + items: + type: string description: >- - Output only. The models deployed in this Endpoint. To add or remove - DeployedModels use EndpointService.DeployModel and - EndpointService.UndeployModel respectively. + 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. type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' - predictRequestResponseLoggingConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig - description: Configures the request-response logging for online prediction. - enablePrivateServiceConnect: - deprecated: true + baseOutputDirectory: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + 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/` + enableDashboardAccess: 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. - network: + 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). + workerPoolSpecs: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1WorkerPoolSpec' + type: array 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. + 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. + serviceAccount: type: string - description: + 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. + persistentResourceId: + 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. type: string - description: The description of the Endpoint. - trafficSplit: - type: object + network: 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. - additionalProperties: - type: integer - format: int32 - modelDeploymentMonitoringJob: + 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: 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}` - createTime: + 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 + tensorboard: + 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}` type: string - description: Output only. Timestamp when this Endpoint was created. - format: google-datetime - readOnly: true - id: GoogleCloudAiplatformV1Endpoint + scheduling: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Scheduling' + description: Scheduling options for a CustomJob. + enableWebAccess: + type: boolean + 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). + id: GoogleCloudAiplatformV1CustomJobSpec + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation + type: object description: >- - Models are deployed into it, and afterwards Endpoint is called to obtain - predictions and explanations. - GoogleCloudAiplatformV1HyperparameterTuningJob: + 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: - trialJobSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' + columnName: + type: string + GoogleCloudAiplatformV1FunctionCall: + type: object + properties: + args: + additionalProperties: + description: Properties of the object. + type: any description: >- - Required. The spec of a trial job. The same spec applies to the - CustomJobs created in all the trials. - startTime: - format: google-datetime + Optional. Required. The function parameters and values in JSON + object format. See [FunctionDeclaration.parameters] for parameter + details. + type: object + name: description: >- - Output only. Time when the HyperparameterTuningJob for the first - time entered the `JOB_STATE_RUNNING` state. - readOnly: true + Required. The name of the function to call. Matches + [FunctionDeclaration.name]. type: string - updateTime: - format: google-datetime - readOnly: true + id: 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. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs + properties: {} + type: object + GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset: + type: object + properties: + dataset: description: >- - Output only. Time when the HyperparameterTuningJob was most recently - updated. + Full resource name of data labeling Dataset. Format: + `projects/{project}/datasets/{dataset}`. type: string - name: - readOnly: true + datasetDisplayName: + description: The Dataset's display name in datalabeling.googleapis.com. type: string - description: Output only. Resource name of the HyperparameterTuningJob. - maxTrialCount: - format: int32 - type: integer - description: Required. The desired total number of Trials. - error: - readOnly: true - description: >- - Output only. Only populated when job's state is JOB_STATE_FAILED or - JOB_STATE_CANCELLED. - $ref: '#/components/schemas/GoogleRpcStatus' - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + dataLabelingAnnotatedDatasets: + type: array 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. - parallelTrialCount: - description: Required. The desired number of Trials to run in parallel. - type: integer - format: int32 - createTime: - description: Output only. Time when the HyperparameterTuningJob was created. - format: google-datetime - readOnly: true - type: string - labels: - type: object + The migratable AnnotatedDataset in datalabeling.googleapis.com + belongs to the data labeling Dataset. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset + id: GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset + description: Represents one Dataset in datalabeling.googleapis.com. + GoogleCloudAiplatformV1SchemaVideoObjectTrackingAnnotation: + id: GoogleCloudAiplatformV1SchemaVideoObjectTrackingAnnotation + properties: + yMin: + description: The topmost coordinate of the bounding box. + type: number + format: double + instanceId: 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. - additionalProperties: - type: string - displayName: + The instance of the object, expressed as a positive integer. Used to + track the same object across different frames. + format: int64 type: string + yMax: + type: number + description: The bottommost coordinate of the bounding box. + format: double + annotationSpecId: 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. - state: - 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. - 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. + The resource Id of the AnnotationSpec that this Annotation pertains + to. type: string - trials: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' - readOnly: true - description: Output only. Trials of the HyperparameterTuningJob. - type: array - endTime: + timeOffset: 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 - format: google-datetime - maxFailedTrialCount: + A time (frame) of a video to which this annotation pertains. + Represented as the duration since the video's start. + format: google-duration + xMax: + description: The rightmost coordinate of the bounding box. + format: double + type: number + displayName: 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 - studySpec: - description: Required. Study configuration of the HyperparameterTuningJob. - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' - id: GoogleCloudAiplatformV1HyperparameterTuningJob - description: >- - Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a - Study specification and multiple CustomJobs with identical CustomJob - specification. + 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 + description: Annotation details specific to video object tracking. + type: object + GoogleCloudAiplatformV1ReadIndexDatapointsRequest: type: object - GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride: - description: The input metadata entries to be overridden. - id: GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride properties: - inputBaselines: + ids: type: array - 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. items: - type: any + type: string + description: IDs of the datapoints to be searched for. + deployedIndexId: + description: The ID of the DeployedIndex that will serve the request. + type: string + id: GoogleCloudAiplatformV1ReadIndexDatapointsRequest + description: The request message for MatchService.ReadIndexDatapoints. + CloudAiLargeModelsVisionMedia: type: object - 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. - id: >- - GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectTimeRangeAndFeature + description: Media. properties: - featureSelector: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' - description: >- - Required. Selectors choosing which feature values to be deleted from - the EntityType. - timeRange: - $ref: '#/components/schemas/GoogleTypeInterval' - description: >- - Required. Select feature generated within a half-inclusive time - range. The time range is lower inclusive and upper exclusive. - skipOnlineStorageDelete: - type: boolean - 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. + video: + $ref: '#/components/schemas/CloudAiLargeModelsVisionVideo' + description: Video + image: + $ref: '#/components/schemas/CloudAiLargeModelsVisionImage' + description: Image. + id: CloudAiLargeModelsVisionMedia + GoogleCloudAiplatformV1DeployIndexOperationMetadata: type: object - GoogleCloudAiplatformV1ScheduleRunResponse: properties: - runResponse: - type: string - description: The response of the scheduled run. - scheduledRunTime: - format: google-datetime - description: The scheduled run time based on the user-specified schedule. + deployedIndexId: + description: The unique index id specified by user type: string - type: object - id: GoogleCloudAiplatformV1ScheduleRunResponse - description: Status of a scheduled run. - GoogleCloudAiplatformV1ModelExplanation: - description: Aggregated explanation metrics for a Model over a set of instances. + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Runtime operation information for IndexEndpointService.DeployIndex. + id: GoogleCloudAiplatformV1DeployIndexOperationMetadata + GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics: + description: Metrics for a single confidence threshold. + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics type: object properties: - meanAttributions: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Attribution' - type: array - readOnly: true + confidenceThreshold: 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. - id: GoogleCloudAiplatformV1ModelExplanation - GoogleCloudAiplatformV1DirectRawPredictResponse: - description: Response message for PredictionService.DirectRawPredict. - properties: - output: - description: The prediction output. - format: byte - type: string - id: GoogleCloudAiplatformV1DirectRawPredictResponse - type: object - GoogleCloudAiplatformV1Dataset: + Output only. The confidence threshold value used to compute the + metrics. + type: number + format: float + f1Score: + format: float + type: number + description: Output only. The harmonic mean of recall and precision. + recall: + type: number + format: float + description: Output only. Recall for the given confidence threshold. + precision: + type: number + description: Output only. Precision for the given confidence threshold. + format: float + GoogleCloudAiplatformV1SyncFeatureViewResponse: type: object + id: GoogleCloudAiplatformV1SyncFeatureViewResponse properties: - metadata: - type: any - description: Required. Additional information about the Dataset. - description: - type: string - description: The description of the Dataset. - name: - readOnly: true - description: Output only. The resource name of the Dataset. + featureViewSync: + description: >- + Format: + `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}` type: string - updateTime: + description: Respose message for FeatureOnlineStoreAdminService.SyncFeatureView. + GoogleCloudAiplatformV1TrainingPipeline: + properties: + state: + 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 readOnly: true - description: Output only. Timestamp when this Dataset was last updated. - format: google-datetime - type: string - dataItemCount: type: string - format: int64 - readOnly: true - description: >- - Output only. The number of DataItems in this Dataset. Only apply for - non-structured Dataset. + 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. createTime: - readOnly: true + description: Output only. Time when the TrainingPipeline was created. type: string - description: Output only. Timestamp when this Dataset was created. format: google-datetime - etag: - description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. - type: string - metadataArtifact: 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}`. - type: string - 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. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SavedQuery' - type: array - metadataSchemaUri: - type: string - 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/. - modelReference: - description: >- - Optional. Reference to the public base model last used by the - dataset. Only set for prompt datasets. + modelId: type: string - displayName: 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. + 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. + name: + description: Output only. Resource name of the TrainingPipeline. type: string + readOnly: true labels: - additionalProperties: - type: string + type: object description: >- - The labels with user-defined metadata to organize your Datasets. + 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. 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. - type: object - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. + additionalProperties: + type: string + parentModel: 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. - id: GoogleCloudAiplatformV1Dataset - description: A collection of DataItems and Annotations on them. - GoogleCloudAiplatformV1PipelineJobRuntimeConfig: - type: object - description: The runtime config of a PipelineJob. - properties: - failurePolicy: + 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 + encryptionSpec: 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: - - 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 + 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. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + endTime: type: string - inputArtifacts: - type: object - 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. - parameterValues: - type: object + Output only. Time when the TrainingPipeline entered any of the + following states: `PIPELINE_STATE_SUCCEEDED`, + `PIPELINE_STATE_FAILED`, `PIPELINE_STATE_CANCELLED`. + readOnly: true + format: google-datetime + updateTime: 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. - additionalProperties: - type: any - parameters: - deprecated: true - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Value' + Output only. Time when the TrainingPipeline was most recently + updated. + format: google-datetime + type: string + readOnly: true + modelToUpload: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' 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 - gcsOutputDirectory: + 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. + error: 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. + Output only. Only populated when the pipeline's state is + `PIPELINE_STATE_FAILED` or `PIPELINE_STATE_CANCELLED`. + readOnly: true + $ref: '#/components/schemas/GoogleRpcStatus' + trainingTaskDefinition: type: string - id: GoogleCloudAiplatformV1PipelineJobRuntimeConfig - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTables: - type: object - properties: - metadata: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata - description: The metadata information. - inputs: - description: The input parameters of this TrainingJob. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTables - description: A TrainingJob that trains and uploads an AutoML Tables Model. - GoogleCloudAiplatformV1ResumeScheduleRequest: - properties: - catchUp: 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: boolean - id: GoogleCloudAiplatformV1ResumeScheduleRequest - description: Request message for ScheduleService.ResumeSchedule. - type: object - GoogleCloudAiplatformV1GcsDestination: - properties: - outputUriPrefix: + 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: >- - 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 - id: GoogleCloudAiplatformV1GcsDestination - description: The Google Cloud Storage location where the output is to be written to. - type: object - GoogleCloudAiplatformV1NotebookEucConfig: - type: object - id: GoogleCloudAiplatformV1NotebookEucConfig - properties: - bypassActasCheck: + 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. + startTime: + format: google-datetime readOnly: true - type: boolean + 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. - eucDisabled: - type: boolean + Output only. Time when the TrainingPipeline for the first time + entered the `PIPELINE_STATE_RUNNING` state. + trainingTaskMetadata: + readOnly: true + type: any 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. - description: The euc configuration of NotebookRuntimeTemplate. - GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse: - description: Response message for TensorboardService.ExportTensorboardTimeSeriesData. - id: GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse - type: object - properties: - timeSeriesDataPoints: - description: The returned time series data points. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesDataPoint' - nextPageToken: + 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. + trainingTaskInputs: 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 - GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef: - properties: - id: - description: ID of the AnnotationSpec. - type: string + Required. The training task's parameter(s), as specified in the + training_task_definition's `inputs`. + type: any displayName: type: string - description: Display name of the AnnotationSpec. + description: Required. The user-defined name of this TrainingPipeline. + 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. type: object - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef - GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest: + GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution: type: object - description: >- - Request message for - FeaturestoreOnlineServingService.StreamingFeatureValuesRead. - id: GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest properties: - featureSelector: - description: >- - Required. Selector choosing Features of the target EntityType. - Feature IDs will be deduplicated. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' - entityIds: - 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`. + max: + type: number + readOnly: true + format: double + description: Output only. The maximum of the population values. + p95: + readOnly: true + description: Output only. The 95th percentile of the values in the population. + type: number + format: double + p5: + readOnly: true + format: double + type: number + description: Output only. The 5th percentile of the values in the population. + mean: + format: double + type: number + readOnly: true + description: Output only. The arithmetic mean of the values in the population. + min: + readOnly: true + type: number + description: Output only. The minimum of the population values. + format: double + buckets: items: - type: string + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket type: array - GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec: + description: Output only. Defines the histogram bucket. + readOnly: true + sum: + type: string + readOnly: true + description: Output only. Sum of a given population of values. + format: int64 + median: + format: double + type: number + description: Output only. The median of the values in the population. + readOnly: true + id: GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution + description: Dataset distribution for Supervised Tuning. + GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError: + type: object + id: GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError properties: - configs: + errorMessage: 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 - id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec - type: object - description: Specification for how the data should be sliced. - GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig: - properties: - datasetDisplayName: - description: >- - Required. Display name of the Dataset in Vertex AI. System will pick - a display name if unspecified. + 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 - dataset: + sourceGcsUri: 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. - type: object - GoogleCloudAiplatformV1SchemaPredictParamsVideoObjectTrackingPredictionParams: + description: Cloud Storage URI pointing to the original file in user's bucket. + errorType: + description: The error type of this record. + type: string + 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 embedding. + 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 + rawRecord: + description: The original content of this record. + type: string + embeddingId: + type: string + description: Empty if the embedding id is failed to parse. + GoogleCloudAiplatformV1FeatureNoiseSigma: properties: - maxPredictions: - type: integer - 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. - confidenceThreshold: - description: >- - The Model only returns predictions with at least this confidence - score. Default value is 0.0 - type: number - format: float - minBoundingBoxSize: - format: float - type: number + noiseSigma: + type: array 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. + Noise sigma per feature. No noise is added to features that are not + set. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature + 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. + id: GoogleCloudAiplatformV1FeatureNoiseSigma type: object - description: Prediction model parameters for Video Object Tracking. - id: >- - GoogleCloudAiplatformV1SchemaPredictParamsVideoObjectTrackingPredictionParams - GoogleCloudAiplatformV1ListNasTrialDetailsResponse: - id: GoogleCloudAiplatformV1ListNasTrialDetailsResponse + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation: properties: - nasTrialDetails: - description: List of top NasTrials in the requested page. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrialDetail' - type: array - nextPageToken: - description: >- - A token to retrieve the next page of results. Pass to - ListNasTrialDetailsRequest.page_token to obtain that page. + columnName: type: string - description: Response message for JobService.ListNasTrialDetails + 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 type: object - GoogleCloudAiplatformV1TimeSeriesDataPoint: + GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint: + id: 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. properties: - wallTime: + publicEndpointDomainName: type: string - format: google-datetime description: >- - Wall clock timestamp when this data point is generated by the end - user. - tensor: - description: A tensor value. - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTensor' - step: - description: Step index of this data point within the run. - type: string - format: int64 - scalar: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Scalar' - description: A scalar value. - blobs: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardBlobSequence' - description: A blob sequence value. - description: A TensorboardTimeSeries data point. - id: GoogleCloudAiplatformV1TimeSeriesDataPoint - GoogleCloudAiplatformV1FeatureStatsAnomaly: + Output only. This field will be populated with the domain name to + use for this FeatureOnlineStore + readOnly: true + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs: type: object - id: GoogleCloudAiplatformV1FeatureStatsAnomaly - 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: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs properties: - score: - format: double - type: number - 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 - 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). - 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. - type: number - format: double - distributionDeviation: - type: number - 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. - format: double - 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). - startTime: - 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). + 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. type: string - format: google-datetime - GoogleCloudAiplatformV1RawPredictRequest: - description: Request message for PredictionService.RawPredict. - id: GoogleCloudAiplatformV1RawPredictRequest - type: object + 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 + GoogleCloudAiplatformV1StreamRawPredictRequest: 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. - $ref: '#/components/schemas/GoogleApiHttpBody' - GoogleCloudAiplatformV1CreateDeploymentResourcePoolOperationMetadata: + payload. + id: GoogleCloudAiplatformV1StreamRawPredictRequest + description: Request message for PredictionService.StreamRawPredict. + type: object + GoogleCloudAiplatformV1DeployModelOperationMetadata: properties: genericMetadata: - description: The operation generic information. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - id: GoogleCloudAiplatformV1CreateDeploymentResourcePoolOperationMetadata - description: Runtime operation information for CreateDeploymentResourcePool method. + description: The operation generic information. + description: Runtime operation information for EndpointService.DeployModel. + id: GoogleCloudAiplatformV1DeployModelOperationMetadata type: object - GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec: + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation + type: object + properties: + numeric: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation + timestamp: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation + auto: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation + repeatedCategorical: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation + repeatedText: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation + categorical: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation + repeatedNumeric: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation + text: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation: 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. + 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 properties: - useElapsedDuration: + columnName: + type: string + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation + GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig: + id: GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig + description: >- + Config for migrating Model in automl.googleapis.com to Vertex AI's + Model. + properties: + model: 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 + Required. Full resource name of automl Model. Format: + `projects/{project}/locations/{location}/models/{model}`. + type: string + modelDisplayName: + type: string + description: >- + Optional. Display name of the model in Vertex AI. System will pick a + display name if unspecified. type: object - GoogleCloudAiplatformV1CopyModelOperationMetadata: - id: GoogleCloudAiplatformV1CopyModelOperationMetadata - description: Details of ModelService.CopyModel operation. + GoogleCloudAiplatformV1DatasetStats: properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The common part of the operation metadata. + totalTuningCharacterCount: + type: string + format: int64 + readOnly: true + description: Output only. Number of tuning characters in the tuning dataset. + totalBillableCharacterCount: + format: int64 + type: string + readOnly: true + description: Output only. Number of billable characters in the tuning dataset. + tuningStepCount: + type: string + format: int64 + description: Output only. Number of tuning steps for this Tuning Job. + readOnly: true + userInputTokenDistribution: + readOnly: true + description: Output only. Dataset distributions for the user input tokens. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetDistribution' + tuningDatasetExampleCount: + format: int64 + description: Output only. Number of examples in the tuning dataset. + readOnly: true + type: string + userMessagePerExampleDistribution: + description: Output only. Dataset distributions for the messages per example. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetDistribution' + readOnly: true + userOutputTokenDistribution: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetDistribution' + description: Output only. Dataset distributions for the user output tokens. + readOnly: true + userDatasetExamples: + type: array + readOnly: true + description: Output only. Sample user messages in the training dataset uri. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' type: object - GoogleCloudAiplatformV1FeatureGroupBigQuery: - id: GoogleCloudAiplatformV1FeatureGroupBigQuery - description: Input source type for BigQuery Tables and Views. + id: GoogleCloudAiplatformV1DatasetStats + description: Statistics computed over a tuning dataset. + GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest: properties: - entityIdColumns: + names: items: type: string + 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}` type: array + type: object + id: GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest + description: Request message for PipelineService.BatchCancelPipelineJobs. + GoogleCloudAiplatformV1FeatureValueDestination: + type: object + id: GoogleCloudAiplatformV1FeatureValueDestination + description: A destination location for Feature values and format. + properties: + tfrecordDestination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TFRecordDestination' description: >- - Optional. Columns to construct entity_id / row keys. If not provided - defaults to `entity_id`. - bigQuerySource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' + 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 + csvDestination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvDestination' description: >- - Required. Immutable. The BigQuery source URI that points to either a - BigQuery Table or View. + Output in CSV format. Array Feature value types are not allowed in + CSV format. + bigqueryDestination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' + description: >- + Output in BigQuery format. BigQueryDestination.output_uri in + FeatureValueDestination.bigquery_destination must refer to a table. + GoogleCloudAiplatformV1CancelTrainingPipelineRequest: type: object - GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest: - description: Request message for TensorboardService.BatchCreateTensorboardRuns. - id: GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest + id: GoogleCloudAiplatformV1CancelTrainingPipelineRequest + description: Request message for PipelineService.CancelTrainingPipeline. + properties: {} + GoogleCloudAiplatformV1PublisherModelResourceReference: properties: - requests: - description: >- - Required. The request message specifying the TensorboardRuns to - create. A maximum of 1000 TensorboardRuns can be created in a batch. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CreateTensorboardRunRequest + useCase: + type: string + deprecated: true + description: Use case (CUJ) of the resource. + resourceName: + type: string + description: The resource name of the Google Cloud resource. + description: + type: string + deprecated: true + description: Description of the resource. + uri: + description: The URI of the resource. + type: string + description: Reference to a resource. + type: object + id: GoogleCloudAiplatformV1PublisherModelResourceReference + GoogleCloudAiplatformV1SchemaPredictPredictionTabularRegressionPredictionResult: + description: Prediction output format for Tabular Regression. type: object - GoogleCloudAiplatformV1SchemaPredictParamsImageSegmentationPredictionParams: id: >- - GoogleCloudAiplatformV1SchemaPredictParamsImageSegmentationPredictionParams + GoogleCloudAiplatformV1SchemaPredictPredictionTabularRegressionPredictionResult 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. + upperBound: + description: The upper bound of the prediction interval. format: float type: number - type: object - description: Prediction model parameters for Image Segmentation. - GoogleCloudAiplatformV1BlurBaselineConfig: - properties: - maxBlurSigma: + lowerBound: type: number + description: The lower bound of the prediction interval. 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. - 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 + quantileValues: + description: Quantile values. + items: + type: number + format: float + type: array + quantilePredictions: + type: array + items: + type: number + format: float + description: Quantile predictions, in 1-1 correspondence with quantile_values. + value: + description: The regression value. + type: number + format: float + GoogleCloudAiplatformV1SchemaPredictionResult: + description: Represents a line of JSONL in the batch prediction output file. + id: GoogleCloudAiplatformV1SchemaPredictionResult type: object - id: GoogleCloudAiplatformV1BlurBaselineConfig - CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox: properties: - y2: - description: The Y coordinate of the bottom-right corner, in pixels. - format: int32 - type: integer - x1: - type: integer - description: The X coordinate of the top-left corner, in pixels. - format: int32 - x2: - format: int32 - description: The X coordinate of the bottom-right corner, in pixels. - type: integer - y1: - format: int32 - type: integer - description: The Y coordinate of the top-left corner, in pixels. - type: object - id: CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox - description: >- - An integer bounding box of original pixels of the image for the detected - labels. - GoogleCloudAiplatformV1UpdateFeatureViewOperationMetadata: + instance: + additionalProperties: + description: Properties of the object. + type: any + type: object + 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. + key: + type: string + description: Optional user-provided key from the input instance. + error: + description: The error result. Do not set prediction if this is set. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaPredictionResultError + 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 + GoogleCloudAiplatformV1CreateTensorboardRunRequest: + description: Request message for TensorboardService.CreateTensorboardRun. type: object - description: Details of operations that perform update FeatureView. + id: GoogleCloudAiplatformV1CreateTensorboardRunRequest + properties: + parent: + type: string + description: >- + 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: >- + 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. + GoogleCloudAiplatformV1PurgeContextsMetadata: properties: genericMetadata: + description: Operation metadata for purging Contexts. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for FeatureView Update. - id: GoogleCloudAiplatformV1UpdateFeatureViewOperationMetadata - GoogleCloudAiplatformV1GenerateContentRequest: - id: GoogleCloudAiplatformV1GenerateContentRequest - description: Request message for [PredictionService.GenerateContent]. + type: object + description: Details of operations that perform MetadataService.PurgeContexts. + id: GoogleCloudAiplatformV1PurgeContextsMetadata + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecasting: + type: object + description: A TrainingJob that trains and uploads an AutoML Forecasting Model. properties: - safetySettings: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetySetting' + inputs: + description: The input parameters of this TrainingJob. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs + metadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata + description: The metadata information. + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecasting + GoogleCloudAiplatformV1InputDataConfig: + type: object + properties: + gcsDestination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' description: >- - Optional. Per request settings for blocking unsafe content. Enforced - on GenerateContentResponse.candidates. - type: array - contents: + 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}" + annotationSchemaUri: 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. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' - type: array - tools: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tool' + 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 + persistMlUseAssignment: + type: boolean + description: Whether to persist the ML use assignment to data item system labels. + savedQueryId: + type: string 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: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + 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. + annotationsFilter: 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. - toolConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolConfig' + 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. + type: string + filterSplit: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FilterSplit' + description: Split based on the provided filters for each set. + fractionSplit: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FractionSplit' + description: Split based on fractions defining the size of each set. + datasetId: + type: string description: >- - Optional. Tool config. This config is shared for all tools provided - in the request. - generationConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenerationConfig' - description: Optional. Generation config. + 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. + timestampSplit: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TimestampSplit' + description: >- + Supported only for tabular Datasets. Split based on the timestamp of + the input data pieces. + predefinedSplit: + description: >- + Supported only for tabular Datasets. Split based on a predefined + key. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredefinedSplit' + stratifiedSplit: + description: >- + Supported only for tabular Datasets. Split based on the distribution + of the specified column. + $ref: '#/components/schemas/GoogleCloudAiplatformV1StratifiedSplit' + 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' + description: >- + Specifies Vertex AI owned input data to be used for training, and + possibly evaluating, the Model. + id: GoogleCloudAiplatformV1InputDataConfig + GoogleCloudAiplatformV1BatchReadFeatureValuesResponse: type: object - GoogleCloudAiplatformV1CreateFeatureOperationMetadata: - description: Details of operations that perform create Feature. + description: Response message for FeaturestoreService.BatchReadFeatureValues. + id: GoogleCloudAiplatformV1BatchReadFeatureValuesResponse + properties: {} + GoogleCloudAiplatformV1PublisherModelCallToAction: + description: Actions could take on this Publisher Model. type: object - id: GoogleCloudAiplatformV1CreateFeatureOperationMetadata properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Feature. + openGenie: + description: Optional. Open Genie / Playground. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + openNotebook: + description: Optional. Open notebook of the PublisherModel. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + requestAccess: + description: Optional. Request for access. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + openEvaluationPipeline: + description: Optional. Open evaluation pipeline of the PublisherModel. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + viewRestApi: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi + description: Optional. To view Rest API docs. + 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. + createApplication: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + description: Optional. Create application using the PublisherModel. + openFineTuningPipeline: + description: Optional. Open fine-tuning pipeline of the PublisherModel. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + deploy: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionDeploy + description: Optional. Deploy the PublisherModel to Vertex Endpoint. + openNotebooks: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks + description: Optional. Open notebooks of the PublisherModel. + openPromptTuningPipeline: + description: Optional. Open prompt-tuning pipeline of the PublisherModel. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + openGenerationAiStudio: + description: Optional. Open in Generation AI Studio. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + fineTune: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + description: >- + Optional. Fine tune the PublisherModel with the third-party model + tuning UI. + id: GoogleCloudAiplatformV1PublisherModelCallToAction GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig: - id: GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig type: object + id: GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig properties: desiredMinSafeTrialsFraction: + type: number + format: double description: >- Desired minimum fraction of safe trials (over total number of trials) that should be targeted by the algorithm at any time during @@ -7380,2574 +7147,3144 @@ components: 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: - type: number 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 description: >- Used in safe optimization to specify threshold levels and risk tolerance. - GoogleCloudAiplatformV1TrialParameter: - properties: - value: - type: any - 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'. - parameterId: - readOnly: true - description: >- - Output only. The ID of the parameter. The parameter should be - defined in StudySpec's Parameters. - type: string + GoogleCloudAiplatformV1DeployedModelRef: + description: Points to a DeployedModel. + id: GoogleCloudAiplatformV1DeployedModelRef type: object - description: A message representing a parameter to be tuned. - id: GoogleCloudAiplatformV1TrialParameter - 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: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PscAutomatedEndpoints' - description: >- - Output only. PscAutomatedEndpoints is populated if private service - connect is enabled if PscAutomatedConfig is set. - readOnly: true - type: array - matchGrpcAddress: + endpoint: + description: Immutable. A resource name of an Endpoint. type: string - description: Output only. The ip address used to send match gRPC requests. - readOnly: true - serviceAttachment: - description: >- - Output only. The name of the service attachment resource. Populated - if private service connect is enabled. - readOnly: true + deployedModelId: + description: Immutable. An ID of a DeployedModel in the above Endpoint. type: string + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecasting: type: object - id: GoogleCloudAiplatformV1IndexPrivateEndpoints - GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScaling: + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecasting properties: - minNodeCount: - description: >- - Required. The minimum number of nodes to scale down to. Must be - greater than or equal to 1. - type: integer - format: int32 - cpuUtilizationTarget: - type: integer - 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. - format: int32 - maxNodeCount: - type: integer - format: int32 - 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: 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 - GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult: - type: object + inputs: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs + description: The input parameters of this TrainingJob. + metadata: + description: The metadata information. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata + description: A TrainingJob that trains and uploads an AutoML Forecasting Model. + GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair: id: >- - GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult + GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair + type: object + description: Feature name & value pair. properties: - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The error result of the migration request in case of failure. - model: - description: Migrated model resource name. - type: string - request: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequest' - description: >- - It's the same as the value in - MigrateResourceRequest.migrate_resource_requests. - dataset: + value: + description: Feature value. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' + name: + description: Feature short name. type: string - description: Migrated dataset resource name. + GoogleCloudAiplatformV1SchemaAnnotationSpecColor: description: >- - Represents a partial result in batch migration operation for one - MigrateResourceRequest. - GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion: - id: GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion + An entry of mapping between color and AnnotationSpec. The mapping is + used in segmentation mask. type: object properties: - version: - type: string + displayName: description: >- - Full resource name of ml engine model Version. Format: - `projects/{project}/models/{model}/versions/{version}`. - endpoint: + The display name of the AnnotationSpec represented by the color in + the segmentation mask. + type: string + color: + description: The color of the AnnotationSpec in a segmentation mask. + $ref: '#/components/schemas/GoogleTypeColor' + id: type: string 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 - description: Represents one model Version in ml.googleapis.com. - 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. + The ID of the AnnotationSpec represented by the color in the + segmentation mask. + id: GoogleCloudAiplatformV1SchemaAnnotationSpecColor + GoogleIamV1Policy: type: object - id: GoogleCloudAiplatformV1Index properties: - indexStats: - description: Output only. Stats of the index resource. - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexStats' - displayName: - type: string - 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. - 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. - metadata: - type: any - description: >- - An additional information about the Index; the schema of the - metadata can be found in metadata_schema. - updateTime: - format: google-datetime + version: + format: int32 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. - readOnly: true - type: string + 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 etag: - description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. - type: string - metadataSchemaUri: + format: byte type: string 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. - createTime: - description: Output only. Timestamp when this Index was created. + `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: + 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/GoogleIamV1Binding' + 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/). + GoogleCloudAiplatformV1StudySpecStudyStoppingConfig: + type: object + description: >- + The configuration (stopping conditions) for automated stopping of a + Study. Conditions include trial budgets, time budgets, and convergence + detection. + id: GoogleCloudAiplatformV1StudySpecStudyStoppingConfig + properties: + maxNumTrials: + type: integer + format: int32 + description: If there are more than this many trials, stop the study. + minNumTrials: + description: >- + If there are fewer than this many COMPLETED trials, do not stop the + study. + type: integer + format: int32 + 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). + maxDurationNoProgress: + 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 type: string + maxNumTrialsNoProgress: + 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 + type: integer + 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' + maximumRuntimeConstraint: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudyTimeConstraint' + description: If the specified time or duration has passed, stop the study. + 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. + distributionDeviation: + type: number + 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. + format: double + startTime: + 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: google-datetime - readOnly: true - name: - readOnly: true type: string - description: Output only. The resource name of the Index. - description: - description: The description of the Index. + statsUri: + 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). + type: string + endTime: type: string - deployedIndexes: - readOnly: true - 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. - indexUpdateMethod: - 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. + 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). + format: google-datetime + 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. + anomalyUri: type: string - 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. - labels: - additionalProperties: - type: string - type: object + 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). + 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. + type: object + id: GoogleCloudAiplatformV1FeatureStatsAnomaly + GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig: + type: object + id: GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig + properties: + scaling: 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. - GoogleCloudAiplatformV1Tensorboard: + 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. + description: >- + OnlineServingConfig specifies the details for provisioning online + serving resources. + GoogleCloudAiplatformV1SchemaPredictInstanceTextSentimentPredictionInstance: + description: Prediction input format for Text Sentiment. + type: object properties: - name: + content: + type: string + description: The text snippet to make the predictions on. + mimeType: + type: string description: >- - Output only. Name of the Tensorboard. Format: - `projects/{project}/locations/{location}/tensorboards/{tensorboard}` + The MIME type of the text snippet. The supported MIME types are + listed below. - text/plain + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceTextSentimentPredictionInstance + GoogleCloudAiplatformV1DeployedIndexRef: + id: GoogleCloudAiplatformV1DeployedIndexRef + properties: + deployedIndexId: + description: Immutable. The ID of the DeployedIndex in the above IndexEndpoint. type: string + displayName: readOnly: true - runCount: - description: Output only. The number of Runs stored in this Tensorboard. + type: string + description: Output only. The display name of the DeployedIndex. + indexEndpoint: + type: string + description: Immutable. A resource name of the IndexEndpoint. + description: Points to a DeployedIndex. + type: object + GoogleCloudAiplatformV1DeployIndexResponse: + properties: + deployedIndex: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' + description: The DeployedIndex that had been deployed in the IndexEndpoint. + id: GoogleCloudAiplatformV1DeployIndexResponse + type: object + description: Response message for IndexEndpointService.DeployIndex. + GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors: + id: GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors + properties: + neighbors: + type: array + description: All its neighbors. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FindNeighborsResponseNeighbor + id: + description: The ID of the query datapoint. + type: string + description: Nearest neighbors for one query. + type: object + GoogleCloudAiplatformV1IndexEndpoint: + id: GoogleCloudAiplatformV1IndexEndpoint + description: >- + Indexes are deployed into it. An IndexEndpoint can have multiple + DeployedIndexes. + properties: + name: readOnly: true - type: integer - format: int32 - description: + description: Output only. The resource name of the IndexEndpoint. type: string - description: Description of this Tensorboard. + 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 + publicEndpointEnabled: + type: boolean + description: >- + Optional. If true, the deployed index will be accessible through + public endpoint. createTime: type: string - description: Output only. Timestamp when this Tensorboard was created. + readOnly: true + description: Output only. Timestamp when this IndexEndpoint was created. + format: google-datetime + updateTime: format: google-datetime + type: string readOnly: true - 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. + 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. + labels: 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. additionalProperties: type: string - blobStoragePathPrefix: - readOnly: true + etag: 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 '/'. + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. type: string + deployedIndexes: + description: Output only. The indexes deployed in this endpoint. + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' displayName: - description: Required. User provided name of this Tensorboard. + 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 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' - isDefault: + 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. + enablePrivateServiceConnect: 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: + 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 + privateServiceConnectConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PrivateServiceConnectConfig description: >- - Used to perform a consistent read-modify-write updates. If not set, - a blind "overwrite" update happens. + Optional. Configuration for private service connect. network and + private_service_connect_config are mutually exclusive. + description: type: string - updateTime: - format: google-datetime - description: Output only. Timestamp when this Tensorboard was last updated. + description: The description of the IndexEndpoint. + 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 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 - readOnly: true - 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. - id: GoogleCloudAiplatformV1Tensorboard type: object - GoogleCloudAiplatformV1SchemaTextDatasetMetadata: + GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse: + id: GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse + description: Response message for TensorboardService.WriteTensorboardExperimentData. + properties: {} + type: object + GoogleCloudAiplatformV1ListOptimalTrialsResponse: + id: GoogleCloudAiplatformV1ListOptimalTrialsResponse properties: - gcsBucket: - type: string - description: >- - Google Cloud Storage Bucket name that contains the blob data of this - Dataset. - dataItemSchemaUri: + optimalTrials: description: >- - Points to a YAML file stored on Google Cloud Storage describing - payload of the Text DataItems that belong to this Dataset. - type: string - description: The metadata of Datasets that contain Text DataItems. + 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 + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + type: array type: object - id: GoogleCloudAiplatformV1SchemaTextDatasetMetadata - GoogleCloudAiplatformV1ModelDataStats: - id: GoogleCloudAiplatformV1ModelDataStats + description: Response message for VizierService.ListOptimalTrials. + GoogleCloudAiplatformV1SafetyRating: + id: GoogleCloudAiplatformV1SafetyRating properties: - testAnnotationsCount: - type: string - format: int64 - 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. - validationDataItemsCount: - format: int64 - type: string - description: >- - Number of DataItems that were used for validating this Model during - training. - validationAnnotationsCount: - format: int64 - type: string - description: >- - Number of Annotations that are used for validating this Model during - training. - trainingAnnotationsCount: + severityScore: + type: number + readOnly: true + description: Output only. Harm severity score. + format: float + category: + description: Output only. 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. + enum: + - HARM_CATEGORY_UNSPECIFIED + - HARM_CATEGORY_HATE_SPEECH + - HARM_CATEGORY_DANGEROUS_CONTENT + - HARM_CATEGORY_HARASSMENT + - HARM_CATEGORY_SEXUALLY_EXPLICIT + readOnly: true type: string - description: Number of Annotations that are used for training this Model. - format: int64 - testDataItemsCount: - 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. + probabilityScore: + format: float + type: number + readOnly: true + description: Output only. Harm probability score. + probability: + enum: + - HARM_PROBABILITY_UNSPECIFIED + - NEGLIGIBLE + - LOW + - MEDIUM + - HIGH + description: Output only. Harm probability levels in the content. type: string - format: int64 - trainingDataItemsCount: - description: Number of DataItems that were used for training this Model. + readOnly: true + enumDescriptions: + - Harm probability unspecified. + - Negligible level of harm. + - Low level of harm. + - Medium level of harm. + - High level of harm. + severity: + enumDescriptions: + - Harm severity unspecified. + - Negligible level of harm severity. + - Low level of harm severity. + - Medium level of harm severity. + - High level of harm severity. type: string - format: int64 + enum: + - HARM_SEVERITY_UNSPECIFIED + - HARM_SEVERITY_NEGLIGIBLE + - HARM_SEVERITY_LOW + - HARM_SEVERITY_MEDIUM + - HARM_SEVERITY_HIGH + readOnly: true + description: Output only. Harm severity levels in the content. + blocked: + readOnly: true + description: >- + Output only. Indicates whether the content was filtered out because + of this rating. + type: boolean type: object - description: Stats of data used for train or evaluate the Model. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics: + description: Safety rating corresponding to the generated content. + GoogleCloudAiplatformV1WriteTensorboardRunDataRequest: properties: - f1ScoreMicro: - format: float - type: number - description: Micro-averaged F1 Score. - confidenceThreshold: - type: number - description: >- - Metrics are computed with an assumption that the Model never returns - predictions with score lower than this value. - format: float - truePositiveCount: - format: int64 - description: The number of Model created labels that match a ground truth label. + tensorboardRun: type: string - 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 DataItem. - format: float - f1ScoreMacro: - format: float + Required. The resource name of the TensorboardRun to write data to. + Format: + `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` + timeSeriesData: + type: array + 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' + description: Request message for TensorboardService.WriteTensorboardRunData. + type: object + id: GoogleCloudAiplatformV1WriteTensorboardRunDataRequest + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics: + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics + type: object + properties: + f1Score: + description: The harmonic mean of recall and precision. type: number - description: Macro-averaged F1 Score. - precision: format: float - type: number + precision: description: Precision for the given confidence threshold. - confusionMatrix: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix - description: Confusion matrix of the evaluation for this confidence_threshold. - recall: - description: Recall (True Positive Rate) for the given confidence threshold. type: number format: float - precisionAt1: - description: >- - The precision when only considering the label that has the highest - prediction score and not below the confidence threshold for each - DataItem. - format: float - type: number - falseNegativeCount: - description: >- - The number of ground truth labels that are not matched by a Model - created label. - format: int64 - type: string - falsePositiveCount: - description: >- - The number of Model created labels that do not match a ground truth - label. - format: int64 - type: string - falsePositiveRate: + recall: format: float - description: False Positive Rate for the given confidence threshold. - type: number - f1ScoreAt1: - description: The harmonic mean of recallAt1 and precisionAt1. + description: Recall (True Positive Rate) for the given confidence threshold. type: number - format: float - falsePositiveRateAt1: + confidenceThreshold: 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. + Metrics are computed with an assumption that the Model never returns + predictions with score lower than this value. type: number format: float - maxPredictions: - 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`. - type: integer - trueNegativeCount: - type: string - description: >- - The number of labels that were not created by the Model, but if they - would, they would not match a ground truth label. + GoogleCloudAiplatformV1TrainingConfig: + properties: + timeoutTrainingMilliHours: format: int64 - f1Score: description: >- - The harmonic mean of recall and precision. For summary metrics, it - computes the micro-averaged F1 score. - format: float - type: number - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics - type: object - GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse: + 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 + 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. type: object - description: Response message for ListDeploymentResourcePools method. + id: GoogleCloudAiplatformV1TrainingConfig + GoogleCloudAiplatformV1DirectPredictResponse: properties: - deploymentResourcePools: - description: The DeploymentResourcePools from the specified location. - type: array + outputs: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool' - 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: GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse - GoogleCloudAiplatformV1SchemaPredictPredictionImageSegmentationPredictionResult: - description: Prediction output format for Image Segmentation. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + type: array + description: The prediction output. + parameters: + description: The parameters that govern the prediction. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + id: GoogleCloudAiplatformV1DirectPredictResponse + description: Response message for PredictionService.DirectPredict. + type: object + GoogleCloudAiplatformV1SchemaModelevaluationMetricsSummarizationEvaluationMetrics: properties: - 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: - 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. + rougeLSum: + type: number + description: ROUGE-L (Longest Common Subsequence) scoring at summary level. + format: float id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionImageSegmentationPredictionResult - type: object - GoogleCloudAiplatformV1EnvVar: + GoogleCloudAiplatformV1SchemaModelevaluationMetricsSummarizationEvaluationMetrics type: object - id: GoogleCloudAiplatformV1EnvVar + GoogleCloudAiplatformV1TensorboardTimeSeries: 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: + pluginName: 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. - 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 - id: GoogleCloudAiplatformV1Measurement - properties: - metrics: - description: >- - Output only. A list of metrics got by evaluating the objective - functions using suggested Parameter values. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MeasurementMetric' - readOnly: true - elapsedDuration: + Immutable. Name of the plugin this time series pertain to. Such as + Scalar, Tensor, Blob + 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. Type of TensorboardTimeSeries value. type: string - format: google-duration - description: >- - Output only. Time that the Trial has been running at the point of - this Measurement. - readOnly: true - stepCount: - format: int64 + enum: + - VALUE_TYPE_UNSPECIFIED + - SCALAR + - TENSOR + - BLOB_SEQUENCE + displayName: description: >- - Output only. The number of steps the machine learning model has been - trained for. Must be non-negative. - readOnly: true + 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 - 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: - text: - description: Optional. Text part (can be code). + createTime: + format: google-datetime type: string - videoMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1VideoMetadata' - description: >- - Optional. Video metadata. The metadata should only be specified - while the video data is presented in inline_data or file_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. - inlineData: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Blob' - description: Optional. Inlined bytes data. - fileData: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FileData' - description: Optional. URI based data. - functionResponse: + description: Output only. Timestamp when this TensorboardTimeSeries was created. + readOnly: true + metadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata + readOnly: true 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' - GoogleTypeExpr: - type: object - properties: - expression: + Output only. Scalar, Tensor, or Blob metadata for this + TensorboardTimeSeries. + pluginData: type: string - description: >- - Textual representation of an expression in Common Expression - Language syntax. - title: + description: Data of the current plugin, with the size limited to 65KB. + format: byte + etag: 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. + Used to perform a consistent read-modify-write updates. If not set, + a blind "overwrite" update happens. description: + description: Description of this TensorboardTimeSeries. 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: + name: 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 - 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. - GoogleCloudAiplatformV1Neighbor: - description: Neighbors for example-based explanations. - type: object - id: GoogleCloudAiplatformV1Neighbor - properties: - neighborId: + description: Output only. Name of the TensorboardTimeSeries. readOnly: true + updateTime: type: string - description: Output only. The neighbor id. - neighborDistance: - description: Output only. The neighbor distance. - format: double + format: google-datetime + description: >- + Output only. Timestamp when this TensorboardTimeSeries was last + updated. readOnly: true - type: number - GoogleCloudAiplatformV1GcsSource: type: object + id: GoogleCloudAiplatformV1TensorboardTimeSeries + description: TensorboardTimeSeries maps to times series produced in training runs + GoogleCloudAiplatformV1SearchNearestEntitiesRequest: + type: object + description: The request message for FeatureOnlineStoreService.SearchNearestEntities. properties: - uris: + returnFullEntity: 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 - type: array - description: The Google Cloud Storage location for the input content. - id: GoogleCloudAiplatformV1GcsSource - GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionRecognitionMetrics: + 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' + id: GoogleCloudAiplatformV1SearchNearestEntitiesRequest + GoogleCloudAiplatformV1StartNotebookRuntimeOperationMetadata: + description: Metadata information for NotebookService.StartNotebookRuntime. properties: - evaluatedActionCount: - type: integer - description: The number of ground truth actions used to create this evaluation. - format: int32 - videoActionMetrics: - type: array - description: 'The metric entries for precision window lengths: 1s,2s,3s.' + 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' + id: GoogleCloudAiplatformV1StartNotebookRuntimeOperationMetadata + type: object + GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks: + description: Open notebooks. + properties: + notebooks: items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + description: Required. Regional resource references to notebooks. + type: array + type: object + id: GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks + GoogleCloudAiplatformV1SyncFeatureViewRequest: + type: object + id: GoogleCloudAiplatformV1SyncFeatureViewRequest + description: Request message for FeatureOnlineStoreAdminService.SyncFeatureView. + properties: {} + GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse: type: object - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionRecognitionMetrics - description: Model evaluation metrics for video action recognition. - 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. - 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 - type: string - timeSegmentEnd: + timeSeriesData: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesData' + description: The returned time series data. + id: GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse + description: Response message for TensorboardService.ReadTensorboardTimeSeriesData. + GoogleCloudAiplatformV1SuggestTrialsRequest: + id: GoogleCloudAiplatformV1SuggestTrialsRequest + description: Request message for VizierService.SuggestTrials. + properties: + suggestionCount: + type: integer + format: int32 + description: Required. The number of suggestions requested. It must be positive. + clientId: type: string 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. + 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: + 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. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrialContext' type: object - description: Prediction input format for Video Object Tracking. - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceVideoObjectTrackingPredictionInstance - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig: - description: The config for Prediction data drift detection. - id: >- - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig + GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest: + id: GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest properties: - driftThresholds: - type: object + requests: 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' - defaultDriftThreshold: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' + 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 + type: array + description: Request message for TensorboardService.BatchCreateTensorboardRuns. + type: object + GoogleCloudAiplatformV1RemoveDatapointsResponse: + properties: {} + description: Response message for IndexService.RemoveDatapoints + id: GoogleCloudAiplatformV1RemoveDatapointsResponse + type: object + GoogleTypeDate: + type: object + properties: + day: + type: integer 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. - attributionScoreDriftThresholds: - 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. + format: int32 + year: 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' + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + type: integer + format: int32 + 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 + 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 + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs: + properties: + multiLabel: + type: boolean type: object - GoogleCloudAiplatformV1ReinforcementLearningDataStats: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs + GoogleCloudAiplatformV1MetadataStoreDataplexConfig: + id: GoogleCloudAiplatformV1MetadataStoreDataplexConfig + properties: + enabledPipelinesLineage: + description: >- + Optional. Whether or not Data Lineage synchronization is enabled for + Vertex Pipelines. + type: boolean type: object - description: Statistics computed for datasets used for reinforcement learning. + description: Represents Dataplex integration settings. + GoogleCloudAiplatformV1UserActionReference: properties: - promptDatasetStats: + method: + type: string description: >- - Output only. Statistics computed for the prompt dataset used during - reinforcement learning. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetStats' - readOnly: true - preferenceDatasetStats: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetStats' + The method name of the API RPC call. For example, + "/google.cloud.aiplatform.{apiVersion}.DatasetService.CreateDataset" + dataLabelingJob: + type: string description: >- - Output only. Statistics computed for the preference dataset. This - can be either a human preference dataset or a preference dataset - generated from AI feedback. - readOnly: true - id: GoogleCloudAiplatformV1ReinforcementLearningDataStats - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation: + 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}` + id: GoogleCloudAiplatformV1UserActionReference description: >- - Training pipeline will infer the proper transformation based on the - statistic of dataset. + References an API call. It contains more information about long running + operation and Jobs that are triggered by the API call. type: object + GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata: + id: GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata properties: - columnName: - type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation - GoogleCloudAiplatformV1FeaturestoreMonitoringConfig: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. + type: object + description: Metadata information for NotebookService.CreateNotebookRuntimeTemplate. + GoogleCloudAiplatformV1CountTokensRequest: properties: - categoricalThresholdConfig: + contents: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + description: Required. Input content. + type: array + model: 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). - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig - snapshotAnalysis: - description: The config for Snapshot Analysis Based Feature Monitoring. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigSnapshotAnalysis - numericalThresholdConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig + Required. The name of the publisher model requested to serve the + prediction. Format: + `projects/{project}/locations/{location}/publishers/*/models/*` + type: string + instances: + type: array + items: + type: any 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). - importFeaturesAnalysis: - description: The config for ImportFeatures Analysis Based Feature Monitoring. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis - id: GoogleCloudAiplatformV1FeaturestoreMonitoringConfig - description: Configuration of how features in Featurestore are monitored. + Required. The instances that are the input to token counting call. + Schema is identical to the prediction schema of the underlying + model. + id: GoogleCloudAiplatformV1CountTokensRequest + description: Request message for PredictionService.CountTokens. type: object - GoogleCloudAiplatformV1SchemaTablesDatasetMetadata: - id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadata - properties: - inputConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs: type: object - description: The metadata of Datasets that contain tables data. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs + properties: + modelType: + enum: + - MODEL_TYPE_UNSPECIFIED + - CLOUD + - MOBILE_VERSATILE_1 + - MOBILE_JETSON_VERSATILE_1 + - MOBILE_CORAL_VERSATILE_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 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. + type: string CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity: - id: CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity type: object + description: The properties for a detected entity from the rai signal. properties: + score: + description: Confidence score of the label + type: number + format: float + mid: + description: MID of the label + type: string + boundingBox: + description: Bounding box of the label + $ref: >- + #/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox description: type: string description: Description of the label iouScore: - format: float description: >- The intersection ratio between the detection bounding box and the mask. type: number - boundingBox: - $ref: >- - #/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox - description: Bounding box of the label - score: - type: number - description: Confidence score of the label format: float - mid: + id: CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity + GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies: + type: object + properties: + threshold: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' + description: Threshold for anomaly detection. + trainingStats: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureStatsAnomaly' + description: Stats calculated for the Training Dataset. + featureDisplayName: + description: Display Name of the Feature. type: string - description: MID of the label - description: The properties for a detected entity from the rai signal. - GoogleCloudAiplatformV1DataLabelingJob: + predictionStats: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureStatsAnomaly' + description: >- + A list of historical stats generated by different time window's + Prediction Dataset. + type: array + id: >- + GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies + description: Historical Stats (and Anomalies) for a specific Feature. + GoogleCloudAiplatformV1SchemaPredictPredictionTextSentimentPredictionResult: + description: Prediction output format for Text Sentiment + type: object properties: - instructionUri: + sentiment: + format: int32 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. + 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 + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionTextSentimentPredictionResult + GoogleCloudAiplatformV1ListMetadataStoresResponse: + description: Response message for MetadataService.ListMetadataStores. + properties: + metadataStores: + description: The MetadataStores found for the Location. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataStore' + nextPageToken: type: string - 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. - specialistPools: - items: - type: string - type: array - description: The SpecialistPools' resource names associated with this job. - name: - description: Output only. Resource name of the DataLabelingJob. + 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 + type: object + GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField: + properties: + fieldName: type: string - readOnly: true - datasets: - items: - type: string - type: array description: >- - Required. Dataset resource names. Right now we only support labeling - from a single Dataset. Format: - `projects/{project}/locations/{location}/datasets/{dataset}` - labelingProgress: + 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. + description: Describe pass-through fields in read_instance source. + id: GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField + type: object + GoogleCloudAiplatformV1CountTokensResponse: + description: Response message for PredictionService.CountTokens. + properties: + totalBillableCharacters: format: int32 description: >- - Output only. Current labeling job progress percentage scaled in - interval [0, 100], indicating the percentage of DataItems that has - been finished. - readOnly: true + The total number of billable characters counted across all instances + from the request. type: integer - annotationLabels: + totalTokens: 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. + The total number of tokens counted across all instances from the + request. + type: integer + format: int32 + id: GoogleCloudAiplatformV1CountTokensResponse + type: object + GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse: + properties: + timeSeriesData: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesData' + type: array + description: The returned time series data. + type: object + id: GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse + description: >- + Response message for + TensorboardService.BatchReadTensorboardTimeSeriesData. + GoogleCloudAiplatformV1ExplanationMetadataOverride: + type: object + id: GoogleCloudAiplatformV1ExplanationMetadataOverride + properties: + inputs: type: object + 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: - type: string - updateTime: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride + description: >- + The ExplanationMetadata entries that can be overridden at online + explanation time. + GoogleCloudAiplatformV1CsvDestination: + properties: + gcsDestination: + description: Required. Google Cloud Storage location. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + description: The storage details for CSV output content. + type: object + id: GoogleCloudAiplatformV1CsvDestination + GoogleCloudAiplatformV1ListPersistentResourcesResponse: + properties: + persistentResources: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' + nextPageToken: type: string - format: google-datetime description: >- - Output only. Timestamp when this DataLabelingJob was updated most - recently. - readOnly: true - displayName: - type: string + A token to retrieve next page of results. Pass to + ListPersistentResourcesRequest.page_token to obtain that page. + id: GoogleCloudAiplatformV1ListPersistentResourcesResponse + type: object + description: Response message for PersistentResourceService.ListPersistentResources + GoogleCloudAiplatformV1SchemaPredictParamsVideoClassificationPredictionParams: + id: >- + GoogleCloudAiplatformV1SchemaPredictParamsVideoClassificationPredictionParams + properties: + maxPredictions: 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. - inputsSchemaUri: - type: string + 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. + type: integer + format: int32 + segmentClassification: + type: boolean 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. - error: - readOnly: true + 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 + confidenceThreshold: + format: float + type: number 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' - 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 Model only returns predictions with at least this confidence + score. Default value is 0.0 + oneSecIntervalClassification: + 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 + type: boolean + 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 + type: object + description: Prediction model parameters for Video Classification. + GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse: + properties: + blobs: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardBlob' + description: Blob messages containing blob bytes. + type: object + description: Response message for TensorboardService.ReadTensorboardBlobData. + id: GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse + GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies: + description: Statistics and anomalies generated by Model Monitoring. + type: object + properties: + anomalyCount: + type: integer + format: int32 + description: Number of anomalies within all stats. + deployedModelId: + description: Deployed Model ID. + type: string + objective: + 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. - >- - 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. + Raw feature values' stats to detect skew between + Training-Prediction datasets. - >- - The job is being updated. Only jobs in the `RUNNING` state can be - updated. After updating, the job goes back to the `RUNNING` state. + Raw feature values' stats to detect drift between + Serving-Prediction datasets. - >- - The job is partially succeeded, some results may be missing due to - errors. - description: Output only. The detailed state of the job. + Feature attribution scores to detect skew between + Training-Prediction datasets. + - >- + Feature attribution scores to detect skew between Prediction + datasets collected within different time windows. + description: Model Monitoring Objective those stats and anomalies belonging to. + featureStats: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies + description: A list of historical Stats and Anomalies generated for all Features. + type: array + id: GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies + GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource: + id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource + properties: + uri: + type: string + description: The URI of a BigQuery table. + type: object + GoogleCloudAiplatformV1FeatureGroup: + type: object + description: Vertex AI Feature Group. + id: GoogleCloudAiplatformV1FeatureGroup + properties: + updateTime: + description: Output only. Timestamp when this FeatureGroup was last updated. readOnly: true + format: google-datetime + type: string + description: + description: Optional. Description of the FeatureGroup. + type: string + etag: 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 - inputs: - description: Required. Input config parameters for the DataLabelingJob. - type: any - labelerCount: - type: integer - format: int32 - description: Required. Number of labelers to work on each DataItem. - 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' + Optional. Used to perform consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. createTime: + description: Output only. Timestamp when this FeatureGroup was created. format: google-datetime type: string readOnly: true - description: Output only. Timestamp when this DataLabelingJob was created. labels: additionalProperties: type: string description: >- - The labels with user-defined metadata to organize your - DataLabelingJobs. Label keys and values can be no longer than 64 + 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 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. + 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. type: object - currentSpend: - readOnly: true - $ref: '#/components/schemas/GoogleTypeMoney' + name: + type: string description: >- - Output only. Estimated cost(in US dollars) that the DataLabelingJob - has incurred to date. - id: GoogleCloudAiplatformV1DataLabelingJob - description: >- - DataLabelingJob is used to trigger a human labeling job on unlabeled - data from the following Dataset: - type: object - GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest: - properties: {} - description: Request message for JobService.ResumeModelDeploymentMonitoringJob. - id: GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest - type: object - GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats: - id: >- - GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats - properties: - validSparseRecordCount: + Identifier. Name of the FeatureGroup. Format: + `projects/{project}/locations/{location}/featureGroups/{featureGroup}` + bigQuery: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroupBigQuery' description: >- - Number of sparse records in this file that were successfully - processed. - type: string - format: int64 - sourceGcsUri: - type: string - description: Cloud Storage URI pointing to the original file in user's bucket. - invalidRecordCount: - description: Number of records in this file we skipped due to validate errors. + 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`. + GoogleCloudAiplatformV1UndeployModelRequest: + properties: + deployedModelId: type: string - format: int64 - invalidSparseRecordCount: description: >- - Number of sparse records in this file we skipped due to validate - errors. - format: int64 - type: string - validRecordCount: - type: string - description: Number of records in this file that were successfully processed. - format: int64 - partialErrors: - type: array + Required. The ID of the DeployedModel to be undeployed from the + Endpoint. + trafficSplit: + type: object 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. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError + 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. + additionalProperties: + format: int32 + type: integer + description: Request message for EndpointService.UndeployModel. + id: GoogleCloudAiplatformV1UndeployModelRequest type: object - GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse: - id: GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse + GoogleCloudAiplatformV1Citation: + properties: + endIndex: + format: int32 + readOnly: true + description: Output only. End index into the content. + type: integer + license: + description: Output only. License of the attribution. + type: string + readOnly: true + publicationDate: + $ref: '#/components/schemas/GoogleTypeDate' + description: Output only. Publication date of the attribution. + readOnly: true + uri: + description: Output only. Url reference of the attribution. + type: string + readOnly: true + startIndex: + readOnly: true + format: int32 + description: Output only. Start index into the content. + type: integer + title: + description: Output only. Title of the attribution. + type: string + readOnly: true + id: GoogleCloudAiplatformV1Citation + description: Source attributions for content. type: object - description: >- - Response message for - FeatureOnlineStoreAdminService.ListFeatureOnlineStores. + GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse: properties: nextPageToken: - type: string 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. - featureOnlineStores: - type: array - description: The FeatureOnlineStores matching the request. + 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 + deploymentResourcePools: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' - GoogleCloudAiplatformV1SchemaModelevaluationMetricsGeneralTextGenerationEvaluationMetrics: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool' + type: array + description: The DeploymentResourcePools from the specified location. + id: GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse + type: object + description: Response message for ListDeploymentResourcePools method. + GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly: + description: >- + A list of historical SnapshotAnalysis or ImportFeaturesAnalysis stats + requested by user, sorted by FeatureStatsAnomaly.start_time descending. + id: GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly + type: object properties: - bleu: + featureStatsAnomaly: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureStatsAnomaly' description: >- - BLEU (bilingual evaluation understudy) scores based on sacrebleu - implementation. - format: float - type: number - rougeLSum: - type: number - format: float - description: ROUGE-L (Longest Common Subsequence) scoring at summary level. + Output only. The stats and anomalies generated at specific + timestamp. + readOnly: true + objective: + readOnly: true + enumDescriptions: + - If it's OBJECTIVE_UNSPECIFIED, monitoring_stats will be empty. + - Stats are generated by Import Feature Analysis. + - Stats are generated by Snapshot Analysis. + type: string + description: Output only. The objective for each stats. + enum: + - OBJECTIVE_UNSPECIFIED + - IMPORT_FEATURE_ANALYSIS + - SNAPSHOT_ANALYSIS + GoogleCloudAiplatformV1ExportFilterSplit: + 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. type: object - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsGeneralTextGenerationEvaluationMetrics - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation: properties: - timeFormat: + trainingFilter: + 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) + 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 - 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: + 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 - 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. - type: object - GoogleCloudAiplatformV1DeleteMetadataStoreOperationMetadata: - type: object - properties: - genericMetadata: - description: Operation metadata for deleting a MetadataStore. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - id: GoogleCloudAiplatformV1DeleteMetadataStoreOperationMetadata - description: Details of operations that perform MetadataService.DeleteMetadataStore. - GoogleCloudAiplatformV1TokensInfo: - properties: - tokens: - items: - type: string - format: byte - description: A list of tokens from the input. - type: array - tokenIds: - description: A list of token ids from the input. - items: - type: string - format: int64 - type: array - id: GoogleCloudAiplatformV1TokensInfo + 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. + id: GoogleCloudAiplatformV1ExportFilterSplit + GoogleCloudAiplatformV1SavedQuery: type: object description: >- - Tokens info with a list of tokens and the corresponding list of token - ids. - GoogleCloudAiplatformV1SchemaPredictPredictionVideoClassificationPredictionResult: + A SavedQuery is a view of the dataset. It references a subset of + annotations by problem type and filters. properties: - timeSegmentStart: - type: string - 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 displayName: - description: The display name of the AnnotationSpec that had been identified. + 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 - timeSegmentEnd: + updateTime: + format: google-datetime + description: Output only. Timestamp when SavedQuery was last updated. type: string - format: google-duration + readOnly: true + annotationFilter: + type: string + description: Output only. Filters on the Annotations in the dataset. + readOnly: true + etag: 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. - type: + Used to perform a consistent read-modify-write update. If not set, a + blind "overwrite" update happens. + type: string + metadata: + type: any + description: Some additional information about the SavedQuery. + name: type: string + readOnly: true + description: Output only. Resource name of the SavedQuery. + annotationSpecCount: + format: int32 + type: integer + readOnly: true 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 - confidence: - type: number + Output only. Number of AnnotationSpecs in the context of the + SavedQuery. + problemType: description: >- - The Model's confidence in correction of this prediction, higher - value means higher confidence. - format: float - id: + 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 type: string - description: The resource ID of the AnnotationSpec that had been identified. - description: Prediction output format for Video Classification. - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionVideoClassificationPredictionResult + createTime: + type: string + description: Output only. Timestamp when this SavedQuery was created. + readOnly: true + format: google-datetime + supportAutomlTraining: + readOnly: true + type: boolean + description: >- + Output only. If the Annotations belonging to the SavedQuery can be + used for AutoML training. + id: GoogleCloudAiplatformV1SavedQuery + GoogleCloudAiplatformV1SchemaTextSentimentSavedQueryMetadata: + id: GoogleCloudAiplatformV1SchemaTextSentimentSavedQueryMetadata type: object - GoogleCloudAiplatformV1UpdateFeaturestoreOperationMetadata: - description: Details of operations that perform update Featurestore. - id: GoogleCloudAiplatformV1UpdateFeaturestoreOperationMetadata properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Featurestore. - type: object - GoogleCloudAiplatformV1BatchPredictionJobInputConfig: - id: GoogleCloudAiplatformV1BatchPredictionJobInputConfig + sentimentMax: + type: integer + description: The maximum sentiment of sentiment Anntoation in this SavedQuery. + format: int32 + description: The metadata of SavedQuery contains TextSentiment Annotations. + GoogleCloudAiplatformV1TensorboardExperiment: + description: >- + A TensorboardExperiment is a group of TensorboardRuns, that are + typically the results of a training job run, in a Tensorboard. + id: GoogleCloudAiplatformV1TensorboardExperiment properties: - bigquerySource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' + etag: 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. - gcsSource: - description: The Cloud Storage location for the input instances. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' - instancesFormat: + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. type: string + source: description: >- - Required. The format in which instances are given, must be one of - the Model's supported_input_storage_formats. - 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. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs: - properties: - forecastHorizon: - format: int64 + Immutable. Source of the TensorboardExperiment. Example: a custom + training job. type: string + labels: + type: object 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. - additionalExperiments: - 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. + additionalProperties: type: string - type: array - description: Additional experiment flags for the time series forcasting training. - contextWindow: - 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 - 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. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation - targetColumn: - type: string - description: >- - The name of the column that the Model is to predict values for. This - column must be unavailable at forecast. - quantiles: - 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 - items: - type: number - format: double - timeSeriesIdentifierColumn: - type: string - description: The name of the column that identifies the time series. - 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. + displayName: type: string - validationOptions: + description: User provided name of this TensorboardExperiment. + createTime: + description: Output only. Timestamp when this TensorboardExperiment was created. + format: google-datetime 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 - dataGranularity: - description: Expected difference in time granularity between rows in the data. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity - trainBudgetMilliNodeHours: + readOnly: true + updateTime: + format: google-datetime type: string + readOnly: true 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 - 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 - optimizationObjective: + Output only. Timestamp when this TensorboardExperiment was last + updated. + description: 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. - hierarchyConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig - description: >- - Configuration that defines the hierarchical relationship of time - series and parameters for hierarchical forecasting strategies. - timeSeriesAttributeColumns: - 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. - type: array - windowConfig: - description: Config containing strategy for generating sliding windows. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig - 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. - unavailableAtForecastColumns: - items: - type: string - 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. - timeColumn: - description: >- - The name of the column that identifies time order in the time - series. This column must be available at forecast. + description: Description of this TensorboardExperiment. + name: 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 + Output only. Name of the TensorboardExperiment. Format: + `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` + readOnly: true type: object - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs - GoogleCloudAiplatformV1ListModelsResponse: + GoogleCloudAiplatformV1ExportDataRequest: + id: GoogleCloudAiplatformV1ExportDataRequest properties: - nextPageToken: - description: >- - A token to retrieve next page of results. Pass to - ListModelsRequest.page_token to obtain that page. - type: string - models: - description: List of Models in the requested page. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' - id: GoogleCloudAiplatformV1ListModelsResponse - type: object - description: Response message for ModelService.ListModels - GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource: - id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource + exportConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportDataConfig' + description: Required. The desired output location. + description: Request message for DatasetService.ExportData. type: object - 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. - items: - type: string - type: array - GoogleCloudAiplatformV1WriteFeatureValuesPayload: - id: GoogleCloudAiplatformV1WriteFeatureValuesPayload + 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 - description: Contains Feature values to be written for a specific entity. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation properties: - entityId: - description: Required. The ID of the entity. + columnName: type: string - featureValues: - type: object - 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. - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' - GoogleCloudAiplatformV1ListIndexesResponse: - description: Response message for IndexService.ListIndexes. + GoogleCloudAiplatformV1ListEntityTypesResponse: + id: GoogleCloudAiplatformV1ListEntityTypesResponse properties: + entityTypes: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' + description: The EntityTypes matching the request. nextPageToken: - type: string description: >- - A token to retrieve next page of results. Pass to - ListIndexesRequest.page_token to obtain that page. - indexes: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' - description: List of indexes in the requested page. - type: array - id: GoogleCloudAiplatformV1ListIndexesResponse + 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 + description: Response message for FeaturestoreService.ListEntityTypes. type: object - GoogleCloudAiplatformV1StudySpecParameterSpec: - description: Represents a single parameter to optimize. - id: GoogleCloudAiplatformV1StudySpecParameterSpec + GoogleCloudAiplatformV1MachineSpec: + description: Specification of a single machine. type: object + id: GoogleCloudAiplatformV1MachineSpec properties: - parameterId: - description: >- - Required. The ID of the parameter. Must not contain whitespaces and - must be unique amongst all ParameterSpecs. + machineType: type: string - conditionalParameterSpecs: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec - type: array 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. - scaleType: - type: string - 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. + 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: + description: >- + Immutable. The type of accelerator(s) that may be attached to the + machine as per accelerator_count. enum: - - SCALE_TYPE_UNSPECIFIED - - UNIT_LINEAR_SCALE - - UNIT_LOG_SCALE - - UNIT_REVERSE_LOG_SCALE + - 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 + enumDescriptions: + - Unspecified accelerator type, which means no accelerator. + - 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. + - TPU v2. + - TPU v3. + - TPU v4. + - TPU v5. + type: string + tpuTopology: + type: string description: >- - How the parameter should be scaled. Leave unset for `CATEGORICAL` - parameters. - doubleValueSpec: - description: The value spec for a 'DOUBLE' parameter. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec - integerValueSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec - description: The value spec for an 'INTEGER' parameter. - categoricalValueSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec - description: The value spec for a 'CATEGORICAL' parameter. - discreteValueSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec - description: The value spec for a 'DISCRETE' parameter. - GoogleCloudAiplatformV1PurgeContextsRequest: - id: GoogleCloudAiplatformV1PurgeContextsRequest + Immutable. The topology of the TPUs. Corresponds to the TPU + topologies available from GKE. (Example: tpu_topology: "2x2x1"). + acceleratorCount: + type: integer + description: The number of accelerators to attach to the machine. + format: int32 + GoogleCloudAiplatformV1ResourcesConsumed: properties: - filter: - description: >- - Required. A required filter matching the Contexts to be purged. - E.g., `update_time <= 2020-11-19T11:30:00-04:00`. - type: string - force: - type: boolean + replicaHours: 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. + 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 type: object - description: Request message for MetadataService.PurgeContexts. - 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: GoogleCloudAiplatformV1ResourcesConsumed + description: Statistics information about resource consumption. + GoogleCloudAiplatformV1ExplanationSpecOverride: + id: GoogleCloudAiplatformV1ExplanationSpecOverride 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 + examplesOverride: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExamplesOverride' + description: The example-based explanations parameter overrides. + parameters: 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 - blurBaselineConfig: + 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: >- - 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' + The metadata to be overridden. If not specified, no metadata is + overridden. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataOverride + description: >- + The ExplanationSpec entries that can be overridden at online explanation + time. + type: object + GoogleCloudAiplatformV1TrialContext: + description: 'Next ID: 3' type: object - id: GoogleCloudAiplatformV1XraiAttribution - GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource: properties: - uri: + parameters: + type: array + 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. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrialParameter' + 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 - description: The URI of a BigQuery table. + id: GoogleCloudAiplatformV1TrialContext + GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor: + description: Metadata for requested Features. type: object - id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity: properties: - unit: + id: + description: Feature ID. type: string - description: >- - The time granularity unit of this time period. The supported units - are: * "minute" * "hour" * "day" * "week" * "month" * "year" + id: GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity: + type: object + 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: + description: >- + The time granularity unit of this time period. The supported units + are: * "minute" * "hour" * "day" * "week" * "month" * "year" type: string id: >- GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity description: A duration of time expressed in time granularity units. + GoogleCloudAiplatformV1DeleteMetadataStoreOperationMetadata: + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for deleting a MetadataStore. + description: Details of operations that perform MetadataService.DeleteMetadataStore. + id: GoogleCloudAiplatformV1DeleteMetadataStoreOperationMetadata + type: object + GoogleCloudAiplatformV1SearchEntryPoint: type: object - GoogleCloudAiplatformV1ResourceRuntimeSpec: properties: - serviceAccountSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ServiceAccountSpec' - description: >- - Optional. Configure the use of workload identity on the - PersistentResource - raySpec: - description: >- - Optional. Ray cluster configuration. Required when creating a - dedicated RayCluster on the PersistentResource. - $ref: '#/components/schemas/GoogleCloudAiplatformV1RaySpec' - type: object - 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 - GoogleCloudAiplatformV1DeployedModel: - description: A deployment of a Model. Endpoints contain one or more DeployedModels. - type: object - properties: - 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. - sharedResources: - description: >- - The resource name of the shared DeploymentResourcePool to deploy on. - Format: - `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` - type: string - privateEndpoints: - 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 - $ref: '#/components/schemas/GoogleCloudAiplatformV1PrivateEndpoints' - disableExplanations: - description: >- - If true, deploy the model without explainable feature, regardless - the existence of Model.explanation_spec or explanation_spec. - type: boolean - 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' - modelVersionId: - type: string - readOnly: true - description: Output only. The version ID of the model that is deployed. - id: + renderedContent: 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]/`. + Optional. Web content snippet that can be embedded in a web page or + an app webview. type: string - 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. + sdkBlob: + description: Optional. Base64 encoded JSON representing array of tuple. type: string + format: byte + id: GoogleCloudAiplatformV1SearchEntryPoint + description: Google search entry point. + GoogleCloudAiplatformV1SchemaImageClassificationAnnotation: + properties: displayName: - description: >- - The display name of the DeployedModel. If not provided upon - creation, the Model's display_name is used. - type: string - 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. - 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' - explanationSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpec' + The display name of the AnnotationSpec that this Annotation pertains + to. + annotationSpecId: 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. - createTime: - readOnly: true - format: google-datetime - description: Output only. Timestamp when the DeployedModel was created. + The resource Id of the AnnotationSpec that this Annotation pertains + to. type: string - 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. - id: GoogleCloudAiplatformV1DeployedModel - GoogleCloudAiplatformV1StreamRawPredictRequest: + type: object + id: GoogleCloudAiplatformV1SchemaImageClassificationAnnotation + description: Annotation details specific to image classification. + GoogleCloudAiplatformV1CreateFeatureOperationMetadata: + description: Details of operations that perform create Feature. properties: - httpBody: - $ref: '#/components/schemas/GoogleApiHttpBody' - description: >- - The prediction input. Supports HTTP headers and arbitrary data - payload. - id: GoogleCloudAiplatformV1StreamRawPredictRequest + genericMetadata: + description: Operation metadata for Feature. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + id: GoogleCloudAiplatformV1CreateFeatureOperationMetadata type: object - description: Request message for PredictionService.StreamRawPredict. - GoogleCloudAiplatformV1CreateFeatureRequest: - id: GoogleCloudAiplatformV1CreateFeatureRequest + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassification: + properties: + metadata: + description: The metadata information. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata + inputs: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs + description: The input parameters of this TrainingJob. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassification description: >- - Request message for FeaturestoreService.CreateFeature. Request message - for FeatureRegistryService.CreateFeature. + A TrainingJob that trains and uploads an AutoML Image Classification + Model. type: object + GoogleCloudAiplatformV1PurgeContextsRequest: properties: - feature: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' - description: Required. The Feature to create. - featureId: - type: string + force: + type: boolean 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. - parent: - type: string + 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: 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}` - GoogleCloudAiplatformV1CreateFeatureViewOperationMetadata: - properties: - genericMetadata: - description: Operation metadata for FeatureView Create. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - id: GoogleCloudAiplatformV1CreateFeatureViewOperationMetadata + Required. A required filter matching the Contexts to be purged. + E.g., `update_time <= 2020-11-19T11:30:00-04:00`. + type: string + description: Request message for MetadataService.PurgeContexts. type: object - description: Details of operations that perform create FeatureView. - GoogleCloudAiplatformV1ListBatchPredictionJobsResponse: + id: GoogleCloudAiplatformV1PurgeContextsRequest + GoogleCloudAiplatformV1ListAnnotationsResponse: + id: GoogleCloudAiplatformV1ListAnnotationsResponse + description: Response message for DatasetService.ListAnnotations. type: object - id: GoogleCloudAiplatformV1ListBatchPredictionJobsResponse - description: Response message for JobService.ListBatchPredictionJobs properties: nextPageToken: type: string - description: >- - A token to retrieve the next page of results. Pass to - ListBatchPredictionJobsRequest.page_token to obtain that page. - batchPredictionJobs: - type: array - description: List of BatchPredictionJobs in the requested page. + description: The standard List next-page token. + annotations: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' - GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi: - description: Rest API docs. - id: GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi - type: object - properties: - documentations: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Annotation' type: array - description: Required. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelDocumentation - title: - type: string - description: Required. The title of the view rest API. - CloudAiLargeModelsVisionRaiInfoDetectedLabels: + description: >- + A list of Annotations that matches the specified filter in the + request. + GoogleCloudAiplatformV1Examples: + id: GoogleCloudAiplatformV1Examples + description: >- + Example-based explainability that returns the nearest neighbors from the + provided dataset. properties: - entities: + neighborCount: + type: integer + format: int32 + description: The number of neighbors to return when querying for examples. + exampleGcsSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExamplesExampleGcsSource' + description: The Cloud Storage input instances. + 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. + 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). + type: object + GoogleCloudAiplatformV1AddContextChildrenRequest: + id: GoogleCloudAiplatformV1AddContextChildrenRequest + description: Request message for MetadataService.AddContextChildren. + properties: + childContexts: type: array items: - $ref: >- - #/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity - description: The list of detected entities for the rai signal. - raiCategory: - description: The RAI category for the deteceted labels. - type: string - id: CloudAiLargeModelsVisionRaiInfoDetectedLabels - description: Filters returning list of deteceted labels, scores, and bounding boxes. - type: object - GoogleCloudAiplatformV1ListTensorboardsResponse: - id: GoogleCloudAiplatformV1ListTensorboardsResponse + type: string + description: The resource names of the child Contexts. type: object - description: Response message for TensorboardService.ListTensorboards. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry: + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry properties: - tensorboards: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' - description: The Tensorboards mathching the request. - type: array - nextPageToken: + iouScore: 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: string - GoogleCloudAiplatformV1Value: + The intersection-over-union score. The measure of overlap of the + annotation's category mask with ground truth category mask on the + DataItem. + type: number + format: float + diceScoreCoefficient: + type: number + description: DSC or the F1 score, The harmonic mean of recall and precision. + format: float + confusionMatrix: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix + description: Confusion matrix for the given confidence threshold. + recall: + description: Recall (True Positive Rate) for the given confidence threshold. + type: number + format: float + confidenceThreshold: + type: number + description: >- + Metrics are computed with an assumption that the model never returns + predictions with score lower than this value. + format: float + precision: + format: float + description: Precision for the given confidence threshold. + type: number + type: object + GoogleCloudAiplatformV1SchemaPredictParamsImageObjectDetectionPredictionParams: + id: >- + GoogleCloudAiplatformV1SchemaPredictParamsImageObjectDetectionPredictionParams + description: Prediction model parameters for Image Object Detection. type: object - id: GoogleCloudAiplatformV1Value properties: - stringValue: - type: string - description: A string value. - intValue: - format: int64 - type: string - description: An integer value. - doubleValue: + 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: A double value. - format: double - description: Value is the value of the field. - GoogleCloudAiplatformV1Context: + GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry: + id: GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry + type: object properties: - 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. - schemaVersion: + type: 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. + description: The type of the grounding checking source. + enum: + - UNSPECIFIED + - WEB + - ENTERPRISE + - VERTEX_AI_SEARCH + - INLINE + enumDeprecated: + - false + - false + - true + - false + - false + enterpriseDatastore: 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. - updateTime: - description: Output only. Timestamp when this Context was last updated. - format: google-datetime - readOnly: true + The uri of the Vertex AI Search data source. Deprecated. Use + vertex_ai_search_datastore instead. + deprecated: true type: string - 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). - type: object - additionalProperties: - type: string - createTime: - description: Output only. Timestamp when this Context was created. - readOnly: true + vertexAiSearchDatastore: + description: The uri of the Vertex AI Search data source. type: string - format: google-datetime - metadata: + inlineContext: 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 - type: object - description: + The grounding text passed inline with the Predict API. It can + support up to 1 million bytes. type: string - description: Description of the Context - parentContexts: + description: Single source entry for the grounding checking. + GoogleCloudAiplatformV1ExamplesRestrictionsNamespace: + id: GoogleCloudAiplatformV1ExamplesRestrictionsNamespace + type: object + description: Restrictions namespace for example-based explanations overrides. + properties: + allow: type: array - readOnly: true 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. - etag: - type: string - description: >- - An eTag used to perform consistent read-modify-write updates. If not - set, a blind "overwrite" update happens. - name: - description: Immutable. The resource name of the Context. - type: string - displayName: + description: The list of allowed tags. + namespaceName: type: string - description: >- - User provided display name of the Context. May be up to 128 Unicode - characters. - id: GoogleCloudAiplatformV1Context - description: Instance of a general context. + description: The namespace name. + deny: + type: array + items: + type: string + description: The list of deny tags. + GoogleCloudAiplatformV1BigQuerySource: type: object - GoogleCloudAiplatformV1ModelGardenSource: - description: >- - Contains information about the source of the models generated from Model - Garden. properties: - publicModelName: + inputUri: + description: >- + Required. BigQuery URI to a table, up to 2000 characters long. + Accepted forms: * BigQuery path. For example: + `bq://projectId.bqDatasetId.bqTableId`. type: string - description: Required. The model garden source model resource name. - id: GoogleCloudAiplatformV1ModelGardenSource - type: object - GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig: - properties: {} - description: Configuration options for using brute force search. - type: object - id: GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig - GoogleCloudAiplatformV1NasJobOutput: - description: Represents a uCAIP NasJob output. + id: GoogleCloudAiplatformV1BigQuerySource + description: The BigQuery location for the input content. + GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata: + description: All metadata of most recent monitoring pipelines. properties: - multiTrialJobOutput: - readOnly: true + runTime: description: >- - Output only. The output of this multi-trial Neural Architecture - Search (NAS) job. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput - id: GoogleCloudAiplatformV1NasJobOutput + The time that most recent monitoring pipelines that is related to + this run. + format: google-datetime + type: string + status: + description: The status of the most recent monitoring pipeline. + $ref: '#/components/schemas/GoogleRpcStatus' type: object - GoogleCloudAiplatformV1IndexStats: + id: >- + GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs: type: object - id: GoogleCloudAiplatformV1IndexStats properties: - sparseVectorsCount: - readOnly: true - format: int64 - type: string - description: Output only. The number of sparse vectors in the Index. - shardsCount: - description: Output only. The number of shards in the Index. - format: int32 - type: integer - readOnly: true - vectorsCount: - format: int64 - readOnly: true + 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. + items: + type: string + type: array + validationOptions: type: string - description: Output only. The number of dense vectors in the Index. - description: Stats of the Index. - GoogleCloudAiplatformV1GenerateContentResponse: - type: object - description: Response message for [PredictionService.GenerateContent]. - id: GoogleCloudAiplatformV1GenerateContentResponse - properties: - candidates: + 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 + 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. + format: int64 + type: string + 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 + 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 + 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. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Candidate' - readOnly: true + type: string type: array - description: Output only. Generated candidates. - promptFeedback: - readOnly: true + targetColumn: 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. + The name of the column that the Model is to predict values for. This + column must be unavailable at forecast. + 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. + items: + type: string + type: array + hierarchyConfig: + description: >- + Configuration that defines the hierarchical relationship of time + series and parameters for hierarchical forecasting strategies. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback - usageMetadata: + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig + additionalExperiments: + items: + type: string + description: Additional experiment flags for the time series forcasting training. + type: array + dataGranularity: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata - description: Usage metadata about the response(s). - GoogleCloudAiplatformV1SchemaPredictInstanceImageClassificationPredictionInstance: - properties: - content: + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity + description: Expected difference in time granularity between rows in the data. + windowConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig + description: Config containing strategy for generating sliding windows. + 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 - description: The image bytes or Cloud Storage URI to make the prediction on. - mimeType: + timeSeriesIdentifierColumn: + description: The name of the column that identifies the time series. type: string + quantiles: + type: array 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: object - description: Prediction input format for Image Classification. - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceImageClassificationPredictionInstance - GoogleCloudAiplatformV1FindNeighborsRequest: - properties: - queries: + 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. items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FindNeighborsRequestQuery + format: double + type: number + enableProbabilisticInference: + 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 + timeColumn: + description: >- + 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: >- + 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. + availableAtForecastColumns: type: array - description: The list of queries. - deployedIndexId: + items: + 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. + 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. + optimizationObjective: type: string - 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 - description: The request message for MatchService.FindNeighbors. - id: GoogleCloudAiplatformV1FindNeighborsRequest + 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: + 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/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs + GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig: + id: GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig + description: The config for email alert. + properties: + userEmails: + description: The email addresses to send the alert. + items: + type: string + type: array type: object - GoogleCloudAiplatformV1CopyModelRequest: + GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable: properties: - modelId: + bigqueryTablePath: 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: - description: >- - Customer-managed encryption key options. If this is set, then the - Model copy will be encrypted with the provided encryption key. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - sourceModel: + 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 type: string - 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}` - parentModel: + enumDescriptions: + - Unspecified type. + - Predict logs. + - Explain logs. + description: The type of log. + logSource: + enumDescriptions: + - Unspecified source. + - Logs coming from Training dataset. + - Logs coming from Serving traffic. + description: The source of log. type: string + enum: + - LOG_SOURCE_UNSPECIFIED + - TRAINING + - SERVING + requestResponseLoggingSchemaVersion: description: >- - Optional. Specify this field to copy source_model into this existing - Model as a new version. Format: - `projects/{project}/locations/{location}/models/{model}` - id: GoogleCloudAiplatformV1CopyModelRequest + Output only. The schema version of the request/response logging + BigQuery table. Default to v1 if unset. + type: string + readOnly: true type: object - description: Request message for ModelService.CopyModel. - GoogleCloudAiplatformV1ExportFeatureValuesResponse: - properties: {} - description: Response message for FeaturestoreService.ExportFeatureValues. - id: GoogleCloudAiplatformV1ExportFeatureValuesResponse + id: GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable + description: >- + ModelDeploymentMonitoringBigQueryTable specifies the BigQuery table name + as well as some information of the logs stored in this table. + GoogleCloudAiplatformV1SchemaPredictPredictionTextExtractionPredictionResult: + description: Prediction output format for Text Extraction. + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionTextExtractionPredictionResult type: object - GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata: - description: All metadata of most recent monitoring pipelines. + properties: + textSegmentStartOffsets: + type: array + items: + type: string + format: int64 + 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: + 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 + displayNames: + description: >- + The display names of the AnnotationSpecs that had been identified, + order matches the IDs. + type: array + items: + type: string + textSegmentEndOffsets: + type: array + items: + type: string + format: int64 + 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. + GoogleCloudAiplatformV1AddTrialMeasurementRequest: type: object + properties: + measurement: + description: Required. The measurement to be added to a Trial. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' + id: GoogleCloudAiplatformV1AddTrialMeasurementRequest + description: Request message for VizierService.AddTrialMeasurement. + GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectTimeRangeAndFeature: id: >- - GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata + GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectTimeRangeAndFeature properties: - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of the most recent monitoring pipeline. - runTime: - format: google-datetime + featureSelector: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' description: >- - The time that most recent monitoring pipelines that is related to - this run. + Required. Selectors choosing which feature values to be deleted from + the EntityType. + skipOnlineStorageDelete: + type: boolean + 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. + timeRange: + $ref: '#/components/schemas/GoogleTypeInterval' + description: >- + Required. Select feature generated within a half-inclusive time + range. The time range is lower inclusive and upper exclusive. + 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 + GoogleCloudAiplatformV1ReadTensorboardSizeResponse: + properties: + storageSizeByte: + format: int64 type: string - GoogleCloudAiplatformV1BatchCreateFeaturesOperationMetadata: + description: Payload storage size for the TensorBoard + type: object + description: Response message for TensorboardService.ReadTensorboardSize. + id: GoogleCloudAiplatformV1ReadTensorboardSizeResponse + GoogleCloudAiplatformV1PurgeArtifactsMetadata: properties: genericMetadata: + description: Operation metadata for purging Artifacts. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Feature. - id: GoogleCloudAiplatformV1BatchCreateFeaturesOperationMetadata + description: Details of operations that perform MetadataService.PurgeArtifacts. + type: object + id: GoogleCloudAiplatformV1PurgeArtifactsMetadata + GoogleCloudAiplatformV1ListEndpointsResponse: + id: GoogleCloudAiplatformV1ListEndpointsResponse + description: Response message for EndpointService.ListEndpoints. type: object - description: Details of operations that perform batch create Features. - GoogleCloudAiplatformV1MutateDeployedModelResponse: - id: GoogleCloudAiplatformV1MutateDeployedModelResponse properties: - deployedModel: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' - description: The DeployedModel that's being mutated. + nextPageToken: + description: >- + A token to retrieve the next page of results. Pass to + ListEndpointsRequest.page_token to obtain that page. + type: string + endpoints: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' + type: array + description: List of Endpoints in the requested page. + GoogleCloudAiplatformV1ListFeatureViewSyncsResponse: + id: GoogleCloudAiplatformV1ListFeatureViewSyncsResponse + properties: + nextPageToken: + type: string + 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. + featureViewSyncs: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewSync' + type: array + description: The FeatureViewSyncs matching the request. type: object - description: Response message for EndpointService.MutateDeployedModel. - GoogleCloudAiplatformV1UpdateModelDeploymentMonitoringJobOperationMetadata: description: >- - Runtime operation information for - JobService.UpdateModelDeploymentMonitoringJob. + Response message for + FeatureOnlineStoreAdminService.ListFeatureViewSyncs. + GoogleCloudAiplatformV1ExportDataOperationMetadata: properties: genericMetadata: - description: The operation generic information. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The common part of the operation metadata. + gcsOutputDirectory: + description: >- + A Google Cloud Storage directory which path ends with '/'. The + exported data is stored in the directory. + type: string type: object - id: >- - GoogleCloudAiplatformV1UpdateModelDeploymentMonitoringJobOperationMetadata - GoogleCloudAiplatformV1SchemaPredictInstanceTextClassificationPredictionInstance: + description: Runtime operation information for DatasetService.ExportData. + id: GoogleCloudAiplatformV1ExportDataOperationMetadata + GoogleCloudAiplatformV1DirectRawPredictRequest: + id: GoogleCloudAiplatformV1DirectRawPredictRequest properties: - content: + input: type: string - description: The text snippet to make the predictions on. - mimeType: + description: The prediction input. + format: byte + methodName: type: string description: >- - The MIME type of the text snippet. The supported MIME types are - listed below. - text/plain - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceTextClassificationPredictionInstance - description: Prediction input format for Text Classification. + Fully qualified name of the API method being invoked to perform + predictions. Format: `/namespace.Service/Method/` Example: + `/tensorflow.serving.PredictionService/Predict` + description: Request message for PredictionService.DirectRawPredict. type: object - GoogleCloudAiplatformV1CreateFeaturestoreOperationMetadata: - id: GoogleCloudAiplatformV1CreateFeaturestoreOperationMetadata - description: Details of operations that perform create Featurestore. + GoogleCloudAiplatformV1GcsDestination: type: object + description: The Google Cloud Storage location where the output is to be written to. properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Featurestore. - GoogleCloudAiplatformV1SafetyRating: - properties: - severity: - readOnly: true - type: string - 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. Harm severity levels in the content. - category: - enum: - - HARM_CATEGORY_UNSPECIFIED - - HARM_CATEGORY_HATE_SPEECH - - HARM_CATEGORY_DANGEROUS_CONTENT - - HARM_CATEGORY_HARASSMENT - - HARM_CATEGORY_SEXUALLY_EXPLICIT - description: Output only. Harm category. - type: string - readOnly: true - 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. - probability: - description: Output only. Harm probability levels in the content. - enumDescriptions: - - Harm probability unspecified. - - Negligible level of harm. - - Low level of harm. - - Medium level of harm. - - High level of harm. + outputUriPrefix: type: string - enum: - - HARM_PROBABILITY_UNSPECIFIED - - NEGLIGIBLE - - LOW - - MEDIUM - - HIGH - readOnly: true - blocked: - type: boolean - readOnly: true description: >- - Output only. Indicates whether the content was filtered out because - of this rating. - severityScore: - format: float - description: Output only. Harm severity score. - type: number - readOnly: true - probabilityScore: - readOnly: true - description: Output only. Harm probability score. + 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. + id: GoogleCloudAiplatformV1GcsDestination + GoogleCloudAiplatformV1ExplanationParameters: + id: GoogleCloudAiplatformV1ExplanationParameters + properties: + topK: + type: integer + format: int32 + 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. + 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 + 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. + examples: + description: >- + Example-based explanations that returns the nearest neighbors from + the provided dataset. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Examples' + 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: any + type: array + 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. + type: object + description: Parameters to configure explaining for Model's predictions. + GoogleCloudAiplatformV1BlurBaselineConfig: + properties: + maxBlurSigma: + 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: GoogleCloudAiplatformV1SafetyRating - description: Safety rating corresponding to the generated content. + id: GoogleCloudAiplatformV1BlurBaselineConfig type: object - GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization: - description: Visualization configurations for image explanation. + 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 + GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec: + type: object + 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. properties: - overlayType: + minMeasurementCount: type: string 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. - 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 - colorMap: + 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 + learningRateParameterName: type: string 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. - 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. - clipPercentUpperbound: + 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. + minStepCount: + format: int64 + 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. + type: string + 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. + useElapsedDuration: + type: boolean + 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. + maxStepCount: + type: string + format: int64 + 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. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation + type: object + properties: + auto: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation + timestamp: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation + categorical: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation + numeric: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation + text: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation + GoogleCloudAiplatformV1SchemaModelevaluationMetricsRegressionEvaluationMetrics: + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsRegressionEvaluationMetrics + description: Metrics for regression evaluation results. + properties: + meanAbsoluteError: + format: float + description: Mean Absolute Error (MAE). type: number + rootMeanSquaredLogError: 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. - clipPercentLowerbound: + Root mean squared log error. Undefined when there are negative + ground truth values or predictions. + meanAbsolutePercentageError: format: float type: number description: >- - Excludes attributions below the specified percentile, from the - highlighted areas. Defaults to 62. - type: - type: string - 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. + Mean absolute percentage error. Infinity when there are zeros in the + ground truth. + rootMeanSquaredError: + format: float + description: Root Mean Squared Error (RMSE). + type: number + rSquared: + type: number + format: float 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 + Coefficient of determination as Pearson correlation coefficient. + Undefined when ground truth or predictions are constant or near + constant. + type: object + 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. + properties: + metricName: 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. + 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 - id: GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization - type: object - GoogleCloudAiplatformV1FeatureOnlineStore: + target: + type: integer + 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: object + id: GoogleCloudAiplatformV1AutoscalingMetricSpec + GoogleCloudAiplatformV1DataLabelingJob: + id: GoogleCloudAiplatformV1DataLabelingJob + description: >- + DataLabelingJob is used to trigger a human labeling job on unlabeled + data from the following Dataset: properties: - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + currentSpend: + $ref: '#/components/schemas/GoogleTypeMoney' description: >- - Optional. Customer-managed encryption key spec for data storage. If - set, online store will be secured by this key. + Output only. Estimated cost(in US dollars) that the DataLabelingJob + has incurred to date. + readOnly: true + inputsSchemaUri: + 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. + activeLearningConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ActiveLearningConfig' + 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. + name: + type: string + description: Output only. Resource name of the DataLabelingJob. + readOnly: true + specialistPools: + items: + type: string + type: array + description: The SpecialistPools' resource names associated with this job. + 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 + 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. + annotationLabels: + additionalProperties: + type: string + 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. + inputs: + description: Required. Input config parameters for the DataLabelingJob. + type: any labels: description: >- - Optional. The labels with user-defined metadata to organize your - FeatureOnlineStore. Label keys and values can be no longer than 64 + 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 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. + 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 - dedicatedServingEndpoint: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint + encryptionSpec: description: >- - Optional. The dedicated serving endpoint for this - FeatureOnlineStore, which is different from common Vertex service - endpoint. - etag: + 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' + error: + readOnly: true + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + Output only. DataLabelingJob errors. It is only populated when job's + state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`. + createTime: + format: google-datetime + description: Output only. Timestamp when this DataLabelingJob was created. type: string + readOnly: true + labelingProgress: + readOnly: true + format: int32 description: >- - Optional. Used to perform consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. + Output only. Current labeling job progress percentage scaled in + interval [0, 100], indicating the percentage of DataItems that has + been finished. + type: integer + labelerCount: + type: integer + description: Required. Number of labelers to work on each DataItem. + format: int32 + instructionUri: + 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. + updateTime: + format: google-datetime + readOnly: true + type: string + description: >- + Output only. Timestamp when this DataLabelingJob was updated most + recently. 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 type: string + description: Output only. The detailed state of the job. enumDescriptions: - - Default value. This value is unused. + - The job state is unspecified. - >- - 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 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 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. + 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: - - STATE_UNSPECIFIED - - STABLE - - UPDATING - description: Output only. State of the featureOnlineStore. - name: - type: string + type: object + GoogleTypeMoney: + description: Represents an amount of money with its currency type. + properties: + units: description: >- - Identifier. Name of the FeatureOnlineStore. Format: - `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}` - optimized: + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. + format: int64 + type: string + currencyCode: + description: The three-letter currency code defined in ISO 4217. + type: string + nanos: + type: integer + format: int32 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 - bigtable: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreBigtable + 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. + id: GoogleTypeMoney + type: object + 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). + type: object + properties: + predictRoute: + type: string description: >- - Contains settings for the Cloud Bigtable instance that will be - created to serve featureValues for all FeatureViews under this - FeatureOnlineStore. - updateTime: - readOnly: true + 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).) + startupProbe: + description: Immutable. Specification for Kubernetes startup probe. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Probe' + command: + items: + type: string description: >- - Output only. Timestamp when this FeatureOnlineStore was last - updated. + 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). + type: array + imageUri: + 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 - format: google-datetime - createTime: - format: google-datetime - description: Output only. Timestamp when this FeatureOnlineStore was created. + 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 + 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). + ports: + items: + $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 + 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). + type: array + deploymentTimeout: + format: google-duration type: string - readOnly: true - id: GoogleCloudAiplatformV1FeatureOnlineStore - 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. - GoogleCloudAiplatformV1NearestNeighborsNeighbor: - properties: - entityKeyValues: 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. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponse - entityId: + Immutable. Deployment timeout. Limit for deployment timeout is 2 + hours. + sharedMemorySizeMb: type: string - description: The id of the similar entity. - distance: - type: number - description: The distance between the neighbor and the query vector. - format: double - id: GoogleCloudAiplatformV1NearestNeighborsNeighbor - type: object - description: A neighbor of the query vector. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation: - type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation - properties: - columnName: + description: >- + Immutable. The amount of the VM memory to reserve as the shared + memory for the model in megabytes. + format: int64 + healthProbe: + description: Immutable. Specification for Kubernetes readiness probe. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Probe' + healthRoute: 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. - GoogleCloudAiplatformV1RayMetricSpec: - id: GoogleCloudAiplatformV1RayMetricSpec - properties: - disabled: - description: Optional. Flag to disable the Ray metrics collection. - type: boolean - description: Configuration for the Ray metrics. - type: object - GoogleCloudAiplatformV1CreateFeatureOnlineStoreOperationMetadata: - type: object - id: GoogleCloudAiplatformV1CreateFeatureOnlineStoreOperationMetadata - description: Details of operations that perform create FeatureOnlineStore. - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for FeatureOnlineStore. - GoogleCloudAiplatformV1StringArray: - type: object - description: A list of string values. - id: GoogleCloudAiplatformV1StringArray + 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).) + GoogleCloudAiplatformV1ListTrialsResponse: properties: - values: - description: A list of string values. + trials: type: array items: - type: string - GoogleCloudAiplatformV1ImportDataOperationMetadata: - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The common part of the operation metadata. - id: GoogleCloudAiplatformV1ImportDataOperationMetadata - description: Runtime operation information for DatasetService.ImportData. - 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 - 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. - epochCount: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + description: The Trials associated with the Study. + nextPageToken: description: >- - Optional. Number of complete passes the model makes over the entire - training dataset during training. - format: int64 + 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 - learningRateMultiplier: - format: double - type: number - description: Optional. Multiplier for adjusting the default learning rate. - id: GoogleCloudAiplatformV1SupervisedHyperParameters + description: Response message for VizierService.ListTrials. type: object - GoogleCloudAiplatformV1ListNotebookRuntimesResponse: - id: GoogleCloudAiplatformV1ListNotebookRuntimesResponse + id: GoogleCloudAiplatformV1ListTrialsResponse + GoogleCloudAiplatformV1BatchCreateFeaturesRequest: + id: GoogleCloudAiplatformV1BatchCreateFeaturesRequest + description: Request message for FeaturestoreService.BatchCreateFeatures. + properties: + requests: + 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. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CreateFeatureRequest' type: object - description: Response message for NotebookService.ListNotebookRuntimes. + GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest: properties: - nextPageToken: + pageSize: + description: The standard list page size. + type: integer + format: int32 + 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 + startTime: description: >- - A token to retrieve next page of results. Pass to - ListNotebookRuntimesRequest.page_token to obtain that page. - notebookRuntimes: - description: List of NotebookRuntimes in the requested page. + The earliest timestamp of stats being generated. If not set, + indicates fetching stats till the earliest possible one. + type: string + format: google-datetime + objectives: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookRuntime' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective + description: Required. Objectives of the stats to retrieve. type: array - GoogleCloudAiplatformV1DeployModelOperationMetadata: - properties: - genericMetadata: - description: The operation generic information. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - type: object - id: GoogleCloudAiplatformV1DeployModelOperationMetadata - description: Runtime operation information for EndpointService.DeployModel. - GoogleCloudAiplatformV1SchemaVertex: + deployedModelId: + type: string + description: >- + Required. The DeployedModel ID of the + [ModelDeploymentMonitoringObjectiveConfig.deployed_model_id]. + pageToken: + type: string + description: >- + A page token received from a previous + JobService.SearchModelDeploymentMonitoringStatsAnomalies call. + endTime: + type: string + format: google-datetime + description: >- + The latest timestamp of stats being generated. If not set, indicates + feching stats till the latest possible one. 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. + Request message for + JobService.SearchModelDeploymentMonitoringStatsAnomalies. type: object - id: GoogleCloudAiplatformV1SchemaVertex + id: >- + GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest + CloudAiLargeModelsVisionImageRAIScores: + type: object + id: CloudAiLargeModelsVisionImageRAIScores properties: - x: - format: double - description: X coordinate. - type: number - 'y': - description: Y coordinate. + agileWatermarkDetectionScore: format: double type: number - GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint: + description: Agile watermark score for image. + description: RAI scores for generated image returned. + GoogleCloudAiplatformV1TensorboardBlobSequence: + type: object properties: - publicEndpointDomainName: - description: >- - Output only. This field will be populated with the domain name to - use for this FeatureOnlineStore + values: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardBlob' + type: array + 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. + id: GoogleCloudAiplatformV1TensorboardBlobSequence + 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. + properties: + rowSynced: + format: int64 + description: Output only. Total number of rows synced. + readOnly: true type: string + totalSlot: readOnly: true + description: Output only. BigQuery slot milliseconds consumed for the sync job. + type: string + format: int64 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 - GoogleCloudAiplatformV1GroundingMetadata: + id: GoogleCloudAiplatformV1FeatureViewSyncSyncSummary + GoogleCloudAiplatformV1ListSchedulesResponse: + description: Response message for ScheduleService.ListSchedules + id: GoogleCloudAiplatformV1ListSchedulesResponse properties: - searchEntryPoint: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SearchEntryPoint' - description: Optional. Google search entry for the following-up web searches. - webSearchQueries: + nextPageToken: + type: string + description: >- + A token to retrieve the next page of results. Pass to + ListSchedulesRequest.page_token to obtain that page. + schedules: items: - type: string + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' + description: List of Schedules in the requested page. type: array - description: Optional. Web search queries for the following-up web search. - id: GoogleCloudAiplatformV1GroundingMetadata type: object - description: Metadata returned to client when grounding is enabled. - GoogleCloudAiplatformV1FractionSplit: + GoogleIamV1Binding: + id: GoogleIamV1Binding properties: - trainingFraction: - format: double - description: >- - The fraction of the input data that is to be used to train the - Model. - type: number - testFraction: - format: double - type: number + role: + type: string description: >- - The fraction of the input data that is to be used to evaluate the - Model. - validationFraction: - format: double - type: number - description: >- - The fraction of the input data that is to be used to validate the - Model. - id: 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. - type: object - GoogleCloudAiplatformV1MergeVersionAliasesRequest: - properties: - versionAliases: - items: - type: string - 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. - id: GoogleCloudAiplatformV1MergeVersionAliasesRequest - description: Request message for ModelService.MergeVersionAliases. - type: object - GoogleIamV1Binding: - description: Associates `members`, or principals, with a `role`. - 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: + 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 @@ -9957,8 +10294,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/GoogleTypeExpr' members: + items: + type: string description: >- Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A @@ -10018,3993 +10356,3670 @@ 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`. - items: - type: string type: array + description: Associates `members`, or principals, with a `role`. type: object - GoogleCloudAiplatformV1CustomJobSpec: - id: GoogleCloudAiplatformV1CustomJobSpec + GoogleCloudAiplatformV1SearchDataItemsResponse: + id: GoogleCloudAiplatformV1SearchDataItemsResponse + type: object + description: Response message for DatasetService.SearchDataItems. properties: - protectedArtifactLocationId: + nextPageToken: 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 + A token to retrieve next page of results. Pass to + SearchDataItemsRequest.page_token to obtain that page. type: string - experiment: + dataItemViews: + type: array + description: The DataItemViews read. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataItemView' + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata: + properties: + evaluatedDataItemsBigqueryUri: type: string + description: BigQuery destination uri for exported evaluated examples. + trainCostMilliNodeHours: + format: int64 description: >- - Optional. The Experiment associated with this job. Format: - `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}` - scheduling: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Scheduling' - description: Scheduling options for a CustomJob. - baseOutputDirectory: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + 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 + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata + type: object + description: Model metadata specific to TFT Forecasting. + GoogleCloudAiplatformV1FunctionDeclaration: + id: GoogleCloudAiplatformV1FunctionDeclaration + properties: + parameters: 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/` - enableWebAccess: - type: boolean + 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' + description: 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). - reservedIpRanges: - type: array + Optional. Description and purpose of the function. Model uses it to + decide how and whether to call the function. + type: string + name: + type: string 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']. + 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: object + 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. + GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest: + description: >- + Request message for + FeaturestoreOnlineServingService.StreamingFeatureValuesRead. + id: GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest + type: object + properties: + featureSelector: + description: >- + Required. Selector choosing Features of the target EntityType. + Feature IDs will be deduplicated. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' + entityIds: items: type: string - 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 - 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: + 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 - items: - type: string + GoogleCloudAiplatformV1ExportFeatureValuesResponse: + type: object + properties: {} + id: GoogleCloudAiplatformV1ExportFeatureValuesResponse + description: Response message for FeaturestoreService.ExportFeatureValues. + GoogleCloudAiplatformV1FeaturestoreMonitoringConfig: + properties: + importFeaturesAnalysis: + description: The config for ImportFeatures Analysis Based Feature Monitoring. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis + snapshotAnalysis: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigSnapshotAnalysis + description: The config for Snapshot Analysis Based Feature Monitoring. + categoricalThresholdConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig 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. - enableDashboardAccess: - type: boolean + 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: >- - 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). - tensorboard: - type: string + 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 + type: object + description: Configuration of how features in Featurestore are monitored. + id: GoogleCloudAiplatformV1FeaturestoreMonitoringConfig + GoogleCloudAiplatformV1NearestNeighborQueryParameters: + type: object + properties: + approximateNeighborCandidates: + format: int32 + type: integer 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}` - serviceAccount: + Optional. The number of neighbors to find via approximate search + before exact reordering is performed; if set, this value must be > + neighbor_count. + leafNodesSearchFraction: + format: double + 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. + type: number + id: GoogleCloudAiplatformV1NearestNeighborQueryParameters + description: >- + Parameters that can be overrided in each query to tune query latency and + recall. + GoogleCloudAiplatformV1CancelTuningJobRequest: + properties: {} + id: GoogleCloudAiplatformV1CancelTuningJobRequest + type: object + description: Request message for GenAiTuningService.CancelTuningJob. + GoogleCloudAiplatformV1Dataset: + properties: + metadataArtifact: + readOnly: true type: string 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. - persistentResourceId: + 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}`. + encryptionSpec: 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. - type: string - network: + 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' + name: type: string - 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. - description: Represents the spec of a CustomJob. - type: object - GoogleCloudAiplatformV1TensorboardRun: - description: >- - TensorboardRun maps to a specific execution of a training job with a - given set of hyperparameter values, model definition, dataset, etc - properties: + readOnly: true + description: Output only. The resource name of the Dataset. description: type: string - description: Description of this TensorboardRun. - displayName: + description: The description of the Dataset. + metadataSchemaUri: 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: - format: google-datetime - description: Output only. Timestamp when this TensorboardRun was created. + 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 - readOnly: true etag: - description: >- - Used to perform a consistent read-modify-write updates. If not set, - a blind "overwrite" update happens. type: string - updateTime: - format: google-datetime + description: >- + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. + dataItemCount: type: string + format: int64 readOnly: true - description: Output only. Timestamp when this TensorboardRun was last updated. - name: + description: >- + Output only. The number of DataItems in this Dataset. Only apply for + non-structured Dataset. + savedQueries: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SavedQuery' + 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. + displayName: type: string - readOnly: true description: >- - Output only. Name of the TensorboardRun. Format: - `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` + 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. labels: 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. type: object + metadata: + type: any + description: Required. Additional information about the Dataset. + modelReference: 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. - id: GoogleCloudAiplatformV1TensorboardRun - type: object - GoogleCloudAiplatformV1MigratableResource: - properties: - automlDataset: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigratableResourceAutomlDataset - description: Output only. Represents one Dataset in automl.googleapis.com. - readOnly: true - lastUpdateTime: + Optional. Reference to the public base model last used by the + dataset. Only set for prompt datasets. + type: string + createTime: readOnly: true format: google-datetime + description: Output only. Timestamp when this Dataset was created. type: string - description: >- - Output only. Timestamp when this MigratableResource was last - updated. - lastMigrateTime: + updateTime: + readOnly: true + description: Output only. Timestamp when this Dataset was last updated. format: google-datetime 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. - mlEngineModelVersion: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion - description: Output only. Represents one Version in ml.googleapis.com. - dataLabelingDataset: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset - description: Output only. Represents one Dataset in datalabeling.googleapis.com. - automlModel: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigratableResourceAutomlModel - description: Output only. Represents one Model in automl.googleapis.com. - readOnly: true + description: A collection of DataItems and Annotations on them. + id: GoogleCloudAiplatformV1Dataset type: object - id: GoogleCloudAiplatformV1MigratableResource - description: >- - Represents one resource that exists in automl.googleapis.com, - datalabeling.googleapis.com or ml.googleapis.com. - GoogleCloudAiplatformV1ListSchedulesResponse: - id: GoogleCloudAiplatformV1ListSchedulesResponse - description: Response message for ScheduleService.ListSchedules + GoogleCloudAiplatformV1WriteFeatureValuesPayload: type: object properties: - nextPageToken: + featureValues: + type: object description: >- - A token to retrieve the next page of results. Pass to - ListSchedulesRequest.page_token to obtain that page. + 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. + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' + entityId: + description: Required. The ID of the entity. type: string - schedules: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' - description: List of Schedules in the requested page. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassification: + id: GoogleCloudAiplatformV1WriteFeatureValuesPayload + description: Contains Feature values to be written for a specific entity. + GoogleCloudAiplatformV1WriteTensorboardRunDataResponse: type: object + description: Response message for TensorboardService.WriteTensorboardRunData. + id: GoogleCloudAiplatformV1WriteTensorboardRunDataResponse + properties: {} + GoogleCloudAiplatformV1UpdateModelDeploymentMonitoringJobOperationMetadata: description: >- - A TrainingJob that trains and uploads an AutoML Video Classification - Model. - properties: - inputs: - description: The input parameters of this TrainingJob. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs + Runtime operation information for + JobService.UpdateModelDeploymentMonitoringJob. id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassification - GoogleCloudAiplatformV1CancelNasJobRequest: + GoogleCloudAiplatformV1UpdateModelDeploymentMonitoringJobOperationMetadata type: object - description: Request message for JobService.CancelNasJob. - id: GoogleCloudAiplatformV1CancelNasJobRequest - properties: {} - GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair: properties: - name: - type: string - description: Feature short name. - value: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' - description: Feature value. - description: Feature name & value pair. - id: >- - GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. + GoogleCloudLocationLocation: + id: GoogleCloudLocationLocation type: object - GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig: - id: GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig + description: A resource that represents a Google Cloud location. properties: - keyField: + displayName: 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 - includedFields: - type: array - items: - type: string + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + type: string + locationId: + type: string + description: 'The canonical id for this location. For example: `"us-east1"`.' + name: + 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. - excludedFields: - items: - type: string + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + labels: + type: object 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. - type: array - instanceType: + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + additionalProperties: + type: string + metadata: 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. + 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 + GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig: + description: >- + Config for migrating AnnotatedDataset in datalabeling.googleapis.com to + Vertex AI's SavedQuery. + properties: + annotatedDataset: type: string + description: >- + Required. Full resource name of data labeling AnnotatedDataset. + Format: + `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`. + id: >- + GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig type: object - description: >- - Configuration defining how to transform batch prediction input instances - to the instances that the Model accepts. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata: + GoogleCloudAiplatformV1SuggestTrialsResponse: + type: object + description: Response message for VizierService.SuggestTrials. + id: GoogleCloudAiplatformV1SuggestTrialsResponse properties: - successfulStopReason: + trials: + description: A list of Trials. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + studyState: + enum: + - STATE_UNSPECIFIED + - ACTIVE + - INACTIVE + - COMPLETED + description: The state of the Study. type: string enumDescriptions: - - Should not be set. - - The inputs.budgetMilliNodeHours had been reached. + - The study state is unspecified. + - The study is active. + - The study is stopped due to an internal error. - >- - 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. - 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. + The study is done when the service exhausts the parameter search + space or max_trial_count is reached. + startTime: type: string - format: int64 + description: The time at which the operation was started. + format: google-datetime + endTime: + type: string + description: The time at which operation processing completed. + format: google-datetime + GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata: + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for PersistentResource. + progressMessage: + description: Progress Message for Update LRO + type: string + id: GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata + description: Details of operations that perform update PersistentResource. type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata - GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse: - description: >- - Response message for - TensorboardService.BatchReadTensorboardTimeSeriesData. + GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest: type: object + id: GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest properties: - timeSeriesData: - description: The returned time series data. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesData' + requests: type: array - id: GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse - GoogleCloudAiplatformV1DeployedIndex: - description: >- - A deployment of an Index. IndexEndpoints contain one or more - DeployedIndexes. - type: object - properties: - reservedIpRanges: 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. + Required. The request message specifying the TensorboardTimeSeries + to create. A maximum of 1000 TensorboardTimeSeries can be created in + a batch. items: - type: string - type: array - enableAccessLogging: - 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. - displayName: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest + description: Request message for TensorboardService.BatchCreateTensorboardTimeSeries. + GoogleCloudAiplatformV1VideoMetadata: + properties: + startOffset: + description: Optional. The start offset of the video. + format: google-duration + type: string + endOffset: + format: google-duration type: string + description: Optional. The end offset of the video. + type: object + id: GoogleCloudAiplatformV1VideoMetadata + description: Metadata describes the input video content. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics: + description: Metrics for general pairwise text generation evaluation results. + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics + properties: + modelWinRate: + format: float description: >- - The display name of the DeployedIndex. If not provided upon - creation, the Index's display_name is used. - privateEndpoints: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexPrivateEndpoints' + Percentage of time the autorater decided the model had the better + response. + type: number + falseNegativeCount: + type: string + format: int64 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 - indexSyncTime: - readOnly: true + Number of examples where the autorater chose the baseline model, but + humans preferred the model. + accuracy: + description: Fraction of cases where the autorater agreed with the human raters. + type: number + format: float + recall: + type: number 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 - dedicatedResources: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' + 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 + f1Score: + format: float + description: Harmonic mean of precision and recall. + type: number + baselineModelWinRate: 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. - id: + Percentage of time the autorater decided the baseline model had the + better response. + type: number + format: float + truePositiveCount: 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. + Number of examples where both the autorater and humans decided that + the model had the better response. + format: int64 type: string - automaticResources: + cohensKappa: + format: float + type: number 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' - createTime: + A measurement of agreement between the autorater and human raters + that takes the likelihood of random agreement into account. + falsePositiveCount: type: string - description: Output only. Timestamp when the DeployedIndex was created. - readOnly: true - format: google-datetime - deployedIndexAuthConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndexAuthConfig' description: >- - Optional. If set, the authentication is enabled for the private - endpoint. - index: + Number of examples where the autorater chose the model, but humans + preferred the baseline model. + format: int64 + trueNegativeCount: description: >- - Required. The name of the Index this is the deployment of. We may - refer to this Index as the DeployedIndex's "original" Index. + Number of examples where both the autorater and humans decided that + the model had the worse response. + format: int64 type: string - deploymentGroup: + humanPreferenceBaselineModelWinRate: + format: float 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 - id: GoogleCloudAiplatformV1DeployedIndex - GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadata: - id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadata + Percentage of time humans decided the baseline model had the better + response. + type: number + humanPreferenceModelWinRate: + format: float + description: Percentage of time humans decided the model had the better response. + type: number + precision: + 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 autorater thought + the model had a better response. True positive divided by all + positive. type: object - description: The metadata of Datasets that contain time series data. + CloudAiLargeModelsVisionVideo: + id: CloudAiLargeModelsVisionVideo properties: - timeColumn: + video: + format: byte + description: Raw bytes. type: string - description: >- - The column name of the time column that identifies time order in the - time series. - timeSeriesIdentifierColumn: + uri: + description: Path to another storage (typically Google Cloud Storage). type: string - description: >- - The column name of the time series identifier column that identifies - the time series. - inputConfig: + description: Video + type: object + GoogleCloudAiplatformV1DeleteFeatureValuesResponse: + description: Response message for FeaturestoreService.DeleteFeatureValues. + id: GoogleCloudAiplatformV1DeleteFeatureValuesResponse + properties: + selectTimeRangeAndFeature: + description: Response for request specifying time range and feature $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig - GoogleCloudAiplatformV1SchemaPredictInstanceVideoClassificationPredictionInstance: + #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature + selectEntity: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity + description: Response for request specifying the entities to delete + type: object + GoogleCloudAiplatformV1Blob: + type: object properties: + data: + description: Required. Raw bytes. + type: string + format: byte mimeType: type: string - description: >- - The MIME type of the content of the video. Only the following are - supported: video/mp4 video/avi video/quicktime - timeSegmentStart: + description: Required. The IANA standard MIME type of the source data. + description: >- + Content blob. It's preferred to send as text directly rather than raw + bytes. + id: GoogleCloudAiplatformV1Blob + GoogleCloudAiplatformV1LargeModelReference: + description: Contains information about the Large Model. + type: object + properties: + name: 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: + 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. + id: GoogleCloudAiplatformV1LargeModelReference + GoogleCloudAiplatformV1FeatureViewIndexConfigTreeAHConfig: + 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. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata: + type: object + properties: + backingHyperparameterTuningJob: description: >- - The Google Cloud Storage location of the video on which to perform - the prediction. - timeSegmentEnd: + The resource name of the HyperparameterTuningJob that has been + created to carry out this HyperparameterTuning task. + type: string + bestTrialBackingCustomJob: type: string 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 resource name of the CustomJob that has been created to run the + best Trial of this HyperparameterTuning task. id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceVideoClassificationPredictionInstance - description: Prediction input format for Video Classification. - type: object - GoogleCloudAiplatformV1SavedQuery: + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata + GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail: + id: GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail type: object properties: - createTime: - description: Output only. Timestamp when this SavedQuery was created. - format: google-datetime - readOnly: true - type: string - supportAutomlTraining: - type: boolean + failedJobs: + type: array description: >- - Output only. If the Annotations belonging to the SavedQuery can be - used for AutoML training. + Output only. The names of the previously failed CustomJob. The list + includes the all attempts in chronological order. readOnly: true - metadata: - description: Some additional information about the SavedQuery. - type: any - updateTime: + items: + type: string + job: + description: Output only. The name of the CustomJob. readOnly: true - description: Output only. Timestamp when SavedQuery was last updated. - format: google-datetime type: string - name: - type: string - readOnly: true - description: Output only. Resource name of the SavedQuery. - annotationSpecCount: + description: The detailed info for a custom job executor. + GoogleCloudAiplatformV1ImportDataConfig: + type: object + id: GoogleCloudAiplatformV1ImportDataConfig + properties: + annotationLabels: + additionalProperties: + type: string description: >- - Output only. Number of AnnotationSpecs in the context of the - SavedQuery. - readOnly: true - type: integer - format: int32 - annotationFilter: - description: Output only. Filters on the Annotations in the dataset. - type: string - readOnly: true - etag: + 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. + type: object + gcsSource: + description: The Google Cloud Storage location for the input content. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' + importSchemaUri: type: string description: >- - Used to perform a consistent read-modify-write update. If not set, a - blind "overwrite" update happens. - problemType: - 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 - type: string - displayName: + 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: >- - 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 + 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. description: >- - A SavedQuery is a view of the dataset. It references a subset of - annotations by problem type and filters. - id: GoogleCloudAiplatformV1SavedQuery - GoogleCloudAiplatformV1FeatureViewSync: + 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. + GoogleCloudAiplatformV1DatasetVersion: type: object + id: GoogleCloudAiplatformV1DatasetVersion properties: - createTime: - format: google-datetime + metadata: + type: any readOnly: true + description: >- + Required. Output only. Additional information about the + DatasetVersion. + etag: + description: >- + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. type: string + modelReference: 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. - finalStatus: - $ref: '#/components/schemas/GoogleRpcStatus' + 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. Final status of the FeatureViewSync. - syncSummary: - description: Output only. Summary of the sync job. + bigQueryDatasetName: + description: Output only. Name of the associated BigQuery dataset. readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureViewSyncSyncSummary - name: - 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: + name: readOnly: true - description: Output only. Time when this FeatureViewSync is finished. - $ref: '#/components/schemas/GoogleTypeInterval' - id: GoogleCloudAiplatformV1FeatureViewSync - description: >- - FeatureViewSync is a representation of sync operation which copies data - from data source to Feature View in Online Store. - GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData: - description: Per user usage data. - id: GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData - properties: - viewCount: - format: int64 - description: Number of times the user has read data within the Tensorboard. + description: Output only. The resource name of the DatasetVersion. type: string - username: + displayName: type: string - description: User's username - type: object - GoogleCloudAiplatformV1SearchDataItemsResponse: - type: object - description: Response message for DatasetService.SearchDataItems. - properties: - dataItemViews: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataItemView' - description: The DataItemViews read. - type: array - nextPageToken: description: >- - A token to retrieve next page of results. Pass to - SearchDataItemsRequest.page_token to obtain that page. - type: string - id: GoogleCloudAiplatformV1SearchDataItemsResponse - GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata: - properties: - maxStep: + The user-defined name of the DatasetVersion. The name can be up to + 128 characters long and can consist of any UTF-8 characters. + createTime: type: string - description: >- - Output only. Max step index of all data points within a - TensorboardTimeSeries. + description: Output only. Timestamp when this DatasetVersion was created. readOnly: true - format: int64 - maxBlobSequenceLength: - 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. + format: google-datetime + updateTime: readOnly: true + description: Output only. Timestamp when this DatasetVersion was last updated. type: string - maxWallTime: + format: google-datetime + description: Describes the dataset version. + GoogleCloudAiplatformV1FeatureValueMetadata: + properties: + generateTime: format: google-datetime type: string - readOnly: true description: >- - Output only. Max wall clock timestamp of all data points within a - TensorboardTimeSeries. - id: GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata - description: Describes metadata for a TensorboardTimeSeries. + 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. + id: GoogleCloudAiplatformV1FeatureValueMetadata type: object - GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity: + description: Metadata of feature value. + GoogleCloudAiplatformV1ReinforcementLearningDataStats: type: object - id: GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity - description: Response message if the request uses the SelectEntity option. + id: GoogleCloudAiplatformV1ReinforcementLearningDataStats properties: - onlineStorageDeletedEntityCount: - type: string - format: int64 + preferenceDatasetStats: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetStats' description: >- - The count of deleted entities in the online storage. Each entity ID - corresponds to one entity. - offlineStorageDeletedEntityRowCount: - type: string - format: int64 + Output only. Statistics computed for the preference dataset. This + can be either a human preference dataset or a preference dataset + generated from AI feedback. + readOnly: true + promptDatasetStats: 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. - GoogleCloudAiplatformV1PredictResponse: - type: object + Output only. Statistics computed for the prompt dataset used during + reinforcement learning. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetStats' + readOnly: true + description: Statistics computed for datasets used for reinforcement learning. + GoogleCloudAiplatformV1SchemaPredictPredictionVideoClassificationPredictionResult: properties: - modelDisplayName: + timeSegmentEnd: type: string - readOnly: true + format: google-duration description: >- - Output only. The display name of the Model which is deployed as the - DeployedModel that this prediction hits. - model: + 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. + 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 + type: description: >- - Output only. The resource name of the Model which is deployed as the - DeployedModel that this prediction hits. - readOnly: true - metadata: + 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: + type: number description: >- - Output only. Request-level metadata returned by the model. The - metadata type will be dependent upon the model implementation. - type: any - readOnly: true - deployedModelId: + The Model's confidence in correction of this prediction, higher + value means higher confidence. + format: float + displayName: type: string - description: ID of the Endpoint's DeployedModel that served this prediction. - modelVersionId: + description: The display name of the AnnotationSpec that had been identified. + id: type: string - readOnly: true - description: >- - Output only. The version ID of the Model which is deployed as the - DeployedModel that this prediction hits. - predictions: + description: The resource ID of the AnnotationSpec that had been identified. + description: Prediction output format for Video Classification. + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionVideoClassificationPredictionResult + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTracking: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTracking + properties: + inputs: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs + description: The input parameters of this TrainingJob. + type: object + description: >- + A TrainingJob that trains and uploads an AutoML Video ObjectTracking + Model. + GoogleCloudAiplatformV1PipelineTaskDetailArtifactList: + id: GoogleCloudAiplatformV1PipelineTaskDetailArtifactList + properties: + artifacts: + description: Output only. A list of artifact metadata. type: array - 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 - id: GoogleCloudAiplatformV1PredictResponse - description: Response message for PredictionService.Predict. - GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + readOnly: true + description: A list of artifact metadata. + type: object + GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation: + description: Represents a polyline in image. properties: - parts: - items: - type: string + vertexes: description: >- - Parts to construct Entity ID. Should match with the same ID columns - as defined in FeatureView in the same order. + 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 + 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 + id: >- + GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation type: object - description: ID that is comprised from several parts (columns). - id: GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey - GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail: + GoogleCloudAiplatformV1FeatureValue: type: object - id: GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail properties: - 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. - readOnly: true + structValue: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StructValue' + description: A struct type feature value. + bytesValue: + type: string + description: Bytes feature value. + format: byte + doubleArrayValue: + description: A list of double type feature value. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DoubleArray' + int64Value: + format: int64 + description: Int64 feature value. + type: string + metadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueMetadata' + description: Metadata of feature value. + stringArrayValue: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StringArray' + description: A list of string type feature value. + doubleValue: + format: double + type: number + description: Double type feature value. + int64ArrayValue: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Int64Array' + description: A list of int64 type feature value. + stringValue: + type: string + description: String feature value. + boolValue: + description: Bool type feature value. + type: boolean + boolArrayValue: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BoolArray' + description: A list of bool type feature value. + description: Value for a feature. + id: GoogleCloudAiplatformV1FeatureValue + GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest: + properties: + artifacts: items: type: string type: array - preCachingCheckJob: - readOnly: true - type: string - 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. - mainJob: - type: string - description: >- - Output only. The name of the CustomJob for the main container - execution. - readOnly: true - failedMainJobs: - 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. + The resource names of the Artifacts to attribute to the Context. + Format: + `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` + executions: items: type: string type: array - description: >- - The detail of a container execution. It contains the job names of the - lifecycle of a container execution. - GoogleCloudAiplatformV1SearchFeaturesResponse: + description: >- + The resource names of the Executions to associate with the Context. + Format: + `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` + description: Request message for MetadataService.AddContextArtifactsAndExecutions. + id: GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest type: object + GoogleCloudAiplatformV1PrivateServiceConnectConfig: properties: - features: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' - description: >- - The Features matching the request. Fields returned: * `name` * - `description` * `labels` * `create_time` * `update_time` + projectAllowlist: 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. - type: string - description: Response message for FeaturestoreService.SearchFeatures. - id: GoogleCloudAiplatformV1SearchFeaturesResponse - GoogleCloudAiplatformV1GenieSource: - 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. + A list of Projects from which the forwarding rule will target the + service attachment. + items: + type: string + enablePrivateServiceConnect: + type: boolean + description: >- + Required. If true, expose the IndexEndpoint via private service + connect. + description: Represents configuration for private service connect. type: object - id: GoogleCloudAiplatformV1GenieSource - GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor: - id: GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor + id: GoogleCloudAiplatformV1PrivateServiceConnectConfig + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata: type: object + description: Model metadata specific to AutoML Tables. + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata properties: - id: + evaluatedDataItemsBigqueryUri: type: string - description: Feature ID. - description: Metadata for requested Features. - GoogleCloudAiplatformV1PscAutomatedEndpoints: + description: BigQuery destination uri for exported evaluated examples. + 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 + GoogleCloudAiplatformV1TrialParameter: + description: A message representing a parameter to be tuned. + id: GoogleCloudAiplatformV1TrialParameter type: object - id: GoogleCloudAiplatformV1PscAutomatedEndpoints - description: >- - PscAutomatedEndpoints defines the output of the forwarding rule - automatically created by each PscAutomationConfig. properties: - matchAddress: - type: string - description: Ip Address created by the automated forwarding rule. - network: - type: string - description: Corresponding network in pscAutomationConfigs. - projectId: + value: + 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 + parameterId: + description: >- + Output only. The ID of the parameter. The parameter should be + defined in StudySpec's Parameters. + readOnly: true type: string - description: Corresponding project_id in pscAutomationConfigs - GoogleCloudAiplatformV1PublisherModelResourceReference: - description: Reference to a resource. + GoogleCloudAiplatformV1ReadIndexDatapointsResponse: type: object - id: GoogleCloudAiplatformV1PublisherModelResourceReference properties: - description: - description: Description of the resource. - deprecated: true - type: string - resourceName: - type: string - description: The resource name of the Google Cloud resource. - uri: - type: string - description: The URI of the resource. - useCase: - deprecated: true + datapoints: + type: array + description: The result list of datapoints. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' + id: GoogleCloudAiplatformV1ReadIndexDatapointsResponse + description: The response message for MatchService.ReadIndexDatapoints. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation + properties: + columnName: type: string - description: Use case (CUJ) of the resource. - GoogleCloudAiplatformV1DataItem: description: >- - A piece of data in a Dataset. Could be an image, a video, a document or - plain text. + 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 + GoogleCloudAiplatformV1BatchCreateFeaturesOperationMetadata: + description: Details of operations that perform batch create Features. properties: - createTime: - description: Output only. Timestamp when this DataItem was created. - readOnly: true + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for Feature. + type: object + id: GoogleCloudAiplatformV1BatchCreateFeaturesOperationMetadata + GoogleCloudAiplatformV1StudyTimeConstraint: + description: Time-based Constraint for Study + id: GoogleCloudAiplatformV1StudyTimeConstraint + properties: + maxDuration: + description: Counts the wallclock time passed since the creation of this Study. type: string + format: google-duration + endTime: format: google-datetime - labels: + description: Compares the wallclock time to this time. Must use UTC timezone. + type: string + type: object + GoogleCloudAiplatformV1FetchFeatureValuesResponse: + id: GoogleCloudAiplatformV1FetchFeatureValuesResponse + properties: + protoStruct: type: object + description: Feature values in proto Struct format. additionalProperties: - type: string - 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. - etag: - description: >- - Optional. Used to perform consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. - type: string - name: - type: string - description: Output only. The resource name of the DataItem. - readOnly: true - payload: - type: any + description: Properties of the object. + type: any + dataKey: 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. - updateTime: - readOnly: true - type: string - format: google-datetime - description: Output only. Timestamp when this DataItem was last updated. - id: GoogleCloudAiplatformV1DataItem - GoogleCloudAiplatformV1DeployModelResponse: - properties: - deployedModel: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' - description: The DeployedModel that had been deployed in the Endpoint. - id: GoogleCloudAiplatformV1DeployModelResponse + The data key associated with this response. Will only be populated + for FeatureOnlineStoreService.StreamingFetchFeatureValues RPCs. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewDataKey' + keyValues: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList + description: Feature values in KeyValue format. type: object - description: Response message for EndpointService.DeployModel. - GoogleCloudAiplatformV1DestinationFeatureSetting: + description: Response message for FeatureOnlineStoreService.FetchFeatureValues + GoogleCloudAiplatformV1ImportModelEvaluationRequest: type: object + description: Request message for ModelService.ImportModelEvaluation properties: - featureId: - description: Required. The ID of the Feature to apply the setting to. + modelEvaluation: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' + description: Required. Model evaluation resource to be imported. + id: GoogleCloudAiplatformV1ImportModelEvaluationRequest + GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec: + description: The min/max number of replicas allowed if enabling autoscaling + type: object + id: GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec + properties: + maxReplicaCount: + format: int64 + description: >- + Optional. max replicas in the node pool, must be ≥ replica_count and + > min_replica_count or will throw error type: string - destinationField: + minReplicaCount: description: >- - Specify the field name in the export destination. If not specified, - Feature ID is used. + Optional. min replicas in the node pool, must be ≤ replica_count and + < max_replica_count or will throw error + format: int64 type: string - id: GoogleCloudAiplatformV1DestinationFeatureSetting - GoogleCloudAiplatformV1ManualBatchTuningParameters: - description: Manual batch tuning parameters. - type: object + GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse: properties: - batchSize: - type: integer + 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. - format: int32 - id: GoogleCloudAiplatformV1ManualBatchTuningParameters - GoogleCloudAiplatformV1CreateEndpointOperationMetadata: - type: object - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - description: Runtime operation information for EndpointService.CreateEndpoint. - id: GoogleCloudAiplatformV1CreateEndpointOperationMetadata - GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest: - description: Request message for ModelService.BatchImportEvaluatedAnnotations - properties: - evaluatedAnnotations: - 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 + timeSeriesDataPoints: + description: The returned time series data points. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EvaluatedAnnotation' - description: Required. Evaluated annotations resource to be imported. + $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesDataPoint' + type: array + description: Response message for TensorboardService.ExportTensorboardTimeSeriesData. type: object - id: GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest - GoogleCloudAiplatformV1SchemaTextPromptDatasetMetadata: - description: The metadata of Datasets that contain Text Prompt data. + id: GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig: type: object properties: - text: - type: string - description: The content of the prompt dataset. - topP: - format: float + defaultDriftThreshold: 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 - maxOutputTokens: + 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' + attributionScoreDriftThresholds: + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' description: >- - Value of the maximum number of tokens generated set when the dataset - was saved. - format: int64 - type: string - stopSequences: - items: - type: string - description: Customized stop sequences. - type: array - candidateCount: - format: int64 - type: string - description: Number of candidates. - groundingConfig: - description: Grounding checking configuration. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig - hasPromptVariable: - description: Whether the prompt dataset has prompt variable. - type: boolean - gcsUri: - description: The Google Cloud Storage URI that stores the prompt data. - type: string - promptType: - type: string - description: Type of the prompt dataset. - note: - type: string - description: User-created prompt note. Note size limit is 2KB. - systemInstruction: - type: string - description: The content of the prompt dataset system instruction. - systemInstructionGcsUri: - 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 + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' description: >- - The Google Cloud Storage URI that stores the system instruction, - starting with gs://. - temperature: + 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. + id: >- + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig + description: The config for Prediction data drift detection. + GoogleCloudAiplatformV1CsvSource: + id: GoogleCloudAiplatformV1CsvSource + description: The storage details for CSV input content. + properties: + gcsSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' + description: Required. Google Cloud Storage location. + type: object + GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics: + description: Metrics for a single confidence threshold. + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics + properties: + precision: type: number - description: >- - Temperature value used for sampling set when the dataset was saved. - This value is used to tune the degree of randomness. + description: Precision under the given confidence threshold. format: float - topK: - 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 - id: GoogleCloudAiplatformV1SchemaTextPromptDatasetMetadata - GoogleCloudAiplatformV1ListAnnotationsResponse: + f1Score: + format: float + description: The harmonic mean of recall and precision. + type: number + confidenceThreshold: + description: The confidence threshold value used to compute the metrics. + format: float + type: number + recall: + format: float + type: number + description: Recall under the given confidence threshold. + type: object + GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata: + id: GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata + type: object + description: Details of operations that perform create PersistentResource. properties: - nextPageToken: - description: The standard List next-page token. + progressMessage: type: string - annotations: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Annotation' - description: >- - A list of Annotations that matches the specified filter in the - request. - description: Response message for DatasetService.ListAnnotations. - id: GoogleCloudAiplatformV1ListAnnotationsResponse - type: object - GoogleCloudAiplatformV1ModelExportFormat: - id: GoogleCloudAiplatformV1ModelExportFormat + description: Progress Message for Create LRO + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for PersistentResource. + GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesResponse: + description: Response message for ModelService.BatchImportModelEvaluationSlices properties: - exportableContents: + importedModelEvaluationSlices: 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. - type: array readOnly: true - description: Output only. The content of this Model that may be exported. - id: - readOnly: true - type: string - 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. - description: >- - Represents export format supported by the Model. All formats export to - Google Cloud Storage. + description: Output only. List of imported ModelEvaluationSlice.name. + type: array type: object - GoogleCloudAiplatformV1PipelineTaskDetail: - id: GoogleCloudAiplatformV1PipelineTaskDetail + id: GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesResponse + GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse: properties: - pipelineTaskStatus: - description: >- - Output only. A list of task status. This field keeps a record of - task status evolving over time. - readOnly: true + featureOnlineStores: + description: The FeatureOnlineStores matching the request. items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' type: array - inputs: - type: object - description: Output only. The runtime input artifacts of the task. - readOnly: true - 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. - $ref: '#/components/schemas/GoogleRpcStatus' - readOnly: true - taskId: - type: string - format: int64 - description: Output only. The system generated ID of the task. - readOnly: true - executorDetail: - readOnly: true - description: Output only. The detailed execution info. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PipelineTaskExecutorDetail - createTime: - format: google-datetime - readOnly: true - description: Output only. Task create time. - type: string - state: - enum: - - STATE_UNSPECIFIED - - PENDING - - RUNNING - - SUCCEEDED - - CANCEL_PENDING - - CANCELLING - - CANCELLED - - FAILED - - SKIPPED - - NOT_TRIGGERED - readOnly: true - type: string - 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. - endTime: - type: string - readOnly: true - description: Output only. Task end time. - format: google-datetime - parentTaskId: - type: string + nextPageToken: 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 - format: int64 - startTime: - description: Output only. Task start time. - type: string - readOnly: true - format: google-datetime - execution: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' - description: Output only. The execution metadata of the task. - readOnly: true - taskName: - readOnly: true + 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: >- - Output only. The user specified name of the task that is defined in - pipeline_spec. - outputs: - readOnly: true - description: Output only. The runtime output artifacts of the task. - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetailArtifactList - type: object - type: object - description: The runtime detail of a task execution. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassification: - properties: - inputs: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs - description: The input parameters of this TrainingJob. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassification type: object description: >- - A TrainingJob that trains and uploads an AutoML Text Classification - Model. - GoogleCloudAiplatformV1Execution: + Response message for + FeatureOnlineStoreAdminService.ListFeatureOnlineStores. + id: GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse + GoogleCloudAiplatformV1ImportFeatureValuesRequest: properties: - name: - description: Output only. The resource name of the Execution. - type: string - readOnly: true - description: - type: string - description: Description of the Execution - updateTime: - format: google-datetime - readOnly: true + avroSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1AvroSource' + featureTimeField: + description: >- + Source column that holds the Feature timestamp for all Feature + values in each entity. type: string - description: Output only. Timestamp when this Execution was last updated. - schemaTitle: + entityIdField: + description: >- + Source column that holds entity IDs. If not provided, entity IDs are + extracted from the column named entity_id. type: string + disableOnlineServing: + type: boolean 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. - createTime: - description: Output only. Timestamp when this Execution was created. + 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. + disableIngestionAnalysis: + description: If true, API doesn't start ingestion analysis pipeline. + type: boolean + featureTime: + description: >- + Single Feature timestamp for all entities being imported. The + timestamp must not have higher than millisecond precision. format: google-datetime type: string - readOnly: true - metadata: + bigquerySource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' + csvSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvSource' + workerCount: + type: integer 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. - displayName: + 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. + format: int32 + featureSpecs: description: >- - User provided display name of the Execution. May be up to 128 - Unicode characters. + 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 + type: object + description: Request message for FeaturestoreService.ImportFeatureValues. + GoogleCloudAiplatformV1SchemaPredictionResultError: + properties: + message: + description: Error message with additional details. type: string - etag: + status: type: string description: >- - An eTag 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 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). - type: object - 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. - type: string - state: + Error status. This will be serialized into the enum name e.g. + "NOT_FOUND". enum: - - STATE_UNSPECIFIED - - NEW - - RUNNING - - COMPLETE - - FAILED - - CACHED + - OK - CANCELLED - type: string + - 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 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. - id: GoogleCloudAiplatformV1Execution + - '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 - description: Instance of a general execution. - GoogleCloudAiplatformV1CreatePipelineJobRequest: - id: GoogleCloudAiplatformV1CreatePipelineJobRequest + id: GoogleCloudAiplatformV1SchemaPredictionResultError + 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: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation type: object properties: - parent: + columnName: type: string + 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: description: >- - 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' - pipelineJobId: - 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-/`. + A token to retrieve the next page of results. Pass to + ListBatchPredictionJobsRequest.page_token to obtain that page. type: string - description: Request message for PipelineService.CreatePipelineJob. - GoogleCloudAiplatformV1ExportModelOperationMetadata: + GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetrics: + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetrics + description: Metrics for image segmentation evaluation results. + type: object properties: - outputInfo: + confidenceMetricsEntries: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry description: >- - Output only. Information further describing the output of this Model - export. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The common part of the operation metadata. - id: GoogleCloudAiplatformV1ExportModelOperationMetadata + 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 + GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics: + properties: + meanAveragePrecision: + type: number + description: The mean average precision, most often close to `auPrc`. + format: float + iouThreshold: + format: float + type: number + description: >- + The intersection-over-union threshold value used to compute this + metrics entry. + 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. Precision-recall curve is + derived from them. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics type: object - description: Details of ModelService.ExportModel operation. - GoogleCloudAiplatformV1Scalar: - id: GoogleCloudAiplatformV1Scalar + id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics + description: >- + Bounding box matching model metrics for a single intersection-over-union + threshold and multiple label match confidence thresholds. + 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: - value: - description: Value of the point at this step / timestamp. + 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. + testFraction: + description: >- + The fraction of the input data that is to be used to evaluate the + Model. + type: number + format: double + validationFraction: + format: double + description: >- + The fraction of the input data that is to be used to validate the + Model. + type: number + trainingFraction: format: double type: number + description: >- + The fraction of the input data that is to be used to train the + Model. + id: GoogleCloudAiplatformV1StratifiedSplit type: object - description: One point viewable on a scalar metric plot. - GoogleCloudAiplatformV1BatchPredictionJobOutputConfig: + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs: type: object - id: 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: - predictionsFormat: + exportEvaluatedDataItemsConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig description: >- - Required. The format in which Vertex AI gives the predictions, must - be one of the Model's supported_output_storage_formats. + Configuration for exporting test set predictions to a BigQuery + table. If this configuration is absent, then the export is not + performed. + 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 - gcsDestination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + additionalExperiments: + type: array + description: Additional experiment flags for the Tables training pipeline. + items: + type: string + disableEarlyStopping: 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' + 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. + type: boolean + trainBudgetMilliNodeHours: + format: int64 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`. - GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource: - properties: - projectNumber: + 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 + optimizationObjective: description: >- - Optional. The project number of the parent project of the Feature - Groups. + 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). type: string - format: int64 - featureGroups: - description: Required. List of features that need to be synced to Online Store. + targetColumn: + type: string + description: The column name of the target column that the model is to predict. + optimizationObjectivePrecisionValue: + description: >- + Required when optimization_objective is + "maximize-recall-at-precision". Must be between 0 and 1, inclusive. + type: number + format: float + transformations: type: array items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup - type: object - id: GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource - description: >- - A Feature Registry source for features that need to be synced to Online - Store. - GoogleCloudAiplatformV1NotebookRuntime: - id: GoogleCloudAiplatformV1NotebookRuntime - properties: - serviceAccount: - readOnly: true - type: string + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation description: >- - Output only. The service account that the NotebookRuntime workload - runs as. - satisfiesPzs: - readOnly: true - description: Output only. Reserved for future use. - type: boolean - notebookRuntimeTemplateRef: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplateRef + 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. + optimizationObjectiveRecallValue: + type: number + format: float description: >- - Output only. The pointer to NotebookRuntimeTemplate this - NotebookRuntime is created from. - createTime: - description: Output only. Timestamp when this NotebookRuntime was created. - format: google-datetime + Required when optimization_objective is + "maximize-precision-at-recall". Must be between 0 and 1, inclusive. + 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 - readOnly: true - isUpgradable: - type: boolean - readOnly: true - description: Output only. Whether NotebookRuntime is upgradable. - proxyUri: - readOnly: true - description: Output only. The proxy endpoint used to access the NotebookRuntime. + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs + GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest: + properties: + tensorboardTimeSeriesId: type: string - healthState: - enum: - - HEALTH_STATE_UNSPECIFIED - - HEALTHY - - UNHEALTHY - description: Output only. The health state of the NotebookRuntime. + 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: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries' + description: Required. The TensorboardTimeSeries to create. + parent: + type: string + description: >- + Required. The resource name of the TensorboardRun to create the + TensorboardTimeSeries in. Format: + `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` + id: GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest + description: Request message for TensorboardService.CreateTensorboardTimeSeries. + type: object + GoogleCloudAiplatformV1Context: + description: Instance of a general context. + id: GoogleCloudAiplatformV1Context + properties: + 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. + type: array readOnly: true + schemaVersion: type: string - enumDescriptions: - - Unspecified health state. - - NotebookRuntime is in healthy state. Applies to ACTIVE state. - - NotebookRuntime is in unhealthy state. Applies to ACTIVE state. - description: + 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. + schemaTitle: + 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. type: string - description: The description of the NotebookRuntime. 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 - encryptionSpec: description: >- - Output only. Customer-managed encryption key spec for the notebook - runtime. + User provided display name of the Context. May be up to 128 Unicode + characters. + createTime: readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - satisfiesPzi: - readOnly: true - type: boolean - description: Output only. Reserved for future use. - 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: - type: string - type: array - runtimeState: - description: Output only. The runtime (instance) state of the NotebookRuntime. - 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. - type: string - readOnly: true - enum: - - RUNTIME_STATE_UNSPECIFIED - - RUNNING - - BEING_STARTED - - BEING_STOPPED - - STOPPED - - BEING_UPGRADED - - ERROR - - INVALID - expirationTime: - readOnly: true - 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. + description: Output only. Timestamp when this Context was created. type: string format: google-datetime 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. + 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 - notebookRuntimeType: - readOnly: true - description: Output only. The type of the notebook runtime. - type: string - 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. - runtimeUser: - description: Required. The user email of the NotebookRuntime. + description: type: string + description: Description of the Context updateTime: + readOnly: true + description: Output only. Timestamp when this Context was last updated. format: google-datetime + type: string + metadata: + additionalProperties: + description: Properties of the object. + type: any description: >- - Output only. Timestamp when this NotebookRuntime was most recently - updated. - readOnly: true + Properties of the Context. Top level metadata keys' heading and + trailing spaces will be trimmed. The size of this field should not + exceed 200KB. + type: object + etag: type: string - idleShutdownConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookIdleShutdownConfig - readOnly: true description: >- - Output only. The idle shutdown configuration of the notebook - runtime. + An eTag 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 NotebookRuntime. - type: string - readOnly: true - version: - description: Output only. The VM os image version of NotebookRuntime. - readOnly: true + description: Immutable. The resource name of the Context. type: string type: object + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfig: 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. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter: + The config for integrating with Vertex Explainable AI. Only applicable + if the Model has explanation_spec populated. + type: object + id: GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfig properties: - checkpointName: - type: string + enableFeatureAttributes: + type: boolean description: >- - Optional. An unique name of pretrained model checkpoint provided in - model garden, it will be mapped to a GCS location internally. - trainerType: - enumDescriptions: - - Default value. - - '' - - '' - type: string - enum: - - TRAINER_TYPE_UNSPECIFIED - - AUTOML_TRAINER - - MODEL_GARDEN_TRAINER - trainerConfig: - additionalProperties: - type: string - type: object - description: Customizable trainer settings, used in the `model_garden_trainer`. - datasetConfig: - type: object - additionalProperties: - type: string - description: Customizable dataset settings, used in the `model_garden_trainer`. - studySpec: + 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. + explanationBaseline: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline description: >- - Optioinal. StudySpec of hyperparameter tuning job. Required for - `model_garden_trainer`. - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' + Predictions generated by the BatchPredictionJob using baseline + dataset. + GoogleCloudAiplatformV1Explanation: + id: GoogleCloudAiplatformV1Explanation + properties: + attributions: + 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. + readOnly: true + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Attribution' + neighbors: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Neighbor' + type: array + 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. + readOnly: true description: >- - A wrapper class which contains the tunable parameters in an AutoML Image - training job. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter + Explanation of a prediction (provided in PredictResponse.predictions) + produced by the Model on a given instance. type: object - GoogleCloudAiplatformV1StartNotebookRuntimeRequest: + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentation: + properties: + metadata: + description: The metadata information. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata + inputs: + description: The input parameters of this TrainingJob. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs type: object - description: Request message for NotebookService.StartNotebookRuntime. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentation + description: >- + A TrainingJob that trains and uploads an AutoML Image Segmentation + Model. + GoogleCloudAiplatformV1ReadFeatureValuesResponse: + properties: + 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. + header: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader + description: Response header. + description: Response message for FeaturestoreOnlineServingService.ReadFeatureValues. + type: object + id: GoogleCloudAiplatformV1ReadFeatureValuesResponse + GoogleCloudAiplatformV1UpsertDatapointsResponse: + id: GoogleCloudAiplatformV1UpsertDatapointsResponse + description: Response message for IndexService.UpsertDatapoints properties: {} - id: GoogleCloudAiplatformV1StartNotebookRuntimeRequest - GoogleCloudAiplatformV1ListArtifactsResponse: type: object + GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig: properties: - nextPageToken: - type: string + samplingRate: + type: number 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: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' - description: The Artifacts retrieved from the MetadataStore. - type: array - id: GoogleCloudAiplatformV1ListArtifactsResponse - description: Response message for MetadataService.ListArtifacts. - GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines: - id: GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines + Percentage of requests to be logged, expressed as a fraction in + range(0,1]. + 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. + type: object + id: GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig + GoogleCloudAiplatformV1ExamplesOverride: + type: object properties: - fineTuningPipelines: + neighborCount: + type: integer + format: int32 + description: The number of neighbors to return. + restrictions: + type: array items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - description: Required. Regional resource references to fine tuning pipelines. + #/components/schemas/GoogleCloudAiplatformV1ExamplesRestrictionsNamespace + description: >- + Restrict the resulting nearest neighbors to respect these + constraints. + crowdingCount: + format: int32 + type: integer + description: The number of neighbors to return that have the same crowding tag. + returnEmbeddings: + description: If true, return the embeddings instead of neighbors. + type: boolean + dataFormat: + description: The format of the data being provided with each call. + type: string + 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: Overrides for example-based explanations. + id: GoogleCloudAiplatformV1ExamplesOverride + GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition: + 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. type: array + items: + format: double + type: number type: object - description: Open fine tuning pipelines. - GoogleCloudAiplatformV1BatchPredictionJob: - type: object + GoogleCloudAiplatformV1UpdateSpecialistPoolOperationMetadata: + id: GoogleCloudAiplatformV1UpdateSpecialistPoolOperationMetadata properties: - 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. - state: - 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. + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. + specialistPool: 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 - labels: - type: object - additionalProperties: - type: string 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. - outputInfo: - description: Output only. Information further describing the output of this job. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchPredictionJobOutputInfo + 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 - updateTime: + type: object + description: >- + Runtime operation metadata for + SpecialistPoolService.UpdateSpecialistPool. + GoogleCloudAiplatformV1CancelNasJobRequest: + type: object + id: GoogleCloudAiplatformV1CancelNasJobRequest + properties: {} + description: Request message for JobService.CancelNasJob. + GoogleCloudAiplatformV1SampledShapleyAttribution: + properties: + pathCount: + 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 + type: integer + 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. + id: GoogleCloudAiplatformV1SampledShapleyAttribution + type: object + GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation: + type: object + id: >- + GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation + properties: + annotationSpecId: type: string - readOnly: true - format: google-datetime description: >- - Output only. Time when the BatchPredictionJob was most recently - updated. - modelParameters: - type: any + The resource Id of the AnnotationSpec that this Annotation pertains + to. + vertexes: + type: array description: >- - The parameters that govern the predictions. The schema of the - parameters may be specified via the Model's PredictSchemata's - parameters_schema_uri. - endTime: + 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' + displayName: type: string - format: google-datetime - readOnly: true description: >- - Output only. Time when the BatchPredictionJob entered any of the - following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, - `JOB_STATE_CANCELLED`. - createTime: - format: google-datetime + The display name of the AnnotationSpec that this Annotation pertains + to. + description: Represents a polygon in image. + GoogleCloudAiplatformV1DiskSpec: + description: Represents the spec of disk options. + id: GoogleCloudAiplatformV1DiskSpec + type: object + properties: + bootDiskSizeGb: + description: Size in GB of the boot disk (default is 100GB). + format: int32 + type: integer + 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 - readOnly: true - description: Output only. Time when the BatchPredictionJob was created. - displayName: - description: Required. The user-defined name of this BatchPredictionJob. + GoogleCloudAiplatformV1SchemaTextExtractionAnnotation: + properties: + annotationSpecId: type: string - completionStats: description: >- - Output only. Statistics on completed and failed prediction - instances. - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1CompletionStats' - modelVersionId: - readOnly: true + The resource Id of the AnnotationSpec that this Annotation pertains + to. + textSegment: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaTextSegment' + description: The segment of the text content. + displayName: type: string description: >- - Output only. The version ID of the Model that produces the - predictions via this job. - disableContainerLogging: - type: boolean + The display name of the AnnotationSpec that this Annotation pertains + to. + type: object + id: GoogleCloudAiplatformV1SchemaTextExtractionAnnotation + description: Annotation details specific to text extraction. + GoogleCloudAiplatformV1DestinationFeatureSetting: + id: GoogleCloudAiplatformV1DestinationFeatureSetting + properties: + featureId: + description: Required. The ID of the Feature to apply the setting to. + type: string + destinationField: 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. - 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. - startTime: - description: >- - Output only. Time when the BatchPredictionJob for the first time - entered the `JOB_STATE_RUNNING` state. - type: string - readOnly: true - format: google-datetime - 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' - 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' - model: + Specify the field name in the export destination. If not specified, + Feature ID is used. 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}` - generateExplanation: + type: object + GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec: + type: object + properties: + useElapsedDuration: 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. - 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' - name: - readOnly: true - type: string - description: Output only. Resource name of the BatchPredictionJob. - inputConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchPredictionJobInputConfig - 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. - 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. - 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). - partialFailures: - 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. - readOnly: true - items: - $ref: '#/components/schemas/GoogleRpcStatus' - type: array - 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. - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourcesConsumed' - 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. - 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. - id: GoogleCloudAiplatformV1BatchPredictionJob + 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: >- - 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. - GoogleCloudAiplatformV1ReadIndexDatapointsRequest: + 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 + GoogleCloudAiplatformV1ExportDataResponse: + description: Response message for DatasetService.ExportData. type: object properties: - deployedIndexId: - type: string - description: The ID of the DeployedIndex that will serve the request. - ids: - type: array - description: IDs of the datapoints to be searched for. + 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: items: type: string - description: The request message for MatchService.ReadIndexDatapoints. - id: GoogleCloudAiplatformV1ReadIndexDatapointsRequest - GoogleCloudAiplatformV1MetadataStoreDataplexConfig: - description: Represents Dataplex integration settings. - properties: - enabledPipelinesLineage: - type: boolean + type: array description: >- - Optional. Whether or not Data Lineage synchronization is enabled for - Vertex Pipelines. + 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-*). + id: GoogleCloudAiplatformV1ExportDataResponse + GoogleCloudAiplatformV1AvroSource: type: object - id: GoogleCloudAiplatformV1MetadataStoreDataplexConfig - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextSentimentEvaluationMetrics: + description: The storage details for Avro input content. + id: GoogleCloudAiplatformV1AvroSource + properties: + gcsSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' + description: Required. Google Cloud Storage location. + GoogleCloudAiplatformV1DeleteFeatureValuesRequest: type: object - description: Model evaluation metrics for text sentiment problems. - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextSentimentEvaluationMetrics properties: - meanSquaredError: - description: >- - Mean squared error. Only set for ModelEvaluations, not for - ModelEvaluationSlices. - format: float - type: number - meanAbsoluteError: - description: >- - Mean absolute error. Only set for ModelEvaluations, not for - ModelEvaluationSlices. - type: number - format: float - recall: - description: Recall. - format: float - type: number - f1Score: - type: number - description: The harmonic mean of recall and precision. - format: float - confusionMatrix: + selectEntity: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix - description: >- - Confusion matrix of the evaluation. Only set for ModelEvaluations, - not for ModelEvaluationSlices. - quadraticKappa: - format: float - description: >- - Quadratic weighted kappa. Only set for ModelEvaluations, not for - ModelEvaluationSlices. - type: number - precision: - format: float - type: number - description: Precision. - linearKappa: - description: >- - Linear weighted kappa. Only set for ModelEvaluations, not for - ModelEvaluationSlices. - type: number - format: float - GoogleCloudAiplatformV1SchemaImageSegmentationAnnotation: - properties: - maskAnnotation: + #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity + description: Select feature values to be deleted by specifying entities. + selectTimeRangeAndFeature: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation + #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectTimeRangeAndFeature description: >- - Mask based segmentation annotation. Only one mask annotation can - exist for one image. - polygonAnnotation: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation - description: Polygon annotation. - polylineAnnotation: - description: Polyline annotation. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation - description: Annotation details specific to image segmentation. - id: GoogleCloudAiplatformV1SchemaImageSegmentationAnnotation - type: object - GoogleCloudAiplatformV1SchemaPredictPredictionTabularClassificationPredictionResult: - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionTabularClassificationPredictionResult - description: Prediction output format for Tabular Classification. + Select feature values to be deleted by specifying time range and + features. + description: Request message for FeaturestoreService.DeleteFeatureValues. + id: GoogleCloudAiplatformV1DeleteFeatureValuesRequest + GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest: + description: Request message for JobService.ResumeModelDeploymentMonitoringJob. + properties: {} type: object + id: GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest + GoogleCloudAiplatformV1AssignNotebookRuntimeRequest: + description: Request message for NotebookService.AssignNotebookRuntime. + id: GoogleCloudAiplatformV1AssignNotebookRuntimeRequest properties: - classes: + notebookRuntimeId: + type: string + description: Optional. User specified ID for the notebook runtime. + notebookRuntime: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookRuntime' description: >- - The name of the classes being classified, contains all possible - values of the target column. - type: array - items: - type: string - scores: - type: array - items: - format: float - type: number + Required. Provide runtime specific information (e.g. runtime owner, + notebook id) used for NotebookRuntime assignment. + notebookRuntimeTemplate: + type: string 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. - GoogleCloudAiplatformV1ExplanationSpec: + Required. The resource name of the NotebookRuntimeTemplate based on + which a NotebookRuntime will be assigned (reuse or create a new + one). type: object - properties: - parameters: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationParameters' - description: >- - Required. Parameters that configure explaining of the Model's - predictions. - metadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationMetadata' - description: >- - Optional. Metadata describing the Model's input and output for - explanation. - description: Specification of Model explanation. - id: GoogleCloudAiplatformV1ExplanationSpec - GoogleCloudAiplatformV1PredictRequest: + GoogleCloudAiplatformV1BigQueryDestination: type: object - id: GoogleCloudAiplatformV1PredictRequest + id: GoogleCloudAiplatformV1BigQueryDestination properties: - instances: - items: - type: any - type: array - 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. - parameters: - type: any + outputUri: + type: string 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. - description: Request message for PredictionService.Predict. - GoogleCloudAiplatformV1ListEntityTypesResponse: + 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`. + description: The BigQuery location for the output content. + GoogleCloudAiplatformV1CreateFeatureGroupOperationMetadata: type: object - id: GoogleCloudAiplatformV1ListEntityTypesResponse + id: GoogleCloudAiplatformV1CreateFeatureGroupOperationMetadata properties: - entityTypes: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' - description: The EntityTypes matching the request. - type: array - 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 - description: Response message for FeaturestoreService.ListEntityTypes. - GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec: - description: Represents a parameter spec with condition from its parent parameter. + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for FeatureGroup. + description: Details of operations that perform create FeatureGroup. + GoogleCloudAiplatformV1ExportDataConfig: + id: GoogleCloudAiplatformV1ExportDataConfig + description: >- + Describes what part of the Dataset is to be exported, the destination of + the export and how to export. type: object properties: - parentIntValues: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition + fractionSplit: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportFractionSplit' + description: Split based on fractions defining the size of each set. + filterSplit: + description: Split based on the provided filters for each set. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportFilterSplit' + gcsDestination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' description: >- - The spec for matching values from a parent parameter of `INTEGER` - type. - parentCategoricalValues: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition + 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: description: >- - The spec for matching values from a parent parameter of - `CATEGORICAL` type. - parameterSpec: - description: Required. The spec for a conditional parameter. - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpec' - parentDiscreteValues: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition + 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. + type: string + 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. + annotationsFilter: description: >- - The spec for matching values from a parent parameter of `DISCRETE` - type. - id: GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec - GoogleCloudAiplatformV1DeploymentResourcePool: - properties: - name: + 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 + savedQueryId: type: string description: >- - Immutable. The resource name of the DeploymentResourcePool. Format: - `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` - disableContainerLogging: + 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. + GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest: + description: Request message for TensorboardService.ExportTensorboardTimeSeriesData. + type: object + properties: + pageToken: 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 - serviceAccount: + 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 + filter: 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' + Exports the TensorboardTimeSeries' data that match the filter + expression. + pageSize: + format: int32 description: >- - Required. The underlying DedicatedResources that the - DeploymentResourcePool uses. - createTime: - description: Output only. Timestamp when this DeploymentResourcePool was created. - readOnly: true + 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 + orderBy: type: string - format: google-datetime - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' 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. - id: GoogleCloudAiplatformV1DeploymentResourcePool - description: >- - A description of resources that can be shared by multiple - DeployedModels, whose underlying specification consists of a - DedicatedResources. + Field to use to sort the TensorboardTimeSeries' data. By default, + TensorboardTimeSeries' data is returned in a pseudo random order. + id: GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest + GoogleCloudAiplatformV1WriteFeatureValuesRequest: type: object - GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics: - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics - description: Metrics for a single confidence threshold. + description: Request message for FeaturestoreOnlineServingService.WriteFeatureValues. properties: - f1Score: - description: The harmonic mean of recall and precision. - format: float - type: number - recall: - format: float - description: Recall under the given confidence threshold. - type: number - precision: - description: Precision under the given confidence threshold. - format: float - type: number - confidenceThreshold: - format: float - description: The confidence threshold value used to compute the metrics. - type: number - type: object - 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. - 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. - noisySampleCount: - format: int32 - type: integer + payloads: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteFeatureValuesPayload 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. - id: GoogleCloudAiplatformV1SmoothGradConfig - 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 - GoogleCloudAiplatformV1SchemaPredictInstanceImageSegmentationPredictionInstance: + Required. The entities to be written. Up to 100,000 feature values + can be written across all `payloads`. + id: GoogleCloudAiplatformV1WriteFeatureValuesRequest + GoogleCloudAiplatformV1ListStudiesResponse: + description: Response message for VizierService.ListStudies. + id: GoogleCloudAiplatformV1ListStudiesResponse properties: - mimeType: - type: string + nextPageToken: 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: + 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 - description: The image bytes to make the predictions on. + studies: + type: array + description: The studies associated with the project. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' type: object - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceImageSegmentationPredictionInstance - description: Prediction input format for Image Segmentation. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation: + GoogleCloudAiplatformV1StructValue: + id: GoogleCloudAiplatformV1StructValue + type: object + description: Struct (or object) type feature value. properties: - auto: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation - timestamp: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation - numeric: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation - text: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation - categorical: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation + values: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StructFieldValue' + description: A list of field values. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation: id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation - type: object - GoogleCloudAiplatformV1PurgeArtifactsMetadata: - id: GoogleCloudAiplatformV1PurgeArtifactsMetadata + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation type: object - description: Details of operations that perform MetadataService.PurgeArtifacts. properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for purging Artifacts. - GoogleCloudAiplatformV1EntityType: - id: GoogleCloudAiplatformV1EntityType + columnName: + type: string + description: >- + Training pipeline will infer the proper transformation based on the + statistic of dataset. + GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport: + id: GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport 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. + Describes exporting the latest Feature values of all entities of the + EntityType between [start_time, snapshot_time]. properties: - description: + startTime: + format: google-datetime type: string - description: Optional. Description of the EntityType. - offlineStorageTtlDays: - format: int32 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 - labels: + 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: + type: string + format: google-datetime 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. - type: object - additionalProperties: - type: string - etag: + 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. + GoogleCloudAiplatformV1ExportModelResponse: + id: GoogleCloudAiplatformV1ExportModelResponse + type: object + properties: {} + description: Response message of ModelService.ExportModel operation. + GoogleCloudAiplatformV1PersistentResource: + id: GoogleCloudAiplatformV1PersistentResource + properties: + createTime: + type: string + readOnly: true + description: Output only. Time when the PersistentResource was created. + format: google-datetime + network: description: >- - Optional. Used to perform a consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. + 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 - monitoringConfig: + reservedIpRanges: + items: + type: string 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 - name: + 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 + startTime: + readOnly: true 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 - createTime: + Output only. Time when the PersistentResource for the first time + entered the `RUNNING` state. type: string - readOnly: true - description: Output only. Timestamp when this EntityType was created. format: google-datetime updateTime: readOnly: true type: string format: google-datetime description: >- - Output only. Timestamp when this EntityType was most recently + Output only. Time when the PersistentResource was most recently updated. - GoogleCloudAiplatformV1CreateRegistryFeatureOperationMetadata: - type: object - description: Details of operations that perform create FeatureGroup. - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Feature. - id: GoogleCloudAiplatformV1CreateRegistryFeatureOperationMetadata - GoogleCloudAiplatformV1BatchMigrateResourcesRequest: - id: GoogleCloudAiplatformV1BatchMigrateResourcesRequest - description: Request message for MigrationService.BatchMigrateResources. - type: object - properties: - migrateResourceRequests: - 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. + state: + description: Output only. The detailed state of a Study. + enum: + - STATE_UNSPECIFIED + - PROVISIONING + - RUNNING + - STOPPING + - ERROR + - REBOOTING + - UPDATING + readOnly: true + 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. + resourceRuntime: + description: Output only. Runtime information of the Persistent Resource. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourceRuntime' + resourcePools: + description: Required. The spec of the pools of different resources. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourcePool' type: array - 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); } - GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest: - properties: - orderBy: - type: string - description: >- - Field to use to sort the TensorboardTimeSeries' data. By default, - TensorboardTimeSeries' data is returned in a pseudo random order. - filter: + encryptionSpec: description: >- - Exports the TensorboardTimeSeries' data that match the filter - expression. + 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' + name: type: string - pageToken: + description: Immutable. Resource name of a PersistentResource. + labels: + additionalProperties: + type: string 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. + 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 + displayName: type: string - pageSize: - format: int32 - 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. - type: object - description: Request message for TensorboardService.ExportTensorboardTimeSeriesData. - id: GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest - GoogleCloudAiplatformV1DoubleArray: - properties: - values: - description: A list of double values. - type: array - items: - type: number - format: double - id: GoogleCloudAiplatformV1DoubleArray - type: object - description: A list of double values. - GoogleCloudAiplatformV1WorkerPoolSpec: - properties: - pythonPackageSpec: - description: The Python packaged task. - $ref: '#/components/schemas/GoogleCloudAiplatformV1PythonPackageSpec' - replicaCount: - type: string - format: int64 - description: Optional. The number of worker replicas to use for this worker pool. - machineSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' - description: Optional. Immutable. The specification of a single machine. - containerSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ContainerSpec' - description: The custom container task. - nfsMounts: - description: Optional. List of NFS mount spec. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NfsMount' - diskSpec: - description: Disk spec. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DiskSpec' - id: GoogleCloudAiplatformV1WorkerPoolSpec - description: Represents the spec of a worker pool in a job. - type: object - GoogleCloudAiplatformV1UpdateDeploymentResourcePoolOperationMetadata: - id: GoogleCloudAiplatformV1UpdateDeploymentResourcePoolOperationMetadata - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - description: Runtime operation information for UpdateDeploymentResourcePool method. - type: object - GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecMetricSpec: - id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecMetricSpec - type: object - description: Represents a metric to optimize. - properties: - metricId: - description: Required. The ID of the metric. Must not contain whitespaces. - type: string - goal: - enum: - - GOAL_TYPE_UNSPECIFIED - - MAXIMIZE - - MINIMIZE - type: string - enumDescriptions: - - Goal Type will default to maximize. - - Maximize the goal metric. - - Minimize the goal metric. - description: Required. The optimization goal of the metric. - GoogleCloudAiplatformV1UndeployModelOperationMetadata: - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - description: Runtime operation information for EndpointService.UndeployModel. - id: GoogleCloudAiplatformV1UndeployModelOperationMetadata + Optional. The display name of the PersistentResource. The name can + be up to 128 characters long and can consist of any UTF-8 + characters. + error: + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + Output only. Only populated when persistent resource's state is + `STOPPING` or `ERROR`. + readOnly: true + resourceRuntimeSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourceRuntimeSpec' + description: >- + Optional. Persistent Resource runtime spec. For example, used for + Ray cluster configuration. type: object - GoogleCloudAiplatformV1SchemaVideoDataItem: + 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. + GoogleCloudAiplatformV1ModelEvaluationSliceSlice: + description: Definition of a slice. type: object properties: - gcsUri: + dimension: type: string 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. - mimeType: + 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: 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 readOnly: true - description: Payload of Video DataItem. - id: GoogleCloudAiplatformV1SchemaVideoDataItem - GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata: - type: object - id: GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata + description: Output only. The value of the dimension in this slice. + sliceSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec + readOnly: true + description: Output only. Specification for how the data was sliced. + id: GoogleCloudAiplatformV1ModelEvaluationSliceSlice + GoogleCloudAiplatformV1Tool: properties: - contentValidationStats: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats + retrieval: 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. + 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' + 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 - dataBytesCount: - type: string - description: The ingested data size in bytes. - format: int64 - description: Runtime operation metadata with regard to Matching Engine Index. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation: + googleSearchRetrieval: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GoogleSearchRetrieval' + description: >- + Optional. GoogleSearchRetrieval tool type. Specialized retrieval + tool that is powered by Google search. + id: GoogleCloudAiplatformV1Tool 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. + 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 + 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. 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: - type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation - GoogleCloudAiplatformV1StructFieldValue: - type: object - id: GoogleCloudAiplatformV1StructFieldValue - description: One field of a Struct (or object) type feature value. - properties: - name: - type: string - description: Name of the field in the struct feature. - value: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' - description: The value for this field. - GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry: - id: GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry - properties: - enterpriseDatastore: + inputTensorName: type: string description: >- - The uri of the Vertex AI Search data source. Deprecated. Use - vertex_ai_search_datastore instead. - deprecated: true - inlineContext: - description: >- - The grounding text passed inline with the Predict API. It can - support up to 1 million bytes. - type: string - type: - enumDeprecated: - - false - - false - - true - - false - - false - description: The type of the grounding checking source. - 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. - type: string - enum: - - UNSPECIFIED - - WEB - - ENTERPRISE - - VERTEX_AI_SEARCH - - INLINE - vertexAiSearchDatastore: - type: string - description: The uri of the Vertex AI Search data source. - description: Single source entry for the grounding checking. - type: object - GoogleCloudAiplatformV1CreateFeatureGroupOperationMetadata: - type: object - properties: - genericMetadata: - description: Operation metadata for FeatureGroup. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - id: GoogleCloudAiplatformV1CreateFeatureGroupOperationMetadata - description: Details of operations that perform create FeatureGroup. - CloudAiLargeModelsVisionRaiInfo: - type: object - id: CloudAiLargeModelsVisionRaiInfo - properties: - raiCategories: - description: List of rai categories' information to return - type: array - items: - type: string - detectedLabels: - items: - $ref: '#/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabels' - description: The list of detected labels for different rai categories. - type: array - scores: + Name of the input tensor for this feature. Required and is only + applicable to Vertex AI-provided images for Tensorflow. + encodedBaselines: items: - type: number - format: float + type: any type: array description: >- - List of rai scores mapping to the rai categories. Rounded to 1 - decimal place. - GoogleCloudAiplatformV1CancelTrainingPipelineRequest: - description: Request message for PipelineService.CancelTrainingPipeline. - type: object - id: GoogleCloudAiplatformV1CancelTrainingPipelineRequest - properties: {} - GoogleCloudAiplatformV1EncryptionSpec: - type: object - properties: - kmsKeyName: + 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. + denseShapeTensorName: 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 - description: >- - Represents a customer-managed encryption key spec that can be applied to - a top-level resource. - id: GoogleCloudAiplatformV1EncryptionSpec - GoogleCloudAiplatformV1NotebookRuntimeTemplate: - properties: - name: + 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 - description: The resource name of the NotebookRuntimeTemplate. - serviceAccount: + 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 + inputBaselines: 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. - idleShutdownConfig: + 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: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookIdleShutdownConfig + #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization + description: Visualization configurations for image explanation. + featureValueDomain: description: >- - The idle shutdown configuration of NotebookRuntimeTemplate. This - config will only be set when idle shutdown is enabled. - isDefault: - description: Output only. The default template to use if not specified. - type: boolean - readOnly: true - eucConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookEucConfig' - description: EUC configuration of the NotebookRuntimeTemplate. - networkSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NetworkSpec' - description: Optional. Network spec. - networkTags: - type: array - items: - type: string + The domain details of the input feature value. Like min/max, + original mean or standard deviation if normalized. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain + indicesTensorName: + type: string description: >- - Optional. The Compute Engine tags to add to runtime (see [Tagging - instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)). - machineSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' + 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. + modality: description: >- - Optional. Immutable. The specification of a single machine for the - template. - updateTime: + Modality of the feature. Valid values are: numeric, image. Defaults + to numeric. type: string + groupName: description: >- - Output only. Timestamp when this NotebookRuntimeTemplate was most - recently updated. - format: google-datetime - readOnly: true - 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 + encoding: + description: >- + Defines how the feature is encoded into the input tensor. Defaults + to IDENTITY. type: string - description: The description of the NotebookRuntimeTemplate. - notebookRuntimeType: - description: Optional. Immutable. The type of the notebook runtime template. enum: - - NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED - - USER_DEFINED - - ONE_CLICK + - ENCODING_UNSPECIFIED + - IDENTITY + - BAG_OF_FEATURES + - BAG_OF_FEATURES_SPARSE + - INDICATOR + - COMBINED_EMBEDDING + - CONCAT_EMBEDDING enumDescriptions: + - Default value. This is the same as IDENTITY. + - The tensor represents one feature. - >- - 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 - displayName: - 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. - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - description: Customer-managed encryption key spec for the notebook runtime. - shieldedVmConfig: - description: Optional. Immutable. Runtime Shielded VM spec. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ShieldedVmConfig' - etag: - description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. - type: string - labels: - additionalProperties: + 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: + items: 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. - dataPersistentDiskSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentDiskSpec' - description: >- - Optional. The specification of persistent disk attached to the - runtime as data disk storage. - createTime: - type: string - format: google-datetime - readOnly: true description: >- - Output only. Timestamp when this NotebookRuntimeTemplate was - created. + 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 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. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics: - description: Metrics for a single confidence threshold. + GoogleCloudAiplatformV1NearestNeighborQueryEmbedding: + description: The embedding vector. type: object - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics properties: - trackingRecall: - format: float - description: Tracking recall. - type: number - trackingPrecision: - type: number - format: float - description: Tracking precision. - 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 - confidenceThreshold: - description: The confidence threshold value used to compute the metrics. - type: number - format: float - mismatchRate: - type: number - format: float - description: >- - Mismatch rate, which measures the tracking consistency, i.e. - correctness of instance ID continuity. - GoogleCloudAiplatformV1CompletionStats: + value: + items: + format: float + type: number + description: Optional. Individual value in the embedding. + type: array + id: GoogleCloudAiplatformV1NearestNeighborQueryEmbedding + GoogleCloudAiplatformV1SamplingStrategy: properties: - successfulForecastPointCount: + randomSampleConfig: + description: Random sample config. Will support more sampling strategies later. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig + type: object + description: >- + Sampling Strategy for logging, can be for both training and prediction + dataset. + id: GoogleCloudAiplatformV1SamplingStrategy + GoogleCloudAiplatformV1Event: + type: object + id: GoogleCloudAiplatformV1Event + description: >- + An edge describing the relationship between an Artifact and an Execution + in a lineage graph. + properties: + eventTime: type: string - format: int64 - 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: google-datetime + description: Output only. Time the Event occurred. readOnly: true - successfulCount: + labels: + type: object description: >- - Output only. The number of entities that had been processed - successfully. - readOnly: true - format: int64 + 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. + additionalProperties: + type: string + artifact: + description: Required. The relative resource name of the Artifact in the Event. type: string - failedCount: + execution: readOnly: true type: string description: >- - Output only. The number of entities for which any error was - encountered. - format: int64 - 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). - readOnly: true + Output only. The relative resource name of the Execution in the + Event. + type: + enumDescriptions: + - Unspecified whether input or output of the Execution. + - An input of the Execution. + - An output of the Execution. + description: Required. The type of the Event. type: string - type: object - description: >- - Success and error statistics of processing multiple entities (for - example, DataItems or structured data rows) in batch. - id: GoogleCloudAiplatformV1CompletionStats - GoogleCloudAiplatformV1QueryDeployedModelsResponse: - id: GoogleCloudAiplatformV1QueryDeployedModelsResponse - description: Response message for QueryDeployedModels method. + enum: + - TYPE_UNSPECIFIED + - INPUT + - OUTPUT + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetrics: + description: Metrics for text extraction evaluation results. type: object properties: - deployedModels: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' - description: DEPRECATED Use deployed_model_refs instead. - deprecated: true - totalEndpointCount: + confusionMatrix: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix description: >- - The total number of Endpoints that have DeployedModels on this - DeploymentResourcePool. + 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. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics + type: array + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetrics + GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionRecognitionMetrics: + description: Model evaluation metrics for video action recognition. + type: object + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionRecognitionMetrics + properties: + evaluatedActionCount: + description: The number of ground truth actions used to create this evaluation. type: integer format: int32 - deployedModelRefs: - description: >- - References to the DeployedModels that share the specified - deploymentResourcePool. + videoActionMetrics: type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModelRef' - totalDeployedModelCount: - format: int32 - description: The total number of DeployedModels on this DeploymentResourcePool. - type: integer - 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. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics + description: 'The metric entries for precision window lengths: 1s,2s,3s.' + GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec: + id: GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec + properties: + explanationType: type: string - GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader: - id: GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader + 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. + type: object + GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource: + type: object properties: - featureDescriptors: + featureGroups: type: array - description: >- - List of Feature metadata corresponding to each piece of - ReadFeatureValuesResponse.EntityView.data. items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor - entityType: - description: >- - The resource name of the EntityType from the - ReadFeatureValuesRequest. Value format: - `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. + #/components/schemas/GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup + description: Required. List of features that need to be synced to Online Store. + projectNumber: type: string + format: int64 + description: >- + Optional. The project number of the parent project of the Feature + Groups. + id: GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource + description: >- + A Feature Registry source for features that need to be synced to Online + Store. + GoogleCloudAiplatformV1CreateDeploymentResourcePoolOperationMetadata: + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. type: object + description: Runtime operation information for CreateDeploymentResourcePool method. + id: GoogleCloudAiplatformV1CreateDeploymentResourcePoolOperationMetadata + GoogleCloudAiplatformV1TokensInfo: description: >- - Response header with metadata for the requested - ReadFeatureValuesRequest.entity_type and Features. - GoogleCloudAiplatformV1TuningJob: - id: GoogleCloudAiplatformV1TuningJob + Tokens info with a list of tokens and the corresponding list of token + ids. + id: GoogleCloudAiplatformV1TokensInfo + properties: + tokens: + description: A list of tokens from the input. + type: array + items: + format: byte + type: string + tokenIds: + description: A list of token ids from the input. + type: array + items: + type: string + format: int64 + type: object + GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke: + id: GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke type: object + description: Configurations for PublisherModel GKE deployment properties: - createTime: - format: google-datetime - type: string - description: Output only. Time when the TuningJob was created. - readOnly: true - experiment: - readOnly: true - description: Output only. The Experiment associated with this TuningJob. - type: string - baseModel: - type: string - description: The base model that is being tuned, e.g., "gemini-1.0-pro-002". - startTime: + gkeYamlConfigs: + items: + type: string + description: Optional. GKE deployment configuration in yaml format. + type: array + GoogleCloudAiplatformV1UndeployIndexRequest: + description: Request message for IndexEndpointService.UndeployIndex. + type: object + properties: + deployedIndexId: + description: >- + Required. The ID of the DeployedIndex to be undeployed from the + IndexEndpoint. type: string - readOnly: true - format: google-datetime + id: GoogleCloudAiplatformV1UndeployIndexRequest + GoogleCloudAiplatformV1BatchMigrateResourcesRequest: + type: object + description: Request message for MigrationService.BatchMigrateResources. + properties: + migrateResourceRequests: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequest' description: >- - Output only. Time when the TuningJob for the first time entered the - `JOB_STATE_RUNNING` state. - tunedModel: + 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 + id: GoogleCloudAiplatformV1BatchMigrateResourcesRequest + GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling: + properties: + cpuUtilizationTarget: + type: integer + format: int32 description: >- - Output only. The tuned model resources assiociated with this - TuningJob. - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1TunedModel' - name: - readOnly: true + 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: + type: integer description: >- - Output only. Identifier. Resource name of a TuningJob. Format: - `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` + Required. The minimum number of nodes to scale down to. Must be + greater than or equal to 1. + format: int32 + 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'. + type: integer + format: int32 + id: GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling + type: object + GoogleCloudAiplatformV1CopyModelResponse: + type: object + id: GoogleCloudAiplatformV1CopyModelResponse + description: Response message of ModelService.CopyModel operation. + properties: + modelVersionId: + description: Output only. The version ID of the model that is copied. type: string - endTime: - format: google-datetime readOnly: true + model: 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`. + The name of the copied Model resource. Format: + `projects/{project}/locations/{location}/models/{model}` 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 + GoogleCloudAiplatformV1PublisherModelDocumentation: + id: GoogleCloudAiplatformV1PublisherModelDocumentation + description: A named piece of documentation. + properties: + content: 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 - tunedModelDisplayName: + description: Required. Content of this piece of document (in Markdown format). + title: + description: >- + Required. E.g., OVERVIEW, USE CASES, DOCUMENTATION, SDK & SAMPLES, + JAVA, NODE.JS, etc.. type: string + type: object + GoogleCloudAiplatformV1DeploymentResourcePool: + id: GoogleCloudAiplatformV1DeploymentResourcePool + properties: + dedicatedResources: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' 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. - supervisedTuningSpec: - description: Tuning Spec for Supervised Fine Tuning. - $ref: '#/components/schemas/GoogleCloudAiplatformV1SupervisedTuningSpec' - description: + Required. The underlying DedicatedResources that the + DeploymentResourcePool uses. + serviceAccount: type: string - description: Optional. The description of the TuningJob. - tuningDataStats: - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningDataStats' description: >- - Output only. The tuning data statistics associated with this - TuningJob. - updateTime: - readOnly: true - format: google-datetime + 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. + name: type: string - description: Output only. Time when the TuningJob was most recently updated. - error: - readOnly: true - $ref: '#/components/schemas/GoogleRpcStatus' description: >- - Output only. Only populated when job's state is `JOB_STATE_FAILED` - or `JOB_STATE_CANCELLED`. + Immutable. The resource name of the DeploymentResourcePool. Format: + `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` 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' - 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. - additionalProperties: - type: string - type: object - description: Represents a TuningJob that runs with Google owned models. - 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: - code: - description: The status code, which should be an enum value of google.rpc.Code. - format: int32 - type: integer - message: + 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: + description: Output only. Timestamp when this DeploymentResourcePool was created. + format: google-datetime + readOnly: true type: string + disableContainerLogging: + type: boolean 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: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: array + 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. + description: >- + A description of resources that can be shared by multiple + DeployedModels, whose underlying specification consists of a + DedicatedResources. type: object - id: GoogleRpcStatus + GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest: + properties: {} + id: GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest + type: object + description: Request message for JobService.PauseModelDeploymentMonitoringJob. GoogleCloudAiplatformV1MutateDeployedIndexResponse: - id: 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. + GoogleCloudAiplatformV1BatchDedicatedResources: + description: >- + A description of resources that are used for performing batch + operations, are dedicated to a Model, and need manual configuration. + id: GoogleCloudAiplatformV1BatchDedicatedResources + properties: + 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 + 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: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' + description: Required. Immutable. The specification of a single machine. + type: object + GoogleCloudAiplatformV1IndexDatapointNumericRestriction: + id: GoogleCloudAiplatformV1IndexDatapointNumericRestriction + description: >- + This field allows restricts to be based on numeric comparisons rather + than categorical tokens. type: object - GoogleCloudAiplatformV1SpecialistPool: properties: - name: - type: string - description: Required. The resource name of the SpecialistPool. - displayName: + valueDouble: + type: number + description: Represents 64 bit float. + format: double + valueInt: + description: Represents 64 bit integer. type: string + format: int64 + op: 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. - pendingDataLabelingJobs: - type: array - description: Output only. The resource name of the pending data labeling jobs. - readOnly: true + 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. + enum: + - OPERATOR_UNSPECIFIED + - LESS + - LESS_EQUAL + - EQUAL + - GREATER_EQUAL + - GREATER + - NOT_EQUAL + type: string + namespace: + type: string + description: 'The namespace of this restriction. e.g.: cost.' + valueFloat: + description: Represents 32 bit float. + format: float + type: number + GoogleCloudAiplatformV1Tensor: + type: object + description: A tensor value type. + properties: + structVal: + description: A map of string to tensor. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + stringVal: items: type: string - specialistWorkerEmails: type: array - description: The email addresses of workers in the SpecialistPool. + description: STRING + shape: items: + format: int64 type: string - specialistManagerEmails: + description: Shape of the tensor. + type: array + uintVal: + description: UINT8 UINT16 UINT32 type: array - description: The email addresses of the managers in the SpecialistPool. items: - type: string - specialistManagersCount: - format: int32 - type: integer - description: Output only. The number of managers in this SpecialistPool. - readOnly: true - 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. - id: GoogleCloudAiplatformV1SpecialistPool - GoogleCloudAiplatformV1PublisherModel: - properties: - supportedActions: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToAction - description: Optional. Supported call-to-action options. - frameworks: - description: Optional. Additional information about the model's Frameworks. + format: uint32 + type: integer + boolVal: + type: array + 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 + intVal: + items: + format: int32 + type: integer + type: array + description: INT_8 INT_16 INT_32 + tensorVal: + description: Serialized raw tensor content. + format: byte + type: string + floatVal: + description: FLOAT + type: array + items: + format: float + type: number + bytesVal: + description: STRING type: array items: type: string - name: - description: Output only. The resource name of the PublisherModel. + format: byte + int64Val: + items: + type: string + format: int64 + description: INT64 + type: array + doubleVal: + items: + format: double + type: number + description: DOUBLE + type: array + dtype: type: string - readOnly: true - versionState: - enumDescriptions: - - The version state is unspecified. - - Used to indicate the version is stable. - - Used to indicate the version is unstable. + description: The data type of tensor. enum: - - VERSION_STATE_UNSPECIFIED - - VERSION_STATE_STABLE - - VERSION_STATE_UNSTABLE - type: string - description: Optional. Indicates the state of the model version. - publisherModelTemplate: - readOnly: true - 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 - 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 - launchStage: - type: string - description: Optional. Indicates the launch stage of the model. + - DATA_TYPE_UNSPECIFIED + - BOOL + - STRING + - FLOAT + - DOUBLE + - INT8 + - INT16 + - INT32 + - INT64 + - UINT8 + - UINT16 + - UINT32 + - UINT64 enumDescriptions: - - The model launch stage is unspecified. - >- - Used to indicate the PublisherModel is at Experimental launch - stage, available to a small set of customers. + Not a legal value for DataType. Used to indicate a DataType field + has not been set. - >- - 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. - enum: - - LAUNCH_STAGE_UNSPECIFIED - - EXPERIMENTAL - - PRIVATE_PREVIEW - - PUBLIC_PREVIEW - - GA - openSourceCategory: - type: string - description: Required. Indicates the open source category of the publisher model. - 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. - 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 - predictSchemata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictSchemata' - description: >- - Optional. The schemata that describes formats of the - PublisherModel's predictions and explanations as given and returned - via PredictionService.Predict. - id: GoogleCloudAiplatformV1PublisherModel - type: object - description: A Model Garden Publisher Model. - GoogleCloudAiplatformV1MigrateResourceResponse: - id: GoogleCloudAiplatformV1MigrateResourceResponse - type: object - description: Describes a successfully migrated resource. - properties: - dataset: - type: string - description: Migrated Dataset's resource name. - model: - description: Migrated Model's resource name. - type: string - migratableResource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MigratableResource' - description: >- - Before migration, the identifier in ml.googleapis.com, - automl.googleapis.com or datalabeling.googleapis.com. - GoogleCloudAiplatformV1ListPipelineJobsResponse: - id: GoogleCloudAiplatformV1ListPipelineJobsResponse - description: Response message for PipelineService.ListPipelineJobs - properties: - pipelineJobs: + Data types that all computation devices are expected to be capable + to support. + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + uint64Val: + items: + type: string + format: uint64 + description: UINT64 type: array - description: List of PipelineJobs in the requested page. + listVal: + description: A list of tensor values. items: - $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. - type: object - GoogleCloudAiplatformV1PublisherModelCallToAction: - description: Actions could take on this Publisher Model. - id: GoogleCloudAiplatformV1PublisherModelCallToAction - properties: - requestAccess: - description: Optional. Request for access. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - openNotebooks: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks - description: Optional. Open notebooks of the PublisherModel. - openPromptTuningPipeline: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - description: Optional. Open prompt-tuning pipeline of the PublisherModel. - 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. - deploy: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionDeploy - description: Optional. Deploy the PublisherModel to Vertex Endpoint. - fineTune: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - description: >- - Optional. Fine tune the PublisherModel with the third-party model - tuning UI. - openFineTuningPipelines: - description: Optional. Open fine-tuning pipelines of the PublisherModel. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines - openGenie: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - description: Optional. Open Genie / Playground. - openFineTuningPipeline: - description: Optional. Open fine-tuning pipeline of the PublisherModel. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - openGenerationAiStudio: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - description: Optional. Open in Generation AI Studio. - openNotebook: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - description: Optional. Open notebook 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 - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs: - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + type: array + id: GoogleCloudAiplatformV1Tensor + GoogleCloudAiplatformV1Tensorboard: type: object properties: - optimizationObjective: - 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). - type: string - trainBudgetMilliNodeHours: - 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. + displayName: type: string - optimizationObjectiveRecallValue: - format: float - type: number + description: Required. User provided name of this Tensorboard. + blobStoragePathPrefix: description: >- - Required when optimization_objective is - "maximize-precision-at-recall". Must be between 0 and 1, inclusive. - targetColumn: - description: The column name of the target column that the model is to predict. + 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 type: string - additionalExperiments: - description: Additional experiment flags for the Tables training pipeline. - type: array - items: - type: string - 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. - disableEarlyStopping: + isDefault: 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: - type: number + 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: >- - Required when optimization_objective is - "maximize-recall-at-precision". Must be between 0 and 1, inclusive. - format: float - transformations: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation - type: array + 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' + labels: + type: object 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. - predictionType: + 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 + createTime: + description: Output only. Timestamp when this Tensorboard was created. + format: google-datetime type: string + readOnly: true + etag: 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. - weightColumnName: + Used to perform a consistent read-modify-write updates. If not set, + a blind "overwrite" update happens. 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. - GoogleCloudAiplatformV1SchemaPredictInstanceTextSentimentPredictionInstance: - type: object - properties: - mimeType: - description: >- - The MIME type of the text snippet. The supported MIME types are - listed below. - text/plain + runCount: + format: int32 + type: integer + description: Output only. The number of Runs stored in this Tensorboard. + readOnly: true + updateTime: type: string - content: + format: google-datetime + description: Output only. Timestamp when this Tensorboard was last updated. + readOnly: true + name: + readOnly: true type: string - description: The text snippet to make the predictions on. - description: Prediction input format for Text Sentiment. - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceTextSentimentPredictionInstance - GoogleCloudAiplatformV1NasTrial: - id: GoogleCloudAiplatformV1NasTrial - properties: - id: + description: >- + Output only. Name of the Tensorboard. Format: + `projects/{project}/locations/{location}/tensorboards/{tensorboard}` + description: + description: Description of this Tensorboard. type: string - description: Output only. The identifier of the NasTrial assigned by the service. + 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. + id: GoogleCloudAiplatformV1Tensorboard + GoogleCloudAiplatformV1SupervisedTuningDataStats: + description: Tuning data statistics for Supervised Tuning. + properties: + tuningStepCount: readOnly: true - state: + type: string + format: int64 + description: Output only. Number of tuning steps for this Tuning Job. + tuningDatasetExampleCount: 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. - startTime: + description: Output only. Number of examples in the tuning dataset. + format: int64 + userInputTokenDistribution: + description: Output only. Dataset distributions for the user input tokens. readOnly: true - description: Output only. Time when the NasTrial was started. - format: google-datetime + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution + userMessagePerExampleDistribution: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution + readOnly: true + description: Output only. Dataset distributions for the messages per example. + userOutputTokenDistribution: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution + description: Output only. Dataset distributions for the user output tokens. + readOnly: true + userDatasetExamples: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + readOnly: true + description: Output only. Sample user messages in the training dataset uri. + totalTuningCharacterCount: type: string - endTime: - format: google-datetime - description: >- - Output only. Time when the NasTrial's status changed to `SUCCEEDED` - or `INFEASIBLE`. + format: int64 + description: Output only. Number of tuning characters in the tuning dataset. readOnly: true + totalBillableCharacterCount: type: string - finalMeasurement: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' readOnly: true - description: Output only. The final measurement containing the objective value. - type: object - description: Represents a uCAIP NasJob trial. - GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig: + format: int64 + description: Output only. Number of billable characters in the tuning dataset. + id: GoogleCloudAiplatformV1SupervisedTuningDataStats type: object + GoogleCloudAiplatformV1SchemaImageDataItem: + description: Payload of Image DataItem. properties: - bigquerySource: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource - gcsSource: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource - description: >- - The tables Dataset's data source. The Dataset doesn't store the data - directly, but only pointer(s) to its data. - id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig - GoogleCloudAiplatformV1BigQuerySource: - properties: - inputUri: + 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 type: string description: >- - Required. BigQuery URI to a table, up to 2000 characters long. - Accepted forms: * BigQuery path. For example: - `bq://projectId.bqDatasetId.bqTableId`. + 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: object - description: The BigQuery location for the input content. - id: GoogleCloudAiplatformV1BigQuerySource - GoogleCloudAiplatformV1MeasurementMetric: + id: GoogleCloudAiplatformV1SchemaImageDataItem + GoogleCloudAiplatformV1SchemaPredictPredictionTimeSeriesForecastingPredictionResult: + description: Prediction output format for Time Series Forecasting. + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionTimeSeriesForecastingPredictionResult type: object properties: value: - readOnly: true + format: float type: number - format: double - description: Output only. The value for this metric. - metricId: - readOnly: true + description: The regression value. + quantileValues: + description: Quantile values. + type: array + items: + type: number + format: float + tftFeatureImportance: + description: Only use these if TFt is enabled. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance + quantilePredictions: + description: Quantile predictions, in 1-1 correspondence with quantile_values. + type: array + items: + format: float + type: number + GoogleCloudAiplatformV1DataItemView: + id: GoogleCloudAiplatformV1DataItemView + properties: + dataItem: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataItem' + description: The DataItem. + annotations: description: >- - Output only. The ID of the Metric. The Metric should be defined in - StudySpec's Metrics. + 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. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Annotation' + type: array + hasTruncatedAnnotations: + 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. + type: boolean + description: A container for a single DataItem and Annotations on it. + type: object + GoogleCloudAiplatformV1ListDataLabelingJobsResponse: + description: Response message for JobService.ListDataLabelingJobs. + id: GoogleCloudAiplatformV1ListDataLabelingJobsResponse + type: object + properties: + nextPageToken: + description: The standard List next-page token. type: string - description: A message representing a metric in the measurement. - id: GoogleCloudAiplatformV1MeasurementMetric - GoogleCloudAiplatformV1SchemaImageClassificationAnnotation: + dataLabelingJobs: + description: >- + A list of DataLabelingJobs that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' + GoogleCloudAiplatformV1CompleteTrialRequest: + description: Request message for VizierService.CompleteTrial. type: object - id: GoogleCloudAiplatformV1SchemaImageClassificationAnnotation - description: Annotation details specific to image classification. properties: - displayName: + infeasibleReason: type: string description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. - annotationSpecId: + Optional. A human readable reason why the trial was infeasible. This + should only be provided if `trial_infeasible` is true. + trialInfeasible: description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. - type: string - GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError: - properties: - errorMessage: + Optional. True if the Trial cannot be run with the given Parameter, + and final_measurement will be ignored. + type: boolean + finalMeasurement: 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 - rawRecord: - description: The original content of this record. - type: string - sourceGcsUri: - description: Cloud Storage URI pointing to the original file in user's bucket. - type: string - embeddingId: - description: Empty if the embedding id is failed to parse. - type: string - errorType: - description: The error type of this record. - type: string - 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 embedding. - 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 - id: GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError - type: object - GoogleCloudAiplatformV1ProbeExecAction: - description: ExecAction specifies a command to execute. + 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' + id: GoogleCloudAiplatformV1CompleteTrialRequest + GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance: 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. + horizonWeights: + items: + type: number + format: float + type: array + horizonColumns: type: array items: type: string - type: object - id: GoogleCloudAiplatformV1ProbeExecAction - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata: - properties: - backingCustomJob: + contextWeights: + type: array description: >- - The resource name of the CustomJob that has been created to carry - out this custom task. - type: string - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata - type: object - GoogleCloudAiplatformV1FeatureValue: - id: GoogleCloudAiplatformV1FeatureValue - properties: - bytesValue: - format: byte - description: Bytes feature value. - type: string - stringValue: - description: String feature value. - type: string - boolArrayValue: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BoolArray' - description: A list of bool type feature value. - metadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueMetadata' - description: Metadata of feature value. - int64ArrayValue: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Int64Array' - description: A list of int64 type feature value. - doubleArrayValue: - description: A list of double type feature value. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DoubleArray' - boolValue: - type: boolean - description: Bool type feature value. - doubleValue: - description: Double type feature value. - type: number - format: double - structValue: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StructValue' - description: A struct type feature value. - stringArrayValue: - description: A list of string type feature value. - $ref: '#/components/schemas/GoogleCloudAiplatformV1StringArray' - int64Value: - description: Int64 feature value. - type: string - format: int64 - type: object - description: Value for a feature. - GoogleCloudAiplatformV1DeleteFeatureValuesResponse: - description: Response message for FeaturestoreService.DeleteFeatureValues. - properties: - selectTimeRangeAndFeature: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature - description: Response for request specifying time range and feature - selectEntity: - description: Response for request specifying the entities to delete - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity - type: object - id: GoogleCloudAiplatformV1DeleteFeatureValuesResponse - GoogleCloudAiplatformV1Int64Array: - id: GoogleCloudAiplatformV1Int64Array - description: A list of int64 values. - properties: - values: - description: A list of int64 values. + 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 + attributeColumns: items: type: string - format: int64 type: array - type: object - GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesRequest: - properties: - modelEvaluationSlices: + contextColumns: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSlice' - description: Required. Model evaluation slice resource to be imported. + type: string type: array - id: GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesRequest - type: object - description: Request message for ModelService.BatchImportModelEvaluationSlices - GoogleCloudAiplatformV1ListFeatureViewsResponse: - description: Response message for FeatureOnlineStoreAdminService.ListFeatureViews. - id: GoogleCloudAiplatformV1ListFeatureViewsResponse - type: object - properties: - 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. - featureViews: + attributeWeights: type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' - description: The FeatureViews matching the request. - GoogleCloudAiplatformV1FindNeighborsResponseNeighbor: + type: number + format: float + id: GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance + type: object + GoogleCloudAiplatformV1ExportModelOperationMetadata: + description: Details of ModelService.ExportModel operation. type: object + id: GoogleCloudAiplatformV1ExportModelOperationMetadata properties: - distance: - type: number - description: The distance between the neighbor and the dense embedding query. - format: double - datapoint: + genericMetadata: + description: The common part of the operation metadata. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + outputInfo: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo + readOnly: true 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' - sparseDistance: - format: double - description: The distance between the neighbor and the query sparse_embedding. - type: number - description: A neighbor of the query vector. - id: GoogleCloudAiplatformV1FindNeighborsResponseNeighbor - GoogleCloudAiplatformV1SchemaTextSegment: - description: The text segment inside of DataItem. + Output only. Information further describing the output of this Model + export. + GoogleCloudAiplatformV1SchemaTextClassificationAnnotation: + type: object + id: GoogleCloudAiplatformV1SchemaTextClassificationAnnotation properties: - startOffset: - description: >- - Zero-based character index of the first character of the text - segment (counting characters from the beginning of the text). + displayName: type: string - format: uint64 - 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. - type: string - format: uint64 - content: + 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: The text content in the segment for output only. - type: object - id: GoogleCloudAiplatformV1SchemaTextSegment - GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling: - id: GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling - type: object + description: Annotation details specific to text classification. + GoogleCloudAiplatformV1QueryDeployedModelsResponse: + description: Response message for QueryDeployedModels method. + id: GoogleCloudAiplatformV1QueryDeployedModelsResponse properties: - maxNodeCount: + nextPageToken: + type: string 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 + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + totalDeployedModelCount: type: integer - cpuUtilizationTarget: format: int32 + description: The total number of DeployedModels on this DeploymentResourcePool. + deployedModelRefs: 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 - minNodeCount: + References to the DeployedModels that share the specified + deploymentResourcePool. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModelRef' + totalEndpointCount: + description: >- + The total number of Endpoints that have DeployedModels on this + DeploymentResourcePool. format: int32 type: integer - description: >- - Required. The minimum number of nodes to scale down to. Must be - greater than or equal to 1. - GoogleCloudAiplatformV1NotebookIdleShutdownConfig: - id: GoogleCloudAiplatformV1NotebookIdleShutdownConfig - properties: - idleTimeout: - format: google-duration - type: string - 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. - idleShutdownDisabled: - description: Whether Idle Shutdown is disabled in this NotebookRuntimeTemplate. - type: boolean - type: object - description: >- - The idle shutdown configuration of NotebookRuntimeTemplate, which - contains the idle_timeout as required field. - GoogleCloudAiplatformV1MetadataStoreMetadataStoreState: - properties: - diskUtilizationBytes: - description: The disk utilization of the MetadataStore in bytes. - format: int64 - type: string - type: object - id: GoogleCloudAiplatformV1MetadataStoreMetadataStoreState - description: Represents state information for a MetadataStore. - GoogleCloudAiplatformV1ListTensorboardExperimentsResponse: + deployedModels: + description: DEPRECATED Use deployed_model_refs instead. + deprecated: true + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' + type: array type: object - description: Response message for TensorboardService.ListTensorboardExperiments. - id: GoogleCloudAiplatformV1ListTensorboardExperimentsResponse + GoogleCloudAiplatformV1ListFeatureGroupsResponse: + id: GoogleCloudAiplatformV1ListFeatureGroupsResponse 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: + featureGroups: + description: The FeatureGroups matching the request. type: array - description: The TensorboardExperiments mathching the request. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment' - GoogleCloudAiplatformV1ComputeTokensResponse: - id: GoogleCloudAiplatformV1ComputeTokensResponse - description: Response message for ComputeTokens RPC call. - properties: - tokensInfo: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' + nextPageToken: + type: string 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' - type: array - type: object - GoogleCloudAiplatformV1IntegratedGradientsAttribution: + 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. type: object - 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 - id: GoogleCloudAiplatformV1IntegratedGradientsAttribution + GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse: properties: - stepCount: + importedEvaluatedAnnotationsCount: + description: Output only. Number of EvaluatedAnnotations imported. type: integer format: int32 - 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. - 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 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 - GoogleCloudAiplatformV1ReadTensorboardSizeResponse: - id: GoogleCloudAiplatformV1ReadTensorboardSizeResponse - properties: - storageSizeByte: - description: Payload storage size for the TensorBoard - format: int64 - type: string + readOnly: true + description: Response message for ModelService.BatchImportEvaluatedAnnotations + id: GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse type: object - description: Response message for TensorboardService.ReadTensorboardSize. - GoogleCloudAiplatformV1UploadModelResponse: + GoogleCloudAiplatformV1PipelineJob: + type: object + description: An instance of a machine learning PipelineJob. + id: GoogleCloudAiplatformV1PipelineJob properties: - model: + endTime: + format: google-datetime + readOnly: true + description: Output only. Pipeline end time. + type: string + serviceAccount: description: >- - The name of the uploaded Model resource. Format: - `projects/{project}/locations/{location}/models/{model}` + 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 - modelVersionId: + 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. + scheduleName: + readOnly: true type: string - description: Output only. The version ID of the model that is uploaded. + description: >- + Output only. The schedule resource name. Only returned if the + Pipeline is created by Schedule API. + error: readOnly: true - type: object - id: GoogleCloudAiplatformV1UploadModelResponse - description: Response message of ModelService.UploadModel operation. - GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest: - properties: - writeRunDataRequests: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardRunDataRequest - type: array description: >- - Required. Requests containing per-run TensorboardTimeSeries data to - write. - type: object - id: GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest - description: Request message for TensorboardService.WriteTensorboardExperimentData. - GoogleCloudAiplatformV1CreateDatasetVersionOperationMetadata: - description: Runtime operation information for DatasetService.CreateDatasetVersion. - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The common part of the operation metadata. - id: GoogleCloudAiplatformV1CreateDatasetVersionOperationMetadata - type: object - GoogleCloudAiplatformV1CompleteTrialRequest: - properties: - infeasibleReason: + Output only. The error that occurred during pipeline execution. Only + populated when the pipeline's state is FAILED or CANCELLED. + $ref: '#/components/schemas/GoogleRpcStatus' + updateTime: type: string + readOnly: true description: >- - Optional. A human readable reason why the trial was infeasible. This - should only be provided if `trial_infeasible` is true. - finalMeasurement: + Output only. Timestamp when this PipelineJob was most recently + updated. + format: google-datetime + runtimeConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJobRuntimeConfig' + description: Runtime config of the pipeline. + pipelineSpec: + description: The spec of the pipeline. + additionalProperties: + type: any + description: Properties of the object. + type: object + labels: + type: object + additionalProperties: + type: string 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' - trialInfeasible: - type: boolean + 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. + templateMetadata: description: >- - Optional. True if the Trial cannot be run with the given Parameter, - and final_measurement will be ignored. - id: GoogleCloudAiplatformV1CompleteTrialRequest - description: Request message for VizierService.CompleteTrial. - type: object - GoogleCloudAiplatformV1SchemaPredictPredictionTimeSeriesForecastingPredictionResult: - description: Prediction output format for Time Series Forecasting. + Output only. Pipeline template metadata. Will fill up fields if + PipelineJob.template_uri is from supported template registry. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineTemplateMetadata' + readOnly: true + state: + readOnly: true + type: string + 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. + 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 + reservedIpRanges: + type: array + items: + type: string + 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']. + displayName: + type: string + description: >- + The display name of the Pipeline. The name can be up to 128 + characters long and can consist of any UTF-8 characters. + startTime: + type: string + format: google-datetime + description: Output only. Pipeline start time. + readOnly: true + 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. + jobDetail: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJobDetail' + readOnly: true + description: >- + Output only. The details of pipeline run. Not available in the list + view. + name: + type: string + description: Output only. The resource name of the PipelineJob. + readOnly: true + createTime: + type: string + readOnly: true + format: google-datetime + description: Output only. Pipeline creation time. + network: + type: string + 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. + GoogleCloudAiplatformV1AddExecutionEventsRequest: type: object properties: - value: - format: float - description: The regression value. - type: number - quantileValues: + events: + description: The Events to create and add. type: array - description: Quantile values. - items: - type: number - format: float - tftFeatureImportance: - description: Only use these if TFt is enabled. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance - quantilePredictions: - description: Quantile predictions, in 1-1 correspondence with quantile_values. items: - format: float - type: number - type: array + $ref: '#/components/schemas/GoogleCloudAiplatformV1Event' + id: GoogleCloudAiplatformV1AddExecutionEventsRequest + description: Request message for MetadataService.AddExecutionEvents. + GoogleCloudAiplatformV1SchemaPredictInstanceImageClassificationPredictionInstance: id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionTimeSeriesForecastingPredictionResult - GoogleCloudAiplatformV1DeployedModelRef: - description: Points to a DeployedModel. + GoogleCloudAiplatformV1SchemaPredictInstanceImageClassificationPredictionInstance + type: object properties: - endpoint: - description: Immutable. A resource name of an Endpoint. + 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 - deployedModelId: + content: type: string - description: Immutable. An ID of a DeployedModel in the above Endpoint. - type: object - id: GoogleCloudAiplatformV1DeployedModelRef - GoogleCloudAiplatformV1SchemaImageDataItem: - id: GoogleCloudAiplatformV1SchemaImageDataItem + description: The image bytes or Cloud Storage URI to make the prediction on. + description: Prediction input format for Image Classification. + 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. type: object + id: GoogleCloudAiplatformV1EntityType properties: - gcsUri: + createTime: type: string + description: Output only. Timestamp when this EntityType was created. + readOnly: true + format: google-datetime + labels: description: >- - Required. Google Cloud Storage URI points to the original image in - user's bucket. The image is up to 30MB in size. - mimeType: + 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 + 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 + description: + type: string + description: Optional. Description of the EntityType. + offlineStorageTtlDays: + 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. + format: int32 + 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. + updateTime: + type: string + format: google-datetime + description: >- + Output only. Timestamp when this EntityType was most recently + updated. readOnly: true + etag: type: string 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. - GoogleCloudAiplatformV1BigQueryDestination: + Optional. Used to perform a consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. + GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig: + description: Requests are randomly selected. type: object - id: GoogleCloudAiplatformV1BigQueryDestination - description: The BigQuery location for the output content. + id: GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig properties: - outputUri: - type: string - 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`. - CloudAiLargeModelsVisionVideo: - description: Video - id: CloudAiLargeModelsVisionVideo + sampleRate: + format: double + type: number + description: Sample rate (0, 1] + GoogleCloudAiplatformV1NetworkSpec: + type: object properties: - video: - description: Raw bytes. + subnetwork: type: string - format: byte - uri: + description: >- + The name of the subnet that this instance is in. Format: + `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}` + enableInternetAccess: + type: boolean + description: Whether to enable public internet access. Default false. + network: type: string - description: Path to another storage (typically Google Cloud Storage). - type: object - GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata: - id: GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata + description: >- + The full name of the Google Compute Engine + [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) + description: Network spec. + id: GoogleCloudAiplatformV1NetworkSpec + GoogleCloudAiplatformV1ListModelVersionsResponse: properties: - progressMessage: - description: Progress Message for Reboot LRO + models: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + 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. + nextPageToken: + description: >- + A token to retrieve the next page of results. Pass to + ListModelVersionsRequest.page_token to obtain that page. type: string - genericMetadata: - description: Operation metadata for PersistentResource. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + id: GoogleCloudAiplatformV1ListModelVersionsResponse type: object - description: Details of operations that perform reboot PersistentResource. - GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue: + description: Response message for ModelService.ListModelVersions + GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpec: properties: - stringValue: - description: String type. + 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). type: string - floatValue: - format: float - type: number - description: Float type. + enum: + - MULTI_TRIAL_ALGORITHM_UNSPECIFIED + - REINFORCEMENT_LEARNING + - GRID_SEARCH + description: >- + The multi-trial Neural Architecture Search (NAS) algorithm type. + Defaults to `REINFORCEMENT_LEARNING`. + 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. + description: The spec of multi-trial Neural Architecture Search (NAS). type: object - description: Single value that supports strings and floats. - id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue - GoogleCloudAiplatformV1SchemaPredictInstanceVideoActionRecognitionPredictionInstance: + id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpec + GoogleCloudAiplatformV1SchemaPredictInstanceVideoObjectTrackingPredictionInstance: properties: content: - type: string description: >- The Google Cloud Storage location of the video on which to perform the prediction. - 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 @@ -14013,6 +14028,11 @@ components: 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: type: string description: >- @@ -14020,4316 +14040,4481 @@ components: 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: object id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceVideoActionRecognitionPredictionInstance - description: Prediction input format for Video Action Recognition. - GoogleCloudAiplatformV1IndexDatapointRestriction: - id: GoogleCloudAiplatformV1IndexDatapointRestriction - properties: - allowList: - items: - type: string - description: 'The attributes to allow in this namespace. e.g.: ''red''' - type: array - denyList: - items: - type: string - description: 'The attributes to deny in this namespace. e.g.: ''blue''' - type: array - namespace: - type: string - description: 'The namespace of this restriction. e.g.: color.' + GoogleCloudAiplatformV1SchemaPredictInstanceVideoObjectTrackingPredictionInstance + description: Prediction input format for Video Object Tracking. type: object - description: >- - Restriction of a datapoint which describe its attributes(tokens) from - each of several attribute categories(namespaces). - GoogleCloudAiplatformV1FeatureViewBigQuerySource: + GoogleCloudAiplatformV1PurgeArtifactsRequest: + description: Request message for MetadataService.PurgeArtifacts. + id: GoogleCloudAiplatformV1PurgeArtifactsRequest type: object - id: GoogleCloudAiplatformV1FeatureViewBigQuerySource properties: - uri: - description: >- - Required. The BigQuery view URI that will be materialized on each - sync trigger based on FeatureView.SyncConfig. + filter: type: string - entityIdColumns: - description: Required. Columns to construct entity_id / row keys. - type: array - items: - type: string - 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). More fields may be - added in the future as needed. + description: >- + Required. A required filter matching the Artifacts 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 Artifact names + that would be deleted. + type: boolean + CloudAiLargeModelsVisionSemanticFilterResponse: type: object - id: GoogleCloudAiplatformV1Schema properties: - required: - type: array - description: Optional. Required properties of Type.OBJECT. + passedSemanticFilter: + 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 + namedBoundingBoxes: items: - type: string - minLength: + $ref: '#/components/schemas/CloudAiLargeModelsVisionNamedBoundingBox' + type: array description: >- - Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the - Type.STRING - format: int64 - type: string - minProperties: - format: int64 - type: string - description: Optional. Minimum number of the properties for Type.OBJECT. - maxLength: - description: Optional. Maximum length of the Type.STRING - type: string - format: int64 - minItems: + Class labels of the bounding boxes that failed the semantic + filtering. Bounding box coordinates. + id: CloudAiLargeModelsVisionSemanticFilterResponse + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs: + properties: + budgetMilliNodeHours: type: string - format: int64 - description: Optional. Minimum number of the elements for Type.ARRAY. - example: - type: any description: >- - Optional. Example of the object. Will only populated when the object - is the root. - enum: - type: array - items: - type: string + 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. + format: int64 + multiLabel: + type: boolean 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: - description: Optional. The type of the data. + 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). + uptrainBaseModelId: type: string - 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 - format: 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 - type: string - default: - type: any - description: Optional. Default value of the data. - title: - description: Optional. The title of the Schema. + 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. + 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 - maximum: - type: number - description: Optional. Maximum value of the Type.INTEGER and Type.NUMBER - format: double - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' + disableEarlyStopping: + type: boolean description: >- - Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of - Type.ARRAY. - nullable: - type: boolean - description: Optional. Indicates if the value may be null. - maxProperties: - format: int64 - description: Optional. Maximum number of the properties for Type.OBJECT. - type: string - minimum: - format: double - type: number - description: >- - Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of - the Type.INTEGER and Type.NUMBER - properties: - description: Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' - maxItems: - format: int64 - description: Optional. Maximum number of the elements for Type.ARRAY. - type: string - description: - type: string - description: Optional. The description of the data. - pattern: - type: string - description: >- - Optional. Pattern of the Type.STRING to restrict a string to a - regular expression. - GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata: - description: Metadata information for NotebookService.CreateNotebookRuntimeTemplate. - type: object - properties: - genericMetadata: - description: The operation generic information. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - id: GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata - GoogleCloudAiplatformV1IndexDatapointNumericRestriction: - properties: - op: - description: >- - This MUST be specified for queries and must NOT be specified for - datapoints. + 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. + modelType: 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. + - 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. type: string enum: - - OPERATOR_UNSPECIFIED - - LESS - - LESS_EQUAL - - EQUAL - - GREATER_EQUAL - - GREATER - - NOT_EQUAL - valueFloat: - type: number - format: float - description: Represents 32 bit float. - valueInt: - description: Represents 64 bit integer. - type: string - format: int64 - namespace: - type: string - description: 'The namespace of this restriction. e.g.: cost.' - valueDouble: - type: number - format: double - description: Represents 64 bit float. - description: >- - This field allows restricts to be based on numeric comparisons rather - than categorical tokens. - id: GoogleCloudAiplatformV1IndexDatapointNumericRestriction + - MODEL_TYPE_UNSPECIFIED + - CLOUD + - CLOUD_1 + - MOBILE_TF_LOW_LATENCY_1 + - MOBILE_TF_VERSATILE_1 + - MOBILE_TF_HIGH_ACCURACY_1 + - EFFICIENTNET + - MAXVIT + - VIT + - COCA + tunableParameter: + description: Trainer type for Vision TrainRequest. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs type: object - GoogleCloudAiplatformV1DeployIndexResponse: - description: Response message for IndexEndpointService.DeployIndex. - id: GoogleCloudAiplatformV1DeployIndexResponse - properties: - deployedIndex: - description: The DeployedIndex that had been deployed in the IndexEndpoint. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' + GoogleCloudAiplatformV1GenericOperationMetadata: type: object - GoogleCloudAiplatformV1FeatureViewIndexConfigTreeAHConfig: - description: Configuration options for the tree-AH algorithm. - id: GoogleCloudAiplatformV1FeatureViewIndexConfigTreeAHConfig + id: GoogleCloudAiplatformV1GenericOperationMetadata + description: Generic Metadata shared by all operations. properties: - leafNodeEmbeddingCount: + createTime: + format: google-datetime + readOnly: true + description: Output only. Time when the operation was created. + type: string + partialFailures: + readOnly: true + items: + $ref: '#/components/schemas/GoogleRpcStatus' description: >- - Optional. Number of embeddings on each leaf node. The default value - is 1000 if not set. + 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: array + updateTime: + readOnly: true type: string - format: int64 - type: object - GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly: - type: object - id: GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly + 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. + format: google-datetime + GoogleCloudAiplatformV1PredefinedSplit: properties: - featureStatsAnomaly: + key: description: >- - Output only. The stats and anomalies generated at specific - timestamp. - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureStatsAnomaly' - objective: + 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 - enum: - - OBJECTIVE_UNSPECIFIED - - IMPORT_FEATURE_ANALYSIS - - SNAPSHOT_ANALYSIS - readOnly: true - description: Output only. The objective for each stats. - 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: >- - A list of historical SnapshotAnalysis or ImportFeaturesAnalysis stats - requested by user, sorted by FeatureStatsAnomaly.start_time descending. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation: + Assigns input data to training, validation, and test sets based on the + value of a provided key. Supported only for tabular Datasets. type: object + id: GoogleCloudAiplatformV1PredefinedSplit + GoogleCloudAiplatformV1StudySpecMetricSpec: + id: GoogleCloudAiplatformV1StudySpecMetricSpec properties: - columnName: - type: string - invalidValuesAllowed: + safetyConfig: 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 - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation - 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. - GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig: - id: GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig + 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 + metricId: + description: >- + Required. The ID of the metric. Must not contain whitespaces and + must be unique amongst all MetricSpecs. + type: string + goal: + description: Required. The optimization goal of the metric. + enumDescriptions: + - Goal Type will default to maximize. + - Maximize the goal metric. + - Minimize the goal metric. + type: string + enum: + - GOAL_TYPE_UNSPECIFIED + - MAXIMIZE + - MINIMIZE + description: Represents a metric to optimize. type: object - description: >- - OnlineServingConfig specifies the details for provisioning online - serving resources. + GoogleCloudAiplatformV1TensorboardTensor: + type: object + description: One point viewable on a tensor metric plot. properties: - fixedNodeCount: - type: integer + value: 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. + Required. Serialized form of + https://github.com/tensorflow/tensorflow/blob/master/tensorflow/core/framework/tensor.proto + format: byte + type: string + versionNumber: + description: Optional. Version number of TensorProto used to serialize value. + type: integer format: int32 - 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 - GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest: + id: GoogleCloudAiplatformV1TensorboardTensor + GoogleCloudAiplatformV1PythonPackageSpec: + description: The spec of a Python packaged code. + id: GoogleCloudAiplatformV1PythonPackageSpec type: object - description: Request message for MetadataService.AddContextArtifactsAndExecutions. properties: - executions: - items: - type: string - type: array - description: >- - The resource names of the Executions to associate with the Context. - Format: - `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` - artifacts: + args: type: array items: type: string - description: >- - The resource names of the Artifacts to attribute to the Context. - Format: - `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` - id: GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata: - properties: - trainCostMilliNodeHours: + description: Command line arguments to be passed to the Python task. + pythonModule: 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 - evaluatedDataItemsBigqueryUri: - type: string - description: BigQuery destination uri for exported evaluated examples. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata - description: Model metadata specific to Seq2Seq Plus Forecasting. - type: object - GoogleCloudAiplatformV1EntityIdSelector: - id: GoogleCloudAiplatformV1EntityIdSelector - description: Selector for entityId. Getting ids from the given source. - type: object - properties: - csvSource: - description: Source of Csv - $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvSource' - entityIdField: + Required. The Python module name to run after installing the + packages. + executorImageUri: description: >- - Source column that holds entity IDs. If not provided, entity IDs are - extracted from the column named entity_id. - type: string - GoogleCloudAiplatformV1FeatureViewSyncConfig: - id: GoogleCloudAiplatformV1FeatureViewSyncConfig - properties: - cron: + 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. type: string + env: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EnvVar' 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 * * - * *". - description: Configuration for Sync. Only one option is set. - type: object - GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetrics: - properties: - quantileMetrics: - description: The quantile metrics entries for each quantile. + Environment variables to be passed to the python module. Maximum + limit is 100. + type: array + 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. items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry + type: string type: array - rSquared: + GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetrics: + properties: + rootMeanSquaredError: + type: number + format: float + description: Root Mean Squared Error (RMSE). + 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: format: float + description: >- + Root Mean Square Percentage Error. Square root of MSPE. + Undefined/imaginary when MSPE is negative. + type: number + rSquared: description: >- Coefficient of determination as Pearson correlation coefficient. Undefined when ground truth or predictions are constant or near constant. type: number - meanAbsolutePercentageError: - type: number format: float + meanAbsolutePercentageError: description: >- Mean absolute percentage error. Infinity when there are zeros in the ground truth. - meanAbsoluteError: - type: number - format: float - description: Mean Absolute Error (MAE). - weightedAbsolutePercentageError: - 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 type: number - rootMeanSquaredError: - description: Root Mean Squared Error (RMSE). + meanAbsoluteError: type: number + description: Mean Absolute Error (MAE). format: float + quantileMetrics: + description: The quantile metrics entries for each quantile. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry rootMeanSquaredLogError: + format: float description: >- Root mean squared log error. Undefined when there are negative ground truth values or predictions. - format: float - type: number - rootMeanSquaredPercentageError: type: number - format: float - description: >- - Root Mean Square Percentage Error. Square root of MSPE. - Undefined/imaginary when MSPE is negative. type: object + description: Metrics for forecasting evaluation results. id: >- GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetrics - description: Metrics for forecasting evaluation results. - GoogleCloudAiplatformV1ErrorAnalysisAnnotation: - type: object - description: Model error analysis for each annotation. + GoogleCloudAiplatformV1ActiveLearningConfig: properties: - outlierThreshold: - description: >- - The threshold used to determine if this annotation is an outlier or - not. - format: double - type: number - outlierScore: - format: double + trainingConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingConfig' description: >- - The outlier score of this annotated item. Usually defined as the min - of all distances from attributed items. - type: number - queryType: - description: The query type used for finding the attributed items. + 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: + format: int32 + type: integer + description: Max percent of total DataItems for human labeling. + maxDataItemCount: type: string - enum: - - QUERY_TYPE_UNSPECIFIED - - ALL_SIMILAR - - SAME_CLASS_SIMILAR - - 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. - attributedItems: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem + description: Max number of human labeled DataItems. + format: int64 + sampleConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SampleConfig' description: >- - Attributed items for a given annotation, typically representing - neighbors from the training sets constrained by the query type. - id: GoogleCloudAiplatformV1ErrorAnalysisAnnotation - GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView: + Active learning data sampling config. For every active learning + labeling iteration, it will select a batch of data based on the + sampling strategy. + 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 + GoogleCloudAiplatformV1UpdateFeaturestoreOperationMetadata: + type: object + description: Details of operations that perform update Featurestore. properties: - entityId: - description: ID of the requested entity. + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for Featurestore. + id: GoogleCloudAiplatformV1UpdateFeaturestoreOperationMetadata + GoogleRpcStatus: + id: GoogleRpcStatus + properties: + message: type: string - data: + 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: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData 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. + 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: + format: int32 + description: The status code, which should be an enum value of google.rpc.Code. + 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). type: object - id: GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView - description: Entity view with Feature values. - GoogleCloudAiplatformV1MetadataStore: + GoogleCloudAiplatformV1ExportModelRequest: properties: - dataplexConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MetadataStoreDataplexConfig - description: Optional. Dataplex integration settings. - updateTime: - format: google-datetime - description: Output only. Timestamp when this MetadataStore was last updated. - readOnly: true - 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' - createTime: - format: google-datetime - type: string - description: Output only. Timestamp when this MetadataStore was created. - readOnly: true - description: - type: string - description: Description of the MetadataStore. - name: - readOnly: true - type: string - description: Output only. The resource name of the MetadataStore instance. - state: - description: Output only. State information of the MetadataStore. + outputConfig: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MetadataStoreMetadataStoreState - readOnly: true - description: >- - Instance of a metadata store. Contains a set of metadata that can be - queried. + #/components/schemas/GoogleCloudAiplatformV1ExportModelRequestOutputConfig + description: Required. The desired output location and configuration. + id: GoogleCloudAiplatformV1ExportModelRequest + description: Request message for ModelService.ExportModel. type: object - id: GoogleCloudAiplatformV1MetadataStore - GoogleCloudAiplatformV1UpsertDatapointsRequest: - description: Request message for IndexService.UpsertDatapoints - id: GoogleCloudAiplatformV1UpsertDatapointsRequest + GoogleCloudAiplatformV1ListExecutionsResponse: + id: GoogleCloudAiplatformV1ListExecutionsResponse + description: Response message for MetadataService.ListExecutions. type: object 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. + nextPageToken: type: string - format: google-fieldmask - datapoints: + 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: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + description: The Executions retrieved from the MetadataStore. type: array - description: A list of datapoints to be created/updated. - GoogleCloudAiplatformV1SearchEntryPoint: + GoogleCloudAiplatformV1CancelBatchPredictionJobRequest: + id: GoogleCloudAiplatformV1CancelBatchPredictionJobRequest + properties: {} + type: object + description: Request message for JobService.CancelBatchPredictionJob. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec: + type: object properties: - sdkBlob: - format: byte - description: Optional. Base64 encoded JSON representing array of tuple. - type: string - renderedContent: + maxTrialCount: + description: The desired total number of Trials. + format: int32 + type: integer + maxFailedTrialCount: description: >- - Optional. Web content snippet that can be embedded in a web page or - an app webview. - type: string - type: object - id: GoogleCloudAiplatformV1SearchEntryPoint - description: Google search entry point. - GoogleCloudAiplatformV1CountTokensRequest: + 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 + parallelTrialCount: + format: int32 + description: The desired number of Trials to run in parallel. + type: integer + studySpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' + description: Study configuration of the HyperparameterTuningJob. + trialJobSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' + description: >- + The spec of a trial job. The same spec applies to the CustomJobs + created in all the trials. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec + GoogleCloudAiplatformV1BatchReadFeatureValuesRequest: + description: Request message for FeaturestoreService.BatchReadFeatureValues. + id: GoogleCloudAiplatformV1BatchReadFeatureValuesRequest properties: - model: + startTime: type: string + format: google-datetime description: >- - Required. The name of the publisher model requested to serve the - prediction. Format: - `projects/{project}/locations/{location}/publishers/*/models/*` - contents: - description: Required. Input content. + 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. + destination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueDestination' + description: Required. Specifies output location and format. + passThroughFields: type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' - instances: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField + 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. + bigqueryReadInstances: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' + description: Similar to csv_read_instances, but from BigQuery source. + entityTypeSpecs: + description: >- + Required. Specifies EntityType grouping Features to read values of + and settings. items: - type: any + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec + type: array + csvReadInstances: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvSource' description: >- - Required. The instances that are the input to token counting call. - Schema is identical to the prediction schema of the underlying - model. + 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`. + type: object + GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines: + description: Open fine tuning pipelines. + id: GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines + properties: + fineTuningPipelines: + description: Required. Regional resource references to fine tuning pipelines. type: array - id: GoogleCloudAiplatformV1CountTokensRequest - description: Request message for PredictionService.CountTokens. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences type: object - GoogleCloudAiplatformV1ListDataLabelingJobsResponse: - description: Response message for JobService.ListDataLabelingJobs. + GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList: + description: >- + Response structure in the format of key (feature name) and (feature) + value pair. + id: >- + GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList properties: - dataLabelingJobs: + features: + description: List of feature names and values. + type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair + 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. + properties: + parts: type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Part' description: >- - A list of DataLabelingJobs that matches the specified filter in the - request. - nextPageToken: + Required. Ordered `Parts` that constitute a single message. Parts + may have different IANA MIME types. + role: + description: >- + Optional. The producer of the content. Must be either 'user' or + 'model'. Useful to set for multi-turn conversations, otherwise can + be left blank or unset. type: string - description: The standard List next-page token. + id: GoogleCloudAiplatformV1Content type: object - id: GoogleCloudAiplatformV1ListDataLabelingJobsResponse - CloudAiLargeModelsVisionImage: - id: CloudAiLargeModelsVisionImage + GoogleCloudAiplatformV1ListContextsResponse: properties: - encoding: - type: string - description: Image encoding, encoded as "image/png" or "image/jpg". - image: - type: string - description: Raw bytes. - format: byte - uri: - type: string - description: Path to another storage (typically Google Cloud Storage). - semanticFilterResponse: - $ref: '#/components/schemas/CloudAiLargeModelsVisionSemanticFilterResponse' - description: Semantic filter info for image. - raiInfo: - $ref: '#/components/schemas/CloudAiLargeModelsVisionRaiInfo' - description: RAI info for image. - imageRaiScores: - $ref: '#/components/schemas/CloudAiLargeModelsVisionImageRAIScores' - description: RAI scores for generated image. - text: + nextPageToken: type: string - description: Text/Expanded text input for imagen. - description: Image. + 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: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' + description: The Contexts retrieved from the MetadataStore. + type: array + id: GoogleCloudAiplatformV1ListContextsResponse + description: Response message for MetadataService.ListContexts. type: object - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig: - description: >- - The config for Training & Prediction data skew detection. It specifies - the training dataset sources and the skew detection parameters. - id: >- - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig + GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride: + type: object + description: The input metadata entries to be overridden. 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. - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' - type: object - defaultSkewThreshold: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' - 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. - attributionScoreSkewThresholds: - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' + inputBaselines: 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 + 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 + items: + type: any + id: GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride + GoogleIamV1SetIamPolicyRequest: type: object - GoogleCloudAiplatformV1AvroSource: - id: GoogleCloudAiplatformV1AvroSource + id: GoogleIamV1SetIamPolicyRequest + description: Request message for `SetIamPolicy` method. properties: - gcsSource: - description: Required. Google Cloud Storage location. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' - description: The storage details for Avro input content. + 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' + GoogleCloudAiplatformV1ListArtifactsResponse: type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation: + 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. + type: string + artifacts: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + description: The Artifacts retrieved from the MetadataStore. + id: GoogleCloudAiplatformV1ListArtifactsResponse + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation: 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. * A boolean value that indicates whether the - value is valid. + 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. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation properties: columnName: type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation - GoogleCloudAiplatformV1PipelineJob: + GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadata: type: object - description: An instance of a machine learning PipelineJob. + id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadata + description: The metadata of Datasets that contain time series data. properties: - reservedIpRanges: - 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 - displayName: + timeColumn: type: string description: >- - The display name of the Pipeline. The name can be up to 128 - characters long and can consist of any UTF-8 characters. - 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. - templateMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineTemplateMetadata' + The column name of the time column that identifies time order in the + time series. + timeSeriesIdentifierColumn: + type: string description: >- - Output only. Pipeline template metadata. Will fill up fields if - PipelineJob.template_uri is from supported template registry. - readOnly: true - templateUri: + The column name of the time series identifier column that identifies + the time series. + inputConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig + GoogleCloudAiplatformV1PurgeExecutionsRequest: + id: GoogleCloudAiplatformV1PurgeExecutionsRequest + description: Request message for MetadataService.PurgeExecutions. + properties: + filter: 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 - startTime: + Required. A required filter matching the Executions to be purged. + E.g., `update_time <= 2020-11-19T11:30:00-04:00`. type: string - description: Output only. Pipeline start time. - format: google-datetime - readOnly: true - error: - readOnly: true + force: + type: boolean description: >- - Output only. The error that occurred during pipeline execution. Only - populated when the pipeline's state is FAILED or CANCELLED. - $ref: '#/components/schemas/GoogleRpcStatus' - scheduleName: - readOnly: true + 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 + GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse: + id: GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse + properties: {} + description: Response message for MetadataService.AddContextArtifactsAndExecutions. + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation + description: >- + Training pipeline will infer the proper transformation based on the + statistic of dataset. + properties: + columnName: + type: string + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata: + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata + type: object + properties: + backingCustomJob: description: >- - Output only. The schedule resource name. Only returned if the - Pipeline is created by Schedule API. + The resource name of the CustomJob that has been created to carry + out this custom task. type: string - jobDetail: - readOnly: true + GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScaling: + properties: + maxNodeCount: description: >- - Output only. The details of pipeline run. Not available in the list - view. - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJobDetail' - network: + 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 + minNodeCount: + type: integer + format: int32 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 - state: - description: Output only. The detailed state of the job. - 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 - 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 - pipelineSpec: - additionalProperties: - description: Properties of the object. - type: any - type: object - description: The spec of the pipeline. - updateTime: - type: string - format: google-datetime - description: >- - Output only. Timestamp when this PipelineJob was most recently - updated. - readOnly: true - runtimeConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJobRuntimeConfig' - description: Runtime config of the pipeline. - name: - description: Output only. The resource name of the PipelineJob. - readOnly: true - type: string - 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 - endTime: - description: Output only. Pipeline end time. - readOnly: true - format: google-datetime - type: string - serviceAccount: + Required. The minimum number of nodes to scale down to. Must be + greater than or equal to 1. + cpuUtilizationTarget: + type: integer 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. + 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. + 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). + type: object + id: GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScaling + CloudAiPlatformCommonCreatePipelineJobApiErrorDetail: + properties: + publicMessage: type: string - createTime: - readOnly: true - description: Output only. Pipeline creation time. - format: google-datetime + description: Public messages contains actionable items for the error cause. + errorCause: + description: The error root cause returned by CreatePipelineJob API. type: string - id: GoogleCloudAiplatformV1PipelineJob - GoogleCloudAiplatformV1CreateEntityTypeOperationMetadata: + 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 + 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: object - id: GoogleCloudAiplatformV1CreateEntityTypeOperationMetadata + description: 'Create API error message for Vertex Pipeline. Next Id: 3.' + id: CloudAiPlatformCommonCreatePipelineJobApiErrorDetail + GoogleCloudAiplatformV1SchemaImageSegmentationAnnotation: + id: GoogleCloudAiplatformV1SchemaImageSegmentationAnnotation + description: Annotation details specific to image segmentation. properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for EntityType. - description: Details of operations that perform create EntityType. - GoogleCloudAiplatformV1CreateTensorboardRunRequest: + maskAnnotation: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation + description: >- + Mask based segmentation annotation. Only one mask annotation can + exist for one image. + polygonAnnotation: + description: Polygon annotation. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation + polylineAnnotation: + description: Polyline annotation. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation + type: object + GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig: properties: - parent: + migrateDataLabelingAnnotatedDatasetConfigs: description: >- - Required. The resource name of the TensorboardExperiment to create - the TensorboardRun in. Format: - `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` + 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/GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig + type: array + dataset: type: string - tensorboardRunId: 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-/`. + Required. Full resource name of data labeling Dataset. Format: + `projects/{project}/datasets/{dataset}`. + datasetDisplayName: type: string - tensorboardRun: - description: Required. The TensorboardRun to create. - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' - id: GoogleCloudAiplatformV1CreateTensorboardRunRequest - description: Request message for TensorboardService.CreateTensorboardRun. - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation: + description: >- + Optional. Display name of the Dataset in Vertex AI. System will pick + a display name if unspecified. 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. + Config for migrating Dataset in datalabeling.googleapis.com to Vertex + AI's Dataset. id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation + GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig + type: object + GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity: + description: Response message if the request uses the SelectEntity option. + id: GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity type: object properties: - columnName: - type: string - timeFormat: + offlineStorageDeletedEntityRowCount: 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) + 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 - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs: + format: int64 + onlineStorageDeletedEntityCount: + type: string + format: int64 + description: >- + The count of deleted entities in the online storage. Each entity ID + corresponds to one entity. + GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest: + properties: {} type: object + id: GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest + description: Request message for NotebookService.UpgradeNotebookRuntime. + GoogleCloudAiplatformV1FetchFeatureValuesRequest: + description: >- + Request message for FeatureOnlineStoreService.FetchFeatureValues. All + the features under the requested feature view will be returned. + id: GoogleCloudAiplatformV1FetchFeatureValuesRequest properties: - modelType: + dataKey: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewDataKey' + description: Optional. The request key to fetch feature values for. + dataFormat: 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. + - Not set. Will be treated as the KeyValue format. + - Return response data in key-value format. + - Return response data in proto Struct format. 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 - type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs - GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest: - type: object - properties: - requests: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest - type: array + - FEATURE_VIEW_DATA_FORMAT_UNSPECIFIED + - KEY_VALUE + - PROTO_STRUCT description: >- - Required. The request message specifying the TensorboardTimeSeries - to create. A maximum of 1000 TensorboardTimeSeries can be created in - a batch. - description: Request message for TensorboardService.BatchCreateTensorboardTimeSeries. - id: GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest - GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse: - properties: - notebookRuntimeTemplates: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate - description: List of NotebookRuntimeTemplates in the requested page. - type: array - nextPageToken: + Optional. Response data format. If not set, + FeatureViewDataFormat.KEY_VALUE will be used. type: string - description: >- - A token to retrieve next page of results. Pass to - ListNotebookRuntimeTemplatesRequest.page_token to obtain that page. - description: Response message for NotebookService.ListNotebookRuntimeTemplates. type: object - id: GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse - GoogleCloudAiplatformV1ExportDataOperationMetadata: - id: GoogleCloudAiplatformV1ExportDataOperationMetadata - properties: - genericMetadata: - description: The common part of the operation metadata. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - gcsOutputDirectory: - type: string - description: >- - A Google Cloud Storage directory which path ends with '/'. The - exported data is stored in the directory. - description: Runtime operation information for DatasetService.ExportData. + GoogleCloudAiplatformV1AssignNotebookRuntimeOperationMetadata: + description: Metadata information for NotebookService.AssignNotebookRuntime. + id: GoogleCloudAiplatformV1AssignNotebookRuntimeOperationMetadata type: object - GoogleCloudAiplatformV1StartNotebookRuntimeOperationMetadata: - description: Metadata information for NotebookService.StartNotebookRuntime. - id: GoogleCloudAiplatformV1StartNotebookRuntimeOperationMetadata properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. progressMessage: - type: string description: >- A human-readable message that shows the intermediate progress details of NotebookRuntime. - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation: + type: string + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. + GoogleCloudAiplatformV1VertexAISearch: 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. + Retrieve from Vertex AI Search datastore for grounding. See + https://cloud.google.com/vertex-ai-search-and-conversation properties: - columnName: + datastore: + description: >- + Required. Fully-qualified Vertex AI Search's datastore resource ID. + Format: + `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` type: string + id: GoogleCloudAiplatformV1VertexAISearch + type: object + GoogleCloudAiplatformV1SchemaPredictParamsImageSegmentationPredictionParams: id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation + GoogleCloudAiplatformV1SchemaPredictParamsImageSegmentationPredictionParams + properties: + confidenceThreshold: + type: number + format: float + 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. + description: Prediction model parameters for Image Segmentation. type: object - GoogleCloudAiplatformV1ImportFeatureValuesOperationMetadata: + GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec: + description: >- + Selects Features of an EntityType to read values of and specifies read + settings. type: object - description: Details of operations that perform import Feature values. - id: GoogleCloudAiplatformV1ImportFeatureValuesOperationMetadata + id: GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec properties: - timestampOutsideRetentionRowsCount: + featureSelector: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' description: >- - The number rows that weren't ingested due to having timestamps - outside the retention boundary. - format: int64 + Required. Selectors choosing which Feature values to read from the + EntityType. + entityTypeId: type: string - invalidRowCount: 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 + Required. ID of the EntityType to select Features. The EntityType id + is the entity_type_id specified during EntityType creation. + settings: + description: Per-Feature settings for the batch read. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DestinationFeatureSetting + type: array + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig: + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig + 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. + properties: + strideLength: type: string - importedFeatureValueCount: + 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 + maxCount: + description: >- + Maximum number of windows that should be generated across all time + series. format: int64 - description: Number of Feature values that have been imported by the operation. type: string - blockingOperationIds: + column: description: >- - List of ImportFeatureValues operations running under a single - EntityType that are blocking this operation. - type: array - items: - format: int64 - type: string - importedEntityCount: - description: Number of entities that have been imported by the operation. + 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 - format: int64 - sourceUris: - items: - type: string - description: The source URI from where Feature values are imported. - type: array - genericMetadata: - description: Operation metadata for Featurestore import Feature values. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse: + GoogleCloudAiplatformV1MutateDeployedModelResponse: type: object - id: GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse properties: - importedEvaluatedAnnotationsCount: - format: int32 - type: integer - description: Output only. Number of EvaluatedAnnotations imported. - readOnly: true - description: Response message for ModelService.BatchImportEvaluatedAnnotations - GoogleCloudAiplatformV1ExplainRequest: + deployedModel: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' + description: The DeployedModel that's being mutated. + id: GoogleCloudAiplatformV1MutateDeployedModelResponse + description: Response message for EndpointService.MutateDeployedModel. + GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput: type: object - id: GoogleCloudAiplatformV1ExplainRequest - description: Request message for PredictionService.Explain. + description: The output of a multi-trial Neural Architecture Search (NAS) jobs. properties: - deployedModelId: - type: string - description: >- - If specified, this ExplainRequest will be served by the chosen - DeployedModel, overriding Endpoint.traffic_split. - parameters: - type: any + trainTrials: + type: array 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' + Output only. List of NasTrials that were started as part of train + stage. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' + readOnly: true + searchTrials: + readOnly: true 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: + Output only. List of NasTrials that were started as part of search + stage. items: - type: any + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' type: array - 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. - GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution: - description: Dataset distribution for Supervised Tuning. - id: GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution + id: GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput + GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest: properties: - buckets: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket - description: Output only. Defines the histogram bucket. - readOnly: true - type: array - median: - format: double - description: Output only. The median of the values in the population. - type: number - readOnly: true - sum: - format: int64 + deploymentResourcePoolId: + 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])?$/`. type: string - description: Output only. Sum of a given population of values. - readOnly: true - max: - readOnly: true - format: double - type: number - description: Output only. The maximum of the population values. - min: - format: double - readOnly: true - type: number - description: Output only. The minimum of the population values. - p95: - type: number - description: Output only. The 95th percentile of the values in the population. - format: double - readOnly: true - mean: - readOnly: true - type: number - format: double - description: Output only. The arithmetic mean of the values in the population. - p5: - type: number - description: Output only. The 5th percentile of the values in the population. - format: double - readOnly: true - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs: + deploymentResourcePool: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool' + description: Required. The DeploymentResourcePool to create. type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs + description: Request message for CreateDeploymentResourcePool method. + id: GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest + 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. properties: - sentimentMax: - type: integer - format: int32 + dataItemSchemaUri: 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). - GoogleCloudAiplatformV1NasJob: - id: GoogleCloudAiplatformV1NasJob - description: Represents a Neural Architecture Search (NAS) job. - properties: - error: - readOnly: true + 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. + type: string + annotationSchemaUri: + type: string description: >- - Output only. Only populated when job's state is JOB_STATE_FAILED or - JOB_STATE_CANCELLED. - $ref: '#/components/schemas/GoogleRpcStatus' - enableRestrictedImageTraining: + 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. + modelExplanation: description: >- - Optional. Enable a separation of Custom model training and - restricted image training for tenant project. - type: boolean - deprecated: true - updateTime: + 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' + explanationSpecs: + description: >- + Describes the values of ExplanationSpec that are used for explaining + the predicted values on the evaluated data. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec + type: array + metrics: + type: any + description: >- + Evaluation metrics of the Model. The schema of the metrics is stored + in metrics_schema_uri + createTime: + description: Output only. Timestamp when this ModelEvaluation was created. + readOnly: true format: google-datetime - description: Output only. Time when the NasJob was most recently updated. type: string + name: readOnly: true - displayName: + description: Output only. The resource name of the ModelEvaluation. type: string + metadata: + type: any 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. - nasJobSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJobSpec' - description: Required. The specification of a NasJob. - name: - description: Output only. Resource name of the NasJob. - 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". + metricsSchemaUri: + 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). type: string - nasJobOutput: - description: Output only. Output of the NasJob. - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJobOutput' - startTime: + sliceDimensions: + items: + type: string + type: array description: >- - Output only. Time when the NasJob for the first time entered the - `JOB_STATE_RUNNING` state. - format: google-datetime - readOnly: true + All possible dimensions of ModelEvaluationSlices. The dimensions can + be used as the filter of the ModelService.ListModelEvaluationSlices + request, in the form of `slice.dimension = `. + displayName: type: string + description: The display name of the ModelEvaluation. + type: object + GoogleCloudAiplatformV1Execution: + type: object + id: GoogleCloudAiplatformV1Execution + properties: 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 + - STATE_UNSPECIFIED + - NEW + - RUNNING + - COMPLETE + - FAILED + - CACHED + - CANCELLED 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. + - 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. + type: string + 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. + createTime: + format: google-datetime + description: Output only. Timestamp when this Execution was created. readOnly: true - labels: + type: string + etag: + description: >- + An eTag used to perform consistent read-modify-write updates. If not + set, a blind "overwrite" update happens. + type: string + displayName: + description: >- + User provided display name of the Execution. May be up to 128 + Unicode characters. + type: string + schemaVersion: + type: string + 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. + metadata: additionalProperties: - type: string + type: any + description: Properties of the 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. + 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 + labels: type: object - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' 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. - endTime: + 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 + name: + readOnly: true type: string + description: Output only. The resource name of the Execution. + updateTime: + description: Output only. Timestamp when this Execution was last updated. + format: google-datetime readOnly: true + type: string + description: + description: Description of the Execution + type: string + schemaTitle: 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 - createTime: + 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 - readOnly: true - format: google-datetime - description: Output only. Time when the NasJob was created. + description: Instance of a general execution. + GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket: type: object - GoogleCloudAiplatformV1DirectPredictResponse: - id: GoogleCloudAiplatformV1DirectPredictResponse - description: Response message for PredictionService.DirectPredict. properties: - parameters: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - description: The parameters that govern the prediction. - outputs: - type: array - description: The prediction output. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + count: + type: number + description: Output only. Number of values in the bucket. + readOnly: true + format: double + left: + type: number + format: double + readOnly: true + description: Output only. Left bound of the bucket. + right: + format: double + description: Output only. Right bound of the bucket. + type: number + readOnly: true + description: >- + Dataset bucket used to create a histogram for the distribution given a + population of values. + id: GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetection: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetection type: object - GoogleCloudAiplatformV1BatchCreateFeaturesResponse: - id: GoogleCloudAiplatformV1BatchCreateFeaturesResponse - description: Response message for FeaturestoreService.BatchCreateFeatures. properties: - features: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' - type: array - description: The Features created. + inputs: + description: The input parameters of this TrainingJob. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs + metadata: + description: The metadata information + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata + description: >- + A TrainingJob that trains and uploads an AutoML Image Object Detection + Model. + GoogleCloudAiplatformV1TuningDataStats: + id: GoogleCloudAiplatformV1TuningDataStats type: object - GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData: - id: GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData - description: Per month usage data properties: - userUsageData: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData - description: Usage data for each user in the given month. - type: array + distillationDataStats: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DistillationDataStats' + description: Statistics for distillation. + supervisedTuningDataStats: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDataStats + description: The SFT Tuning data stats. + reinforcementLearningDataStats: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReinforcementLearningDataStats + description: Statistics for reinforcement learning. + description: The tuning data statistic values for TuningJob. + GoogleCloudAiplatformV1ListFeaturesResponse: + description: >- + Response message for FeaturestoreService.ListFeatures. Response message + for FeatureRegistryService.ListFeatures. + id: GoogleCloudAiplatformV1ListFeaturesResponse type: object - GoogleCloudAiplatformV1Tool: properties: - functionDeclarations: + features: + type: array + description: The Features matching the request. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionDeclaration' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + nextPageToken: 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 - googleSearchRetrieval: + 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 + GoogleCloudAiplatformV1UndeployModelResponse: + type: object + description: Response message for EndpointService.UndeployModel. + properties: {} + id: GoogleCloudAiplatformV1UndeployModelResponse + 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. + properties: + maxReplicaCount: + type: integer description: >- - Optional. GoogleSearchRetrieval tool type. Specialized retrieval - tool that is powered by Google search. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GoogleSearchRetrieval' - retrieval: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Retrieval' + 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 + minReplicaCount: + type: integer + format: int32 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. - id: GoogleCloudAiplatformV1Tool + 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: 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). - GoogleCloudAiplatformV1Tensor: - id: GoogleCloudAiplatformV1Tensor + id: GoogleCloudAiplatformV1AutomaticResources + GoogleCloudAiplatformV1Attribution: + description: Attribution that explains a particular prediction output. type: object properties: - tensorVal: + 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 + readOnly: true + outputDisplayName: type: string - description: Serialized raw tensor content. - format: byte - boolVal: + readOnly: true 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 - type: array - items: - type: boolean - bytesVal: - items: - format: byte - type: string - type: array - description: STRING - uint64Val: + 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. + outputName: + readOnly: true + description: >- + Output only. Name of the explain output. Specified as the key in + ExplanationMetadata.outputs. + type: string + outputIndex: items: - type: string - format: uint64 - type: array - description: UINT64 - shape: + format: int32 + type: integer type: array - description: Shape of the tensor. - items: - type: string - format: int64 - floatVal: - type: array - items: - format: float - type: number - description: FLOAT - listVal: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - description: A list of tensor values. - doubleVal: - items: - format: double - type: number - description: DOUBLE - type: array - stringVal: - description: STRING - type: array - items: - type: string - 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. - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - DATA_TYPE_UNSPECIFIED - - BOOL - - STRING - - FLOAT - - DOUBLE - - INT8 - - INT16 - - INT32 - - INT64 - - UINT8 - - UINT16 - - UINT32 - - UINT64 - description: The data type of tensor. - type: string - intVal: - type: array - description: INT_8 INT_16 INT_32 - items: - type: integer - format: int32 - int64Val: - type: array - description: INT64 - items: - type: string - format: int64 - structVal: - description: A map of string to tensor. - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - type: object - uintVal: - description: UINT8 UINT16 UINT32 - items: - format: uint32 - type: integer - type: array - description: A tensor value type. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig: + 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. + readOnly: true + 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 + readOnly: true + type: number + instanceOutputValue: + readOnly: true + 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 + 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). + id: GoogleCloudAiplatformV1Attribution + GoogleCloudAiplatformV1CreateFeaturestoreOperationMetadata: + description: Details of operations that perform create Featurestore. + id: GoogleCloudAiplatformV1CreateFeaturestoreOperationMetadata type: object - id: 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. properties: - maxCount: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for Featurestore. + GoogleCloudAiplatformV1MetadataSchema: + id: GoogleCloudAiplatformV1MetadataSchema + description: Instance of a general MetadataSchema. + properties: + name: + readOnly: true + description: Output only. The resource name of the MetadataSchema. type: string - description: >- - Maximum number of windows that should be generated across all time - series. - format: int64 - strideLength: + schemaVersion: 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 - 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. + 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. + description: + description: Description of the Metadata Schema type: string - GoogleCloudAiplatformV1SchemaPredictInstanceImageObjectDetectionPredictionInstance: - description: Prediction input format for Image Object Detection. - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceImageObjectDetectionPredictionInstance - properties: - content: + createTime: + type: string + format: google-datetime + readOnly: true + description: Output only. Timestamp when this MetadataSchema was created. + schema: type: string - description: The image bytes or Cloud Storage URI to make the prediction on. - 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 + 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) + schemaType: + 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. + 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 type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation: - type: object - 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. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation - GoogleCloudAiplatformV1PublisherModelCallToActionDeploy: - description: >- - Model metadata that is needed for UploadModel or - DeployModel/CreateEndpoint requests. + GoogleCloudAiplatformV1Artifact: + id: GoogleCloudAiplatformV1Artifact type: object + description: Instance of a general artifact. 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. - modelDisplayName: - description: Optional. Default model display name. - type: string - publicArtifactUri: - description: >- - Optional. The signed URI for ephemeral Cloud Storage access to model - artifact. - type: string - deployTaskName: + etag: description: >- - Optional. The name of the deploy task (e.g., "text to image - generation"). + An eTag used to perform consistent read-modify-write updates. If not + set, a blind "overwrite" update happens. type: string - title: + uri: type: string - description: Required. The title of the regional resource reference. - largeModelReference: description: >- - Optional. Large model reference. When this is set, - model_artifact_spec is not needed. - $ref: '#/components/schemas/GoogleCloudAiplatformV1LargeModelReference' - artifactUri: + The uniform resource identifier of the artifact file. May be empty + if there is no actual artifact file. + displayName: description: >- - Optional. The path to the directory containing the Model artifact - and any of its supporting files. - type: string - sharedResources: + User provided display name of the Artifact. May be up to 128 Unicode + characters. type: string + labels: + additionalProperties: + type: string + type: object description: >- - The resource name of the shared DeploymentResourcePool to deploy on. - Format: - `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` - dedicatedResources: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' - description: >- - A description of resources that are dedicated to the DeployedModel, - and that need a higher degree of manual configuration. - id: GoogleCloudAiplatformV1PublisherModelCallToActionDeploy - GoogleCloudAiplatformV1CitationMetadata: - id: GoogleCloudAiplatformV1CitationMetadata - properties: - citations: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Citation' - type: array - description: Output only. List of citations. + 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). + updateTime: + type: string + format: google-datetime + description: Output only. Timestamp when this Artifact was last updated. readOnly: true - description: A collection of source attributions for a piece of content. - type: object - GoogleCloudAiplatformV1DiskSpec: - id: GoogleCloudAiplatformV1DiskSpec - type: object - properties: - bootDiskSizeGb: - description: Size in GB of the boot disk (default is 100GB). - format: int32 - type: integer - bootDiskType: + schemaVersion: 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). - description: Represents the spec of disk options. - 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. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation - type: object - description: >- - Training pipeline will infer the proper transformation based on the - statistic of dataset. - properties: - columnName: + 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. + description: + description: Description of the Artifact type: string - GoogleCloudAiplatformV1StudySpecMetricSpec: - id: GoogleCloudAiplatformV1StudySpecMetricSpec - description: Represents a metric to optimize. - type: object - properties: - safetyConfig: + schemaTitle: 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 - metricId: + 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 + state: + 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. description: >- - Required. The ID of the metric. Must not contain whitespaces and - must be unique amongst all MetricSpecs. - goal: + 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. type: string enum: - - GOAL_TYPE_UNSPECIFIED - - MAXIMIZE - - MINIMIZE - enumDescriptions: - - Goal Type will default to maximize. - - Maximize the goal metric. - - Minimize the goal metric. - description: Required. The optimization goal of the metric. - GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse: - id: GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse - properties: - tensorboardTimeSeries: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries' - description: The created TensorboardTimeSeries. - type: array - description: >- - Response message for - TensorboardService.BatchCreateTensorboardTimeSeries. - type: object - GoogleCloudAiplatformV1ExplanationSpecOverride: - description: >- - The ExplanationSpec entries that can be overridden at online explanation - time. - id: GoogleCloudAiplatformV1ExplanationSpecOverride - type: object - properties: + - STATE_UNSPECIFIED + - PENDING + - LIVE + name: + type: string + description: Output only. The resource name of the Artifact. + readOnly: true metadata: + additionalProperties: + type: any + description: Properties of the object. description: >- - The metadata to be overridden. If not specified, no metadata is - overridden. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataOverride - examplesOverride: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExamplesOverride' - description: The example-based explanations parameter overrides. - parameters: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationParameters' - description: >- - The parameters to be overridden. Note that the attribution method - cannot be changed. If not specified, no parameter is overridden. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecasting: - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecasting - type: object - description: A TrainingJob that trains and uploads an AutoML Forecasting Model. + Properties of the Artifact. Top level metadata keys' heading and + trailing spaces will be trimmed. The size of this field should not + exceed 200KB. + type: object + createTime: + type: string + format: google-datetime + readOnly: true + description: Output only. Timestamp when this Artifact was created. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs: properties: - inputs: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs - description: The input parameters of this TrainingJob. - metadata: + dataGranularity: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata - description: The metadata information. - GoogleCloudAiplatformV1AssignNotebookRuntimeRequest: - properties: - notebookRuntimeId: - type: string - description: Optional. User specified ID for the notebook runtime. - notebookRuntimeTemplate: + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity + description: Expected difference in time granularity between rows in the data. + timeColumn: type: string description: >- - Required. The resource name of the NotebookRuntimeTemplate based on - which a NotebookRuntime will be assigned (reuse or create a new - one). - notebookRuntime: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookRuntime' + The name of the column that identifies time order in the time + series. This column must be available at forecast. + contextWindow: description: >- - Required. Provide runtime specific information (e.g. runtime owner, - notebook id) used for NotebookRuntime assignment. - id: GoogleCloudAiplatformV1AssignNotebookRuntimeRequest - type: object - description: Request message for NotebookService.AssignNotebookRuntime. - GoogleCloudAiplatformV1PersistentDiskSpec: - description: Represents the spec of persistent disk options. - properties: - diskSizeGb: - type: string - description: Size in GB of the disk (default is 100GB). + 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 - diskType: - description: >- - Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" - (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk - Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) - "pd-extreme" (Extreme Persistent Disk) type: string - type: object - id: GoogleCloudAiplatformV1PersistentDiskSpec - GoogleCloudAiplatformV1SchemaVisualInspectionMaskSavedQueryMetadata: - type: object - properties: {} - id: GoogleCloudAiplatformV1SchemaVisualInspectionMaskSavedQueryMetadata - GoogleCloudAiplatformV1FeatureSelector: - description: Selector for Features of an EntityType. - id: GoogleCloudAiplatformV1FeatureSelector - type: object - properties: - idMatcher: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IdMatcher' - description: Required. Matches Features based on ID. - GoogleCloudAiplatformV1TFRecordDestination: - id: GoogleCloudAiplatformV1TFRecordDestination - type: object - properties: - gcsDestination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' - description: Required. Google Cloud Storage location. - description: The storage details for TFRecord output content. - GoogleCloudAiplatformV1UpdateExplanationDatasetRequest: - properties: - examples: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Examples' - description: The example config containing the location of the dataset. - id: GoogleCloudAiplatformV1UpdateExplanationDatasetRequest - type: object - description: Request message for ModelService.UpdateExplanationDataset. - GoogleCloudAiplatformV1UpsertDatapointsResponse: - description: Response message for IndexService.UpsertDatapoints - id: GoogleCloudAiplatformV1UpsertDatapointsResponse - properties: {} - type: object - GoogleCloudAiplatformV1SchemaPredictParamsVideoActionRecognitionPredictionParams: - type: object - id: >- - GoogleCloudAiplatformV1SchemaPredictParamsVideoActionRecognitionPredictionParams - description: Prediction model parameters for Video Action Recognition. - properties: - confidenceThreshold: - description: >- - The Model only returns predictions with at least this confidence - score. Default value is 0.0 - type: number - format: float - maxPredictions: - 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. - type: integer - GoogleCloudAiplatformV1FindNeighborsRequestQuery: - description: >- - A query to find a number of the nearest neighbors (most similar vectors) - of a vector. - id: GoogleCloudAiplatformV1FindNeighborsRequestQuery - properties: - 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. - type: integer - format: int32 - datapoint: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' + hierarchyConfig: description: >- - Required. The datapoint/vector whose nearest neighbors should be - searched for. - rrf: + Configuration that defines the hierarchical relationship of time + series and parameters for hierarchical forecasting strategies. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF - description: Optional. Represents RRF algorithm that combines search results. - neighborCount: - 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). - format: int32 - approximateNeighborCount: - format: int32 + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig + transformations: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation 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 - fractionLeafNodesToSearchOverride: - type: number - format: double + 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 + forecastHorizon: 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. - type: object - GoogleCloudAiplatformV1SchemaPredictPredictionTextExtractionPredictionResult: - description: Prediction output format for Text Extraction. - properties: - ids: + 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 + timeSeriesAttributeColumns: description: >- - The resource IDs of the AnnotationSpecs that had been identified, - ordered by the confidence score descendingly. + 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 - format: int64 - type: array - textSegmentStartOffsets: + trainBudgetMilliNodeHours: + 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: string + quantiles: 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. - items: - format: int64 - type: string - confidences: + 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: float type: number + format: double + holidayRegions: + items: + type: string description: >- - The Model's confidences in correctness of the predicted IDs, higher - value means higher confidence. Order matches the Ids. + 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 - textSegmentEndOffsets: - 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. + timeSeriesIdentifierColumn: + description: The name of the column that identifies the time series. + type: string + additionalExperiments: type: array + description: Additional experiment flags for the time series forcasting training. items: - format: int64 type: string - displayNames: + optimizationObjective: + 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 + 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 + 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. items: type: string - description: >- - The display names of the AnnotationSpecs that had been identified, - order matches the IDs. type: array - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionTextExtractionPredictionResult - type: object - GoogleCloudAiplatformV1NearestNeighbors: - type: object - id: GoogleCloudAiplatformV1NearestNeighbors - properties: - neighbors: - description: All its neighbors. + targetColumn: + description: >- + The name of the column that the Model is to predict values for. This + column must be unavailable at forecast. + type: string + 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: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborsNeighbor - description: Nearest neighbors for one query. - GoogleCloudAiplatformV1Retrieval: - properties: - disableAttribution: - type: boolean + type: string + weightColumn: + type: string description: >- - Optional. Disable using the result from this tool in detecting - grounding attribution. This does not affect how the result is given - to the model for generation. - vertexAiSearch: - $ref: '#/components/schemas/GoogleCloudAiplatformV1VertexAISearch' - description: Set to use data source powered by Vertex AI Search. - description: >- - Defines a retrieval tool that model can call to access external - knowledge. + 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. + 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 + windowConfig: + description: Config containing strategy for generating sliding windows. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig type: object - id: GoogleCloudAiplatformV1Retrieval - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity: + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs + GoogleCloudAiplatformV1ToolConfig: + id: GoogleCloudAiplatformV1ToolConfig + properties: + functionCallingConfig: + description: Optional. Function calling config. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionCallingConfig' type: object - description: A duration of time expressed in time granularity units. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity + description: >- + Tool config. This config is shared for all tools provided in the + request. + GoogleCloudAiplatformV1SchemaVideoDataItem: + type: object + description: Payload of Video DataItem. + id: GoogleCloudAiplatformV1SchemaVideoDataItem properties: - quantity: + gcsUri: 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 - unit: - type: string + 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. + mimeType: + readOnly: true description: >- - The time granularity unit of this time period. The supported units - are: * "minute" * "hour" * "day" * "week" * "month" * "year" - GoogleCloudAiplatformV1ModelBaseModelSource: - id: GoogleCloudAiplatformV1ModelBaseModelSource - description: >- - User input field to specify the base model source. Currently it only - supports specifing the Model Garden models and Genie models. + 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 + GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest: + id: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest + properties: {} + type: object + description: Request message for VizierService.CheckTrialEarlyStoppingState. + GoogleCloudAiplatformV1RemoveDatapointsRequest: properties: - genieSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenieSource' - description: Information about the base model of Genie models. - modelGardenSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelGardenSource' - description: Source information of Model Garden models. + datapointIds: + type: array + items: + type: string + description: A list of datapoint ids to be deleted. + id: GoogleCloudAiplatformV1RemoveDatapointsRequest type: object - GoogleCloudAiplatformV1FunctionDeclaration: + description: Request message for IndexService.RemoveDatapoints + GoogleCloudAiplatformV1NearestNeighborsNeighbor: + id: GoogleCloudAiplatformV1NearestNeighborsNeighbor + description: A neighbor of the query vector. type: object - 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. - id: GoogleCloudAiplatformV1FunctionDeclaration properties: - 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. + distance: + type: number + description: The distance between the neighbor and the query vector. + format: double + entityId: type: string - parameters: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' + description: The id of the similar entity. + entityKeyValues: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponse 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 - 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. + GoogleCloudAiplatformV1PipelineTaskExecutorDetail: + description: The runtime detail of a pipeline executor. + properties: + customJobDetail: + description: Output only. The detailed info for a custom job executor. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail + containerDetail: + description: Output only. The detailed info for a container executor. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail + id: GoogleCloudAiplatformV1PipelineTaskExecutorDetail + type: object + GoogleCloudAiplatformV1SupervisedHyperParameters: + description: Hyperparameters for SFT. + properties: + learningRateMultiplier: + format: double + description: Optional. Multiplier for adjusting the default learning rate. + type: number + adapterSize: + enumDescriptions: + - Adapter size is unspecified. + - Adapter size 1. + - Adapter size 4. + - Adapter size 8. + - Adapter size 16. + description: Optional. Adapter size for tuning. type: string + enum: + - ADAPTER_SIZE_UNSPECIFIED + - ADAPTER_SIZE_ONE + - ADAPTER_SIZE_FOUR + - ADAPTER_SIZE_EIGHT + - ADAPTER_SIZE_SIXTEEN + epochCount: + format: int64 description: >- - Optional. Description and purpose of the function. Model uses it to - decide how and whether to call the function. - GoogleCloudAiplatformV1ExplanationMetadataOverride: - description: >- - The ExplanationMetadata entries that can be overridden at online - explanation time. + Optional. Number of complete passes the model makes over the entire + training dataset during training. + type: string + id: GoogleCloudAiplatformV1SupervisedHyperParameters + type: object + GoogleCloudAiplatformV1IdMatcher: + description: Matcher for Features of an EntityType by Feature ID. type: object properties: - inputs: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride - type: object + ids: 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. - id: GoogleCloudAiplatformV1ExplanationMetadataOverride - GoogleCloudAiplatformV1ServiceAccountSpec: - description: >- - Configuration for the use of custom service account to run the - workloads. + 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 + id: GoogleCloudAiplatformV1IdMatcher + GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig: + id: >- + GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig type: object - id: GoogleCloudAiplatformV1ServiceAccountSpec + description: Config for migrating version in ml.googleapis.com to Vertex AI's Model. properties: - enableCustomServiceAccount: - type: boolean + modelVersion: + type: string 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: + Required. Full resource name of ml engine model version. Format: + `projects/{project}/models/{model}/versions/{version}`. + modelDisplayName: + description: >- + Required. Display name of the model in Vertex AI. System will pick a + display name if unspecified. type: string + endpoint: 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. - GoogleApiHttpBody: - properties: - contentType: + 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 + GoogleCloudAiplatformV1Candidate: + description: A response candidate generated from the model. + type: object + id: GoogleCloudAiplatformV1Candidate + properties: + citationMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CitationMetadata' + description: Output only. Source attribution of the generated content. + readOnly: true + finishMessage: + readOnly: true description: >- - The HTTP Content-Type header value specifying the content type of - the body. - extensions: + Output only. Describes the reason the mode stopped generating tokens + in more detail. This is only filled when `finish_reason` is set. + type: string + content: + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + description: Output only. Content parts of the candidate. + index: + type: integer + format: int32 + readOnly: true + description: Output only. Index of the candidate. + safetyRatings: description: >- - Application specific response metadata. Must be set in the first - response for streaming APIs. + Output only. List of ratings for the safety of a response candidate. + There is at most one rating per category. + readOnly: true + type: array items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - type: array - data: - description: The HTTP request/response body as raw binary. - format: byte + $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyRating' + finishReason: + enum: + - FINISH_REASON_UNSPECIFIED + - STOP + - MAX_TOKENS + - SAFETY + - RECITATION + - OTHER + - BLOCKLIST + - PROHIBITED_CONTENT + - SPII type: string - id: GoogleApiHttpBody - 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. + description: >- + Output only. The reason why the model stopped generating tokens. If + empty, the model has not stopped generating the tokens. + readOnly: true + enumDescriptions: + - The finish reason is unspecified. + - Natural stop point of the model or provided stop sequence. + - >- + The maximum number of tokens as specified in the request was + reached. + - >- + The token generation was stopped as the response was flagged for + safety reasons. NOTE: When streaming the Candidate.content will be + empty if content filters blocked the output. + - >- + The token generation was stopped as the response was flagged for + unauthorized citations. + - All other reasons that stopped the token generation + - >- + The token generation was stopped as the response was flagged for + the terms which are included from the terminology blocklist. + - >- + The token generation was stopped as the response was flagged for + the prohibited contents. + - >- + The token generation was stopped as the response was flagged for + Sensitive Personally Identifiable Information (SPII) contents. + groundingMetadata: + description: >- + Output only. Metadata specifies sources used to ground generated + content. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundingMetadata' + GoogleCloudAiplatformV1UndeployIndexOperationMetadata: type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation: + id: GoogleCloudAiplatformV1UndeployIndexOperationMetadata + description: Runtime operation information for IndexEndpointService.UndeployIndex. properties: - text: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation - timestamp: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation - auto: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation - categorical: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation - numeric: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation - type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation - GoogleCloudAiplatformV1ListEndpointsResponse: - id: GoogleCloudAiplatformV1ListEndpointsResponse + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1ExplanationSpec: type: object - description: Response message for EndpointService.ListEndpoints. properties: - endpoints: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' - type: array - description: List of Endpoints in the requested page. - nextPageToken: + metadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationMetadata' description: >- - A token to retrieve the next page of results. Pass to - ListEndpointsRequest.page_token to obtain that page. - type: string - GoogleCloudAiplatformV1CopyModelResponse: - id: GoogleCloudAiplatformV1CopyModelResponse - properties: - model: + Optional. Metadata describing the Model's input and output for + explanation. + parameters: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationParameters' description: >- - The name of the copied Model resource. Format: - `projects/{project}/locations/{location}/models/{model}` - type: string - modelVersionId: - type: string - description: Output only. The version ID of the model that is copied. - readOnly: true - type: object - description: Response message of ModelService.CopyModel operation. - GoogleCloudAiplatformV1TimeSeriesData: - id: GoogleCloudAiplatformV1TimeSeriesData + Required. Parameters that configure explaining of the Model's + predictions. + id: GoogleCloudAiplatformV1ExplanationSpec + description: Specification of Model explanation. + GoogleCloudAiplatformV1ExplainRequest: properties: - tensorboardTimeSeriesId: + explanationSpecOverride: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpecOverride' description: >- - Required. The ID of the TensorboardTimeSeries, which will become the - final component of the TensorboardTimeSeries' resource name - type: string - valueType: + 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. + 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 - 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 - values: + If specified, this ExplainRequest will be served by the chosen + DeployedModel, overriding Endpoint.traffic_split. + instances: + 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: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesDataPoint' - description: Required. Data points in this time series. - description: All the data stored in a TensorboardTimeSeries. + type: any + description: Request message for PredictionService.Explain. + id: GoogleCloudAiplatformV1ExplainRequest type: object - GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResult: - description: Prediction output format for Video Object Tracking. - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResult + GoogleCloudAiplatformV1SchemaPredictInstanceVideoActionRecognitionPredictionInstance: type: object + description: Prediction input format for Video Action Recognition. + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceVideoActionRecognitionPredictionInstance properties: - displayName: + content: type: string - description: The display name of the AnnotationSpec that had been identified. + description: >- + The Google Cloud Storage location of the video on which to perform + the prediction. 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. + 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: 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 + 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 - id: + mimeType: type: string - description: The resource ID of the AnnotationSpec that had been identified. - frames: - 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. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame - type: array - confidence: - format: float - type: number description: >- - The Model's confidence in correction of this prediction, higher - value means higher confidence. - GoogleCloudAiplatformV1TunedModel: + The MIME type of the content of the video. Only the following are + supported: video/mp4 video/avi video/quicktime + GoogleCloudAiplatformV1SchemaPredictParamsVideoActionRecognitionPredictionParams: + type: object + id: >- + GoogleCloudAiplatformV1SchemaPredictParamsVideoActionRecognitionPredictionParams + description: Prediction model parameters for Video Action Recognition. properties: - model: - readOnly: true + confidenceThreshold: description: >- - Output only. The resource name of the TunedModel. Format: - `projects/{project}/locations/{location}/models/{model}`. - type: string - endpoint: + The Model only returns predictions with at least this confidence + score. Default value is 0.0 + type: number + format: float + maxPredictions: description: >- - Output only. A resource name of an Endpoint. Format: - `projects/{project}/locations/{location}/endpoints/{endpoint}`. - readOnly: true - type: string - type: object - id: GoogleCloudAiplatformV1TunedModel - description: >- - The Model Registry Model and Online Prediction Endpoint assiociated with - this TuningJob. - GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpec: - description: The spec of multi-trial Neural Architecture Search (NAS). + 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. + type: integer + format: int32 + GoogleCloudAiplatformV1StudySpecParameterSpec: 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 + conditionalParameterSpecs: description: >- - The multi-trial Neural Architecture Search (NAS) algorithm type. - Defaults to `REINFORCEMENT_LEARNING`. - enum: - - MULTI_TRIAL_ALGORITHM_UNSPECIFIED - - REINFORCEMENT_LEARNING - - GRID_SEARCH - trainTrialSpec: + 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 + categoricalValueSpec: + description: The value spec for a 'CATEGORICAL' parameter. $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. - searchTrialSpec: + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec + integerValueSpec: + description: The value spec for an 'INTEGER' parameter. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec - description: Required. Spec for search trials. - metric: + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec + doubleValueSpec: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecMetricSpec + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec + description: The value spec for a 'DOUBLE' parameter. + discreteValueSpec: + description: The value spec for a 'DISCRETE' parameter. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec + parameterId: description: >- - Metric specs for the NAS job. Validation for this field is done at - `multi_trial_algorithm_spec` field. - type: object - id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpec - GoogleCloudAiplatformV1SchemaTextSentimentSavedQueryMetadata: - type: object - id: GoogleCloudAiplatformV1SchemaTextSentimentSavedQueryMetadata - properties: - sentimentMax: - format: int32 - type: integer - description: The maximum sentiment of sentiment Anntoation in this SavedQuery. - description: The metadata of SavedQuery contains TextSentiment Annotations. - GoogleCloudAiplatformV1ReadTensorboardUsageResponse: - description: Response message for TensorboardService.ReadTensorboardUsage. - type: object - properties: - monthlyUsageData: - description: Maps year-month (YYYYMM) string to per month usage data. - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData - type: object - id: GoogleCloudAiplatformV1ReadTensorboardUsageResponse - 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. - type: object - id: GoogleCloudAiplatformV1TimestampSplit - properties: - key: + Required. The ID of the parameter. Must not contain whitespaces and + must be unique amongst all ParameterSpecs. 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. - testFraction: - type: number - format: double - description: >- - The fraction of the input data that is to be used to evaluate the - Model. - trainingFraction: - type: number - description: >- - The fraction of the input data that is to be used to train the - Model. - format: double - validationFraction: - format: double - type: number - description: >- - The fraction of the input data that is to be used to validate the - Model. - GoogleCloudAiplatformV1NotebookRuntimeTemplateRef: - properties: - notebookRuntimeTemplate: + scaleType: + enum: + - SCALE_TYPE_UNSPECIFIED + - UNIT_LINEAR_SCALE + - UNIT_LOG_SCALE + - UNIT_REVERSE_LOG_SCALE type: string - description: Immutable. A resource name of the NotebookRuntimeTemplate. - description: Points to a NotebookRuntimeTemplateRef. - id: GoogleCloudAiplatformV1NotebookRuntimeTemplateRef + description: >- + 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. type: object - GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance: - id: GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance + id: GoogleCloudAiplatformV1StudySpecParameterSpec + description: Represents a single parameter to optimize. + GoogleCloudAiplatformV1DeleteOperationMetadata: + properties: + genericMetadata: + description: The common part of the operation metadata. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Details of operations that perform deletes of any entities. + id: GoogleCloudAiplatformV1DeleteOperationMetadata type: object + GoogleCloudAiplatformV1UpsertDatapointsRequest: properties: - attributeColumns: - items: - type: string - type: array - contextWeights: - type: array - items: - type: number - format: float - description: >- - TFT feature importance values. Each pair for - {context/horizon/attribute} should have the same shape since the - weight corresponds to the column names. - contextColumns: - items: - type: string - type: array - horizonWeights: - items: - format: float - type: number - type: array - attributeWeights: - type: array + datapoints: items: - format: float - type: number - horizonColumns: + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' + description: A list of datapoints to be created/updated. type: array - items: - type: string - GoogleCloudAiplatformV1FunctionCall: - id: 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. - type: object - properties: - args: - type: object - additionalProperties: - description: Properties of the object. - type: any - description: >- - Optional. Required. The function parameters and values in JSON - object format. See [FunctionDeclaration.parameters] for parameter - details. - name: + updateMask: description: >- - Required. The name of the function to call. Matches - [FunctionDeclaration.name]. + 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 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. + id: GoogleCloudAiplatformV1UpsertDatapointsRequest + type: object + description: Request message for IndexService.UpsertDatapoints + GoogleCloudAiplatformV1FeatureViewDataKey: type: object properties: - createTime: - readOnly: true + key: type: string - description: Output only. Timestamp when this ModelEvaluationSlice was created. - format: google-datetime - slice: + description: String key to use for lookup. + compositeKey: description: >- - Output only. The slice of the test data that is used to evaluate the - Model. + 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/GoogleCloudAiplatformV1ModelEvaluationSliceSlice - readOnly: true - 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 - metricsSchemaUri: + #/components/schemas/GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey + description: Lookup key for a feature view. + id: GoogleCloudAiplatformV1FeatureViewDataKey + GoogleCloudAiplatformV1UpgradeNotebookRuntimeOperationMetadata: + type: object + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. + progressMessage: + 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 - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + A human-readable message that shows the intermediate progress + details of NotebookRuntime. + id: GoogleCloudAiplatformV1UpgradeNotebookRuntimeOperationMetadata + description: Metadata information for NotebookService.UpgradeNotebookRuntime. + GoogleCloudAiplatformV1NotebookRuntime: + id: GoogleCloudAiplatformV1NotebookRuntime + properties: + runtimeState: readOnly: true + description: Output only. The runtime (instance) state of the NotebookRuntime. type: string - name: + 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 + proxyUri: + description: Output only. The proxy endpoint used to access the NotebookRuntime. + type: string + readOnly: true + 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. readOnly: true type: string - description: Output only. The resource name of the ModelEvaluationSlice. - modelExplanation: + description: Output only. The type of the notebook runtime. + enum: + - NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED + - USER_DEFINED + - ONE_CLICK + idleShutdownConfig: 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. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig - description: Configuration for exporting test set predictions to a BigQuery table. - type: object - 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: + Output only. The idle shutdown configuration of the notebook + runtime. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookIdleShutdownConfig + expirationTime: + format: google-datetime 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` + 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 - GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig: - id: GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig - description: Requests are randomly selected. - properties: - sampleRate: - type: number - description: Sample rate (0, 1] - format: double - type: object - GoogleCloudLocationLocation: - type: object - id: GoogleCloudLocationLocation - description: A resource that represents a Google Cloud location. - properties: - metadata: + readOnly: true + healthState: + type: string + description: Output only. The health state of the NotebookRuntime. + enumDescriptions: + - Unspecified health state. + - NotebookRuntime is in healthy state. Applies to ACTIVE state. + - NotebookRuntime is in unhealthy state. Applies to ACTIVE state. + enum: + - HEALTH_STATE_UNSPECIFIED + - HEALTHY + - UNHEALTHY + readOnly: true + version: + type: string + description: Output only. The VM os image version of NotebookRuntime. + readOnly: true + notebookRuntimeTemplateRef: + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplateRef 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 - type: object - labels: - additionalProperties: - type: string - type: object + Output only. The pointer to NotebookRuntimeTemplate this + NotebookRuntime is created from. + isUpgradable: + type: boolean + readOnly: true + description: Output only. Whether NotebookRuntime is upgradable. + encryptionSpec: + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - Cross-service attributes for the location. For example - {"cloud.googleapis.com/region": "us-east1"} - locationId: - description: 'The canonical id for this location. For example: `"us-east1"`.' + Output only. Customer-managed encryption key spec for the notebook + runtime. + description: + description: The description of the NotebookRuntime. type: string displayName: type: string description: >- - The friendly name for this location, typically a nearby city name. - For example, "Tokyo". - name: + Required. The display name of the NotebookRuntime. The name can be + up to 128 characters long and can consist of any UTF-8 characters. + updateTime: type: string description: >- - Resource name for the location, which may vary between - implementations. For example: - `"projects/example-project/locations/us-east1"` - CloudAiLargeModelsVisionGenerateVideoResponse: - description: Generate video response. - type: object - id: CloudAiLargeModelsVisionGenerateVideoResponse - properties: - raiMediaFilteredReasons: + Output only. Timestamp when this NotebookRuntime was most recently + updated. + format: google-datetime + 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 - description: Returns rai failure reasons if any. items: type: string - raiMediaFilteredCount: - type: integer - description: Returns if any videos were filtered due to RAI policies. - format: int32 - generatedSamples: - items: - $ref: '#/components/schemas/CloudAiLargeModelsVisionMedia' - description: The generates samples. - type: array - GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest: + name: + description: Output only. The resource name of the NotebookRuntime. + readOnly: true + type: string + serviceAccount: + description: >- + Output only. The service account that the NotebookRuntime workload + runs as. + readOnly: true + type: string + runtimeUser: + type: string + description: Required. The user email of the NotebookRuntime. + satisfiesPzi: + readOnly: true + description: Output only. Reserved for future use. + type: boolean + labels: + type: object + additionalProperties: + type: string + 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. + satisfiesPzs: + type: boolean + readOnly: true + description: Output only. Reserved for future use. + 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. + GoogleCloudAiplatformV1LookupStudyRequest: + description: Request message for VizierService.LookupStudy. type: object properties: - deploymentResourcePoolId: - 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])?$/`. + displayName: + description: Required. The user-defined display name of the Study type: string - deploymentResourcePool: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool' - description: Required. The DeploymentResourcePool to create. - id: GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest - description: Request message for CreateDeploymentResourcePool method. - GoogleCloudAiplatformV1ExplanationParameters: + id: GoogleCloudAiplatformV1LookupStudyRequest + GoogleCloudAiplatformV1ListTuningJobsResponse: + description: Response message for GenAiTuningService.ListTuningJobs properties: - 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). - 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 - topK: - 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. - format: int32 - 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: - description: >- - Example-based explanations that returns the nearest neighbors from - the provided dataset. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Examples' - integratedGradientsAttribution: + nextPageToken: + type: string 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 - description: Parameters to configure explaining for Model's predictions. - id: GoogleCloudAiplatformV1ExplanationParameters + 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. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' type: object - GoogleCloudAiplatformV1UpdateFeatureOperationMetadata: - properties: - genericMetadata: - description: Operation metadata for Feature Update. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + id: GoogleCloudAiplatformV1ListTuningJobsResponse + GoogleCloudAiplatformV1DistillationDataStats: + description: Statistics computed for datasets used for distillation. + id: GoogleCloudAiplatformV1DistillationDataStats type: object - id: GoogleCloudAiplatformV1UpdateFeatureOperationMetadata - description: Details of operations that perform update Feature. - GoogleCloudAiplatformV1DeleteFeatureValuesOperationMetadata: properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Featurestore delete Features values. - id: GoogleCloudAiplatformV1DeleteFeatureValuesOperationMetadata + trainingDatasetStats: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetStats' + readOnly: true + description: Output only. Statistics computed for the training dataset. + GoogleCloudAiplatformV1FindNeighborsResponseNeighbor: type: object - description: Details of operations that delete Feature values. - GoogleCloudAiplatformV1AddContextChildrenRequest: + id: GoogleCloudAiplatformV1FindNeighborsResponseNeighbor + description: A neighbor of the query vector. properties: - childContexts: + distance: + type: number + format: double + description: The distance between the neighbor and the dense embedding query. + sparseDistance: + description: The distance between the neighbor and the query sparse_embedding. + format: double + type: number + datapoint: + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' + 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. + GoogleCloudAiplatformV1DeployedIndex: + properties: + reservedIpRanges: type: array items: type: string - description: The resource names of the child Contexts. - type: object - description: Request message for MetadataService.AddContextChildren. - id: GoogleCloudAiplatformV1AddContextChildrenRequest - GoogleCloudAiplatformV1SchemaPredictInstanceTextExtractionPredictionInstance: - type: object - properties: - content: + 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. + 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. + indexSyncTime: + readOnly: true + format: google-datetime + 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. type: string - description: The text snippet to make the predictions on. - key: + id: 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. - mimeType: + 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: + type: string description: >- - The MIME type of the text snippet. The supported MIME types are - listed below. - text/plain + The display name of the DeployedIndex. If not provided upon + creation, the Index's display_name is used. + createTime: + description: Output only. Timestamp when the DeployedIndex was created. type: string - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceTextExtractionPredictionInstance - description: Prediction input format for Text Extraction. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs: - type: object - properties: - disableEarlyStopping: + format: google-datetime + readOnly: true + enableAccessLogging: 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: + 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. + automaticResources: + $ref: '#/components/schemas/GoogleCloudAiplatformV1AutomaticResources' 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 + 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. + 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. + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexPrivateEndpoints' + readOnly: true + deployedIndexAuthConfig: + description: >- + Optional. If set, the authentication is enabled for the private + endpoint. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndexAuthConfig' + deploymentGroup: type: string - 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 - modelType: + 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'). + index: 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. - tunableParameter: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter - description: Trainer type for Vision TrainRequest. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs - GoogleCloudAiplatformV1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics: - description: Metrics for general pairwise text generation evaluation results. + description: >- + Required. The name of the Index this is the deployment of. We may + refer to this Index as the DeployedIndex's "original" Index. + description: >- + A deployment of an Index. IndexEndpoints contain one or more + DeployedIndexes. type: object + id: GoogleCloudAiplatformV1DeployedIndex + GoogleCloudAiplatformV1FeaturestoreMonitoringConfigSnapshotAnalysis: properties: - humanPreferenceModelWinRate: - format: float - description: Percentage of time humans decided the model had the better response. - type: number - cohensKappa: - format: float - description: >- - A measurement of agreement between the autorater and human raters - that takes the likelihood of random agreement into account. - type: number - accuracy: - format: float - description: Fraction of cases where the autorater agreed with the human raters. - type: number - humanPreferenceBaselineModelWinRate: - type: number - format: float + disabled: + type: boolean description: >- - Percentage of time humans decided the baseline model had the better - response. - truePositiveCount: + 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: description: >- - Number of examples where both the autorater and humans decided that - the model had the better response. - type: string - format: int64 - trueNegativeCount: - format: int64 + Configuration of the snapshot analysis based monitoring pipeline + running interval. The value indicates number of days. + format: int32 + type: integer + stalenessDays: + type: integer description: >- - Number of examples where both the autorater and humans decided that - the model had the worse response. - type: string - f1Score: - description: Harmonic mean of precision and recall. + 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 + 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 + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTables: + properties: + inputs: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs + description: The input parameters of this TrainingJob. + metadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata + description: The metadata information. + description: A TrainingJob that trains and uploads an AutoML Tables Model. + type: object + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTables + GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics: + properties: + meanAveragePrecision: + description: The mean average precision. format: float type: number - precision: + precisionWindowLength: + format: google-duration 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 + 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. - format: float - type: number - 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 - falsePositiveCount: type: string - format: int64 - description: >- - Number of examples where the autorater chose the model, but humans - preferred the baseline model. - baselineModelWinRate: + confidenceMetrics: + type: array description: >- - Percentage of time the autorater decided the baseline model had the - better response. - type: number - format: float - falseNegativeCount: + 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 + id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics + GoogleCloudAiplatformV1SearchMigratableResourcesRequest: + type: object + properties: + filter: type: string description: >- - Number of examples where the autorater chose the baseline model, but - humans preferred the model. - format: int64 - modelWinRate: - description: >- - Percentage of time the autorater decided the model had the better - response. + 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. + pageSize: + description: The standard page size. The default and maximum value is 100. + format: int32 + type: integer + pageToken: + type: string + description: The standard page token. + id: GoogleCloudAiplatformV1SearchMigratableResourcesRequest + description: Request message for MigrationService.SearchMigratableResources. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry: + properties: + quantile: + description: The quantile for this entry. + type: number + format: double + scaledPinballLoss: + description: The scaled pinball loss of this quantile. type: number format: float + 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 id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics - GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec: - id: GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec + GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry type: object - 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. + description: Entry for the Quantiles loss type optimization objective. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation: 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. - GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse: - description: Response message for TensorboardService.ReadTensorboardTimeSeriesData. + categorical: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation + numeric: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation + text: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation + auto: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation + timestamp: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation type: object - id: GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse - properties: - timeSeriesData: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesData' - description: The returned time series data. - GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec: - id: GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation + GoogleCloudAiplatformV1SampleConfig: + id: GoogleCloudAiplatformV1SampleConfig type: object - properties: - featureSelector: - description: >- - Required. Selectors choosing which Feature values to read from the - EntityType. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' - 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: - description: Per-Feature settings for the batch read. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DestinationFeatureSetting - type: array description: >- - Selects Features of an EntityType to read values of and specifies read - settings. - GoogleCloudAiplatformV1DeployIndexOperationMetadata: - type: object + Active learning data sampling config. For every active learning labeling + iteration, it will select a batch of data based on the sampling + strategy. properties: - genericMetadata: - description: The operation generic information. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - deployedIndexId: + sampleStrategy: + enumDescriptions: + - Default will be treated as UNCERTAINTY. + - Sample the most uncertain data to label. type: string - description: The unique index id specified by user - id: GoogleCloudAiplatformV1DeployIndexOperationMetadata - description: Runtime operation information for IndexEndpointService.DeployIndex. - GoogleCloudAiplatformV1TensorboardExperiment: + enum: + - SAMPLE_STRATEGY_UNSPECIFIED + - UNCERTAINTY + description: >- + Field to choose sampling strategy. Sampling strategy will decide + which data should be selected for human labeling in every batch. + followingBatchSamplePercentage: + description: >- + The percentage of data needed to be labeled in each following batch + (except the first batch). + type: integer + format: int32 + initialBatchSamplePercentage: + format: int32 + description: The percentage of data needed to be labeled in the first batch. + type: integer + GoogleCloudAiplatformV1PublisherModelCallToActionDeploy: properties: - source: + publicArtifactUri: type: string description: >- - Immutable. Source of the TensorboardExperiment. Example: a custom - training job. - etag: - description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. + Optional. The signed URI for ephemeral Cloud Storage access to model + artifact. + title: type: string - description: + description: Required. The title of the regional resource reference. + largeModelReference: + description: >- + Optional. Large model reference. When this is set, + model_artifact_spec is not needed. + $ref: '#/components/schemas/GoogleCloudAiplatformV1LargeModelReference' + artifactUri: type: string - description: Description of this TensorboardExperiment. - updateTime: description: >- - Output only. Timestamp when this TensorboardExperiment was last - updated. - format: google-datetime - readOnly: true + Optional. The path to the directory containing the Model artifact + and any of its supporting files. + 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. + 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' + modelDisplayName: + description: Optional. Default model display name. type: string - createTime: - readOnly: true - description: Output only. Timestamp when this TensorboardExperiment was created. - format: google-datetime + deployTaskName: type: string - name: - readOnly: true description: >- - Output only. Name of the TensorboardExperiment. Format: - `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` - type: string - labels: + Optional. The name of the deploy task (e.g., "text to image + generation"). + dedicatedResources: 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. - type: object - additionalProperties: - type: string - displayName: - description: User provided name of this TensorboardExperiment. + A description of resources that are dedicated to the DeployedModel, + and that need a higher degree of manual configuration. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' + sharedResources: type: string - id: GoogleCloudAiplatformV1TensorboardExperiment + description: >- + The resource name of the shared DeploymentResourcePool to deploy on. + Format: + `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` + id: GoogleCloudAiplatformV1PublisherModelCallToActionDeploy type: object description: >- - A TensorboardExperiment is a group of TensorboardRuns, that are - typically the results of a training job run, in a Tensorboard. - GoogleCloudAiplatformV1ExportFeatureValuesRequest: + Model metadata that is needed for UploadModel or + DeployModel/CreateEndpoint requests. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognition: properties: - featureSelector: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' - description: Required. Selects Features to export values of. - settings: - type: array - description: Per-Feature export settings. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DestinationFeatureSetting - snapshotExport: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport - description: >- - Exports the latest Feature values of all entities of the EntityType - within a time range. - destination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueDestination' - description: Required. Specifies destination location and format. - fullExport: - description: >- - Exports all historical values of all entities of the EntityType - within a time range + inputs: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport - id: GoogleCloudAiplatformV1ExportFeatureValuesRequest - description: Request message for FeaturestoreService.ExportFeatureValues. - type: object - GoogleCloudAiplatformV1CountTokensResponse: - properties: - totalBillableCharacters: - type: integer - description: >- - The total number of billable characters counted across all instances - from the request. - format: int32 - totalTokens: - type: integer - description: >- - The total number of tokens counted across all instances from the - request. - format: int32 - description: Response message for PredictionService.CountTokens. - id: GoogleCloudAiplatformV1CountTokensResponse - type: object - GoogleCloudAiplatformV1CancelBatchPredictionJobRequest: - description: Request message for JobService.CancelBatchPredictionJob. - id: GoogleCloudAiplatformV1CancelBatchPredictionJobRequest - properties: {} + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs + description: The input parameters of this TrainingJob. type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation: id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognition + description: >- + A TrainingJob that trains and uploads an AutoML Video Action Recognition + Model. + 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 properties: - columnName: - type: string - timeFormat: + functionCall: 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 - 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. - type: object - GoogleCloudAiplatformV1AutomaticResources: - 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. - properties: - minReplicaCount: - type: integer + 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' + fileData: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FileData' + description: Optional. URI based data. + videoMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1VideoMetadata' 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: + 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). + functionResponse: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionResponse' 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. - type: integer - format: int32 - id: GoogleCloudAiplatformV1AutomaticResources - GoogleCloudAiplatformV1SchemaTextSentimentAnnotation: + 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. + inlineData: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Blob' + description: Optional. Inlined bytes data. + id: GoogleCloudAiplatformV1Part + GoogleCloudAiplatformV1RemoveContextChildrenResponse: type: object + id: GoogleCloudAiplatformV1RemoveContextChildrenResponse + description: Response message for MetadataService.RemoveContextChildren. + properties: {} + GoogleCloudAiplatformV1ExportFractionSplit: properties: - sentiment: - description: The sentiment score for text. - format: int32 - type: integer - sentimentMax: - format: int32 - type: integer - description: The sentiment max score for text. - displayName: + validationFraction: + type: number + format: double description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. - type: string - annotationSpecId: + The fraction of the input data that is to be used to validate the + Model. + trainingFraction: + format: double description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. - type: string - description: Annotation details specific to text sentiment. - id: GoogleCloudAiplatformV1SchemaTextSentimentAnnotation - GoogleCloudAiplatformV1PythonPackageSpec: - description: The spec of a Python packaged code. + The fraction of the input data that is to be used to train the + Model. + type: number + testFraction: + description: >- + The fraction of the input data that is to be used to evaluate the + Model. + format: double + type: number + id: 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. + GoogleCloudAiplatformV1DatasetDistribution: type: object + description: Distribution computed over a tuning dataset. + id: GoogleCloudAiplatformV1DatasetDistribution properties: - env: - description: >- - Environment variables to be passed to the python module. Maximum - limit is 100. - type: array + p5: + description: Output only. The 5th percentile of the values in the population. + type: number + format: double + readOnly: true + median: + readOnly: true + description: Output only. The median of the values in the population. + format: double + type: number + min: + description: Output only. The minimum of the population values. + readOnly: true + type: number + format: double + sum: + type: number + description: Output only. Sum of a given population of values. + format: double + readOnly: true + mean: + format: double + type: number + readOnly: true + description: Output only. The arithmetic mean of the values in the population. + buckets: + readOnly: true items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EnvVar' - packageUris: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DatasetDistributionDistributionBucket + description: Output only. Defines the histogram bucket. type: array - items: - type: string + max: + description: Output only. The maximum of the population values. + format: double + readOnly: true + type: number + p95: + format: double + readOnly: true + description: Output only. The 95th percentile of the values in the population. + type: number + GoogleCloudAiplatformV1FilterSplit: + 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 + properties: + validationFilter: + type: string 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. - executorImageUri: + 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: + 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. + type: string + testFilter: 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. - args: + 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: object + GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec: + id: GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec + description: Value specification for a parameter in `CATEGORICAL` type. + properties: + values: type: array items: type: string - description: Command line arguments to be passed to the Python task. - pythonModule: + description: Required. The list of possible categories. + defaultValue: type: string description: >- - Required. The Python module name to run after installing the - packages. - id: GoogleCloudAiplatformV1PythonPackageSpec - GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec: + 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: object + GoogleCloudAiplatformV1DeployIndexRequest: 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 + deployedIndex: + description: Required. The DeployedIndex to be created within the IndexEndpoint. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' type: object - id: GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec - GoogleCloudAiplatformV1ListSavedQueriesResponse: - id: GoogleCloudAiplatformV1ListSavedQueriesResponse + id: GoogleCloudAiplatformV1DeployIndexRequest + description: Request message for IndexEndpointService.DeployIndex. + GoogleCloudAiplatformV1RawPredictRequest: + 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 type: object - description: Response message for DatasetService.ListSavedQueries. + description: Request message for PredictionService.RawPredict. + GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse: + description: Response message for NotebookService.ListNotebookRuntimeTemplates. properties: - savedQueries: + notebookRuntimeTemplates: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SavedQuery' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate + description: List of NotebookRuntimeTemplates in the requested page. type: array - description: >- - A list of SavedQueries that match the specified filter in the - request. nextPageToken: + description: >- + A token to retrieve next page of results. Pass to + ListNotebookRuntimeTemplatesRequest.page_token to obtain that page. type: string - description: The standard List next-page token. - GoogleCloudAiplatformV1GenericOperationMetadata: - id: GoogleCloudAiplatformV1GenericOperationMetadata - description: Generic Metadata shared by all operations. + id: GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse + type: object + GoogleCloudAiplatformV1DeployedModel: type: object + description: A deployment of a Model. Endpoints contain one or more DeployedModels. properties: - 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. - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - updateTime: - format: google-datetime - readOnly: true + id: + 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. + 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]/`. + displayName: type: string + description: >- + The display name of the DeployedModel. If not provided upon + creation, the Model's display_name is used. + 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. createTime: + description: Output only. Timestamp when the DeployedModel was created. type: string - description: Output only. Time when the operation was created. - readOnly: true format: google-datetime - GoogleCloudAiplatformV1TuningDataStats: - id: GoogleCloudAiplatformV1TuningDataStats - description: The tuning data statistic values for TuningJob. - type: object - properties: - reinforcementLearningDataStats: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReinforcementLearningDataStats - description: Statistics for reinforcement learning. - distillationDataStats: - description: Statistics for distillation. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DistillationDataStats' - supervisedTuningDataStats: - description: The SFT Tuning data stats. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDataStats - GoogleCloudAiplatformV1SuggestTrialsMetadata: - id: GoogleCloudAiplatformV1SuggestTrialsMetadata - type: object - properties: - genericMetadata: - description: Operation metadata for suggesting Trials. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - clientId: + readOnly: true + disableContainerLogging: + type: boolean 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. + 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. + modelVersionId: + description: Output only. The version ID of the model that is deployed. + readOnly: true type: string - description: Details of operations that perform Trials suggestion. - GoogleCloudAiplatformV1UpdateFeatureGroupOperationMetadata: - id: GoogleCloudAiplatformV1UpdateFeatureGroupOperationMetadata - type: object - properties: - genericMetadata: - description: Operation metadata for FeatureGroup. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Details of operations that perform update FeatureGroup. - GoogleCloudAiplatformV1EvaluatedAnnotation: - type: object - id: GoogleCloudAiplatformV1EvaluatedAnnotation - description: >- - True positive, false positive, or false negative. EvaluatedAnnotation is - only available under ModelEvaluationSlice with slice of `annotationSpec` - dimension. - properties: - groundTruths: + model: 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 - type: array - readOnly: true - items: - type: any - type: - 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. - readOnly: true - enum: - - EVALUATED_ANNOTATION_TYPE_UNSPECIFIED - - TRUE_POSITIVE - - FALSE_POSITIVE - - FALSE_NEGATIVE + 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 - dataItemPayload: - type: any - readOnly: true + privateEndpoints: description: >- - Output only. The data item payload that the Model predicted this - EvaluatedAnnotation on. - evaluatedDataItemViewId: + 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. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PrivateEndpoints' readOnly: true + sharedResources: type: string 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. - predictions: - items: - type: any - type: array + The resource name of the shared DeploymentResourcePool to deploy on. + Format: + `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` + explanationSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpec' 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 - errorAnalysisAnnotations: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ErrorAnalysisAnnotation - type: array - description: Annotations of model error analysis results. - explanations: + 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. + automaticResources: 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 - GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix: - type: object - id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix - properties: - annotationSpecs: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef - type: array + 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: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' 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. - rows: + A description of resources that are dedicated to the DeployedModel, + and that need a higher degree of manual configuration. + disableExplanations: + type: boolean 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: - items: - type: any - type: array - type: array - GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig: + If true, deploy the model without explainable feature, regardless + the existence of Model.explanation_spec or explanation_spec. + serviceAccount: + 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. + id: GoogleCloudAiplatformV1DeployedModel + GoogleCloudAiplatformV1FractionSplit: properties: - modelVersion: + validationFraction: + type: number description: >- - Required. Full resource name of ml engine model version. Format: - `projects/{project}/models/{model}/versions/{version}`. - type: string - endpoint: + The fraction of the input data that is to be used to validate the + Model. + format: double + testFraction: + format: double 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 - modelDisplayName: + The fraction of the input data that is to be used to evaluate the + Model. + type: number + trainingFraction: + format: double description: >- - Required. Display name of the model in Vertex AI. System will pick a - display name if unspecified. + The fraction of the input data that is to be used to train the + Model. + type: number + 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 + GoogleCloudAiplatformV1DirectRawPredictResponse: + type: object + properties: + output: + description: The prediction output. type: string + format: byte + id: GoogleCloudAiplatformV1DirectRawPredictResponse + description: Response message for PredictionService.DirectRawPredict. + GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition: + 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: + type: string + format: int64 id: >- - GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig - description: Config for migrating version in ml.googleapis.com to Vertex AI's Model. - type: object - GoogleCloudAiplatformV1RemoveDatapointsResponse: + GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition + description: Represents the spec to match integer values from parent parameter. type: object - description: Response message for IndexService.RemoveDatapoints + GoogleCloudAiplatformV1CancelDataLabelingJobRequest: + description: Request message for JobService.CancelDataLabelingJob. + id: GoogleCloudAiplatformV1CancelDataLabelingJobRequest properties: {} - id: GoogleCloudAiplatformV1RemoveDatapointsResponse - GoogleCloudAiplatformV1ExplanationMetadataInputMetadata: + type: object + GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey: + type: object + description: ID that is comprised from several parts (columns). + id: GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey properties: - indexFeatureMapping: + parts: + type: array + description: >- + Parts to construct Entity ID. Should match with the same ID columns + as defined in FeatureView in the same order. items: type: string - type: array + GoogleCloudAiplatformV1EncryptionSpec: + type: object + properties: + kmsKeyName: + type: string 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. - modality: + 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. + id: GoogleCloudAiplatformV1EncryptionSpec + GoogleCloudAiplatformV1SchemaTextDatasetMetadata: + properties: + dataItemSchemaUri: type: string description: >- - Modality of the feature. Valid values are: numeric, image. Defaults - to numeric. - indicesTensorName: + Points to a YAML file stored on Google Cloud Storage describing + payload of the Text DataItems that belong to this Dataset. + gcsBucket: + 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. + Google Cloud Storage Bucket name that contains the blob data of this + Dataset. + type: object + description: The metadata of Datasets that contain Text DataItems. + id: GoogleCloudAiplatformV1SchemaTextDatasetMetadata + GoogleCloudAiplatformV1SearchNearestEntitiesResponse: + id: GoogleCloudAiplatformV1SearchNearestEntitiesResponse + type: object + properties: + nearestNeighbors: + description: The nearest neighbors of the query entity. + $ref: '#/components/schemas/GoogleCloudAiplatformV1NearestNeighbors' + description: Response message for FeatureOnlineStoreService.SearchNearestEntities + GoogleCloudAiplatformV1EvaluatedAnnotationExplanation: + id: GoogleCloudAiplatformV1EvaluatedAnnotationExplanation + type: object + properties: + explanationType: + description: >- + Explanation type. For AutoML Image Classification models, possible + values are: * `image-integrated-gradients` * `image-xrai` type: string - encoding: + explanation: + description: Explanation attribution response details. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Explanation' + description: Explanation result of the prediction produced by the Model. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter: + properties: + studySpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' + description: >- + Optioinal. StudySpec of hyperparameter tuning job. Required for + `model_garden_trainer`. + trainerType: type: string + enumDescriptions: + - Default value. + - '' + - '' enum: - - ENCODING_UNSPECIFIED - - IDENTITY - - BAG_OF_FEATURES - - BAG_OF_FEATURES_SPARSE - - INDICATOR - - COMBINED_EMBEDDING - - CONCAT_EMBEDDING + - TRAINER_TYPE_UNSPECIFIED + - AUTOML_TRAINER + - MODEL_GARDEN_TRAINER + checkpointName: + type: string description: >- - Defines how the feature is encoded into the input tensor. Defaults - to IDENTITY. - 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]] ``` - visualization: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization - description: Visualization configurations for image explanation. - groupName: + Optional. An unique name of pretrained model checkpoint provided in + model garden, it will be mapped to a GCS location internally. + trainerConfig: + description: Customizable trainer settings, used in the `model_garden_trainer`. + additionalProperties: + type: string + type: object + datasetConfig: + description: Customizable dataset settings, used in the `model_garden_trainer`. + type: object + additionalProperties: + type: string + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter + type: object + description: >- + A wrapper class which contains the tunable parameters in an AutoML Image + training job. + GoogleCloudAiplatformV1WorkerPoolSpec: + id: GoogleCloudAiplatformV1WorkerPoolSpec + type: object + properties: + containerSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ContainerSpec' + description: The custom container task. + replicaCount: + format: int64 + type: string + description: Optional. The number of worker replicas to use for this worker pool. + diskSpec: + description: Disk spec. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DiskSpec' + pythonPackageSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PythonPackageSpec' + description: The Python packaged task. + machineSpec: + description: Optional. Immutable. The specification of a single machine. + $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' + nfsMounts: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NfsMount' + description: Optional. List of NFS mount spec. + description: Represents the spec of a worker pool in a job. + GoogleCloudAiplatformV1EnvVar: + properties: + value: type: string 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. - denseShapeTensorName: + 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: >- - 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. Name of the environment variable. Must be a valid C + identifier. type: string - featureValueDomain: + id: GoogleCloudAiplatformV1EnvVar + description: >- + Represents an environment variable present in a Container or Python + Module. + type: object + GoogleCloudAiplatformV1FindNeighborsRequestQuery: + id: GoogleCloudAiplatformV1FindNeighborsRequestQuery + properties: + perCrowdingAttributeNeighborCount: + type: integer + format: int32 description: >- - The domain details of the input feature value. Like min/max, - original mean or standard deviation if normalized. + 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. + rrf: + description: Optional. Represents RRF algorithm that combines search results. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain - inputTensorName: + #/components/schemas/GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF + neighborCount: description: >- - Name of the input tensor for this feature. Required and is only - applicable to Vertex AI-provided images for Tensorflow. + 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 + datapoint: + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' + description: >- + Required. The datapoint/vector whose nearest neighbors should be + searched for. + 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 + approximateNeighborCount: + type: integer + format: int32 + 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. + description: >- + A query to find a number of the nearest neighbors (most similar vectors) + of a vector. + type: object + GoogleCloudAiplatformV1Neighbor: + properties: + neighborDistance: + type: number + readOnly: true + description: Output only. The neighbor distance. + format: double + neighborId: type: string - inputBaselines: - type: array - items: - type: any + description: Output only. The neighbor id. + readOnly: true + description: Neighbors for example-based explanations. + id: GoogleCloudAiplatformV1Neighbor + type: object + 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 + `+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: + format: float + type: number + description: The amount of green in the color as a value in the interval [0, 1]. + alpha: + format: float + type: number 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. - encodedBaselines: - items: - type: any + 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: + format: float + description: The amount of red in the color as a value in the interval [0, 1]. + type: number + blue: + format: float + description: The amount of blue in the color as a value in the interval [0, 1]. + type: number + id: GoogleTypeColor + GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport: + properties: + startTime: 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 - encodedTensorName: + 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: string + endTime: 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. + 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: >- - 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 + Describes exporting all historical Feature values of all entities of the + EntityType between [start_time, end_time]. type: object - GoogleCloudAiplatformV1Model: + id: GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport + GoogleLongrunningOperation: + id: GoogleLongrunningOperation properties: - explanationSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpec' + error: + $ref: '#/components/schemas/GoogleRpcStatus' 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. - labels: + 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 + metadata: type: object 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. + 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: string - supportedInputStorageFormats: - type: array - readOnly: true + type: any + description: Properties of the object. Contains field @type with type URL. + done: 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 - baseModelSource: + 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 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' - supportedDeploymentResourcesTypes: + 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 + description: >- + This resource represents a long-running operation that is the result of + a network API call. + 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: + extensions: + description: >- + Application specific response metadata. Must be set in the first + response for streaming APIs. 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. - 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. - pipelineJob: + 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 + contentType: description: >- - Optional. This field is populated if the model is produced by a - pipeline job. - 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. - versionCreateTime: - description: Output only. Timestamp when this version was created. - type: string - readOnly: true - format: google-datetime - artifactUri: + The HTTP Content-Type header value specifying the content type of + the body. type: string + GoogleCloudAiplatformV1ResourceRuntimeSpec: + id: GoogleCloudAiplatformV1ResourceRuntimeSpec + properties: + serviceAccountSpec: description: >- - Immutable. The path to the directory containing the Model artifact - and any of its supporting files. Not required for AutoML Models. - createTime: - readOnly: true - type: string - format: google-datetime - description: Output only. Timestamp when this Model was uploaded into Vertex AI. - versionDescription: - description: The description of this version. - type: string - versionId: - type: string - readOnly: true + Optional. Configure the use of workload identity on the + PersistentResource + $ref: '#/components/schemas/GoogleCloudAiplatformV1ServiceAccountSpec' + raySpec: 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. - description: - description: The description of the Model. - type: string - supportedOutputStorageFormats: - readOnly: true + Optional. Ray cluster configuration. Required when creating a + dedicated RayCluster on the PersistentResource. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RaySpec' + type: object + 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. + GoogleCloudAiplatformV1Port: + description: Represents a network port in a container. + type: object + properties: + containerPort: 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. + 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 + id: GoogleCloudAiplatformV1Port + GoogleCloudAiplatformV1LineageSubgraph: + type: object + description: >- + A subgraph of the overall lineage graph. Event edges connect Artifact + and Execution nodes. + properties: + executions: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + description: The Execution nodes in the subgraph. + events: + type: array items: - type: string + $ref: '#/components/schemas/GoogleCloudAiplatformV1Event' + description: The Event edges between Artifacts and Executions in the subgraph. + artifacts: type: array - trainingPipeline: - description: >- - Output only. The resource name of the TrainingPipeline that uploaded - this Model, if any. - readOnly: true - 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. - versionAliases: + description: The Artifact nodes in the subgraph. items: - type: string + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + id: GoogleCloudAiplatformV1LineageSubgraph + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata: + type: object + properties: + costMilliNodeHours: + format: int64 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 - name: - description: The resource name of the Model. + 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 - 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' - metadataArtifact: + successfulStopReason: 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 + 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. + enum: + - SUCCESSFUL_STOP_REASON_UNSPECIFIED + - BUDGET_REACHED + - MODEL_CONVERGED type: string - versionUpdateTime: - format: google-datetime - readOnly: true - description: Output only. Timestamp when this version was most recently updated. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata + GoogleCloudAiplatformV1CreateDatasetOperationMetadata: + properties: + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Runtime operation information for DatasetService.CreateDataset. + type: object + id: GoogleCloudAiplatformV1CreateDatasetOperationMetadata + GoogleCloudAiplatformV1MigratableResourceAutomlDataset: + properties: + dataset: type: string - updateTime: - readOnly: true + description: >- + Full resource name of automl Dataset. Format: + `projects/{project}/locations/{location}/datasets/{dataset}`. + datasetDisplayName: + type: string + description: The Dataset's display name in automl.googleapis.com. + description: Represents one Dataset in automl.googleapis.com. + id: GoogleCloudAiplatformV1MigratableResourceAutomlDataset + type: object + GoogleCloudAiplatformV1CopyModelRequest: + properties: + parentModel: type: string - description: Output only. Timestamp when this Model was most recently updated. - format: google-datetime - modelSourceInfo: - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelSourceInfo' 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. + Optional. Specify this field to copy source_model into this existing + Model as a new version. Format: + `projects/{project}/locations/{location}/models/{model}` 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. - etag: + Customer-managed encryption key options. If this is set, then the + Model copy will be encrypted with the provided encryption key. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + modelId: description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. + 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. type: string - displayName: - 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. + sourceModel: type: string - 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. - supportedExportFormats: + Required. The resource name of the Model to copy. That Model must be + in the same Project. Format: + `projects/{project}/locations/{location}/models/{model}` + description: Request message for ModelService.CopyModel. + id: GoogleCloudAiplatformV1CopyModelRequest + type: object + GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain: + id: >- + GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain + 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. + properties: + originalMean: + 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 + format: float + minValue: + type: number + format: float + description: The minimum permissible value for this feature. + originalStddev: + format: float + 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. + type: number + maxValue: + format: float + description: The maximum permissible value for this feature. + type: number + GoogleCloudAiplatformV1PipelineJobDetail: + type: object + id: GoogleCloudAiplatformV1PipelineJobDetail + properties: + taskDetails: type: array readOnly: true + description: Output only. The runtime details of the tasks under the pipeline. 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. - originalModelInfo: - description: >- - Output only. If this Model is a copy of another Model, this contains - info about the original. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelOriginalModelInfo' + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetail' + pipelineRunContext: + description: Output only. The context of the current pipeline run. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' readOnly: true - 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. + pipelineContext: + description: Output only. The context of the pipeline. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' + description: The runtime detail of PipelineJob. + GoogleCloudAiplatformV1RebootPersistentResourceRequest: + id: GoogleCloudAiplatformV1RebootPersistentResourceRequest type: object - description: A trained machine learning Model. - id: GoogleCloudAiplatformV1Model - GoogleCloudAiplatformV1TrainingPipeline: + properties: {} + description: Request message for PersistentResourceService.RebootPersistentResource. + GoogleCloudAiplatformV1MutateDeployedIndexOperationMetadata: + properties: + deployedIndexId: + type: string + description: The unique index id specified by user + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' 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. + Runtime operation information for + IndexEndpointService.MutateDeployedIndex. + id: GoogleCloudAiplatformV1MutateDeployedIndexOperationMetadata + type: object + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig: + type: object properties: - startTime: - format: google-datetime + skewThresholds: description: >- - Output only. Time when the TrainingPipeline for the first time - entered the `PIPELINE_STATE_RUNNING` state. - type: string - readOnly: true - parentModel: + 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: 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`. + 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' + 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' + id: >- + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig + description: >- + The config for Training & Prediction data skew detection. It specifies + the training dataset sources and the skew detection parameters. + GoogleCloudAiplatformV1PurgeExecutionsResponse: + type: object + id: GoogleCloudAiplatformV1PurgeExecutionsResponse + properties: + purgeCount: 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. + format: int64 + purgeSample: + type: array + 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). + description: Response message for MetadataService.PurgeExecutions. + GoogleCloudAiplatformV1AnnotationSpec: + description: Identifies a concept with which DataItems may be annotated with. + id: GoogleCloudAiplatformV1AnnotationSpec + type: object + properties: updateTime: - format: google-datetime type: string + description: Output only. Timestamp when AnnotationSpec was last updated. + format: google-datetime readOnly: true + displayName: description: >- - Output only. Time when the TrainingPipeline was most recently - updated. - modelId: + 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 + etag: 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. - 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 pipeline. - readOnly: true - 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. + Optional. Used to perform consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. + type: string + createTime: + format: google-datetime + description: Output only. Timestamp when this AnnotationSpec was created. type: string - error: readOnly: true - description: >- - Output only. Only populated when the pipeline's state is - `PIPELINE_STATE_FAILED` or `PIPELINE_STATE_CANCELLED`. - $ref: '#/components/schemas/GoogleRpcStatus' - modelToUpload: - 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' - trainingTaskMetadata: - type: any + name: readOnly: true - 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. - trainingTaskDefinition: type: string + description: Output only. Resource name of the AnnotationSpec. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs: + type: object + properties: + sentimentMax: + format: int32 + type: integer 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. + 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). + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs + 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 + properties: displayName: - description: Required. The user-defined name of this TrainingPipeline. type: string - encryptionSpec: 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. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + Required. User provided name of this TensorboardRun. This value must + be unique among all TensorboardRuns belonging to the same parent + TensorboardExperiment. + name: + readOnly: true + description: >- + Output only. Name of the TensorboardRun. Format: + `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` + type: string labels: additionalProperties: type: string type: object 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. - trainingTaskInputs: - description: >- - Required. The training task's parameter(s), as specified in the - training_task_definition's `inputs`. - type: any - createTime: - type: string - format: google-datetime - description: Output only. Time when the TrainingPipeline was created. - readOnly: true - endTime: - readOnly: true - format: google-datetime - type: string - description: >- - Output only. Time when the TrainingPipeline entered any of the - following states: `PIPELINE_STATE_SUCCEEDED`, - `PIPELINE_STATE_FAILED`, `PIPELINE_STATE_CANCELLED`. - 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' - name: - description: Output only. Resource name of the TrainingPipeline. - type: string - readOnly: true - type: object - id: GoogleCloudAiplatformV1TrainingPipeline - GoogleCloudAiplatformV1CsvDestination: - type: object - description: The storage details for CSV output content. - properties: - gcsDestination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' - description: Required. Google Cloud Storage location. - id: GoogleCloudAiplatformV1CsvDestination - GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback: - id: GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback - type: object - properties: - blockReason: - description: Output only. Blocked reason. - readOnly: true - 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. - blockReasonMessage: - description: Output only. A readable block reason message. + 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. + createTime: type: string + description: Output only. Timestamp when this TensorboardRun was created. readOnly: true - safetyRatings: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyRating' - description: Output only. Safety ratings. + format: google-datetime + updateTime: + description: Output only. Timestamp when this TensorboardRun was last updated. readOnly: true - description: Content filter results for a prompt sent in the request. - GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata: - type: object - id: GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata - properties: - promptTokenCount: - type: integer - description: Number of tokens in the request. - format: int32 - totalTokenCount: - format: int32 - type: integer - candidatesTokenCount: - description: Number of tokens in the response(s). - format: int32 - type: integer - description: Usage metadata about response(s). - GoogleCloudAiplatformV1MigratableResourceAutomlDataset: - id: GoogleCloudAiplatformV1MigratableResourceAutomlDataset - properties: - datasetDisplayName: - description: The Dataset's display name in automl.googleapis.com. + format: google-datetime + type: string + etag: type: string - dataset: description: >- - Full resource name of automl Dataset. Format: - `projects/{project}/locations/{location}/datasets/{dataset}`. + Used to perform a consistent read-modify-write updates. If not set, + a blind "overwrite" update happens. + description: type: string + description: Description of this TensorboardRun. type: object - description: Represents one Dataset in automl.googleapis.com. - GoogleCloudAiplatformV1SyncFeatureViewResponse: + GoogleLongrunningListOperationsResponse: + type: object + id: GoogleLongrunningListOperationsResponse + description: The response message for Operations.ListOperations. properties: - featureViewSync: + nextPageToken: + description: The standard List next-page token. type: string + operations: + type: array + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' description: >- - Format: - `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}` - description: Respose message for FeatureOnlineStoreAdminService.SyncFeatureView. - id: GoogleCloudAiplatformV1SyncFeatureViewResponse - type: object - GoogleCloudAiplatformV1PurgeContextsMetadata: - type: object - description: Details of operations that perform MetadataService.PurgeContexts. + A list of operations that matches the specified filter in the + request. + GoogleCloudAiplatformV1CreateEndpointOperationMetadata: + id: GoogleCloudAiplatformV1CreateEndpointOperationMetadata + description: Runtime operation information for EndpointService.CreateEndpoint. properties: genericMetadata: - description: Operation metadata for purging Contexts. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - id: GoogleCloudAiplatformV1PurgeContextsMetadata - GoogleCloudAiplatformV1BatchReadFeatureValuesOperationMetadata: - id: GoogleCloudAiplatformV1BatchReadFeatureValuesOperationMetadata + description: The operation generic information. type: object - description: Details of operations that batch reads Feature values. - properties: - genericMetadata: - description: Operation metadata for Featurestore batch read Features values. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1IndexEndpoint: + GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis: properties: - labels: - type: object - 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. - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + 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: >- - 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. - description: + The baseline used to do anomaly detection for the statistics + generated by import features analysis. type: string - description: The description of the IndexEndpoint. - privateServiceConnectConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PrivateServiceConnectConfig + enum: + - BASELINE_UNSPECIFIED + - LATEST_STATS + - MOST_RECENT_SNAPSHOT_STATS + - PREVIOUS_IMPORT_FEATURES_STATS + state: + type: string + 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. + enum: + - STATE_UNSPECIFIED + - DEFAULT + - ENABLED + - DISABLED description: >- - Optional. Configuration for private service connect. network and - private_service_connect_config are mutually exclusive. - createTime: + Whether to enable / disable / inherite default hebavior for import + features analysis. + 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. + type: object + id: >- + GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis + CloudAiLargeModelsVisionImage: + properties: + image: + format: byte + description: Raw bytes. type: string - format: google-datetime - readOnly: true - description: Output only. Timestamp when this IndexEndpoint was created. - deployedIndexes: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' - type: array - readOnly: true - description: Output only. The indexes deployed in this endpoint. - etag: + uri: + description: Path to another storage (typically Google Cloud Storage). type: string - description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. - displayName: + imageRaiScores: + $ref: '#/components/schemas/CloudAiLargeModelsVisionImageRAIScores' + description: RAI scores for generated image. + raiInfo: + $ref: '#/components/schemas/CloudAiLargeModelsVisionRaiInfo' + description: RAI info for image. + text: 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. - enablePrivateServiceConnect: - deprecated: true - type: boolean - 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. - publicEndpointDomainName: - readOnly: true - description: >- - Output only. If public_endpoint_enabled is true, this field will be - populated with the domain name to use for this index endpoint. + description: Text/Expanded text input for imagen. + encoding: type: string - network: + description: Image encoding, encoded as "image/png" or "image/jpg". + semanticFilterResponse: + $ref: '#/components/schemas/CloudAiLargeModelsVisionSemanticFilterResponse' + description: Semantic filter info for image. + id: CloudAiLargeModelsVisionImage + description: Image. + type: object + GoogleCloudAiplatformV1SchemaPredictPredictionVideoActionRecognitionPredictionResult: + properties: + timeSegmentEnd: + format: google-duration 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 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. - publicEndpointEnabled: - type: boolean - description: >- - Optional. If true, the deployed index will be accessible through - public endpoint. - name: - description: Output only. The resource name of the IndexEndpoint. - readOnly: true + 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. + timeSegmentStart: type: string - updateTime: - format: google-datetime + format: google-duration + 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. + displayName: type: string + description: The display name of the AnnotationSpec that had been identified. + confidence: + format: float 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. - readOnly: true - id: GoogleCloudAiplatformV1IndexEndpoint + The Model's confidence in correction of this prediction, higher + value means higher confidence. + type: number + id: + description: The resource ID of the AnnotationSpec that had been identified. + type: string + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionVideoActionRecognitionPredictionResult + type: object + description: Prediction output format for Video Action Recognition. + GoogleCloudAiplatformV1UpdateFeatureOperationMetadata: + type: object + id: GoogleCloudAiplatformV1UpdateFeatureOperationMetadata + description: Details of operations that perform update Feature. + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for Feature Update. + CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox: + properties: + x2: + format: int32 + type: integer + description: The X coordinate of the bottom-right corner, in pixels. + y2: + format: int32 + description: The Y coordinate of the bottom-right corner, in pixels. + type: integer + y1: + format: int32 + description: The Y coordinate of the top-left corner, in pixels. + type: integer + x1: + format: int32 + description: The X coordinate of the top-left corner, in pixels. + type: integer type: object description: >- - Indexes are deployed into it. An IndexEndpoint can have multiple - DeployedIndexes. - GoogleCloudAiplatformV1ListTrialsResponse: + An integer bounding box of original pixels of the image for the detected + labels. + id: CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox + GoogleCloudAiplatformV1UnmanagedContainerModel: + id: GoogleCloudAiplatformV1UnmanagedContainerModel properties: - nextPageToken: + predictSchemata: + description: Contains the schemata used in Model's predictions and explanations + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictSchemata' + artifactUri: 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. - trials: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' - type: array - description: The Trials associated with the Study. - description: Response message for VizierService.ListTrials. - id: GoogleCloudAiplatformV1ListTrialsResponse + The path to the directory containing the Model artifact and any of + its supporting files. + containerSpec: + description: >- + Input only. The specification of the container that is to be used + when deploying this Model. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelContainerSpec' type: object - GoogleCloudAiplatformV1ListSpecialistPoolsResponse: + description: >- + Contains model information necessary to perform batch prediction without + requiring a full model import. + GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig: + description: >- + Configuration defining how to transform batch prediction input instances + to the instances that the Model accepts. properties: - specialistPools: + excludedFields: + items: + type: string description: >- - A list of SpecialistPools that matches the specified filter in the - request. + 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. + type: array + includedFields: + 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. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' + type: string type: array - nextPageToken: - description: The standard List next-page token. + instanceType: + 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. + 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 - description: Response message for SpecialistPoolService.ListSpecialistPools. type: object - id: GoogleCloudAiplatformV1ListSpecialistPoolsResponse - GoogleCloudAiplatformV1SchemaPredictParamsImageObjectDetectionPredictionParams: - id: >- - GoogleCloudAiplatformV1SchemaPredictParamsImageObjectDetectionPredictionParams + id: GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig + GoogleCloudAiplatformV1PublisherModel: properties: - confidenceThreshold: - type: number - format: float + supportedActions: + description: Optional. Supported call-to-action options. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToAction + 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. + description: Required. Indicates the open source category of the publisher model. + type: string + launchStage: + description: Optional. Indicates the launch stage of the model. + type: string + enum: + - LAUNCH_STAGE_UNSPECIFIED + - EXPERIMENTAL + - PRIVATE_PREVIEW + - PUBLIC_PREVIEW + - GA + 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. + frameworks: + type: array + items: + type: string + description: Optional. Additional information about the model's Frameworks. + publisherModelTemplate: + readOnly: true + type: string description: >- - The Model only returns predictions with at least this confidence - score. Default value is 0.0 - maxPredictions: - format: int32 - type: integer + 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 + type: string + 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. + predictSchemata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictSchemata' 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: object - description: Prediction model parameters for Image Object Detection. - GoogleCloudAiplatformV1CreateIndexOperationMetadata: + Optional. The schemata that describes formats of the + PublisherModel's predictions and explanations as given and returned + via PredictionService.Predict. + name: + type: string + readOnly: true + description: Output only. The resource name of the PublisherModel. + 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 + id: GoogleCloudAiplatformV1PublisherModel type: object - description: Runtime operation information for IndexService.CreateIndex. - id: GoogleCloudAiplatformV1CreateIndexOperationMetadata + description: A Model Garden Publisher Model. + GoogleCloudAiplatformV1ExplanationMetadata: + description: Metadata describing the Model's input and output for explanation. properties: - nearestNeighborSearchOperationMetadata: + outputs: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata 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' - GoogleCloudAiplatformV1ModelEvaluationSliceSlice: - id: GoogleCloudAiplatformV1ModelEvaluationSliceSlice - description: Definition of a slice. + 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 + latentSpaceSource: + type: string + description: >- + Name of the source to generate embeddings for example based + explanations. + inputs: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataInputMetadata + type: object + 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. + 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. + id: GoogleCloudAiplatformV1ExplanationMetadata type: object + GoogleCloudAiplatformV1ContainerRegistryDestination: + description: The Container Registry location for the container image. properties: - sliceSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec - description: Output only. Specification for how the data was sliced. - readOnly: true - value: + outputUri: type: string - description: Output only. The value of the dimension in this slice. - readOnly: true - dimension: - readOnly: true 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. - type: string + 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. + id: GoogleCloudAiplatformV1ContainerRegistryDestination + type: object + GoogleCloudAiplatformV1GroundingMetadata: + type: object + id: GoogleCloudAiplatformV1GroundingMetadata + properties: + webSearchQueries: + type: array + description: Optional. Web search queries for the following-up web search. + items: + type: string + searchEntryPoint: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SearchEntryPoint' + description: Optional. Google search entry for the following-up web searches. + description: Metadata returned to client when grounding is enabled. GoogleCloudAiplatformV1UploadModelOperationMetadata: properties: genericMetadata: $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' description: The common part of the operation metadata. + description: Details of ModelService.UploadModel operation. id: GoogleCloudAiplatformV1UploadModelOperationMetadata type: object - description: Details of ModelService.UploadModel operation. - GoogleCloudAiplatformV1ExamplesRestrictionsNamespace: - id: GoogleCloudAiplatformV1ExamplesRestrictionsNamespace - description: Restrictions namespace for example-based explanations overrides. + GoogleCloudAiplatformV1CopyModelOperationMetadata: + description: Details of ModelService.CopyModel operation. + properties: + genericMetadata: + description: The common part of the operation metadata. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + id: GoogleCloudAiplatformV1CopyModelOperationMetadata + type: object + GoogleCloudAiplatformV1SchemaPredictPredictionClassificationPredictionResult: type: object + description: Prediction output format for Image and Text Classification. + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionClassificationPredictionResult properties: - deny: - description: The list of deny tags. + displayNames: + description: >- + The display names of the AnnotationSpecs that had been identified, + order matches the IDs. + type: array items: type: string - type: array - namespaceName: - type: string - description: The namespace name. - allow: + ids: items: + format: int64 type: string - description: The list of allowed tags. type: array - GoogleCloudAiplatformV1PurgeExecutionsResponse: - type: object - properties: - purgeCount: - 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. - format: int64 - purgeSample: + description: The resource IDs of the AnnotationSpecs that had been identified. + confidences: type: array items: - type: string + format: float + type: number 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). - description: Response message for MetadataService.PurgeExecutions. - id: GoogleCloudAiplatformV1PurgeExecutionsResponse - GoogleCloudAiplatformV1ModelOriginalModelInfo: + The Model's confidences in correctness of the predicted IDs, higher + value means higher confidence. Order matches the Ids. + GoogleCloudAiplatformV1MergeVersionAliasesRequest: properties: - model: - type: string + versionAliases: 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}` - readOnly: true - type: object - id: GoogleCloudAiplatformV1ModelOriginalModelInfo - description: Contains information about the original Model if this Model is a copy. - GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse: - description: Response message for TensorboardService.BatchCreateTensorboardRuns. - properties: - tensorboardRuns: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + 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: array - description: The created TensorboardRuns. - id: GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse - type: object - GoogleCloudAiplatformV1MigrateResourceRequest: - id: GoogleCloudAiplatformV1MigrateResourceRequest + items: + type: string type: object + id: GoogleCloudAiplatformV1MergeVersionAliasesRequest + description: Request message for ModelService.MergeVersionAliases. + GoogleCloudAiplatformV1SupervisedTuningSpec: properties: - migrateAutomlDatasetConfig: - description: >- - Config for migrating Dataset in automl.googleapis.com to Vertex AI's - Dataset. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig - migrateDataLabelingDatasetConfig: + trainingDatasetUri: + type: string description: >- - Config for migrating Dataset in datalabeling.googleapis.com to - Vertex AI's Dataset. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig - migrateMlEngineModelVersionConfig: + Required. Cloud Storage path to file containing training dataset for + tuning. The dataset must be formatted as a JSONL file. + validationDatasetUri: + type: string description: >- - Config for migrating Version in ml.googleapis.com to Vertex AI's - Model. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig - migrateAutomlModelConfig: + Optional. Cloud Storage path to file containing validation dataset + for tuning. The dataset must be formatted as a JSONL file. + hyperParameters: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig - description: >- - Config for migrating Model in automl.googleapis.com to Vertex AI's - Model. + #/components/schemas/GoogleCloudAiplatformV1SupervisedHyperParameters + description: Optional. Hyperparameters for SFT. + type: object + id: GoogleCloudAiplatformV1SupervisedTuningSpec + description: Tuning Spec for Supervised Tuning. + GoogleCloudAiplatformV1PrivateEndpoints: + id: GoogleCloudAiplatformV1PrivateEndpoints description: >- - Config of migrating one resource from automl.googleapis.com, - datalabeling.googleapis.com and ml.googleapis.com to Vertex AI. - GoogleCloudAiplatformV1SchemaVideoClassificationAnnotation: + 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. + type: object properties: - displayName: + explainHttpUri: + readOnly: true type: string + description: Output only. Http(s) path to send explain requests. + serviceAttachment: + readOnly: true 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. + Output only. The name of the service attachment resource. Populated + if private service connect is enabled. 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. - id: GoogleCloudAiplatformV1SchemaVideoClassificationAnnotation - description: Annotation details specific to video classification. + predictHttpUri: + description: Output only. Http(s) path to send prediction requests. + readOnly: true + type: string + healthHttpUri: + readOnly: true + type: string + description: Output only. Http(s) path to send health check requests. + GoogleCloudAiplatformV1ExportFeatureValuesOperationMetadata: + description: Details of operations that exports Features values. + id: GoogleCloudAiplatformV1ExportFeatureValuesOperationMetadata type: object - GoogleCloudAiplatformV1Presets: - description: Preset configuration for example-based explanations + properties: + genericMetadata: + description: Operation metadata for Featurestore export Feature values. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1ModelDataStats: type: object - id: GoogleCloudAiplatformV1Presets + id: GoogleCloudAiplatformV1ModelDataStats + description: Stats of data used for train or evaluate the Model. properties: - query: - enum: - - PRECISE - - FAST + trainingDataItemsCount: + type: string + format: int64 + description: Number of DataItems that were used for training this Model. + testDataItemsCount: + format: int64 description: >- - Preset option controlling parameters for speed-precision trade-off - when querying for examples. If omitted, defaults to `PRECISE`. - enumDescriptions: - - More precise neighbors as a trade-off against slower response. - - Faster response as a trade-off against less precise neighbors. + 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 - modality: + trainingAnnotationsCount: type: string - enum: - - MODALITY_UNSPECIFIED - - IMAGE - - TEXT - - TABULAR - enumDescriptions: - - Should not be set. Added as a recommended best practice for enums - - IMAGE modality - - TEXT modality - - TABULAR modality + description: Number of Annotations that are used for training this Model. + format: int64 + validationDataItemsCount: + type: string + format: int64 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. - GoogleCloudAiplatformV1DirectPredictRequest: - id: GoogleCloudAiplatformV1DirectPredictRequest - description: Request message for PredictionService.DirectPredict. + Number of DataItems that were used for validating this Model during + training. + validationAnnotationsCount: + description: >- + Number of Annotations that are used for validating this Model during + training. + type: string + format: int64 + testAnnotationsCount: + format: int64 + 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 + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecasting: + type: object + description: A TrainingJob that trains and uploads an AutoML Forecasting Model. properties: - parameters: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - description: The parameters that govern the prediction. + metadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata + description: The metadata information. inputs: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - description: The prediction input. - type: object + description: The input parameters of this TrainingJob. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecasting GoogleCloudAiplatformV1DeployedIndexAuthConfig: + type: object description: Used to set up the auth on the DeployedIndex's private endpoint. properties: authProvider: @@ -18337,1512 +18522,1749 @@ components: #/components/schemas/GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider description: Defines the authentication provider that the DeployedIndex uses. id: GoogleCloudAiplatformV1DeployedIndexAuthConfig - type: object - GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig: - type: object - description: The configuration for grounding checking. - id: GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig + GoogleCloudAiplatformV1SearchFeaturesResponse: + id: GoogleCloudAiplatformV1SearchFeaturesResponse properties: - disableAttribution: - type: boolean + nextPageToken: description: >- - If set, skip finding claim attributions (i.e not generate grounding - citation). - sources: - type: array - description: The sources for the grounding checking. + 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. + type: string + features: items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry - GoogleCloudAiplatformV1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + description: >- + The Features matching the request. Fields returned: * `name` * + `description` * `labels` * `create_time` * `update_time` + type: array type: object - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics + description: Response message for FeaturestoreService.SearchFeatures. + GoogleCloudAiplatformV1UpdateIndexOperationMetadata: + id: GoogleCloudAiplatformV1UpdateIndexOperationMetadata properties: - exactMatch: - type: number + nearestNeighborSearchOperationMetadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata description: >- - The rate at which the input predicted strings exactly match their - references. - format: float - GoogleCloudAiplatformV1ListTensorboardRunsResponse: - description: Response message for TensorboardService.ListTensorboardRuns. + The operation metadata with regard to Matching Engine Index + operation. + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. + type: object + description: Runtime operation information for IndexService.UpdateIndex. + GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse: 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: + A token to retrieve next page of results. Pass to + ListModelEvaluationSlicesRequest.page_token to obtain that page. + modelEvaluationSlices: + description: List of ModelEvaluations in the requested page. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSlice' type: array - description: The TensorboardRuns mathching the request. + type: object + description: Response message for ModelService.ListModelEvaluationSlices. + id: GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse + GoogleCloudAiplatformV1FindNeighborsResponse: + type: object + description: The response message for MatchService.FindNeighbors. + properties: + nearestNeighbors: + type: array + description: The nearest neighbors of the query datapoints. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors + id: GoogleCloudAiplatformV1FindNeighborsResponse + GoogleCloudAiplatformV1NotebookIdleShutdownConfig: + id: GoogleCloudAiplatformV1NotebookIdleShutdownConfig type: object - id: GoogleCloudAiplatformV1ListTensorboardRunsResponse - GoogleCloudAiplatformV1MachineSpec: + description: >- + The idle shutdown configuration of NotebookRuntimeTemplate, which + contains the idle_timeout as required field. properties: - acceleratorCount: - description: The number of accelerators to attach to the machine. - type: integer - format: int32 - 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 - tpuTopology: + idleTimeout: + format: google-duration type: string description: >- - Immutable. The topology of the TPUs. Corresponds to the TPU - topologies available from GKE. (Example: tpu_topology: "2x2x1"). - acceleratorType: - 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 - enumDescriptions: - - Unspecified accelerator type, which means no accelerator. - - 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. - - TPU v2. - - TPU v3. - - TPU v4. - - TPU v5. - description: >- - Immutable. The type of accelerator(s) that may be attached to the - machine as per accelerator_count. - type: string - id: GoogleCloudAiplatformV1MachineSpec - description: Specification of a single machine. + 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. + idleShutdownDisabled: + description: Whether Idle Shutdown is disabled in this NotebookRuntimeTemplate. + type: boolean + GoogleCloudAiplatformV1SchemaVisualInspectionMaskSavedQueryMetadata: + id: GoogleCloudAiplatformV1SchemaVisualInspectionMaskSavedQueryMetadata + properties: {} + type: object + GoogleCloudAiplatformV1FindNeighborsRequest: type: object - GoogleCloudAiplatformV1AssignNotebookRuntimeOperationMetadata: properties: - progressMessage: + 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 + queries: + type: array + description: The list of queries. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FindNeighborsRequestQuery + deployedIndexId: 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' - description: Metadata information for NotebookService.AssignNotebookRuntime. - id: GoogleCloudAiplatformV1AssignNotebookRuntimeOperationMetadata + 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. + description: The request message for MatchService.FindNeighbors. + id: GoogleCloudAiplatformV1FindNeighborsRequest + GoogleCloudAiplatformV1UploadModelResponse: + id: GoogleCloudAiplatformV1UploadModelResponse type: object - GoogleCloudAiplatformV1Featurestore: + description: Response message of ModelService.UploadModel operation. properties: - etag: - description: >- - Optional. Used to perform consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. + modelVersionId: + readOnly: true + description: Output only. The version ID of the model that is uploaded. + type: string + model: type: string - name: description: >- - Output only. Name of the Featurestore. Format: - `projects/{project}/locations/{location}/featurestores/{featurestore}` + The name of the uploaded Model resource. Format: + `projects/{project}/locations/{location}/models/{model}` + GoogleCloudAiplatformV1Annotation: + properties: + name: + description: Output only. Resource name of the Annotation. readOnly: true type: string + payload: + type: any + description: Required. The schema of the payload can be found in payload_schema. createTime: format: google-datetime readOnly: true type: string - description: Output only. Timestamp when this Featurestore was created. + description: Output only. Timestamp when this Annotation was created. + annotationSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1UserActionReference' + description: Output only. The source of the Annotation. + readOnly: true 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 + 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. 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. + 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 - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + payloadSchemaUri: 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. - state: - readOnly: true - enum: - - STATE_UNSPECIFIED - - STABLE - - UPDATING + 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. 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. - description: Output only. State of the featurestore. + etag: + type: string + description: >- + Optional. Used to perform consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. updateTime: - description: Output only. Timestamp when this Featurestore was last updated. - readOnly: true + description: Output only. Timestamp when this Annotation was last updated. format: google-datetime + readOnly: true type: string - onlineServingConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig - 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. - onlineStorageTtlDays: - 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 - format: int32 - type: integer - 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: GoogleCloudAiplatformV1Featurestore - GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain: - properties: - maxValue: - format: float - description: The maximum permissible value for this feature. - type: number - 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: - 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 - format: float - minValue: - format: float - type: number - description: The minimum permissible value for this feature. type: object - id: >- - 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. - GoogleCloudAiplatformV1DirectRawPredictRequest: - properties: - methodName: - type: string - 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 - description: Request message for PredictionService.DirectRawPredict. - id: GoogleCloudAiplatformV1DirectRawPredictRequest - GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec: - id: GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec + Used to assign specific AnnotationSpec to a particular area of a + DataItem or the whole part of the DataItem. + id: GoogleCloudAiplatformV1Annotation + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation type: object properties: - defaultValue: - format: double - 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. - type: number - values: - 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. - items: - format: double - type: number - description: Value specification for a parameter in `DISCRETE` type. - GoogleCloudAiplatformV1SchemaPredictionResult: - id: GoogleCloudAiplatformV1SchemaPredictionResult - description: Represents a line of JSONL in the batch prediction output file. - properties: - 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 - instance: - additionalProperties: - description: Properties of the object. - type: any - type: object + timeFormat: 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. - key: + 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: Optional user-provided key from the input instance. - type: object - GoogleCloudAiplatformV1ExportModelRequestOutputConfig: - id: GoogleCloudAiplatformV1ExportModelRequestOutputConfig - properties: - exportFormatId: + columnName: type: string + invalidValuesAllowed: + type: boolean 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. - imageDestination: - 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`. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ContainerRegistryDestination - 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`. + 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. + 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. + GoogleCloudAiplatformV1UpdateExplanationDatasetResponse: type: object - description: Output configuration for the Model export. - GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact: - description: The type of an input artifact. - properties: - artifactId: - 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. - id: GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact + id: GoogleCloudAiplatformV1UpdateExplanationDatasetResponse + description: Response message of ModelService.UpdateExplanationDataset operation. + properties: {} + GoogleCloudAiplatformV1GenerationConfig: + id: GoogleCloudAiplatformV1GenerationConfig type: object - GoogleCloudAiplatformV1ImportDataRequest: - id: GoogleCloudAiplatformV1ImportDataRequest + description: Generation config. properties: - importConfigs: + stopSequences: + description: Optional. Stop sequences. type: array - description: >- - Required. The desired input locations. The contents of all input - locations will be imported in one batch. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ImportDataConfig' - type: object - description: Request message for DatasetService.ImportData. - GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse: - description: Response message for TensorboardService.ReadTensorboardBlobData. - id: GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse - type: object - properties: - blobs: - description: Blob messages containing blob bytes. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardBlob' - type: array - GoogleCloudAiplatformV1Port: - type: object - properties: - containerPort: + type: string + maxOutputTokens: format: int32 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. + Optional. The maximum number of output tokens to generate per + message. type: integer - description: Represents a network port in a container. - id: GoogleCloudAiplatformV1Port - GoogleCloudAiplatformV1SchemaTextClassificationAnnotation: - id: GoogleCloudAiplatformV1SchemaTextClassificationAnnotation - description: Annotation details specific to text classification. - properties: - annotationSpecId: - description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. - type: string - displayName: - description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. - type: string - type: object - GoogleCloudAiplatformV1ActiveLearningConfig: - properties: - trainingConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingConfig' + responseSchema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' 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: + 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 + topP: + type: number + format: float + description: Optional. If specified, nucleus sampling will be used. + candidateCount: type: integer format: int32 - description: Max percent of total DataItems for human labeling. - 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 + description: Optional. Number of candidates to generate. + responseMimeType: type: string - description: Max number of human labeled DataItems. - id: 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. - GoogleCloudAiplatformV1ListDatasetsResponse: - description: Response message for DatasetService.ListDatasets. - id: GoogleCloudAiplatformV1ListDatasetsResponse - type: object + 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. + temperature: + description: Optional. Controls the randomness of predictions. + type: number + format: float + topK: + description: Optional. If specified, top-k sampling will be used. + format: float + type: number + presencePenalty: + type: number + description: Optional. Positive penalties. + format: float + GoogleCloudAiplatformV1SchemaPredictPredictionTabularClassificationPredictionResult: properties: - nextPageToken: - description: The standard List next-page token. - type: string - datasets: + classes: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + type: string + description: >- + The name of the classes being classified, contains all possible + values of the target column. + type: array + scores: + items: + format: float + type: number type: array - description: A list of Datasets that matches the specified filter in the request. - GoogleCloudAiplatformV1ReadFeatureValuesResponse: - properties: - entityView: 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. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView - header: - description: Response header. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader - id: GoogleCloudAiplatformV1ReadFeatureValuesResponse - type: object - description: Response message for FeaturestoreOnlineServingService.ReadFeatureValues. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation: - type: object + 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. id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation - description: >- - Training pipeline will infer the proper transformation based on the - statistic of dataset. + GoogleCloudAiplatformV1SchemaPredictPredictionTabularClassificationPredictionResult + description: Prediction output format for Tabular Classification. + type: object + GoogleCloudAiplatformV1UndeployModelOperationMetadata: + id: GoogleCloudAiplatformV1UndeployModelOperationMetadata properties: - columnName: - type: string - GoogleCloudAiplatformV1LargeModelReference: + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Runtime operation information for EndpointService.UndeployModel. + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig: + description: Configuration for exporting test set predictions to a BigQuery table. + type: object properties: - name: - type: string + overrideExistingTable: 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: object - description: Contains information about the Large Model. - id: GoogleCloudAiplatformV1LargeModelReference - GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoObjectTrackingMetrics: + 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 + destinationBigqueryUri: + 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` id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoObjectTrackingMetrics + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig + GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig: + properties: {} + description: Configuration options for using brute force search. + id: GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig + type: object + GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView: + description: Entity view with Feature values. type: object properties: - evaluatedTrackCount: - type: integer - format: int32 - description: >- - UNIMPLEMENTED. The total number of tracks (i.e. as seen across all - frames) the ground truth used to create this evaluation had. - evaluatedBoundingBoxCount: - format: int32 - description: >- - UNIMPLEMENTED. The total number of bounding boxes (i.e. summed over - all frames) the ground truth used to create this evaluation had. - type: integer - trackMeanBoundingBoxIou: - format: float - description: >- - UNIMPLEMENTED. The single metric for tracks bounding box iou - evaluation: the `meanBoundingBoxIou` averaged over all - `trackMetrics`. - type: number - boundingBoxMetrics: - type: array + data: 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. - trackMeanAveragePrecision: - format: float - description: >- - UNIMPLEMENTED. The single metric for tracks accuracy evaluation: the - `meanAveragePrecision` averaged over all `trackMetrics`. - type: number - trackMeanMismatchRate: - type: number + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData description: >- - UNIMPLEMENTED. The single metric for tracking consistency - evaluation: the `meanMismatchRate` averaged over all `trackMetrics`. - format: float - trackMetrics: + 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. type: array + entityId: + description: ID of the requested entity. + type: string + id: GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView + GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec: + id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec + properties: + trainTrialJobSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' 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. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics - boundingBoxMeanAveragePrecision: - format: float - type: number + Required. The spec of a train trial job. The same spec applies to + all train trials. + frequency: + format: int32 description: >- - The single metric for bounding boxes evaluation: the - `meanAveragePrecision` averaged over all `boundingBoxMetrics`. - evaluatedFrameCount: + 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. + type: integer + maxParallelTrialCount: + description: Required. The maximum number of trials to run in parallel. format: int32 type: integer + type: object + description: Represent spec for train trials. + GoogleCloudAiplatformV1ImportFeatureValuesResponse: + properties: + timestampOutsideRetentionRowsCount: + type: string + format: int64 description: >- - UNIMPLEMENTED. The number of video frames used to create this - evaluation. - 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). - GoogleCloudAiplatformV1ExportFractionSplit: - id: GoogleCloudAiplatformV1ExportFractionSplit + The number rows that weren't ingested due to having feature + timestamps outside the retention boundary. + invalidRowCount: + 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. + type: string + format: int64 + importedFeatureValueCount: + format: int64 + description: Number of Feature values that have been imported by the operation. + type: string + description: Response message for FeaturestoreService.ImportFeatureValues. + type: object + id: GoogleCloudAiplatformV1ImportFeatureValuesResponse + GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadata: 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. + Runtime operation information for + MigrationService.BatchMigrateResources. + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The common part of the operation metadata. + partialResults: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult + description: >- + Partial results that reflect the latest migration operation + progress. + type: array + id: GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadata + type: object + GoogleCloudAiplatformV1SchemaImageDatasetMetadata: + id: GoogleCloudAiplatformV1SchemaImageDatasetMetadata type: object properties: - testFraction: + dataItemSchemaUri: + type: string description: >- - The fraction of the input data that is to be used to evaluate the - Model. - format: double - type: number - trainingFraction: + 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: >- - The fraction of the input data that is to be used to train the - Model. - format: double - type: number - validationFraction: - format: double + Google Cloud Storage Bucket name that contains the blob data of this + Dataset. + description: The metadata of Datasets that contain Image DataItems. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata: + properties: + trainCostMilliNodeHours: description: >- - The fraction of the input data that is to be used to validate the - Model. - type: number - GoogleCloudAiplatformV1PurgeContextsResponse: - id: GoogleCloudAiplatformV1PurgeContextsResponse + 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. + type: object + description: Model metadata specific to AutoML Forecasting. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata + GoogleCloudAiplatformV1CreateDatasetVersionOperationMetadata: type: object + id: GoogleCloudAiplatformV1CreateDatasetVersionOperationMetadata properties: - purgeSample: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The common part of the operation metadata. + description: Runtime operation information for DatasetService.CreateDatasetVersion. + GoogleCloudAiplatformV1FeatureGroupBigQuery: + properties: + entityIdColumns: 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: - format: int64 - type: string + Optional. Columns to construct entity_id / row keys. If not provided + defaults to `entity_id`. + bigQuerySource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' 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. - description: Response message for MetadataService.PurgeContexts. - GoogleCloudAiplatformV1FeatureGroup: + Required. Immutable. The BigQuery source URI that points to either a + BigQuery Table or View. + id: GoogleCloudAiplatformV1FeatureGroupBigQuery + type: object + description: Input source type for BigQuery Tables and Views. + GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences: properties: - 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. + references: type: object additionalProperties: - type: string - createTime: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelResourceReference + description: Required. + resourceTitle: + description: Optional. Title of the resource. type: string - description: Output only. Timestamp when this FeatureGroup was created. - readOnly: true - format: google-datetime - 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' - description: - description: Optional. Description of the FeatureGroup. + title: + type: string + description: 'Required. ' + resourceUseCase: type: string + description: Optional. Use case (CUJ) of the resource. + resourceDescription: + description: Optional. Description of the resource. + type: string + type: object + description: >- + The regional resource name or the URI. Key is region, e.g., us-central1, + europe-west2, global, etc.. + id: >- + GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + GoogleCloudAiplatformV1StructFieldValue: + properties: name: + type: string + description: Name of the field in the struct feature. + value: + description: The value for this field. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' + type: object + id: GoogleCloudAiplatformV1StructFieldValue + description: One field of a Struct (or object) type feature value. + GoogleCloudAiplatformV1ExamplesExampleGcsSource: + description: The Cloud Storage input instances. + id: GoogleCloudAiplatformV1ExamplesExampleGcsSource + properties: + dataFormat: description: >- - Identifier. Name of the FeatureGroup. Format: - `projects/{project}/locations/{location}/featureGroups/{featureGroup}` + The format in which instances are given, if not specified, assume + it's JSONL format. Currently only JSONL format is supported. type: string - etag: + enumDescriptions: + - Format unspecified, used when unset. + - Examples are stored in JSONL files. + enum: + - DATA_FORMAT_UNSPECIFIED + - JSONL + gcsSource: + description: The Cloud Storage location for the input instances. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' + type: object + GoogleCloudAiplatformV1MetadataStore: + id: GoogleCloudAiplatformV1MetadataStore + description: >- + Instance of a metadata store. Contains a set of metadata that can be + queried. + properties: + name: + description: Output only. The resource name of the MetadataStore instance. + type: string + readOnly: true + state: + description: Output only. State information of the MetadataStore. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MetadataStoreMetadataStoreState + readOnly: true + createTime: + format: google-datetime + type: string + description: Output only. Timestamp when this MetadataStore was created. + readOnly: true + encryptionSpec: description: >- - Optional. Used to perform consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. + 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' + description: type: string + description: Description of the MetadataStore. updateTime: - format: google-datetime type: string + format: google-datetime + description: Output only. Timestamp when this MetadataStore was last updated. readOnly: true - description: Output only. Timestamp when this FeatureGroup was last updated. - description: Vertex AI Feature Group. - id: GoogleCloudAiplatformV1FeatureGroup + dataplexConfig: + description: Optional. Dataplex integration settings. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MetadataStoreDataplexConfig type: object - GoogleCloudAiplatformV1SchemaPredictPredictionTextSentimentPredictionResult: - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionTextSentimentPredictionResult + GoogleCloudAiplatformV1FunctionResponse: properties: - sentiment: - type: integer + response: + type: object + additionalProperties: + type: any + description: Properties of the object. + description: Required. The function response in JSON object format. + name: + type: string 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). - format: int32 + Required. The name of the function to call. Matches + [FunctionDeclaration.name] and [FunctionCall.name]. + id: 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. type: object - description: Prediction output format for Text Sentiment - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentation: + GoogleCloudAiplatformV1DedicatedResources: properties: - metadata: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata - description: The metadata information. - inputs: - description: The input parameters of this TrainingJob. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentation + 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, 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). + type: integer + machineSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' + description: >- + Required. Immutable. The specification of a single machine used by + the prediction. + 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 + 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' + id: GoogleCloudAiplatformV1DedicatedResources description: >- - A TrainingJob that trains and uploads an AutoML Image Segmentation - Model. + A description of resources that are dedicated to a DeployedModel, and + that need a higher degree of manual configuration. type: object - GoogleCloudAiplatformV1ComputeTokensRequest: + GoogleCloudAiplatformV1UpdateDeploymentResourcePoolOperationMetadata: type: object - description: Request message for ComputeTokens RPC call. - id: GoogleCloudAiplatformV1ComputeTokensRequest properties: - instances: + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + id: GoogleCloudAiplatformV1UpdateDeploymentResourcePoolOperationMetadata + description: Runtime operation information for UpdateDeploymentResourcePool method. + GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig: + type: object + id: GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig + 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: + format: google-duration + type: string + 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. + description: The config for scheduling monitoring job. + GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec: + 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 + 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. items: - type: any + format: double + type: number + id: GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec + description: Value specification for a parameter in `DISCRETE` type. + type: object + GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource: + properties: + uri: + items: + type: string description: >- - Required. 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. - GoogleCloudAiplatformV1Annotation: + 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 + id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource type: object - id: GoogleCloudAiplatformV1Annotation - description: >- - Used to assign specific AnnotationSpec to a particular area of a - DataItem or the whole part of the DataItem. + GoogleCloudAiplatformV1SchemaVideoActionRecognitionAnnotation: + id: GoogleCloudAiplatformV1SchemaVideoActionRecognitionAnnotation properties: - payload: - description: Required. The schema of the payload can be found in payload_schema. - type: any - createTime: + annotationSpecId: type: string - format: google-datetime - description: Output only. Timestamp when this Annotation was created. - readOnly: true - labels: 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 - additionalProperties: - type: string - name: - type: string - description: Output only. Resource name of the Annotation. - readOnly: true - updateTime: - type: string - description: Output only. Timestamp when this Annotation was last updated. - format: google-datetime - readOnly: true - annotationSource: - description: Output only. The source of the Annotation. - $ref: '#/components/schemas/GoogleCloudAiplatformV1UserActionReference' - readOnly: true - etag: + The resource Id of the AnnotationSpec that this Annotation pertains + to. + timeSegment: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaTimeSegment' description: >- - Optional. Used to perform consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. - type: string - payloadSchemaUri: + 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: >- - 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. - GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec: - description: The min/max number of replicas allowed if enabling autoscaling + The display name of the AnnotationSpec that this Annotation pertains + to. + description: Annotation details specific to video action recognition. type: object + GoogleCloudAiplatformV1ListSavedQueriesResponse: + id: GoogleCloudAiplatformV1ListSavedQueriesResponse properties: - maxReplicaCount: - format: int64 + nextPageToken: type: string + description: The standard List next-page token. + savedQueries: description: >- - Optional. max replicas in the node pool, must be ≥ replica_count and - > min_replica_count or will throw error - minReplicaCount: - description: >- - Optional. min replicas in the node pool, must be ≤ replica_count and - < max_replica_count or will throw error - type: string - format: int64 - id: GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec - GoogleCloudAiplatformV1UpdateExplanationDatasetResponse: - properties: {} - description: Response message of ModelService.UpdateExplanationDataset operation. - id: GoogleCloudAiplatformV1UpdateExplanationDatasetResponse + A list of SavedQueries that match the specified filter in the + request. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SavedQuery' + type: array type: object - GoogleCloudAiplatformV1ExplanationMetadata: - id: GoogleCloudAiplatformV1ExplanationMetadata + description: Response message for DatasetService.ListSavedQueries. + GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig: type: object properties: - outputs: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata - type: object + deployedModelId: + description: The DeployedModel ID of the objective config. + type: string + objectiveConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfig 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. - inputs: - type: object + The objective config of for the modelmonitoring job of this deployed + model. + description: >- + ModelDeploymentMonitoringObjectiveConfig contains the pair of + deployed_model_id to ModelMonitoringObjectiveConfig. + id: GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig + GoogleCloudAiplatformV1SchemaTextPromptDatasetMetadata: + id: GoogleCloudAiplatformV1SchemaTextPromptDatasetMetadata + properties: + systemInstruction: + type: string + description: The content of the prompt dataset system instruction. + systemInstructionGcsUri: + type: string 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 - latentSpaceSource: + The Google Cloud Storage URI that stores the system instruction, + starting with gs://. + maxOutputTokens: + format: int64 type: string description: >- - Name of the source to generate embeddings for example based - explanations. - featureAttributionsSchemaUri: + Value of the maximum number of tokens generated set when the dataset + was saved. + topP: + format: float 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. + 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 + 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: string - description: Metadata describing the Model's input and output for explanation. - GoogleCloudAiplatformV1StudyTimeConstraint: - description: Time-based Constraint for Study - id: GoogleCloudAiplatformV1StudyTimeConstraint + temperature: + description: >- + Temperature value used for sampling set when the dataset was saved. + This value is used to tune the degree of randomness. + type: number + format: float + groundingConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig + description: Grounding checking configuration. + gcsUri: + type: string + description: The Google Cloud Storage URI that stores the prompt data. + promptType: + description: Type of the prompt dataset. + type: string + note: + type: string + description: User-created prompt note. Note size limit is 2KB. + hasPromptVariable: + description: Whether the prompt dataset has prompt variable. + type: boolean + candidateCount: + format: int64 + description: Number of candidates. + type: string + stopSequences: + items: + type: string + description: Customized stop sequences. + type: array + text: + type: string + description: The content of the prompt dataset. type: object + description: The metadata of Datasets that contain Text Prompt data. + GoogleCloudAiplatformV1Index: properties: - endTime: - description: Compares the wallclock time to this time. Must use UTC timezone. + createTime: format: google-datetime + description: Output only. Timestamp when this Index was created. + readOnly: true type: string - maxDuration: + indexUpdateMethod: + enum: + - INDEX_UPDATE_METHOD_UNSPECIFIED + - BATCH_UPDATE + - STREAM_UPDATE type: string - format: google-duration - description: Counts the wallclock time passed since the creation of this Study. - GoogleCloudAiplatformV1UploadModelRequest: - type: object - properties: - modelId: + 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. + description: >- + Immutable. The update method to use with this Index. If not set, + BATCH_UPDATE will be used by default. + updateTime: + 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. type: string + format: google-datetime + readOnly: true + metadata: + type: any 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. - model: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' - description: Required. The Model to create. - serviceAccount: + An additional information about the Index; the schema of the + metadata can be found in metadata_schema. + metadataSchemaUri: 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.). - parentModel: + 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. + name: + readOnly: true + description: Output only. The resource name of the Index. + type: string + displayName: description: >- - Optional. The resource name of the model into which to upload the - version. Only specify this field when uploading a new version. + 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: Request message for ModelService.UploadModel. - id: GoogleCloudAiplatformV1UploadModelRequest - GoogleCloudAiplatformV1PurgeArtifactsRequest: - description: Request message for MetadataService.PurgeArtifacts. - properties: - filter: + deployedIndexes: + readOnly: true + 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. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndexRef' + description: + type: string + description: The description of the Index. + indexStats: + readOnly: true + description: Output only. Stats of the index resource. + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexStats' + etag: + description: >- + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. type: string + labels: + type: object description: >- - Required. A required filter matching the Artifacts to be purged. - E.g., `update_time <= 2020-11-19T11:30:00-04:00`. - force: + 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. + additionalProperties: + type: string + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' 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. + 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. + 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. + id: GoogleCloudAiplatformV1Index + GoogleCloudAiplatformV1SchemaVisualInspectionClassificationLabelSavedQueryMetadata: + id: >- + GoogleCloudAiplatformV1SchemaVisualInspectionClassificationLabelSavedQueryMetadata + type: object + properties: + multiLabel: + description: Whether or not the classification label is multi_label. type: boolean - id: GoogleCloudAiplatformV1PurgeArtifactsRequest + GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest: + id: GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest + description: Request message for TensorboardService.WriteTensorboardExperimentData. type: object - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfig: properties: - trainingDataset: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset + writeRunDataRequests: description: >- - Training dataset for models. This field has to be set only if - TrainingPredictionSkewDetectionConfig is specified. - trainingPredictionSkewDetectionConfig: - description: The config for skew between training data and prediction data. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig - predictionDriftDetectionConfig: - description: The config for drift of prediction data. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig - explanationConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfig - description: The config for integrating with Vertex Explainable AI. - id: GoogleCloudAiplatformV1ModelMonitoringObjectiveConfig + Required. Requests containing per-run TensorboardTimeSeries data to + write. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardRunDataRequest + GoogleCloudAiplatformV1TuningJob: type: object - description: >- - The objective configuration for model monitoring, including the - information needed to detect anomalies for one particular model. - GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig: properties: - monitorInterval: + updateTime: + readOnly: true + description: Output only. Time when the TuningJob was most recently updated. + format: google-datetime + type: string + endTime: + type: string + readOnly: true 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. + 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 + startTime: + description: >- + Output only. Time when the TuningJob for the first time entered the + `JOB_STATE_RUNNING` state. + format: google-datetime type: string - format: google-duration - monitorWindow: - format: google-duration + readOnly: true + 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' + labels: + type: object + additionalProperties: + type: string + 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. + 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 + description: Output only. The detailed state of the job. + 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. + tuningDataStats: + readOnly: true 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: object - description: The config for scheduling monitoring job. - id: GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig - GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig: - id: GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig - description: The config for Featurestore Monitoring threshold. - type: object - properties: - value: + Output only. The tuning data statistics associated with this + TuningJob. + $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningDataStats' + error: + $ref: '#/components/schemas/GoogleRpcStatus' 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 - format: double - GoogleCloudAiplatformV1ResourcePool: - id: GoogleCloudAiplatformV1ResourcePool - properties: - replicaCount: + Output only. Only populated when job's state is `JOB_STATE_FAILED` + or `JOB_STATE_CANCELLED`. + readOnly: true + tunedModelDisplayName: 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 autoscaling - diskSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DiskSpec' - description: Optional. Disk spec for the machine in this node pool. - usedReplicaCount: + Optional. The display name of the TunedModel. The name can be up to + 128 characters long and can consist of any UTF-8 characters. + name: type: string readOnly: true description: >- - Output only. The number of machines currently in use by training - jobs for this resource pool. Will replace idle_replica_count. - format: int64 - id: + Output only. Identifier. Resource name of a TuningJob. Format: + `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` + experiment: + type: string + description: Output only. The Experiment associated with this TuningJob. + readOnly: true + tunedModel: + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1TunedModel' 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. + Output only. The tuned model resources assiociated with this + TuningJob. + createTime: + description: Output only. Time when the TuningJob was created. type: string - machineSpec: - description: Required. Immutable. The specification of a single machine. - $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' - 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. - GoogleCloudAiplatformV1RemoveContextChildrenResponse: - properties: {} - id: GoogleCloudAiplatformV1RemoveContextChildrenResponse - type: object - description: Response message for MetadataService.RemoveContextChildren. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics: + format: google-datetime + readOnly: true + baseModel: + type: string + description: The base model that is being tuned, e.g., "gemini-1.0-pro-002". + supervisedTuningSpec: + description: Tuning Spec for Supervised Fine Tuning. + $ref: '#/components/schemas/GoogleCloudAiplatformV1SupervisedTuningSpec' + description: + type: string + description: Optional. The description of the TuningJob. + description: Represents a TuningJob that runs with Google owned models. + id: GoogleCloudAiplatformV1TuningJob + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics: properties: confidenceThreshold: - type: number - description: >- - Metrics are computed with an assumption that the Model never returns - predictions with score lower than this value. format: float - precision: type: number - description: Precision for the given confidence threshold. + description: The confidence threshold value used to compute the metrics. + boundingBoxIou: + type: number format: float - recall: - description: Recall (True Positive Rate) for the given confidence threshold. + 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). + mismatchRate: + description: >- + Mismatch rate, which measures the tracking consistency, i.e. + correctness of instance ID continuity. type: number format: float - f1Score: + trackingRecall: type: number format: float - description: The harmonic mean of recall and precision. + description: Tracking recall. + trackingPrecision: + format: float + type: number + description: Tracking precision. type: object + description: Metrics for a single confidence threshold. id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics - 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 - id: GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest - GoogleCloudAiplatformV1SuggestTrialsRequest: - description: Request message for VizierService.SuggestTrials. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics + GoogleCloudAiplatformV1Retrieval: properties: - contexts: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrialContext' - type: array - 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. - clientId: + disableAttribution: 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. - type: string - suggestionCount: - type: integer - description: Required. The number of suggestions requested. It must be positive. - format: int32 - id: GoogleCloudAiplatformV1SuggestTrialsRequest + Optional. Disable using the result from this tool in detecting + grounding attribution. This does not affect how the result is given + to the model for generation. + type: boolean + vertexAiSearch: + $ref: '#/components/schemas/GoogleCloudAiplatformV1VertexAISearch' + description: Set to use data source powered by Vertex AI Search. + id: GoogleCloudAiplatformV1Retrieval + description: >- + Defines a retrieval tool that model can call to access external + knowledge. type: object - GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata: - id: GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation: type: object properties: - outputTensorName: - description: >- - Name of the output tensor. Required and is only applicable to Vertex - AI provided images for Tensorflow. - type: string - displayNameMappingKey: + columnName: type: string + description: >- + Training pipeline will infer the proper transformation based on the + statistic of dataset. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation + GoogleCloudAiplatformV1SchemaTimeSegment: + description: >- + A time period inside of a DataItem that has a time dimension (e.g. + video). + properties: + endTimeOffset: 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. - indexDisplayNameMapping: + End of the time segment (exclusive), represented as the duration + since the start of the DataItem. + format: google-duration + type: string + startTimeOffset: 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 - description: Metadata of the prediction output to be explained. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs: - properties: - multiLabel: - type: boolean - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs - type: object - GoogleCloudAiplatformV1DatasetVersion: + Start of the time segment (inclusive), represented as the duration + since the start of the DataItem. + format: google-duration + type: string type: object - description: Describes the dataset version. - id: GoogleCloudAiplatformV1DatasetVersion + id: GoogleCloudAiplatformV1SchemaTimeSegment + GoogleCloudAiplatformV1ErrorAnalysisAnnotation: + description: Model error analysis for each annotation. + id: GoogleCloudAiplatformV1ErrorAnalysisAnnotation properties: - metadata: - type: any - readOnly: true + outlierThreshold: + type: number + format: double description: >- - Required. Output only. Additional information about the - DatasetVersion. - etag: + The threshold used to determine if this annotation is an outlier or + not. + outlierScore: description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. + The outlier score of this annotated item. Usually defined as the min + of all distances from attributed items. + type: number + 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 + description: The query type used for finding the attributed items. type: string - displayName: + attributedItems: + type: array 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. - type: string - name: - type: string - readOnly: true - description: Output only. The resource name of the DatasetVersion. - updateTime: + Attributed items for a given annotation, typically representing + neighbors from the training sets constrained by the query type. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem + type: object + GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse: + id: GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse + properties: + tensorboardRuns: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + description: The created TensorboardRuns. + type: array + description: Response message for TensorboardService.BatchCreateTensorboardRuns. + type: object + GoogleTypeInterval: + properties: + endTime: type: string - description: Output only. Timestamp when this DatasetVersion was last updated. - format: google-datetime - readOnly: true - createTime: - readOnly: true - description: Output only. Timestamp when this DatasetVersion was created. format: google-datetime - type: string - bigQueryDatasetName: - type: string - readOnly: true - description: Output only. Name of the associated BigQuery dataset. - modelReference: description: >- - Output only. Reference to the public base model last used by the - dataset version. Only set for prompt dataset versions. + 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. type: string - readOnly: true - GoogleCloudAiplatformV1StudySpec: - id: GoogleCloudAiplatformV1StudySpec + format: google-datetime + 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 + type: object + GoogleCloudAiplatformV1ListDataItemsResponse: properties: - parameters: - description: Required. The set of parameters to tune. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpec' - type: array - medianAutomatedStoppingSpec: - description: The automated early stopping spec using median rule. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec - 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 - algorithm: - 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. + nextPageToken: type: string - enum: - - ALGORITHM_UNSPECIFIED - - GRID_SEARCH - - RANDOM_SEARCH - description: The search algorithm specified for the Study. - decayCurveStoppingSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec - description: The automated early stopping spec using decay curve rule. - studyStoppingConfig: - description: >- - Conditions for automated stopping of a Study. Enable automated - stopping by configuring at least one condition. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecStudyStoppingConfig - convexAutomatedStoppingSpec: - description: The automated early stopping spec using convex stopping rule. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec - metrics: - description: Required. Metric specs for the Study. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpecMetricSpec' + description: The standard List next-page token. + dataItems: type: array - observationNoise: - enum: - - OBSERVATION_NOISE_UNSPECIFIED - - LOW - - HIGH - type: string + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataItem' description: >- - The observation noise level of the study. Currently only supported - by the Vertex AI Vizier service. Not supported by - HyperparameterTuningJob or TrainingPipeline. - 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. - description: Represents specification of a Study. + A list of DataItems that matches the specified filter in the + request. + type: object + description: Response message for DatasetService.ListDataItems. + id: GoogleCloudAiplatformV1ListDataItemsResponse + GoogleCloudAiplatformV1SmoothGradConfig: type: object - GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig: 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 + 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 properties: - bigquerySource: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource - gcsSource: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource + 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' + noiseSigma: + 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. + type: number + format: float + 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 + id: GoogleCloudAiplatformV1SmoothGradConfig + GoogleCloudAiplatformV1BoolArray: + properties: + values: + description: A list of bool values. + items: + type: boolean + type: array + description: A list of boolean values. type: object - GoogleCloudAiplatformV1ListOptimalTrialsResponse: + id: GoogleCloudAiplatformV1BoolArray + GoogleCloudAiplatformV1NotebookEucConfig: + id: GoogleCloudAiplatformV1NotebookEucConfig type: object - id: GoogleCloudAiplatformV1ListOptimalTrialsResponse - description: Response message for VizierService.ListOptimalTrials. properties: - optimalTrials: + bypassActasCheck: 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 + 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 + type: boolean + 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. + GoogleCloudAiplatformV1FeatureValueList: + type: object + properties: + values: + description: A list of feature values. All of them should be the same data type. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' type: array + id: GoogleCloudAiplatformV1FeatureValueList + description: Container for list of values. + GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi: + type: object + properties: + documentations: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' - GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelDocumentation + description: Required. + type: array + title: + type: string + description: Required. The title of the view rest API. + description: Rest API docs. + id: GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi + GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig: + description: The configuration for grounding checking. type: object properties: - annotatedDatasetDisplayName: - description: The AnnotatedDataset's display name in datalabeling.googleapis.com. - type: string - annotatedDataset: + disableAttribution: description: >- - Full resource name of data labeling AnnotatedDataset. Format: - `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`. - type: string - description: Represents one AnnotatedDataset in datalabeling.googleapis.com. - id: >- - GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset - GoogleCloudAiplatformV1NearestNeighborQuery: - id: GoogleCloudAiplatformV1NearestNeighborQuery - description: A query to find a number of similar entities. + If set, skip finding claim attributions (i.e not generate grounding + citation). + type: boolean + sources: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry + description: The sources for the grounding checking. + type: array + id: GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig + GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse: + description: Response message for JobService.ListModelDeploymentMonitoringJobs. + id: GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse properties: - stringFilters: - description: Optional. The list of string filters. + nextPageToken: + type: string + description: The standard List next-page token. + modelDeploymentMonitoringJobs: items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborQueryStringFilter + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob type: array - neighborCount: - format: int32 description: >- - Optional. The number of similar entities to be retrieved from - feature view for each query. - type: integer - entityId: + A list of ModelDeploymentMonitoringJobs that matches the specified + filter in the request. + type: object + GoogleCloudAiplatformV1ListMetadataSchemasResponse: + id: GoogleCloudAiplatformV1ListMetadataSchemasResponse + description: Response message for MetadataService.ListMetadataSchemas. + type: object + properties: + nextPageToken: description: >- - Optional. The entity id whose similar entities should be searched - for. If embedding is set, search will use embedding instead of - entity_id. + 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 - perCrowdingAttributeNeighborCount: - 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. - parameters: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborQueryParameters - description: Optional. Parameters that can be set to tune query on the fly. + metadataSchemas: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' + type: array + description: The MetadataSchemas found for the MetadataStore. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata: type: object - GoogleCloudAiplatformV1Study: properties: - displayName: + 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 - description: Required. Describes the Study, default value is empty string. - state: - readOnly: true + format: int64 + successfulStopReason: enumDescriptions: - - The study state is unspecified. - - The study is active. - - The study is stopped due to an internal error. + - Should not be set. + - The inputs.budgetMilliNodeHours had been reached. - >- - The study is done when the service exhausts the parameter search - space or max_trial_count is reached. - description: Output only. The detailed state of a Study. + 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. type: string enum: - - STATE_UNSPECIFIED - - ACTIVE - - INACTIVE - - COMPLETED - createTime: - readOnly: true + - SUCCESSFUL_STOP_REASON_UNSPECIFIED + - BUDGET_REACHED + - MODEL_CONVERGED + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata + GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata: + type: object + id: GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata + description: Metadata of the prediction output to be explained. + properties: + outputTensorName: type: string - description: Output only. Time at which the study was created. - format: google-datetime - inactiveReason: description: >- - Output only. A human readable reason why the Study is inactive. This - should be empty if a study is ACTIVE or COMPLETED. + Name of the output tensor. Required and is only applicable to Vertex + AI provided images for Tensorflow. + displayNameMappingKey: type: string - readOnly: true - name: description: >- - Output only. The name of a study. The study's globally unique - identifier. Format: - `projects/{project}/locations/{location}/studies/{study}` - type: string - readOnly: true - studySpec: - description: Required. Configuration of the Study. - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' - type: object - id: GoogleCloudAiplatformV1Study - description: A message representing a Study. - GoogleCloudAiplatformV1TensorboardBlob: - description: One blob (e.g, image, graph) viewable on a blob metric plot. + 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. + 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. + GoogleCloudAiplatformV1ServiceAccountSpec: properties: - data: - format: byte + serviceAccount: type: string description: >- - Optional. The bytes of the blob is not present unless it's returned - by the ReadTensorboardBlobData endpoint. - id: + 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. + enableCustomServiceAccount: + type: boolean 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 - type: string + 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: object - id: GoogleCloudAiplatformV1TensorboardBlob - GoogleCloudAiplatformV1ExamplesExampleGcsSource: + id: GoogleCloudAiplatformV1ServiceAccountSpec + description: >- + Configuration for the use of custom service account to run the + workloads. + GoogleCloudAiplatformV1SchemaVertex: + properties: + x: + format: double + type: number + description: X coordinate. + 'y': + description: Y coordinate. + type: number + format: double type: object - description: The Cloud Storage input instances. + 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 + GoogleCloudAiplatformV1Int64Array: + type: object + id: GoogleCloudAiplatformV1Int64Array + description: A list of int64 values. properties: - gcsSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' - description: The Cloud Storage location for the input instances. - dataFormat: - enum: - - DATA_FORMAT_UNSPECIFIED - - JSONL - enumDescriptions: - - Format unspecified, used when unset. - - Examples are stored in JSONL files. - description: >- - The format in which instances are given, if not specified, assume - it's JSONL format. Currently only JSONL format is supported. + values: + type: array + description: A list of int64 values. + items: + format: int64 + type: string + GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue: + description: Single value that supports strings and floats. + properties: + stringValue: type: string - id: GoogleCloudAiplatformV1ExamplesExampleGcsSource - GoogleCloudAiplatformV1Blob: + description: String type. + floatValue: + description: Float type. + type: number + format: float + type: object + id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue + GoogleCloudAiplatformV1SchemaPredictInstanceImageObjectDetectionPredictionInstance: + description: Prediction input format for Image Object Detection. + type: object properties: + content: + type: string + description: The image bytes or Cloud Storage URI to make the prediction on. mimeType: - description: Required. The IANA standard MIME type of the source data. + 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 - data: - format: byte - description: Required. Raw bytes. + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceImageObjectDetectionPredictionInstance + GoogleCloudAiplatformV1Scheduling: + properties: + timeout: + format: google-duration type: string - description: >- - Content blob. It's preferred to send as text directly rather than raw - bytes. + description: The maximum job running time. The default is 7 days. + disableRetries: + type: boolean + 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. + restartJobOnWorkerRestart: + type: boolean + 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. + description: All parameters related to queuing and scheduling of custom jobs. + id: GoogleCloudAiplatformV1Scheduling type: object - id: GoogleCloudAiplatformV1Blob - GoogleCloudAiplatformV1PublisherModelDocumentation: - description: A named piece of documentation. + GoogleCloudAiplatformV1ListFeaturestoresResponse: + id: GoogleCloudAiplatformV1ListFeaturestoresResponse + description: Response message for FeaturestoreService.ListFeaturestores. properties: - content: - type: string - description: Required. Content of this piece of document (in Markdown format). - title: + featurestores: + description: The Featurestores matching the request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' + nextPageToken: description: >- - Required. E.g., OVERVIEW, USE CASES, DOCUMENTATION, SDK & SAMPLES, - JAVA, NODE.JS, etc.. + 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 type: object - id: GoogleCloudAiplatformV1PublisherModelDocumentation - GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest: + 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. type: object - properties: {} - id: GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest - description: Request message for JobService.PauseModelDeploymentMonitoringJob. - GoogleCloudAiplatformV1ExportDataRequest: - description: Request message for DatasetService.ExportData. + id: GoogleCloudAiplatformV1BatchPredictionJobOutputConfig + properties: + 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`. + predictionsFormat: + type: string + description: >- + Required. The format in which Vertex AI gives the predictions, must + be one of the Model's supported_output_storage_formats. + GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF: + 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. type: object - id: GoogleCloudAiplatformV1ExportDataRequest + description: Parameters for RRF algorithm that combines search results. + id: GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF + GoogleCloudAiplatformV1SchemaPredictInstanceTextClassificationPredictionInstance: properties: - exportConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportDataConfig' - description: Required. The desired output location. - GoogleCloudAiplatformV1CustomJob: + content: + type: string + description: The text snippet to make the predictions on. + mimeType: + description: >- + The MIME type of the text snippet. The supported MIME types are + listed below. - text/plain + type: string + description: Prediction input format for Text Classification. type: object + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceTextClassificationPredictionInstance + GoogleCloudAiplatformV1CompletionStats: properties: - labels: - type: object - additionalProperties: - type: string + failedCount: 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. - startTime: - format: google-datetime + Output only. The number of entities for which any error was + encountered. + format: int64 readOnly: true + type: string + successfulForecastPointCount: + readOnly: true + format: int64 description: >- - Output only. Time when the CustomJob for the first time entered the - `JOB_STATE_RUNNING` state. + 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. type: string - name: + successfulCount: type: string - description: Output only. Resource name of a CustomJob. + format: int64 + description: >- + Output only. The number of entities that had been processed + successfully. readOnly: true - updateTime: - description: Output only. Time when the CustomJob was most recently updated. + incompleteCount: + type: string + 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). readOnly: true - format: google-datetime + description: >- + Success and error statistics of processing multiple entities (for + example, DataItems or structured data rows) in batch. + id: GoogleCloudAiplatformV1CompletionStats + type: object + GoogleCloudAiplatformV1NasJob: + properties: + createTime: type: string - webAccessUris: - type: object + readOnly: true + description: Output only. Time when the NasJob was created. + format: google-datetime + nasJobOutput: + readOnly: true + description: Output only. Output of the NasJob. + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJobOutput' + enableRestrictedImageTraining: + type: boolean + deprecated: 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 - 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 + Optional. Enable a separation of Custom model training and + restricted image training for tenant project. + updateTime: + format: google-datetime + description: Output only. Time when the NasJob was most recently updated. + type: string readOnly: true + displayName: + 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 + type: string + readOnly: true description: >- - Output only. Time when the CustomJob entered any of the following + 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 - format: google-datetime + nasJobSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJobSpec' + description: Required. The specification of a NasJob. + labels: + type: object + additionalProperties: + type: string + 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. + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + 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. state: + description: Output only. The detailed state of the job. + type: string enum: - JOB_STATE_UNSPECIFIED - JOB_STATE_QUEUED @@ -19855,10 +20277,7 @@ components: - JOB_STATE_PAUSED - JOB_STATE_EXPIRED - JOB_STATE_UPDATING - - JOB_STATE_PARTIALLY_SUCCEEDED - readOnly: true - description: Output only. The detailed state of the job. - type: string + - JOB_STATE_PARTIALLY_SUCCEEDED enumDescriptions: - The job state is unspecified. - >- @@ -19881,615 +20300,432 @@ components: - >- The job is partially succeeded, some results may be missing due to errors. - 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. - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - Output only. Only populated when job's state is `JOB_STATE_FAILED` - or `JOB_STATE_CANCELLED`. readOnly: true - createTime: + name: + readOnly: true + description: Output only. Resource name of the NasJob. type: string + startTime: readOnly: true - description: Output only. Time when the CustomJob was created. + type: string format: google-datetime - 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' - jobSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' - description: Required. Job spec. - description: >- - Represents a job that runs custom workloads such as a Docker container - or a Python package. A CustomJob can have multiple worker pools and each - worker pool can have its own machine and input spec. A CustomJob will be - cleaned up once the job enters terminal state (failed or succeeded). - id: GoogleCloudAiplatformV1CustomJob - GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec: - id: GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec - description: Value specification for a parameter in `DOUBLE` type. - properties: - minValue: - description: Required. Inclusive minimum value of the parameter. - type: number - format: double - defaultValue: + Output only. Time when the NasJob for the first time entered the + `JOB_STATE_RUNNING` state. + error: + $ref: '#/components/schemas/GoogleRpcStatus' 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. - format: double - type: number - maxValue: - format: double - type: number - description: Required. Inclusive maximum value of the parameter. + Output only. Only populated when job's state is JOB_STATE_FAILED or + JOB_STATE_CANCELLED. + readOnly: true + description: Represents a Neural Architecture Search (NAS) job. + id: GoogleCloudAiplatformV1NasJob type: object - GoogleCloudAiplatformV1SchemaVideoDatasetMetadata: - description: The metadata of Datasets that contain Video DataItems. - id: GoogleCloudAiplatformV1SchemaVideoDatasetMetadata + GoogleCloudAiplatformV1Presets: 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: + modality: description: >- - Google Cloud Storage Bucket name that contains the blob data of this - Dataset. + 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. type: string - type: object - GoogleCloudAiplatformV1Scheduling: - description: All parameters related to queuing and scheduling of custom jobs. - id: GoogleCloudAiplatformV1Scheduling - type: object - properties: - 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 - disableRetries: + 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 + query: + enumDescriptions: + - More precise neighbors as a trade-off against slower response. + - Faster response as a trade-off against less precise neighbors. 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 - timeout: - format: google-duration + Preset option controlling parameters for speed-precision trade-off + when querying for examples. If omitted, defaults to `PRECISE`. + enum: + - PRECISE + - FAST type: string - description: The maximum job running time. The default is 7 days. - GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation: - description: Represents a polyline in image. + id: GoogleCloudAiplatformV1Presets type: object - id: >- - GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation + description: Preset configuration for example-based explanations + GoogleCloudAiplatformV1StudySpec: + id: GoogleCloudAiplatformV1StudySpec properties: - displayName: - description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. - type: string - annotationSpecId: + algorithm: + description: The search algorithm specified for the Study. type: string - description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. - vertexes: - type: array - description: >- - The vertexes are connected one by one and the last vertex in not - connected to the first one. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaVertex' - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtraction: - properties: - inputs: - description: The input parameters of this TrainingJob. + 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. + medianAutomatedStoppingSpec: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtraction - type: object - description: A TrainingJob that trains and uploads an AutoML Text Extraction Model. - GoogleCloudAiplatformV1ListTrainingPipelinesResponse: - properties: - nextPageToken: + #/components/schemas/GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec + description: The automated early stopping spec using median 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. type: string + enum: + - OBSERVATION_NOISE_UNSPECIFIED + - LOW + - HIGH description: >- - A token to retrieve the next page of results. Pass to - ListTrainingPipelinesRequest.page_token to obtain that page. - trainingPipelines: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' - description: List of TrainingPipelines in the requested page. - id: GoogleCloudAiplatformV1ListTrainingPipelinesResponse - description: Response message for PipelineService.ListTrainingPipelines - type: object - GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetrics: - description: Metrics for image segmentation evaluation results. - type: object - properties: - confidenceMetricsEntries: - 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 - type: array - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetrics - GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks: - id: GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks - description: Open notebooks. - properties: - notebooks: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - description: Required. Regional resource references to notebooks. - type: array - type: object - GoogleCloudAiplatformV1ListMetadataStoresResponse: - properties: - 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 - metadataStores: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataStore' - type: array - description: The MetadataStores found for the Location. - description: Response message for MetadataService.ListMetadataStores. - id: GoogleCloudAiplatformV1ListMetadataStoresResponse - type: object - GoogleCloudAiplatformV1BatchReadFeatureValuesRequest: - description: Request message for FeaturestoreService.BatchReadFeatureValues. - properties: - bigqueryReadInstances: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' - description: Similar to csv_read_instances, but from BigQuery source. - entityTypeSpecs: + The observation noise level of the study. Currently only supported + by the Vertex AI Vizier service. Not supported by + HyperparameterTuningJob or TrainingPipeline. + parameters: type: array - description: >- - Required. Specifies EntityType grouping Features to read values of - and settings. items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec - 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' - 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. + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpec' + description: Required. The set of parameters to tune. + metrics: items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpecMetricSpec' type: array - destination: - description: Required. Specifies output location and format. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueDestination' - 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. + description: Required. Metric specs for the Study. + measurementSelectionType: + description: Describe which measurement selection type will be used type: string - format: google-datetime - type: object - id: GoogleCloudAiplatformV1BatchReadFeatureValuesRequest - GoogleCloudAiplatformV1IdMatcher: - description: Matcher for Features of an EntityType by Feature ID. - type: object - 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. - type: array - items: - type: string - id: GoogleCloudAiplatformV1IdMatcher - GoogleCloudAiplatformV1GoogleSearchRetrieval: - properties: {} - description: Tool to retrieve public web data for grounding, powered by Google. - type: object - id: GoogleCloudAiplatformV1GoogleSearchRetrieval - GoogleCloudAiplatformV1FeatureViewDataKey: - type: object - id: GoogleCloudAiplatformV1FeatureViewDataKey - description: Lookup key for a feature view. - properties: - 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. + enum: + - MEASUREMENT_SELECTION_TYPE_UNSPECIFIED + - LAST_MEASUREMENT + - BEST_MEASUREMENT + enumDescriptions: + - Will be treated as LAST_MEASUREMENT. + - Use the last measurement reported. + - Use the best measurement reported. + convexAutomatedStoppingSpec: + description: The automated early stopping spec using convex stopping rule. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey - key: - description: String key to use for lookup. - type: string - GoogleCloudAiplatformV1NasJobSpec: - id: GoogleCloudAiplatformV1NasJobSpec - properties: - multiTrialAlgorithmSpec: + #/components/schemas/GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec + decayCurveStoppingSpec: $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: + #/components/schemas/GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec + description: The automated early stopping spec using decay curve rule. + studyStoppingConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecStudyStoppingConfig 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: string + Conditions for automated stopping of a Study. Enable automated + stopping by configuring at least one condition. type: object - description: Represents the spec of a NasJob. - GoogleCloudAiplatformV1MutateDeployedModelOperationMetadata: + description: Represents specification of a Study. + GoogleCloudAiplatformV1CreateEntityTypeOperationMetadata: + description: Details of operations that perform create EntityType. + type: object + id: GoogleCloudAiplatformV1CreateEntityTypeOperationMetadata properties: genericMetadata: - description: The operation generic information. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for EntityType. + GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig: type: object - description: Runtime operation information for EndpointService.MutateDeployedModel. - id: GoogleCloudAiplatformV1MutateDeployedModelOperationMetadata - GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata: + id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig description: >- - This message will be placed in the metadata field of a - google.longrunning.Operation associated with a - CheckTrialEarlyStoppingState request. - type: object + The tables Dataset's data source. The Dataset doesn't store the data + directly, but only pointer(s) to its data. properties: - study: - type: string - description: The name of the Study that the Trial belongs to. - trial: - description: The Trial name. - type: string - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for suggesting Trials. - id: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata - CloudAiLargeModelsVisionSemanticFilterResponse: + bigquerySource: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource + gcsSource: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource + GoogleCloudAiplatformV1StringArray: + type: object + id: GoogleCloudAiplatformV1StringArray + description: A list of string values. properties: - namedBoundingBoxes: - type: array + values: items: - $ref: '#/components/schemas/CloudAiLargeModelsVisionNamedBoundingBox' - description: >- - Class labels of the bounding boxes that failed the semantic - filtering. Bounding box coordinates. - passedSemanticFilter: - 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 + type: string + description: A list of string values. + type: array + GoogleCloudAiplatformV1IndexStats: + id: GoogleCloudAiplatformV1IndexStats type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs: + description: Stats of the Index. properties: - baseModelId: - 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. - modelType: + sparseVectorsCount: + format: int64 + description: Output only. The number of sparse vectors in the Index. 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. - enum: - - MODEL_TYPE_UNSPECIFIED - - CLOUD_HIGH_ACCURACY_1 - - CLOUD_LOW_ACCURACY_1 - - MOBILE_TF_LOW_LATENCY_1 - 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). + readOnly: true + shardsCount: + description: Output only. The number of shards in the Index. + readOnly: true + type: integer + format: int32 + vectorsCount: + readOnly: true type: string + description: Output only. The number of dense vectors in the Index. format: int64 + GoogleCloudAiplatformV1StreamingPredictRequest: + properties: + parameters: + description: The parameters that govern the prediction. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + inputs: + description: The prediction input. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + type: array + id: GoogleCloudAiplatformV1StreamingPredictRequest + description: >- + Request message for PredictionService.StreamingPredict. The first + message must contain endpoint field and optionally input. The subsequent + messages must contain input. + type: object + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline: id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline + type: object + properties: + gcs: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + description: Cloud Storage location for BatchExplain output. + bigquery: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' + description: BigQuery location for BatchExplain output. + predictionFormat: + type: string + description: The storage format of the predictions generated BatchPrediction job. + enum: + - PREDICTION_FORMAT_UNSPECIFIED + - JSONL + - BIGQUERY + enumDescriptions: + - Should not be set. + - Predictions are in JSONL files. + - Predictions are in BigQuery. + description: >- + Output from BatchPredictionJob for Model Monitoring baseline dataset, + which can be used to generate baseline attribution scores. + GoogleCloudAiplatformV1FeatureSelector: + properties: + idMatcher: + description: Required. Matches Features based on ID. + $ref: '#/components/schemas/GoogleCloudAiplatformV1IdMatcher' type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata: + id: GoogleCloudAiplatformV1FeatureSelector + description: Selector for Features of an EntityType. + GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata: + id: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata - description: Model metadata specific to AutoML Forecasting. properties: - evaluatedDataItemsBigqueryUri: + study: type: string - description: BigQuery destination uri for exported evaluated examples. - trainCostMilliNodeHours: - 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: The name of the Study that the Trial belongs to. + trial: type: string - GoogleCloudAiplatformV1StratifiedSplit: - type: object + description: The Trial name. + genericMetadata: + description: Operation metadata for suggesting Trials. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' 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. + This message will be placed in the metadata field of a + google.longrunning.Operation associated with a + CheckTrialEarlyStoppingState request. + GoogleCloudAiplatformV1CustomJob: 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. + name: type: string - testFraction: - format: double + description: Output only. Resource name of a CustomJob. + readOnly: true + endTime: + readOnly: true + type: string + format: google-datetime description: >- - The fraction of the input data that is to be used to evaluate the - Model. - type: number - trainingFraction: - format: double - type: number + Output only. Time when the CustomJob entered any of the following + states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, + `JOB_STATE_CANCELLED`. + jobSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' + description: Required. Job spec. + state: + 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 + 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 + error: + readOnly: true + $ref: '#/components/schemas/GoogleRpcStatus' description: >- - The fraction of the input data that is to be used to train the - Model. - validationFraction: - format: double + Output only. Only populated when job's state is `JOB_STATE_FAILED` + or `JOB_STATE_CANCELLED`. + startTime: description: >- - The fraction of the input data that is to be used to validate the - Model. - type: number - id: GoogleCloudAiplatformV1StratifiedSplit - GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec: - properties: - maxParallelTrialCount: - format: int32 - description: Required. The maximum number of trials to run in parallel. - type: integer - maxTrialCount: - format: int32 + Output only. Time when the CustomJob for the first time entered the + `JOB_STATE_RUNNING` state. + type: string + format: google-datetime + readOnly: true + updateTime: + description: Output only. Time when the CustomJob was most recently updated. + type: string + format: google-datetime + readOnly: true + webAccessUris: + readOnly: true description: >- - Required. The maximum number of Neural Architecture Search (NAS) - trials to run. - type: integer - searchTrialJobSpec: + 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 + additionalProperties: + type: string + labels: + type: object + additionalProperties: + type: string description: >- - Required. The spec of a search trial job. The same spec applies to - all search trials. - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' - maxFailedTrialCount: + 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. + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' 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. - type: integer - format: int32 - description: Represent spec for search trials. - type: object - id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation - properties: - numeric: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation - text: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation - timestamp: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation - categorical: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation - auto: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation - type: object - GoogleCloudAiplatformV1FeatureNoiseSigma: - id: GoogleCloudAiplatformV1FeatureNoiseSigma - type: object - properties: - noiseSigma: - type: array + 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: + readOnly: true + type: string + description: Output only. Time when the CustomJob was created. + format: google-datetime + displayName: + type: string description: >- - Noise sigma per feature. No noise is added to features that are not - set. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature + Required. The display name of the CustomJob. The name can be up to + 128 characters long and can consist of any UTF-8 characters. 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. - GoogleCloudAiplatformV1UserActionReference: + Represents a job that runs custom workloads such as a Docker container + or a Python package. A CustomJob can have multiple worker pools and each + worker pool can have its own machine and input spec. A CustomJob will be + cleaned up once the job enters terminal state (failed or succeeded). + id: GoogleCloudAiplatformV1CustomJob type: object - description: >- - References an API call. It contains more information about long running - operation and Jobs that are triggered by the API call. - id: GoogleCloudAiplatformV1UserActionReference + GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata: + type: object + description: Describes metadata for a TensorboardTimeSeries. properties: - operation: + maxWallTime: + readOnly: true 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: - type: string + Output only. Max wall clock timestamp of all data points within a + TensorboardTimeSeries. + format: google-datetime + maxBlobSequenceLength: description: >- - For API calls that start a LabelingJob. Resource name of the - LabelingJob. Format: - `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` - method: + Output only. The largest blob sequence length (number of blobs) of + all data points in this time series, if its ValueType is + BLOB_SEQUENCE. + readOnly: true + format: int64 type: string + maxStep: description: >- - The method name of the API RPC call. For example, - "/google.cloud.aiplatform.{apiVersion}.DatasetService.CreateDataset" - GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation: - description: The mask based segmentation annotation. - properties: - maskGcsUri: + Output only. Max step index of all data points within a + TensorboardTimeSeries. type: string - 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. - annotationSpecColors: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaAnnotationSpecColor - description: The mapping between color and AnnotationSpec for this Annotation. - type: array - id: GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation + format: int64 + readOnly: true + id: GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata + GoogleCloudAiplatformV1PurgeContextsResponse: type: object - GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies: - description: Historical Stats (and Anomalies) for a specific Feature. + id: GoogleCloudAiplatformV1PurgeContextsResponse properties: - threshold: - description: Threshold for anomaly detection. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' - trainingStats: - description: Stats calculated for the Training Dataset. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureStatsAnomaly' - featureDisplayName: - type: string - description: Display Name of the Feature. - predictionStats: + purgeSample: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureStatsAnomaly' - description: >- - A list of historical stats generated by different time window's - Prediction Dataset. + type: string type: array - id: >- - GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies - type: object - GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse: - id: GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse - description: Response message for ModelService.ListModelEvaluationSlices. - properties: - nextPageToken: description: >- - A token to retrieve next page of results. Pass to - ListModelEvaluationSlicesRequest.page_token to obtain that page. - type: string - modelEvaluationSlices: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSlice' - description: List of ModelEvaluations in the requested page. - type: array - type: object - GoogleCloudAiplatformV1ListPersistentResourcesResponse: - properties: - nextPageToken: + 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: description: >- - A token to retrieve next page of results. Pass to - ListPersistentResourcesRequest.page_token to obtain that page. + 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. + format: int64 type: string - persistentResources: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' - type: array - id: GoogleCloudAiplatformV1ListPersistentResourcesResponse - type: object - description: Response message for PersistentResourceService.ListPersistentResources + description: Response message for MetadataService.PurgeContexts. GoogleCloudAiplatformV1ModelDeploymentMonitoringJob: - 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 + type: object properties: - enableMonitoringPipelineLogs: - 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). - type: boolean labels: - type: object additionalProperties: type: string description: >- @@ -20499,53 +20735,84 @@ components: letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. - 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. + type: object + modelDeploymentMonitoringScheduleConfig: + description: Required. Schedule config for running the monitoring job. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig + latestMonitoringPipelineMetadata: + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata + description: Output only. Latest triggered monitoring pipeline metadata. + modelMonitoringAlertConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringAlertConfig + description: Alert config for model monitoring. + createTime: + readOnly: true + format: google-datetime + description: >- + Output only. Timestamp when this ModelDeploymentMonitoringJob was + created. + type: string + updateTime: + type: string + readOnly: true + description: >- + Output only. Timestamp when this ModelDeploymentMonitoringJob was + updated most recently. + format: google-datetime + 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 + scheduleState: + description: >- + Output only. Schedule state when the monitoring job is in Running + state. type: string enum: - MONITORING_SCHEDULE_STATE_UNSPECIFIED - PENDING - OFFLINE - RUNNING + 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. + readOnly: true + enableMonitoringPipelineLogs: + type: boolean description: >- - Output only. Schedule state when the monitoring job is in Running - state. - statsAnomaliesBaseDirectory: - description: Stats anomalies base folder path. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' - bigqueryTables: + 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). + logTtl: 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 - readOnly: true + 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. + format: google-duration + type: string + modelDeploymentMonitoringObjectiveConfigs: + description: >- + Required. The config for monitoring objectives. This is a per + DeployedModel config. Each DeployedModel needs to be configured + separately. items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable - 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 - predictInstanceSchemaUri: + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig + type: array + name: 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. + readOnly: true + description: Output only. Resource name of a ModelDeploymentMonitoringJob. analysisInstanceSchemaUri: - type: string description: >- YAML schema file uri describing the format of a single instance that you want Tensorflow Data Validation (TFDV) to analyze. If this field @@ -20556,36 +20823,30 @@ components: 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. - endpoint: type: string - description: >- - Required. Endpoint resource name. Format: - `projects/{project}/locations/{location}/endpoints/{endpoint}` - modelDeploymentMonitoringScheduleConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig - description: Required. Schedule config for running the monitoring job. - error: + statsAnomaliesBaseDirectory: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + description: Stats anomalies base folder path. + bigqueryTables: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable readOnly: true - $ref: '#/components/schemas/GoogleRpcStatus' + type: array description: >- - Output only. Only populated when the job's state is - `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`. - state: - 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 + 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 + 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' + state: + readOnly: true enumDescriptions: - The job state is unspecified. - >- @@ -20608,747 +20869,515 @@ components: - >- The job is partially succeeded, some results may be missing due to errors. + type: string 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 + displayName: type: string - logTtl: 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. - format: google-duration - type: string - modelDeploymentMonitoringObjectiveConfigs: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig - type: array + 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. + loggingSamplingStrategy: + description: Required. Sample Strategy for logging. + $ref: '#/components/schemas/GoogleCloudAiplatformV1SamplingStrategy' + endpoint: description: >- - Required. The config for monitoring objectives. This is a per - DeployedModel config. Each DeployedModel needs to be configured - separately. + Required. Endpoint resource name. Format: + `projects/{project}/locations/{location}/endpoints/{endpoint}` + type: string nextScheduleTime: - readOnly: true + format: google-datetime description: >- Output only. Timestamp when this monitoring pipeline will be scheduled to run for the next round. - format: google-datetime - type: string - updateTime: - readOnly: true - description: >- - Output only. Timestamp when this ModelDeploymentMonitoringJob was - updated most recently. - format: google-datetime - type: string - name: readOnly: true - description: Output only. Resource name of a ModelDeploymentMonitoringJob. - type: string - 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 - modelMonitoringAlertConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringAlertConfig - description: Alert config for model monitoring. - createTime: - description: >- - Output only. Timestamp when this ModelDeploymentMonitoringJob was - created. - format: google-datetime - readOnly: true + predictInstanceSchemaUri: type: string - latestMonitoringPipelineMetadata: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata - description: Output only. Latest triggered monitoring pipeline metadata. - loggingSamplingStrategy: - description: Required. Sample Strategy for logging. - $ref: '#/components/schemas/GoogleCloudAiplatformV1SamplingStrategy' - 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' - type: object - id: GoogleCloudAiplatformV1ModelDeploymentMonitoringJob - GoogleTypeColor: - id: GoogleTypeColor - properties: - alpha: - format: float + 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. + samplePredictInstance: + type: any 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 - green: - format: float - description: The amount of green in the color as a value in the interval [0, 1]. - type: number - blue: - format: float - description: The amount of blue in the color as a value in the interval [0, 1]. - type: number - red: - type: number - description: The amount of red in the color as a value in the interval [0, 1]. - format: float - type: object + 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. 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(''); }; // ... - GoogleCloudAiplatformV1MutateDeployedModelRequest: + 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. + GoogleCloudAiplatformV1SchemaPredictPredictionImageObjectDetectionPredictionResult: + description: Prediction output format for Image Object Detection. properties: - updateMask: - format: google-fieldmask + bboxes: + type: array description: >- - Required. The update mask applies to the resource. See - google.protobuf.FieldMask. - type: string - deployedModel: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' + 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. + items: + type: array + items: + type: any + ids: + items: + type: string + format: int64 + type: array 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) - description: Request message for EndpointService.MutateDeployedModel. - id: GoogleCloudAiplatformV1MutateDeployedModelRequest - type: object - GoogleCloudAiplatformV1BatchMigrateResourcesResponse: - type: object - id: GoogleCloudAiplatformV1BatchMigrateResourcesResponse - properties: - migrateResourceResponses: + The resource IDs of the AnnotationSpecs that had been identified, + ordered by the confidence score descendingly. + confidences: type: array - description: Successfully migrated resources. + description: >- + The Model's confidences in correctness of the predicted IDs, higher + value means higher confidence. Order matches the Ids. items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigrateResourceResponse - description: Response message for MigrationService.BatchMigrateResources. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation: - properties: - columnName: - type: string - description: >- - Training pipeline will infer the proper transformation based on the - statistic of dataset. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation - type: object - GoogleCloudAiplatformV1TrainingConfig: - type: object - properties: - timeoutTrainingMilliHours: - format: int64 + format: float + type: number + displayNames: + type: array + items: + type: string description: >- - 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 - 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. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation: + The display names of the AnnotationSpecs that had been identified, + order matches the IDs. + type: object id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation + GoogleCloudAiplatformV1SchemaPredictPredictionImageObjectDetectionPredictionResult + GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem: + id: GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem 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: - columnName: - type: string - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation: properties: - columnName: + distance: + type: number + format: double + description: The distance of this item to the annotation. + annotationResourceName: type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation + description: >- + The unique ID for each annotation. Used by FE to allocate the + annotation in DB. 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 - GoogleCloudAiplatformV1BatchPredictionJobOutputInfo: - description: Further describes this job's output. Supplements output_config. - type: object + Attributed items for a given annotation, typically representing + neighbors from the training sets constrained by the query type. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetrics: properties: - bigqueryOutputTable: - type: string + confidenceMetrics: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics + 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. - readOnly: true - bigqueryOutputDataset: - readOnly: true + 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. + confusionMatrix: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix + description: Confusion matrix of the evaluation. + auRoc: description: >- - Output only. The path of the BigQuery dataset created, in - `bq://projectId.bqDatasetId` format, into which the prediction - output is written. - type: string - gcsOutputDirectory: + The Area Under Receiver Operating Characteristic curve metric. + Micro-averaged for the overall evaluation. + type: number + format: float + logLoss: + format: float + description: The Log Loss metric. + type: number + auPrc: + type: number description: >- - Output only. The full path of the Cloud Storage directory created, - into which the prediction output is written. - readOnly: true - type: string - id: GoogleCloudAiplatformV1BatchPredictionJobOutputInfo - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs: - type: object + The Area Under Precision-Recall Curve metric. Micro-averaged for the + overall evaluation. + format: float id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs + GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetrics + description: Metrics for classification evaluation results. + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation: properties: - modelType: + timeFormat: 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. - GoogleCloudAiplatformV1LookupStudyRequest: - description: Request message for VizierService.LookupStudy. - properties: - 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 - description: Required. The user-defined display name of the Study - id: GoogleCloudAiplatformV1LookupStudyRequest - type: object - GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig: type: object - properties: - 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` - enabled: - description: If logging is enabled or not. - type: boolean - samplingRate: - format: double - type: number - description: >- - Percentage of requests to be logged, expressed as a fraction in - range(0,1]. - id: GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig - description: Configuration for logging request-response to a BigQuery table. - GoogleCloudAiplatformV1Event: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation description: >- - An edge describing the relationship between an Artifact and an Execution - in a lineage graph. + 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. + GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest: properties: - labels: - additionalProperties: + names: + type: array + items: 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: object - artifact: - description: Required. The relative resource name of the Artifact in the Event. - type: string - eventTime: - readOnly: true - description: Output only. Time the Event occurred. - format: google-datetime - type: string - execution: - readOnly: true + 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: object + description: Request message for PipelineService.BatchDeletePipelineJobs. + id: GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest + GoogleCloudAiplatformV1ListTensorboardsResponse: + id: GoogleCloudAiplatformV1ListTensorboardsResponse + description: Response message for TensorboardService.ListTensorboards. + properties: + tensorboards: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' + type: array + description: The Tensorboards mathching the request. + nextPageToken: type: string description: >- - Output only. The relative resource name of the Execution in the - Event. - type: - type: string - enumDescriptions: - - Unspecified whether input or output of the Execution. - - An input of the Execution. - - An output of the Execution. - description: Required. The type of the Event. - enum: - - TYPE_UNSPECIFIED - - INPUT - - OUTPUT - id: GoogleCloudAiplatformV1Event - type: object - GoogleCloudAiplatformV1CancelDataLabelingJobRequest: - description: Request message for JobService.CancelDataLabelingJob. - properties: {} - id: GoogleCloudAiplatformV1CancelDataLabelingJobRequest + 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 - GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition: + GoogleCloudAiplatformV1ListModelEvaluationsResponse: + id: GoogleCloudAiplatformV1ListModelEvaluationsResponse type: object - description: Represents the spec to match discrete values from parent parameter. + description: Response message for ModelService.ListModelEvaluations. properties: - values: + nextPageToken: + type: string 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. + A token to retrieve next page of results. Pass to + ListModelEvaluationsRequest.page_token to obtain that page. + modelEvaluations: items: - type: number - format: double + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' type: array - id: >- - GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition - GoogleCloudAiplatformV1VertexAISearch: + description: List of ModelEvaluations in the requested page. + GoogleCloudAiplatformV1DatasetDistributionDistributionBucket: properties: - datastore: + right: + readOnly: true + description: Output only. Right bound of the bucket. + format: double + type: number + left: + readOnly: true + type: number + format: double + description: Output only. Left bound of the bucket. + count: + readOnly: true type: string - description: >- - Required. Fully-qualified Vertex AI Search's datastore resource ID. - Format: - `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + description: Output only. Number of values in the bucket. + format: int64 + id: GoogleCloudAiplatformV1DatasetDistributionDistributionBucket type: object - id: GoogleCloudAiplatformV1VertexAISearch description: >- - Retrieve from Vertex AI Search datastore for grounding. See - https://cloud.google.com/vertex-ai-search-and-conversation - GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest: - id: GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest + Dataset bucket used to create a histogram for the distribution given a + population of values. + GoogleCloudAiplatformV1ModelExplanation: + 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. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Attribution' + readOnly: true type: object - properties: {} - description: Request message for JobService.CancelHyperparameterTuningJob. - GoogleCloudAiplatformV1ThresholdConfig: + id: GoogleCloudAiplatformV1ModelExplanation + GoogleCloudAiplatformV1Scalar: + description: One point viewable on a scalar metric plot. 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. format: double + description: Value of the point at this step / timestamp. type: number + id: GoogleCloudAiplatformV1Scalar type: object - id: GoogleCloudAiplatformV1ThresholdConfig - description: The config for feature monitoring threshold. - GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesResponse: - description: Response message for ModelService.BatchImportModelEvaluationSlices - properties: - importedModelEvaluationSlices: - type: array - items: - type: string - description: Output only. List of imported ModelEvaluationSlice.name. - readOnly: true - id: GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesResponse + GoogleCloudAiplatformV1WriteFeatureValuesResponse: + type: object + properties: {} + id: GoogleCloudAiplatformV1WriteFeatureValuesResponse + description: >- + Response message for + FeaturestoreOnlineServingService.WriteFeatureValues. + GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition: + description: Represents the spec to match categorical values from parent parameter. type: object - GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke: - id: GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke properties: - gkeYamlConfigs: + values: type: array - description: Optional. GKE deployment configuration in yaml format. + description: >- + Required. Matches values of the parent parameter of 'CATEGORICAL' + type. All values must exist in `categorical_value_spec` of parent + parameter. items: type: string - description: Configurations for PublisherModel GKE deployment - type: object - GoogleCloudAiplatformV1NfsMount: - id: GoogleCloudAiplatformV1NfsMount + id: >- + GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition + GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats: properties: - mountPoint: - type: string - description: >- - Required. Destination mount path. The NFS will be mounted for the - user under /mnt/nfs/ - path: + sourceGcsUri: 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: Cloud Storage URI pointing to the original file in user's bucket. + invalidRecordCount: type: string - description: Required. IP address of the NFS server. - type: object - description: Represents a mount configuration for Network File System (NFS) to mount. - GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig: - properties: - objectiveConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfig + description: Number of records in this file we skipped due to validate errors. + format: int64 + validSparseRecordCount: description: >- - The objective config of for the modelmonitoring job of this deployed - model. - deployedModelId: - type: string - description: The DeployedModel ID of the objective config. - id: GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig - description: >- - ModelDeploymentMonitoringObjectiveConfig contains the pair of - deployed_model_id to ModelMonitoringObjectiveConfig. - type: object - GoogleCloudAiplatformV1MetadataSchema: - type: object - properties: - name: - description: Output only. The resource name of the MetadataSchema. - type: string - readOnly: true - 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. + Number of sparse records in this file that were successfully + processed. + format: int64 type: string - 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: + partialErrors: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError 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 - schemaVersion: + 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 + invalidSparseRecordCount: type: string 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. - description: - type: string - description: Description of the Metadata Schema - createTime: - readOnly: true - format: google-datetime + Number of sparse records in this file we skipped due to validate + errors. + format: int64 + validRecordCount: + description: Number of records in this file that were successfully processed. + format: int64 type: string - description: Output only. Timestamp when this MetadataSchema was created. - description: Instance of a general MetadataSchema. - id: GoogleCloudAiplatformV1MetadataSchema - GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource: + id: >- + GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats + type: object + GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData: properties: - uri: - type: string - description: >- - The URI of a BigQuery table. e.g. - bq://projectId.bqDatasetId.bqTableId + userUsageData: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData + description: Usage data for each user in the given month. + description: Per month usage data type: object - id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource - GoogleCloudAiplatformV1Candidate: + id: GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData + GoogleCloudAiplatformV1FeatureViewIndexConfig: + description: Configuration for vector indexing. + id: GoogleCloudAiplatformV1FeatureViewIndexConfig type: object properties: - content: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' - description: Output only. Content parts of the candidate. - readOnly: true - finishReason: - readOnly: true + embeddingColumn: type: string - enum: - - FINISH_REASON_UNSPECIFIED - - STOP - - MAX_TOKENS - - SAFETY - - RECITATION - - OTHER - - BLOCKLIST - - PROHIBITED_CONTENT - - SPII description: >- - Output only. The reason why the model stopped generating tokens. If - empty, the model has not stopped generating the tokens. + 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. + distanceMeasureType: + type: string + description: Optional. The distance measure used in nearest neighbor search. + enum: + - DISTANCE_MEASURE_TYPE_UNSPECIFIED + - SQUARED_L2_DISTANCE + - COSINE_DISTANCE + - DOT_PRODUCT_DISTANCE enumDescriptions: - - The finish reason is unspecified. - - Natural stop point of the model or provided stop sequence. - - >- - The maximum number of tokens as specified in the request was - reached. - - >- - The token generation was stopped as the response was flagged for - safety reasons. NOTE: When streaming the Candidate.content will be - empty if content filters blocked the output. - - >- - The token generation was stopped as the response was flagged for - unauthorized citations. - - All other reasons that stopped the token generation - - >- - The token generation was stopped as the response was flagged for - the terms which are included from the terminology blocklist. - - >- - The token generation was stopped as the response was flagged for - the prohibited contents. + - Should not be set. + - Euclidean (L_2) Distance. - >- - The token generation was stopped as the response was flagged for - Sensitive Personally Identifiable Information (SPII) contents. - groundingMetadata: + 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. + treeAhConfig: description: >- - Output only. Metadata specifies sources used to ground generated - content. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundingMetadata' - readOnly: true - safetyRatings: + 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 + filterColumns: description: >- - Output only. List of ratings for the safety of a response candidate. - There is at most one rating per category. + Optional. Columns of features that're used to filter vector search + results. type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyRating' - readOnly: true - index: - readOnly: true - type: integer - format: int32 - description: Output only. Index of the candidate. - finishMessage: + 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. + crowdingColumn: type: string - readOnly: true description: >- - Output only. Describes the reason the mode stopped generating tokens - in more detail. This is only filled when `finish_reason` is set. - citationMetadata: - description: Output only. Source attribution of the generated content. - $ref: '#/components/schemas/GoogleCloudAiplatformV1CitationMetadata' - readOnly: true - id: GoogleCloudAiplatformV1Candidate - description: A response candidate generated from the model. - GoogleCloudAiplatformV1UpdateFeatureOnlineStoreOperationMetadata: - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for FeatureOnlineStore. - description: Details of operations that perform update FeatureOnlineStore. - type: object - id: GoogleCloudAiplatformV1UpdateFeatureOnlineStoreOperationMetadata - GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket: + 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. + embeddingDimension: + format: int32 + description: Optional. The number of dimensions of the input embedding. + type: integer + GoogleCloudAiplatformV1EntityIdSelector: properties: - count: - readOnly: true - type: number - description: Output only. Number of values in the bucket. - format: double - left: - description: Output only. Left bound of the bucket. - format: double - readOnly: true - type: number - right: - format: double - description: Output only. Right bound of the bucket. - readOnly: true - type: number - id: GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket - description: >- - Dataset bucket used to create a histogram for the distribution given a - population of values. + csvSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvSource' + description: Source of Csv + entityIdField: + type: string + description: >- + Source column that holds entity IDs. If not provided, entity IDs are + extracted from the column named entity_id. type: object - GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame: + id: GoogleCloudAiplatformV1EntityIdSelector + description: Selector for entityId. Getting ids from the given source. + GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup: + id: GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup 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 + Features belonging to a single feature group that will be synced to + Online Store. type: object properties: - yMax: - format: float - type: number - description: The bottommost coordinate of the bounding box. - timeOffset: - format: google-duration - 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. + featureGroupId: type: string - xMax: - format: float - description: The rightmost coordinate of the bounding box. - type: number - yMin: - type: number - format: float - description: The topmost coordinate of the bounding box. - xMin: - type: number - format: float - description: The leftmost coordinate of the bounding box. - GoogleCloudAiplatformV1RemoveContextChildrenRequest: - id: GoogleCloudAiplatformV1RemoveContextChildrenRequest - properties: - childContexts: - description: The resource names of the child Contexts. + description: Required. Identifier of the feature group. + featureIds: + description: Required. Identifiers of features under the feature group. + type: array items: type: string - type: array - type: object - description: Request message for MetadataService.DeleteContextChildrenRequest. - GoogleLongrunningListOperationsResponse: + GoogleCloudAiplatformV1ModelMonitoringAlertConfig: + description: The alert config for model monitoring. + id: GoogleCloudAiplatformV1ModelMonitoringAlertConfig type: object - id: GoogleLongrunningListOperationsResponse - description: The response message for Operations.ListOperations. properties: - nextPageToken: - type: string - description: The standard List next-page token. - operations: - type: array + notificationChannels: items: - $ref: '#/components/schemas/GoogleLongrunningOperation' + type: string description: >- - A list of operations that matches the specified filter in the - request. + Resource names of the NotificationChannels to send alert. Must be of + the format `projects//notificationChannels/` + type: array + emailAlertConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig + description: Email alert config. + enableLogging: + type: boolean + 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. + GoogleCloudAiplatformV1FeatureOnlineStoreOptimized: + properties: {} + type: object + id: GoogleCloudAiplatformV1FeatureOnlineStoreOptimized + description: Optimized storage type GoogleCloudAiplatformV1PredictSchemata: description: >- Contains the schemata used in Model's predictions and explanations via PredictionService.Predict, PredictionService.Explain and BatchPredictionJob. - id: GoogleCloudAiplatformV1PredictSchemata - type: object properties: - parametersSchemaUri: + predictionSchemaUri: 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 + 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, if no - parameters are supported, then it is set to an empty string. Note: + 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 - predictionSchemaUri: + parametersSchemaUri: 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 + 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. Note: + 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 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 @@ -21356,1092 +21385,1057 @@ components: 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. - type: string - GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics: - description: >- - Bounding box matching model metrics for a single intersection-over-union - threshold and multiple label match confidence thresholds. + 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: object + id: GoogleCloudAiplatformV1PredictSchemata + GoogleCloudAiplatformV1CreateFeatureRequest: + id: GoogleCloudAiplatformV1CreateFeatureRequest properties: - confidenceMetrics: - type: array + featureId: 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. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics - meanAveragePrecision: - format: float - type: number - description: The mean average precision, most often close to `auPrc`. - iouThreshold: + 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: >- - The intersection-over-union threshold value used to compute this - metrics entry. - type: number - format: float - id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics - GoogleCloudAiplatformV1SamplingStrategy: - id: GoogleCloudAiplatformV1SamplingStrategy + 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: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + description: Required. The Feature to create. description: >- - Sampling Strategy for logging, can be for both training and prediction - dataset. + Request message for FeaturestoreService.CreateFeature. Request message + for FeatureRegistryService.CreateFeature. type: object - properties: - randomSampleConfig: - description: Random sample config. Will support more sampling strategies later. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig - GoogleCloudAiplatformV1UpdateExplanationDatasetOperationMetadata: - description: Runtime operation information for ModelService.UpdateExplanationDataset. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation: type: object properties: - genericMetadata: - description: The common part of the operation metadata. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - id: GoogleCloudAiplatformV1UpdateExplanationDatasetOperationMetadata - GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest: - description: Request message for PipelineService.BatchDeletePipelineJobs. - id: GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest + columnName: + type: string + 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. + GoogleCloudAiplatformV1PauseScheduleRequest: type: object - properties: - names: - type: array - 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 - GoogleCloudAiplatformV1UndeployModelResponse: - description: Response message for EndpointService.UndeployModel. - id: GoogleCloudAiplatformV1UndeployModelResponse properties: {} - type: object - GoogleCloudAiplatformV1FeatureValueDestination: - id: GoogleCloudAiplatformV1FeatureValueDestination + id: GoogleCloudAiplatformV1PauseScheduleRequest + description: Request message for ScheduleService.PauseSchedule. + GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec: + id: GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec 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: + parameterSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpec' + description: Required. The spec for a conditional parameter. + parentIntValues: 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. - type: object - GoogleCloudAiplatformV1IndexDatapoint: - id: GoogleCloudAiplatformV1IndexDatapoint - description: A datapoint of Index. - properties: - sparseEmbedding: - description: Optional. Feature embedding vector for sparse index. + The spec for matching values from a parent parameter of `INTEGER` + type. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1IndexDatapointSparseEmbedding - featureVector: - items: - type: number - format: float - description: >- - Required. Feature embedding vector for dense index. An array of - numbers with the length of [NearestNeighborSearchConfig.dimensions]. - type: array - numericRestricts: + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition + parentDiscreteValues: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition 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. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1IndexDatapointNumericRestriction - type: array - restricts: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1IndexDatapointRestriction + The spec for matching values from a parent parameter of `DISCRETE` + type. + parentCategoricalValues: 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 - datapointId: - description: Required. Unique identifier of the datapoint. - type: string - crowdingTag: + The spec for matching values from a parent parameter of + `CATEGORICAL` type. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1IndexDatapointCrowdingTag - description: >- - Optional. CrowdingTag of the datapoint, the number of neighbors to - return in each crowding can be configured during query. + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition type: object - GoogleCloudAiplatformV1FunctionCallingConfig: - description: Function calling config. + description: Represents a parameter spec with condition from its parent parameter. + GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData: type: object + description: >- + Container to hold value(s), successive in time, for one Feature from the + request. + id: GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData properties: - allowedFunctionNames: - items: - type: string - type: array + values: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueList' 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. - mode: - description: Optional. Function calling mode. - enum: - - MODE_UNSPECIFIED - - AUTO - - ANY - - NONE - enumDescriptions: - - Unspecified function calling mode. This value should not be used. - - >- - Default model behavior, model decides to predict either a function - call or a natural language repspose. - - >- - Model is constrained to always predicting a function call only. If - "allowed_function_names" are set, the predicted function call will - be limited to any one of "allowed_function_names", else the - predicted function call will be any one of the provided - "function_declarations". - - >- - Model will not predict any function call. Model behavior is same - as when not passing any function declarations. - type: string - id: GoogleCloudAiplatformV1FunctionCallingConfig - GoogleCloudAiplatformV1ListModelVersionsResponse: - description: Response message for ModelService.ListModelVersions + 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' + GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset: properties: - models: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' - description: >- - List of Model versions in the requested page. In the returned Model - name field, version ID instead of regvision tag will be included. - type: array - nextPageToken: - description: >- - A token to retrieve the next page of results. Pass to - ListModelVersionsRequest.page_token to obtain that page. + annotatedDatasetDisplayName: + description: The AnnotatedDataset's display name in datalabeling.googleapis.com. type: string - id: GoogleCloudAiplatformV1ListModelVersionsResponse - type: object - GoogleCloudAiplatformV1AddExecutionEventsResponse: + annotatedDataset: + type: string + description: >- + Full resource name of data labeling AnnotatedDataset. Format: + `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`. + description: Represents one AnnotatedDataset in datalabeling.googleapis.com. + id: >- + GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset type: object - id: GoogleCloudAiplatformV1AddExecutionEventsResponse - properties: {} - description: Response message for MetadataService.AddExecutionEvents. - GoogleCloudAiplatformV1BatchCreateFeaturesRequest: - id: GoogleCloudAiplatformV1BatchCreateFeaturesRequest + GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec: + description: Value specification for a parameter in `DOUBLE` type. type: object properties: - requests: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CreateFeatureRequest' + maxValue: + type: number + description: Required. Inclusive maximum value of the parameter. + format: double + defaultValue: + type: number 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. - description: Request message for FeaturestoreService.BatchCreateFeatures. - GoogleCloudAiplatformV1AddTrialMeasurementRequest: - id: GoogleCloudAiplatformV1AddTrialMeasurementRequest + 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. + format: double + minValue: + format: double + description: Required. Inclusive minimum value of the parameter. + type: number + id: GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation: + description: >- + Training pipeline will infer the proper transformation based on the + statistic of dataset. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation properties: - measurement: - description: Required. The measurement to be added to a Trial. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' - description: Request message for VizierService.AddTrialMeasurement. + columnName: + type: string type: object - GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig: - description: >- - Config for migrating AnnotatedDataset in datalabeling.googleapis.com to - Vertex AI's SavedQuery. + GoogleCloudAiplatformV1CreatePipelineJobRequest: properties: - annotatedDataset: + parent: + type: string description: >- - Required. Full resource name of data labeling AnnotatedDataset. - Format: - `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`. + 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' + pipelineJobId: type: string - id: >- - GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs: - properties: {} - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs + 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: object - GoogleCloudAiplatformV1DeleteFeatureValuesRequest: - description: Request message for FeaturestoreService.DeleteFeatureValues. + description: Request message for PipelineService.CreatePipelineJob. + id: GoogleCloudAiplatformV1CreatePipelineJobRequest + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs: type: object - id: GoogleCloudAiplatformV1DeleteFeatureValuesRequest + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs properties: - selectEntity: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity - description: Select feature values to be deleted by specifying entities. - selectTimeRangeAndFeature: + budgetMilliNodeHours: description: >- - Select feature values to be deleted by specifying time range and - features. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectTimeRangeAndFeature - GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetrics: + 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 + modelType: + 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. + enum: + - MODEL_TYPE_UNSPECIFIED + - CLOUD_HIGH_ACCURACY_1 + - CLOUD_LOW_ACCURACY_1 + - MOBILE_TF_LOW_LATENCY_1 + type: string + 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 + GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoObjectTrackingMetrics: + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoObjectTrackingMetrics type: object properties: - confidenceMetrics: + boundingBoxMeanAveragePrecision: 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 - auPrc: + The single metric for bounding boxes evaluation: the + `meanAveragePrecision` averaged over all `boundingBoxMetrics`. type: number - description: >- - The Area Under Precision-Recall Curve metric. Micro-averaged for the - overall evaluation. format: float - logLoss: + evaluatedTrackCount: + type: integer + format: int32 + description: >- + UNIMPLEMENTED. The total number of tracks (i.e. as seen across all + frames) the ground truth used to create this evaluation had. + trackMeanBoundingBoxIou: + description: >- + UNIMPLEMENTED. The single metric for tracks bounding box iou + evaluation: the `meanBoundingBoxIou` averaged over all + `trackMetrics`. type: number format: float - description: The Log Loss metric. - auRoc: + trackMeanAveragePrecision: format: float type: number description: >- - The Area Under Receiver Operating Characteristic curve metric. - Micro-averaged for the overall evaluation. - confusionMatrix: - description: Confusion matrix of the evaluation. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetrics - description: Metrics for classification evaluation results. - GoogleCloudAiplatformV1WriteFeatureValuesRequest: - type: object - description: Request message for FeaturestoreOnlineServingService.WriteFeatureValues. - id: GoogleCloudAiplatformV1WriteFeatureValuesRequest - properties: - payloads: - type: array + UNIMPLEMENTED. The single metric for tracks accuracy evaluation: the + `meanAveragePrecision` averaged over all `trackMetrics`. + trackMeanMismatchRate: + format: float description: >- - Required. The entities to be written. Up to 100,000 feature values - can be written across all `payloads`. + UNIMPLEMENTED. The single metric for tracking consistency + evaluation: the `meanMismatchRate` averaged over all `trackMetrics`. + type: number + evaluatedFrameCount: + description: >- + UNIMPLEMENTED. The number of video frames used to create this + evaluation. + format: int32 + type: integer + evaluatedBoundingBoxCount: + type: integer + 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 + 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/GoogleCloudAiplatformV1WriteFeatureValuesPayload - GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField: - description: Describe pass-through fields in read_instance source. - id: GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField - properties: - fieldName: + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics + boundingBoxMetrics: + type: array 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 - type: object - GoogleCloudAiplatformV1SampledShapleyAttribution: + 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 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. - properties: - pathCount: - 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 - format: int32 - type: object - id: GoogleCloudAiplatformV1SampledShapleyAttribution - GoogleCloudAiplatformV1DedicatedResources: + 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). + 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 properties: - autoscalingMetricSpecs: + title: 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' - type: array - minReplicaCount: + 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: >- - 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. - format: int32 - type: integer - maxReplicaCount: + Textual representation of an expression in Common Expression + Language syntax. + type: string + location: + type: string 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 - machineSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. + description: description: >- - Required. Immutable. The specification of a single machine used by - the prediction. - id: GoogleCloudAiplatformV1DedicatedResources - description: >- - A description of resources that are dedicated to a DeployedModel, and - that need a higher degree of manual configuration. - GoogleCloudAiplatformV1RestoreDatasetVersionOperationMetadata: - id: GoogleCloudAiplatformV1RestoreDatasetVersionOperationMetadata + 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 + GoogleCloudAiplatformV1PurgeExecutionsMetadata: + type: object + id: GoogleCloudAiplatformV1PurgeExecutionsMetadata + description: Details of operations that perform MetadataService.PurgeExecutions. properties: genericMetadata: + description: Operation metadata for purging Executions. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The common part of the operation metadata. + 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: + type: string + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation type: object - description: Runtime operation information for DatasetService.RestoreDatasetVersion. - GoogleCloudAiplatformV1AddContextChildrenResponse: - id: GoogleCloudAiplatformV1AddContextChildrenResponse + GoogleCloudAiplatformV1StopTrialRequest: + description: Request message for VizierService.StopTrial. + id: GoogleCloudAiplatformV1StopTrialRequest properties: {} type: object - description: Response message for MetadataService.AddContextChildren. - GoogleCloudAiplatformV1ModelContainerSpec: + GoogleCloudAiplatformV1ReadFeatureValuesRequest: + description: Request message for FeaturestoreOnlineServingService.ReadFeatureValues. + type: object + id: GoogleCloudAiplatformV1ReadFeatureValuesRequest + properties: + entityId: + type: string + 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: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' + description: Required. Selector choosing Features of the target EntityType. + GoogleCloudAiplatformV1RaySpec: + type: object 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). + 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 properties: - ports: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Port' + imageUri: + type: string 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 - grpcPorts: + 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. + headNodeResourcePoolId: 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 - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Port' - command: + 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 + resourcePoolImages: 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). - type: array - items: + 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" } + additionalProperties: type: string - imageUri: + type: object + rayMetricSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RayMetricSpec' + description: Optional. Ray metrics configurations. + GoogleCloudAiplatformV1HyperparameterTuningJob: + type: object + properties: + labels: 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. + 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 + updateTime: type: string - startupProbe: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Probe' - description: Immutable. Specification for Kubernetes startup probe. - env: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EnvVar' + format: google-datetime 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). + Output only. Time when the HyperparameterTuningJob was most recently + updated. + readOnly: true + name: + readOnly: true + description: Output only. Resource name of the HyperparameterTuningJob. + type: string + trials: + readOnly: true + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' type: array - 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).) + description: Output only. Trials of the HyperparameterTuningJob. + state: + 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. 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).) + 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 + displayName: type: string - healthProbe: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Probe' - description: Immutable. Specification for Kubernetes readiness probe. - args: - 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). - type: array - deploymentTimeout: + Required. The display name of the HyperparameterTuningJob. The name + can be up to 128 characters long and can consist of any UTF-8 + characters. + error: + description: >- + Output only. Only populated when job's state is JOB_STATE_FAILED or + JOB_STATE_CANCELLED. + readOnly: true + $ref: '#/components/schemas/GoogleRpcStatus' + startTime: + description: >- + Output only. Time when the HyperparameterTuningJob for the first + time entered the `JOB_STATE_RUNNING` state. + readOnly: true + format: google-datetime type: string + trialJobSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' description: >- - Immutable. Deployment timeout. Limit for deployment timeout is 2 - hours. - format: google-duration - sharedMemorySizeMb: + Required. The spec of a trial job. The same spec applies to the + CustomJobs created in all the trials. + parallelTrialCount: + type: integer + description: Required. The desired number of Trials to run in parallel. + format: int32 + endTime: + format: google-datetime description: >- - Immutable. The amount of the VM memory to reserve as the shared - memory for the model in megabytes. - format: int64 + Output only. Time when the HyperparameterTuningJob entered any of + the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, + `JOB_STATE_CANCELLED`. type: string - type: object - id: GoogleCloudAiplatformV1ModelContainerSpec - GoogleCloudAiplatformV1UndeployIndexResponse: - type: object - description: Response message for IndexEndpointService.UndeployIndex. - id: GoogleCloudAiplatformV1UndeployIndexResponse - properties: {} - GoogleCloudAiplatformV1CreateIndexEndpointOperationMetadata: - id: GoogleCloudAiplatformV1CreateIndexEndpointOperationMetadata + readOnly: true + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + 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. + createTime: + type: string + description: Output only. Time when the HyperparameterTuningJob was created. + readOnly: true + format: google-datetime + maxFailedTrialCount: + type: integer + format: int32 + 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. + maxTrialCount: + format: int32 + type: integer + description: Required. The desired total number of Trials. + studySpec: + description: Required. Study configuration of the HyperparameterTuningJob. + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' + id: GoogleCloudAiplatformV1HyperparameterTuningJob description: >- - Runtime operation information for - IndexEndpointService.CreateIndexEndpoint. + Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a + Study specification and multiple CustomJobs with identical CustomJob + specification. + GoogleCloudAiplatformV1MutateDeployedModelOperationMetadata: + type: object + id: GoogleCloudAiplatformV1MutateDeployedModelOperationMetadata properties: genericMetadata: $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' description: The operation generic information. - type: object - GoogleCloudAiplatformV1DatasetDistributionDistributionBucket: - description: >- - Dataset bucket used to create a histogram for the distribution given a - population of values. - id: GoogleCloudAiplatformV1DatasetDistributionDistributionBucket + description: Runtime operation information for EndpointService.MutateDeployedModel. + CloudAiLargeModelsVisionNamedBoundingBox: type: object properties: - count: - readOnly: true - format: int64 - description: Output only. Number of values in the bucket. - type: string - right: - format: double + classes: + items: + type: string + type: array + scores: + items: + format: float + type: number + type: array + y2: + type: number + format: float + x1: + format: float + type: number + entities: + type: array + items: + type: string + y1: type: number - description: Output only. Right bound of the bucket. - readOnly: true - left: - readOnly: true - description: Output only. Left bound of the bucket. - format: double + format: float + x2: type: number - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfig: - type: object - id: GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfig + format: float + id: CloudAiLargeModelsVisionNamedBoundingBox + GoogleCloudAiplatformV1TensorboardBlob: properties: - enableFeatureAttributes: - type: boolean + data: 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. - explanationBaseline: + Optional. The bytes of the blob is not present unless it's returned + by the ReadTensorboardBlobData endpoint. + format: byte + type: string + id: description: >- - Predictions generated by the BatchPredictionJob using baseline - dataset. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline - description: >- - The config for integrating with Vertex Explainable AI. Only applicable - if the Model has explanation_spec populated. - GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport: - id: GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport + 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 + id: GoogleCloudAiplatformV1TensorboardBlob + description: One blob (e.g, image, graph) viewable on a blob metric plot. type: object + GoogleCloudAiplatformV1SchemaTextSegment: properties: - snapshotTime: - format: google-datetime + startOffset: + 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. + Zero-based character index of the first character of the text + segment (counting characters from the beginning of the text). + format: uint64 + content: type: string - startTime: + description: The text content in the segment for output only. + endOffset: 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. + 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. type: string - format: google-datetime - description: >- - Describes exporting the latest Feature values of all entities of the - EntityType between [start_time, snapshot_time]. - GoogleCloudAiplatformV1ExportDataResponse: - id: GoogleCloudAiplatformV1ExportDataResponse - description: Response message for DatasetService.ExportData. + format: uint64 + id: GoogleCloudAiplatformV1SchemaTextSegment + description: The text segment inside of DataItem. type: object + GoogleCloudAiplatformV1IndexDatapointSparseEmbedding: + description: >- + Feature embedding vector for sparse index. An array of numbers whose + values are located in the specified dimensions. properties: - 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: + values: + items: + type: number + format: float + description: Required. The list of embedding values of the sparse vector. type: array - 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-*). + dimensions: items: + format: int64 type: string - GoogleCloudAiplatformV1FilterSplit: - id: GoogleCloudAiplatformV1FilterSplit - type: object - 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. - 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. - 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. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomTask: + Required. The list of indexes for the embedding values of the sparse + vector. + type: array + id: GoogleCloudAiplatformV1IndexDatapointSparseEmbedding + type: object + GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata: + id: GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata properties: - metadata: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata - description: The metadata information. - inputs: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' - description: The input parameters of this CustomTask. + candidatesTokenCount: + description: Number of tokens in the response(s). + type: integer + format: int32 + promptTokenCount: + format: int32 + description: Number of tokens in the request. + type: integer + totalTokenCount: + type: integer + format: int32 type: object - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomTask - description: A TrainingJob that trains a custom code Model. - GoogleCloudAiplatformV1ReadIndexDatapointsResponse: + description: Usage metadata about response(s). + GoogleCloudAiplatformV1ComputeTokensRequest: type: object - id: GoogleCloudAiplatformV1ReadIndexDatapointsResponse - description: The response message for MatchService.ReadIndexDatapoints. properties: - datapoints: + instances: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' - description: The result list of datapoints. + type: any type: array - GoogleCloudAiplatformV1ToolConfig: + description: >- + Required. 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. + description: Request message for ComputeTokens RPC call. + id: GoogleCloudAiplatformV1ComputeTokensRequest + GoogleCloudAiplatformV1ModelBaseModelSource: properties: - functionCallingConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionCallingConfig' - description: Optional. Function calling config. - id: GoogleCloudAiplatformV1ToolConfig - type: object + modelGardenSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelGardenSource' + description: Source information of Model Garden models. + genieSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenieSource' + description: Information about the base model of Genie models. description: >- - Tool config. This config is shared for all tools provided in the - request. - GoogleCloudAiplatformV1ListOptimalTrialsRequest: - description: Request message for VizierService.ListOptimalTrials. - properties: {} + 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 + GoogleCloudAiplatformV1NearestNeighborQuery: type: object - id: GoogleCloudAiplatformV1ListOptimalTrialsRequest - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs: properties: - 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). - tunableParameter: + stringFilters: + type: array + description: Optional. The list of string filters. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborQueryStringFilter + embedding: + description: Optional. The embedding vector that be used for similar search. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter - description: Trainer type for Vision TrainRequest. - disableEarlyStopping: + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborQueryEmbedding + perCrowdingAttributeNeighborCount: + format: int32 + type: integer 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 - 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 - 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. - baseModelId: + 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. + neighborCount: + description: >- + Optional. The number of similar entities to be retrieved from + feature view for each query. + type: integer + format: int32 + parameters: + description: Optional. Parameters that can be set to tune query on the fly. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborQueryParameters + entityId: 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: + Optional. The entity id whose similar entities should be searched + for. If embedding is set, search will use embedding instead of + entity_id. + id: GoogleCloudAiplatformV1NearestNeighborQuery + description: A query to find a number of similar entities. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation + type: object + properties: + numeric: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation + timestamp: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation + auto: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation + text: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation + categorical: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation + GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo: + description: >- + Further describes the output of the ExportModel. Supplements + ExportModelRequest.OutputConfig. + id: GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo + properties: + artifactOutputUri: 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 - budgetMilliNodeHours: + 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. type: string + readOnly: true + imageOutputUri: 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. - format: int64 - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs + 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. + readOnly: true + type: string type: object - GoogleCloudAiplatformV1BatchDedicatedResources: + GoogleCloudAiplatformV1Featurestore: description: >- - A description of resources that are used for performing batch - operations, are dedicated to a Model, and need manual configuration. + 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: GoogleCloudAiplatformV1BatchDedicatedResources properties: - startingReplicaCount: + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' 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 + 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. + updateTime: + type: string + description: Output only. Timestamp when this Featurestore was last updated. + readOnly: true + format: google-datetime + 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 + createTime: + readOnly: true + format: google-datetime + description: Output only. Timestamp when this Featurestore was created. + type: string + 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 - machineSpec: - description: Required. Immutable. The specification of a single machine. - $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' - maxReplicaCount: - type: integer + onlineServingConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig description: >- - Immutable. The maximum number of machine replicas the batch - operation may be scaled to. The default value is 10. - format: int32 - GoogleCloudAiplatformV1SupervisedTuningSpec: - id: GoogleCloudAiplatformV1SupervisedTuningSpec - type: object - properties: - trainingDatasetUri: + 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. + name: description: >- - Required. Cloud Storage path to file containing training dataset for - tuning. The dataset must be formatted as a JSONL file. + Output only. Name of the Featurestore. Format: + `projects/{project}/locations/{location}/featurestores/{featurestore}` type: string - validationDatasetUri: + readOnly: true + etag: description: >- - Optional. Cloud Storage path to file containing validation dataset - for tuning. The dataset must be formatted as a JSONL file. + Optional. Used to perform consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. type: string - hyperParameters: - description: Optional. Hyperparameters for SFT. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedHyperParameters - description: Tuning Spec for Supervised Tuning. - GoogleCloudAiplatformV1ListDatasetVersionsResponse: - id: GoogleCloudAiplatformV1ListDatasetVersionsResponse - description: Response message for DatasetService.ListDatasetVersions. + state: + type: string + 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. + id: GoogleCloudAiplatformV1Featurestore + GoogleCloudAiplatformV1DeleteFeatureValuesOperationMetadata: + id: GoogleCloudAiplatformV1DeleteFeatureValuesOperationMetadata + type: object + description: Details of operations that delete Feature values. + properties: + genericMetadata: + description: Operation metadata for Featurestore delete Features values. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1AddExecutionEventsResponse: + id: GoogleCloudAiplatformV1AddExecutionEventsResponse + description: Response message for MetadataService.AddExecutionEvents. type: object + properties: {} + GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata: + type: object + id: GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata + description: Details of operations that perform reboot PersistentResource. + properties: + progressMessage: + type: string + description: Progress Message for Reboot LRO + genericMetadata: + description: Operation metadata for PersistentResource. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudLocationListLocationsResponse: + description: The response message for Locations.ListLocations. properties: nextPageToken: - description: The standard List next-page token. type: string - datasetVersions: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + description: The standard List next-page token. + locations: description: >- - A list of DatasetVersions that matches the specified filter in the + A list of locations that matches the specified filter in the request. type: array - GoogleCloudAiplatformV1SchemaVideoObjectTrackingAnnotation: + items: + $ref: '#/components/schemas/GoogleCloudLocationLocation' + type: object + id: GoogleCloudLocationListLocationsResponse + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtraction: + type: object 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 - yMin: - format: double - type: number - description: The topmost coordinate of the bounding box. - instanceId: - description: >- - The instance of the object, expressed as a positive integer. Used to - track the same object across different frames. - type: string - format: int64 - timeOffset: - format: google-duration - type: string - description: >- - A time (frame) of a video to which this annotation pertains. - Represented as the duration since the video's start. - annotationSpecId: - description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. - type: string - xMax: - description: The rightmost coordinate of the bounding box. - type: number - format: double - yMax: - type: number - description: The bottommost coordinate of the bounding box. - format: double - description: Annotation details specific to video object tracking. + inputs: + description: The input parameters of this TrainingJob. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtraction + description: A TrainingJob that trains and uploads an AutoML Text Extraction Model. + GoogleCloudAiplatformV1ModelExportFormat: type: object - id: GoogleCloudAiplatformV1SchemaVideoObjectTrackingAnnotation - GoogleCloudAiplatformV1Content: - id: GoogleCloudAiplatformV1Content properties: - parts: + exportableContents: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Part' + enum: + - EXPORTABLE_CONTENT_UNSPECIFIED + - ARTIFACT + - IMAGE + type: string + 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. + description: Output only. The content of this Model that may be exported. + readOnly: true type: array - description: >- - Required. Ordered `Parts` that constitute a single message. Parts - may have different IANA MIME types. - role: - description: >- - Optional. The producer of the content. Must be either 'user' or - 'model'. Useful to set for multi-turn conversations, otherwise can - be left blank or unset. + id: type: string - type: object + readOnly: true + 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. 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. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics: + Represents export format supported by the Model. All formats export to + Google Cloud Storage. + id: GoogleCloudAiplatformV1ModelExportFormat + GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest: + type: object properties: - confidenceMetrics: + evaluatedAnnotations: 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 - precisionWindowLength: - 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. - format: google-duration - type: string - meanAveragePrecision: - type: number - description: The mean average precision. - format: float - type: object - id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics - description: The Evaluation metrics given a specific precision_window_length. - 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. - id: GoogleCloudAiplatformV1PrivateEndpoints + $ref: '#/components/schemas/GoogleCloudAiplatformV1EvaluatedAnnotation' + description: Required. Evaluated annotations resource to be imported. + description: Request message for ModelService.BatchImportEvaluatedAnnotations + id: GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest + GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback: + description: Content filter results for a prompt sent in the request. type: object properties: - predictHttpUri: - type: string - description: Output only. Http(s) path to send prediction requests. - readOnly: true - serviceAttachment: - description: >- - Output only. The name of the service attachment resource. Populated - if private service connect is enabled. + safetyRatings: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyRating' readOnly: true + type: array + description: Output only. Safety ratings. + blockReasonMessage: type: string - healthHttpUri: - type: string - description: Output only. Http(s) path to send health check requests. + description: Output only. A readable block reason message. readOnly: true - explainHttpUri: - type: string - description: Output only. Http(s) path to send explain requests. + blockReason: + 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. readOnly: true - GoogleCloudAiplatformV1UndeployIndexOperationMetadata: - description: Runtime operation information for IndexEndpointService.UndeployIndex. + description: Output only. Blocked reason. + type: string + id: GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback + GoogleCloudAiplatformV1RestoreDatasetVersionOperationMetadata: + id: GoogleCloudAiplatformV1RestoreDatasetVersionOperationMetadata + description: Runtime operation information for DatasetService.RestoreDatasetVersion. properties: genericMetadata: - description: The operation generic information. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The common part of the operation metadata. type: object - id: GoogleCloudAiplatformV1UndeployIndexOperationMetadata + GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageObjectDetectionEvaluationMetrics: + description: Metrics for image object detection evaluation results. + properties: + boundingBoxMeanAveragePrecision: + format: float + description: >- + The single metric for bounding boxes evaluation: the + `meanAveragePrecision` averaged over all + `boundingBoxMetricsEntries`. + type: number + 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. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics + 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: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageObjectDetectionEvaluationMetrics + type: object + GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef: + properties: + displayName: + description: Display name of the AnnotationSpec. + type: string + id: + description: ID of the AnnotationSpec. + type: string + type: object + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef + GoogleCloudAiplatformV1ListIndexesResponse: + type: object + properties: + indexes: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' + type: array + description: List of indexes in the requested page. + nextPageToken: + type: string + description: >- + A token to retrieve next page of results. Pass to + ListIndexesRequest.page_token to obtain that page. + description: Response message for IndexService.ListIndexes. + id: GoogleCloudAiplatformV1ListIndexesResponse parameters: - 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 @@ -22451,10 +22445,13 @@ components: enum: - '1' - '2' - 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 prettyPrint: @@ -22463,23 +22460,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 - 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 fields: @@ -22494,19 +22484,29 @@ components: name: callback 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 - key: + 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: >- - 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: @@ -22517,7 +22517,7 @@ components: type: string x-stackQL-resources: models: - id: aiplatform.models + id: google.aiplatform.models name: models title: Models methods: @@ -22528,112 +22528,112 @@ components: response: mediaType: application/json openAPIDocKey: '200' - compute_tokens: + delete: 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}~1models~1{modelsId}/delete response: mediaType: application/json openAPIDocKey: '200' - server_streaming_predict: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:serverStreamingPredict/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}/patch response: mediaType: application/json openAPIDocKey: '200' - generate_content: + copy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:generateContent/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models:copy/post response: mediaType: application/json openAPIDocKey: '200' - predict: + upload: 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}~1models:upload/post response: mediaType: application/json openAPIDocKey: '200' - stream_raw_predict: + export: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:streamRawPredict/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:export/post response: mediaType: application/json openAPIDocKey: '200' - raw_predict: + merge_version_aliases: 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}:mergeVersionAliases/post response: mediaType: application/json openAPIDocKey: '200' - stream_generate_content: - operation: + _list: + operation: &ref_1 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:streamGenerateContent/post - response: + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models/get + response: &ref_2 mediaType: application/json openAPIDocKey: '200' - count_tokens: + objectKey: $.models + list: + operation: *ref_1 + response: *ref_2 + server_streaming_predict: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:countTokens/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:serverStreamingPredict/post response: mediaType: application/json openAPIDocKey: '200' - patch: + generate_content: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:generateContent/post response: mediaType: application/json openAPIDocKey: '200' - delete: + count_tokens: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:countTokens/post response: mediaType: application/json openAPIDocKey: '200' - export: + stream_raw_predict: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:export/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:streamRawPredict/post response: mediaType: application/json openAPIDocKey: '200' - upload: + raw_predict: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models:upload/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:rawPredict/post response: mediaType: application/json openAPIDocKey: '200' - merge_version_aliases: + stream_generate_content: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:mergeVersionAliases/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:streamGenerateContent/post response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + predict: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models/get - response: &ref_2 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:predict/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.models - list: - operation: *ref_1 - response: *ref_2 - copy: + compute_tokens: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models:copy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:computeTokens/post response: mediaType: application/json openAPIDocKey: '200' @@ -22643,20 +22643,15 @@ components: - $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' delete: - $ref: '#/components/x-stackQL-resources/models/methods/delete' locations: - id: aiplatform.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' _list: operation: &ref_3 $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' @@ -22667,6 +22662,12 @@ components: list: operation: *ref_3 response: *ref_4 + 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' @@ -22674,200 +22675,87 @@ components: insert: [] update: [] delete: [] - datasets: - id: aiplatform.datasets - name: datasets - title: Datasets + operations: + id: google.aiplatform.operations + name: operations + title: Operations methods: - import: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}:import/post - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' _list: operation: &ref_5 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}~1operations/get response: &ref_6 mediaType: application/json openAPIDocKey: '200' - objectKey: $.datasets + objectKey: $.operations list: operation: *ref_5 response: *ref_6 - create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets/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' - export: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}:export/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: [] - delete: - - $ref: '#/components/x-stackQL-resources/datasets/methods/delete' - annotation_specs: - id: aiplatform.annotation_specs - name: annotation_specs - title: Annotation_specs - methods: - get: + cancel: 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}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}~1operations~1{operationsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/annotation_specs/methods/get' - insert: [] - update: [] - delete: [] - operations: - id: aiplatform.operations - name: operations - title: Operations - methods: wait: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}~1operations~1{operationsId}:wait/post - response: - mediaType: application/json - openAPIDocKey: '200' - cancel: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}~1operations~1{operationsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}~1operations~1{operationsId}:wait/post response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}~1operations~1{operationsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}~1operations~1{operationsId}/delete response: mediaType: application/json openAPIDocKey: '200' get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}~1operations~1{operationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - _list: - operation: &ref_7 + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}~1operations/get - response: &ref_8 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}~1operations~1{operationsId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations - list: - operation: *ref_7 - response: *ref_8 sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' + - $ref: '#/components/x-stackQL-resources/operations/methods/get' - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - $ref: '#/components/x-stackQL-resources/operations/methods/get' @@ -22877,6 +22765,9 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' @@ -22884,10 +22775,28 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/get' - $ref: '#/components/x-stackQL-resources/operations/methods/get' - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: @@ -22930,1021 +22839,1087 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - annotations: - id: aiplatform.annotations - name: annotations - title: Annotations + 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}~1trainingPipelines/post + response: + mediaType: application/json + openAPIDocKey: '200' _list: - operation: &ref_9 + operation: &ref_7 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dataItems~1{dataItemsId}~1annotations/get - response: &ref_10 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines/get + response: &ref_8 mediaType: application/json openAPIDocKey: '200' - objectKey: $.annotations + objectKey: $.trainingPipelines list: - operation: *ref_9 - response: *ref_10 + operation: *ref_7 + response: *ref_8 + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines~1{trainingPipelinesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines~1{trainingPipelinesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + cancel: + operation: + $ref: >- + #/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/annotations/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: [] - delete: [] - data_items: - id: aiplatform.data_items - name: data_items - title: Data_items + delete: + - $ref: '#/components/x-stackQL-resources/training_pipelines/methods/delete' + slices: + id: google.aiplatform.slices + name: slices + title: Slices methods: + 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' + batch_import: + operation: + $ref: >- + #/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' _list: - operation: &ref_11 + operation: &ref_9 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dataItems/get - response: &ref_12 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}~1slices/get + response: &ref_10 mediaType: application/json openAPIDocKey: '200' - objectKey: $.dataItems + objectKey: $.modelEvaluationSlices list: - operation: *ref_11 - response: *ref_12 + operation: *ref_9 + response: *ref_10 sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/data_items/methods/list' + - $ref: '#/components/x-stackQL-resources/slices/methods/get' + - $ref: '#/components/x-stackQL-resources/slices/methods/list' insert: [] update: [] delete: [] - saved_queries: - id: aiplatform.saved_queries - name: saved_queries - title: Saved_queries + evaluations: + id: google.aiplatform.evaluations + name: evaluations + title: Evaluations methods: + import: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations:import/post + response: + mediaType: application/json + openAPIDocKey: '200' _list: - operation: &ref_13 + operation: &ref_11 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1savedQueries/get - response: &ref_14 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations/get + response: &ref_12 mediaType: application/json openAPIDocKey: '200' - objectKey: $.savedQueries + objectKey: $.modelEvaluations list: - operation: *ref_13 - response: *ref_14 - delete: + operation: *ref_11 + response: *ref_12 + get: 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}~1models~1{modelsId}~1evaluations~1{evaluationsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/saved_queries/methods/list' + - $ref: '#/components/x-stackQL-resources/evaluations/methods/get' + - $ref: '#/components/x-stackQL-resources/evaluations/methods/list' insert: [] update: [] - delete: - - $ref: '#/components/x-stackQL-resources/saved_queries/methods/delete' - dataset_versions: - id: aiplatform.dataset_versions - name: dataset_versions - title: Dataset_versions + delete: [] + models_iam_policies: + id: google.aiplatform.models_iam_policies + name: models_iam_policies + title: Models_iam_policies methods: - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: + _get_iam_policy: + operation: &ref_13 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}/get - response: + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:getIamPolicy/post + response: &ref_14 mediaType: application/json openAPIDocKey: '200' - patch: + objectKey: $.bindings + get_iam_policy: + operation: *ref_13 + response: *ref_14 + set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - create: + test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1datasetVersions/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: [] + delete: [] + models_versions: + id: google.aiplatform.models_versions + name: models_versions + title: Models_versions + methods: + _list_versions: operation: &ref_15 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1datasetVersions/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:listVersions/get response: &ref_16 mediaType: application/json openAPIDocKey: '200' - objectKey: $.datasetVersions - list: + objectKey: $.models + list_versions: operation: *ref_15 response: *ref_16 - restore: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/models_versions/methods/list_versions + insert: [] + update: [] + 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}~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}:restore/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:updateExplanationDataset/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' + select: [] + insert: [] + update: [] + 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}~1models~1{modelsId}:deleteVersion/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] update: [] delete: - - $ref: '#/components/x-stackQL-resources/dataset_versions/methods/delete' - training_pipelines: - id: aiplatform.training_pipelines - name: training_pipelines - title: Training_pipelines + - $ref: >- + #/components/x-stackQL-resources/models_version/methods/delete_version + studies: + id: google.aiplatform.studies + name: studies + title: Studies methods: - cancel: + lookup: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines~1{trainingPipelinesId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies:lookup/post response: mediaType: application/json openAPIDocKey: '200' _list: operation: &ref_17 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies/get response: &ref_18 mediaType: application/json openAPIDocKey: '200' - objectKey: $.trainingPipelines + objectKey: $.studies list: operation: *ref_17 response: *ref_18 create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies/post response: mediaType: application/json openAPIDocKey: '200' - delete: + get: 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}/get response: mediaType: application/json openAPIDocKey: '200' - get: + delete: 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}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/training_pipelines/methods/list' - - $ref: '#/components/x-stackQL-resources/training_pipelines/methods/get' + - $ref: '#/components/x-stackQL-resources/studies/methods/get' + - $ref: '#/components/x-stackQL-resources/studies/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/training_pipelines/methods/create' + - $ref: '#/components/x-stackQL-resources/studies/methods/create' update: [] delete: - - $ref: '#/components/x-stackQL-resources/training_pipelines/methods/delete' - tensorboards: - id: aiplatform.tensorboards - name: tensorboards - title: Tensorboards + - $ref: '#/components/x-stackQL-resources/studies/methods/delete' + trials: + id: google.aiplatform.trials + name: trials + title: Trials methods: - read_size: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}:readSize/get - response: - mediaType: application/json - openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}/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}~1tensorboards~1{tensorboardsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}/delete response: mediaType: application/json openAPIDocKey: '200' _list: operation: &ref_19 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials/get response: &ref_20 mediaType: application/json openAPIDocKey: '200' - objectKey: $.tensorboards + objectKey: $.trials list: operation: *ref_19 response: *ref_20 create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials/post response: mediaType: application/json openAPIDocKey: '200' - read_usage: + complete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}:readUsage/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:complete/post response: mediaType: application/json openAPIDocKey: '200' - batch_read: + stop: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}:batchRead/get + #/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/tensorboards/methods/get' - - $ref: '#/components/x-stackQL-resources/tensorboards/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/tensorboards/methods/create' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/tensorboards/methods/delete' - time_series: - id: aiplatform.time_series - name: time_series - title: Time_series - methods: - export_tensorboard_time_series: + suggest: 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:suggest/post response: mediaType: application/json openAPIDocKey: '200' - delete: + 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~1{timeSeriesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:checkTrialEarlyStoppingState/post response: mediaType: application/json openAPIDocKey: '200' - get: + 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: [] + 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}~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:listOptimalTrials/post response: mediaType: application/json openAPIDocKey: '200' - patch: + sqlVerbs: + select: [] + insert: [] + update: [] + 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~1{runsId}~1timeSeries~1{timeSeriesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:addTrialMeasurement/post response: mediaType: application/json openAPIDocKey: '200' - read: + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + index_endpoints: + id: google.aiplatform.index_endpoints + name: index_endpoints + title: Index_endpoints + methods: + mutate_deployed_index: 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}~1indexEndpoints~1{indexEndpointsId}:mutateDeployedIndex/post response: mediaType: application/json openAPIDocKey: '200' - create: + undeploy_index: 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}~1indexEndpoints~1{indexEndpointsId}:undeployIndex/post response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_21 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries/get - response: &ref_22 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.tensorboardTimeSeries - list: - operation: *ref_21 - response: *ref_22 - 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}~1indexEndpoints~1{indexEndpointsId}/delete 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' - insert: - - $ref: '#/components/x-stackQL-resources/time_series/methods/create' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/time_series/methods/delete' - runs: - id: aiplatform.runs - name: runs - title: Runs - methods: - _list: - operation: &ref_23 + patch: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs/get - response: &ref_24 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}/patch + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.tensorboardRuns - list: - operation: *ref_23 - response: *ref_24 - create: + get: 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}~1indexEndpoints~1{indexEndpointsId}/get response: mediaType: application/json openAPIDocKey: '200' - write: + read_index_datapoints: 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}~1indexEndpoints~1{indexEndpointsId}:readIndexDatapoints/post response: mediaType: application/json openAPIDocKey: '200' - patch: - operation: + _list: + operation: &ref_21 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}/patch - response: + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints/get + response: &ref_22 mediaType: application/json openAPIDocKey: '200' - get: + objectKey: $.indexEndpoints + list: + operation: *ref_21 + response: *ref_22 + 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}~1indexEndpoints/post response: mediaType: application/json openAPIDocKey: '200' - delete: + find_neighbors: 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}~1indexEndpoints~1{indexEndpointsId}:findNeighbors/post response: mediaType: application/json openAPIDocKey: '200' - batch_create: + deploy_index: 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}~1indexEndpoints~1{indexEndpointsId}:deployIndex/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/runs/methods/list' - - $ref: '#/components/x-stackQL-resources/runs/methods/get' + - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/get' + - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/runs/methods/create' - update: [] + - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/patch' delete: - - $ref: '#/components/x-stackQL-resources/runs/methods/delete' - experiments: - id: aiplatform.experiments - name: experiments - title: Experiments + - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/delete' + time_series: + id: google.aiplatform.time_series + name: time_series + title: Time_series methods: - _list: - operation: &ref_25 + delete: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments/get - response: &ref_26 + #/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' - objectKey: $.tensorboardExperiments - list: - operation: *ref_25 - response: *ref_26 - create: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments/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' - get: + patch: 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}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}/patch response: mediaType: application/json openAPIDocKey: '200' - patch: + create: 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}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries/post response: mediaType: application/json openAPIDocKey: '200' - delete: + _list: + operation: &ref_23 + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries/get + response: &ref_24 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.tensorboardTimeSeries + list: + operation: *ref_23 + response: *ref_24 + read_blob_data: 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}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}:readBlobData/get response: mediaType: application/json openAPIDocKey: '200' - write: + read: 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}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}:read/get response: mediaType: application/json openAPIDocKey: '200' - batch_create: + export_tensorboard_time_series: 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}~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/experiments/methods/list' - - $ref: '#/components/x-stackQL-resources/experiments/methods/get' + - $ref: '#/components/x-stackQL-resources/time_series/methods/get' + - $ref: '#/components/x-stackQL-resources/time_series/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/experiments/methods/create' - update: [] + - $ref: '#/components/x-stackQL-resources/time_series/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/time_series/methods/patch' delete: - - $ref: '#/components/x-stackQL-resources/experiments/methods/delete' - hyperparameter_tuning_jobs: - id: aiplatform.hyperparameter_tuning_jobs - name: hyperparameter_tuning_jobs - title: Hyperparameter_tuning_jobs + - $ref: '#/components/x-stackQL-resources/time_series/methods/delete' + runs: + id: google.aiplatform.runs + name: runs + title: Runs methods: get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}/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' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}/delete response: mediaType: application/json openAPIDocKey: '200' - create: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}/patch + 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' _list: - operation: &ref_27 + operation: &ref_25 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs/get - response: &ref_28 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs/get + response: &ref_26 mediaType: application/json openAPIDocKey: '200' - objectKey: $.hyperparameterTuningJobs + objectKey: $.tensorboardRuns list: - operation: *ref_27 - response: *ref_28 - cancel: + operation: *ref_25 + response: *ref_26 + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs/post + 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' 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/runs/methods/get' + - $ref: '#/components/x-stackQL-resources/runs/methods/list' insert: - - $ref: >- - #/components/x-stackQL-resources/hyperparameter_tuning_jobs/methods/create - update: [] + - $ref: '#/components/x-stackQL-resources/runs/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/runs/methods/patch' delete: - - $ref: >- - #/components/x-stackQL-resources/hyperparameter_tuning_jobs/methods/delete - endpoints: - id: aiplatform.endpoints - name: endpoints - title: Endpoints + - $ref: '#/components/x-stackQL-resources/runs/methods/delete' + experiments: + id: google.aiplatform.experiments + name: experiments + title: Experiments methods: - patch: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}/get response: mediaType: application/json openAPIDocKey: '200' - delete: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}/patch 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}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - create: + batch_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}:batchCreate/post response: mediaType: application/json openAPIDocKey: '200' _list: - operation: &ref_29 + operation: &ref_27 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints/get - response: &ref_30 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments/get + response: &ref_28 mediaType: application/json openAPIDocKey: '200' - objectKey: $.endpoints + objectKey: $.tensorboardExperiments list: - operation: *ref_29 - response: *ref_30 - stream_generate_content: + operation: *ref_27 + response: *ref_28 + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:streamGenerateContent/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments/post response: mediaType: application/json openAPIDocKey: '200' - raw_predict: + write: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:rawPredict/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}:write/post response: mediaType: application/json openAPIDocKey: '200' - count_tokens: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/experiments/methods/get' + - $ref: '#/components/x-stackQL-resources/experiments/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/experiments/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/experiments/methods/patch' + delete: + - $ref: '#/components/x-stackQL-resources/experiments/methods/delete' + tensorboards: + id: google.aiplatform.tensorboards + name: tensorboards + title: Tensorboards + methods: + batch_read: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:countTokens/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}:batchRead/get response: mediaType: application/json openAPIDocKey: '200' - undeploy_model: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:undeployModel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards/post response: mediaType: application/json openAPIDocKey: '200' - deploy_model: - operation: + _list: + operation: &ref_29 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:deployModel/post - response: + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards/get + response: &ref_30 mediaType: application/json openAPIDocKey: '200' - stream_raw_predict: + objectKey: $.tensorboards + list: + operation: *ref_29 + response: *ref_30 + read_usage: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:streamRawPredict/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}:readUsage/get response: mediaType: application/json openAPIDocKey: '200' - server_streaming_predict: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:serverStreamingPredict/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}/delete response: mediaType: application/json openAPIDocKey: '200' - generate_content: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:generateContent/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}/get response: mediaType: application/json openAPIDocKey: '200' - direct_predict: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:directPredict/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}/patch response: mediaType: application/json openAPIDocKey: '200' - compute_tokens: + read_size: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:computeTokens/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}:readSize/get response: mediaType: application/json openAPIDocKey: '200' - direct_raw_predict: + 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' + delete: + - $ref: '#/components/x-stackQL-resources/tensorboards/methods/delete' + persistent_resources: + id: google.aiplatform.persistent_resources + name: persistent_resources + title: Persistent_resources + methods: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:directRawPredict/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}/get response: mediaType: application/json openAPIDocKey: '200' - mutate_deployed_model: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:mutateDeployedModel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}/patch response: mediaType: application/json openAPIDocKey: '200' - predict: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:predict/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}/delete response: mediaType: application/json openAPIDocKey: '200' - explain: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:explain/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources/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' - insert: - - $ref: '#/components/x-stackQL-resources/endpoints/methods/create' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/endpoints/methods/delete' - nas_trial_details: - id: aiplatform.nas_trial_details - name: nas_trial_details - title: Nas_trial_details - methods: _list: operation: &ref_31 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}~1nasTrialDetails/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources/get response: &ref_32 mediaType: application/json openAPIDocKey: '200' - objectKey: $.nasTrialDetails + objectKey: $.persistentResources list: operation: *ref_31 response: *ref_32 - get: + reboot: 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}~1persistentResources~1{persistentResourcesId}:reboot/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/nas_trial_details/methods/list' - - $ref: '#/components/x-stackQL-resources/nas_trial_details/methods/get' - insert: [] - update: [] - delete: [] - nas_jobs: - id: aiplatform.nas_jobs - name: nas_jobs - title: Nas_jobs - methods: - cancel: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}:cancel/post - response: - mediaType: application/json - openAPIDocKey: '200' + - $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 delete: - operation: - $ref: >- - #/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}~1nasJobs~1{nasJobsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' + - $ref: >- + #/components/x-stackQL-resources/persistent_resources/methods/delete + deployment_resource_pools: + id: google.aiplatform.deployment_resource_pools + name: deployment_resource_pools + title: Deployment_resource_pools + methods: create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools/post response: mediaType: application/json openAPIDocKey: '200' _list: operation: &ref_33 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools/get response: &ref_34 mediaType: application/json openAPIDocKey: '200' - objectKey: $.nasJobs + objectKey: $.deploymentResourcePools list: operation: *ref_33 response: *ref_34 - 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: [] delete: - - $ref: '#/components/x-stackQL-resources/nas_jobs/methods/delete' - index_endpoints: - id: aiplatform.index_endpoints - name: index_endpoints - title: Index_endpoints - methods: - deploy_index: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:deployIndex/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools~1{deploymentResourcePoolsId}/delete response: mediaType: application/json openAPIDocKey: '200' - find_neighbors: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:findNeighbors/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools~1{deploymentResourcePoolsId}/get response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_35 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints/get - response: &ref_36 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.indexEndpoints - list: - operation: *ref_35 - response: *ref_36 - create: + query_deployed_models: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools~1{deploymentResourcePoolsId}:queryDeployedModels/get response: mediaType: application/json openAPIDocKey: '200' - mutate_deployed_index: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/deployment_resource_pools/methods/get + - $ref: >- + #/components/x-stackQL-resources/deployment_resource_pools/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/deployment_resource_pools/methods/create + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/deployment_resource_pools/methods/delete + features: + id: google.aiplatform.features + name: features + title: Features + methods: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:mutateDeployedIndex/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features~1{featuresId}/patch response: mediaType: application/json openAPIDocKey: '200' - undeploy_index: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:undeployIndex/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features~1{featuresId}/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}~1featureGroups~1{featureGroupsId}~1features~1{featuresId}/get response: mediaType: application/json openAPIDocKey: '200' - patch: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features/post response: mediaType: application/json openAPIDocKey: '200' - delete: - operation: + _list: + operation: &ref_35 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}/delete - response: + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features/get + response: &ref_36 mediaType: application/json openAPIDocKey: '200' - read_index_datapoints: + objectKey: $.features + list: + operation: *ref_35 + response: *ref_36 + batch_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:readIndexDatapoints/post + #/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/index_endpoints/methods/list' - - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/get' + - $ref: '#/components/x-stackQL-resources/features/methods/get' + - $ref: '#/components/x-stackQL-resources/features/methods/list' + - $ref: '#/components/x-stackQL-resources/features/methods/get' + - $ref: '#/components/x-stackQL-resources/features/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/create' - update: [] + - $ref: '#/components/x-stackQL-resources/features/methods/create' + - $ref: '#/components/x-stackQL-resources/features/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/features/methods/patch' + - $ref: '#/components/x-stackQL-resources/features/methods/patch' delete: - - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/delete' - metadata_stores: - id: aiplatform.metadata_stores - name: metadata_stores - title: Metadata_stores + - $ref: '#/components/x-stackQL-resources/features/methods/delete' + - $ref: '#/components/x-stackQL-resources/features/methods/delete' + entity_types: + id: google.aiplatform.entity_types + name: entity_types + title: Entity_types methods: - _list: - operation: &ref_37 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores/get - response: &ref_38 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.metadataStores - list: - operation: *ref_37 - response: *ref_38 - create: + export_feature_values: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores/post + #/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~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}/get + #/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}~1metadataStores~1{metadataStoresId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/metadata_stores/methods/list' - - $ref: '#/components/x-stackQL-resources/metadata_stores/methods/get' - insert: - - $ref: '#/components/x-stackQL-resources/metadata_stores/methods/create' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/metadata_stores/methods/delete' - metadata_schemas: - id: aiplatform.metadata_schemas - name: metadata_schemas - title: Metadata_schemas - methods: - _list: - operation: &ref_39 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1metadataSchemas/get - response: &ref_40 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.metadataSchemas - list: - operation: *ref_39 - response: *ref_40 - create: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1metadataSchemas/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}/patch response: mediaType: application/json openAPIDocKey: '200' - get: + import_feature_values: 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}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:importFeatureValues/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/metadata_schemas/methods/list' - - $ref: '#/components/x-stackQL-resources/metadata_schemas/methods/get' - insert: - - $ref: '#/components/x-stackQL-resources/metadata_schemas/methods/create' - update: [] - delete: [] - contexts: - id: aiplatform.contexts - name: contexts - title: Contexts - methods: - purge: + read_feature_values: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts:purge/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:readFeatureValues/post response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_41 + streaming_read_feature_values: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts/get - response: &ref_42 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:streamingReadFeatureValues/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.contexts - list: - operation: *ref_41 - response: *ref_42 create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes/post response: mediaType: application/json openAPIDocKey: '200' - query_context_lineage_subgraph: - operation: + _list: + operation: &ref_37 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:queryContextLineageSubgraph/get - response: + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes/get + response: &ref_38 mediaType: application/json openAPIDocKey: '200' - patch: + objectKey: $.entityTypes + list: + operation: *ref_37 + response: *ref_38 + write_feature_values: 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}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:writeFeatureValues/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' 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 + methods: + test_iam_permissions: 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}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - get: + _get_iam_policy: + operation: &ref_39 + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:getIamPolicy/post + response: &ref_40 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + get_iam_policy: + operation: *ref_39 + response: *ref_40 + set_iam_policy: 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}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/contexts/methods/list' - - $ref: '#/components/x-stackQL-resources/contexts/methods/get' - insert: - - $ref: '#/components/x-stackQL-resources/contexts/methods/create' + - $ref: >- + #/components/x-stackQL-resources/entity_types_iam_policies/methods/get_iam_policy + insert: [] update: [] - delete: - - $ref: '#/components/x-stackQL-resources/contexts/methods/delete' - contexts_context_children: - id: aiplatform.contexts_context_children - name: contexts_context_children - title: Contexts_context_children + delete: [] + entity_types_feature_values: + id: google.aiplatform.entity_types_feature_values + name: entity_types_feature_values + title: Entity_types_feature_values methods: - add_context_children: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:addContextChildren/post - response: - mediaType: application/json - openAPIDocKey: '200' - remove_context_children: + delete_feature_values: 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}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:deleteFeatureValues/post response: mediaType: application/json openAPIDocKey: '200' @@ -23953,1127 +23928,1111 @@ components: insert: [] update: [] delete: [] - contexts_context_artifacts_and_executions: - id: aiplatform.contexts_context_artifacts_and_executions - name: contexts_context_artifacts_and_executions - title: Contexts_context_artifacts_and_executions + featurestores_iam_policies: + id: google.aiplatform.featurestores_iam_policies + name: featurestores_iam_policies + title: Featurestores_iam_policies methods: - add_context_artifacts_and_executions: + test_iam_permissions: 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}~1featurestores~1{featurestoresId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + _get_iam_policy: + operation: &ref_41 + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:getIamPolicy/post + response: &ref_42 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + get_iam_policy: + operation: *ref_41 + response: *ref_42 + set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/featurestores_iam_policies/methods/get_iam_policy insert: [] update: [] delete: [] - executions: - id: aiplatform.executions - name: executions - title: Executions + featurestores: + id: google.aiplatform.featurestores + name: featurestores + title: Featurestores methods: - query_execution_inputs_and_outputs: + delete: 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}~1featurestores~1{featurestoresId}/delete response: mediaType: application/json openAPIDocKey: '200' - purge: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions:purge/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}/get response: mediaType: application/json openAPIDocKey: '200' - get: + patch: 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}~1featurestores~1{featurestoresId}/patch response: mediaType: application/json openAPIDocKey: '200' - delete: + search_features: 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}~1featurestores:searchFeatures/get response: mediaType: application/json openAPIDocKey: '200' - patch: + create: 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}~1featurestores/post response: mediaType: application/json openAPIDocKey: '200' _list: operation: &ref_43 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores/get response: &ref_44 mediaType: application/json openAPIDocKey: '200' - objectKey: $.executions + objectKey: $.featurestores list: operation: *ref_43 response: *ref_44 - create: + batch_read_feature_values: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions/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/executions/methods/get' - - $ref: '#/components/x-stackQL-resources/executions/methods/list' + - $ref: '#/components/x-stackQL-resources/featurestores/methods/get' + - $ref: '#/components/x-stackQL-resources/featurestores/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/executions/methods/create' - update: [] + - $ref: '#/components/x-stackQL-resources/featurestores/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/featurestores/methods/patch' delete: - - $ref: '#/components/x-stackQL-resources/executions/methods/delete' - executions_execution_events: - id: 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: [] - update: [] - delete: [] - artifacts: - id: aiplatform.artifacts - name: artifacts - title: Artifacts + - $ref: '#/components/x-stackQL-resources/featurestores/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}~1metadataStores~1{metadataStoresId}~1artifacts~1{artifactsId}/get - 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' - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts~1{artifactsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs~1{tuningJobsId}/get response: mediaType: application/json openAPIDocKey: '200' _list: operation: &ref_45 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs/get response: &ref_46 mediaType: application/json openAPIDocKey: '200' - objectKey: $.artifacts + objectKey: $.tuningJobs list: operation: *ref_45 response: *ref_46 - purge: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts:purge/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs/post response: mediaType: application/json openAPIDocKey: '200' - query_artifact_lineage_subgraph: + cancel: 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}~1tuningJobs~1{tuningJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/artifacts/methods/get' - - $ref: '#/components/x-stackQL-resources/artifacts/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/artifacts/methods/create' + - $ref: '#/components/x-stackQL-resources/tuning_jobs/methods/create' update: [] - delete: - - $ref: '#/components/x-stackQL-resources/artifacts/methods/delete' - featurestores: - id: aiplatform.featurestores - name: featurestores - title: Featurestores + delete: [] + batch_prediction_jobs: + id: google.aiplatform.batch_prediction_jobs + name: batch_prediction_jobs + title: Batch_prediction_jobs methods: create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs/post response: mediaType: application/json openAPIDocKey: '200' _list: operation: &ref_47 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs/get response: &ref_48 mediaType: application/json openAPIDocKey: '200' - objectKey: $.featurestores + objectKey: $.batchPredictionJobs list: operation: *ref_47 response: *ref_48 - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - patch: + cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs~1{batchPredictionJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - search_features: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores:searchFeatures/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs~1{batchPredictionJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' - batch_read_feature_values: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:batchReadFeatureValues/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs~1{batchPredictionJobsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/featurestores/methods/list' - - $ref: '#/components/x-stackQL-resources/featurestores/methods/get' + - $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/featurestores/methods/create' + - $ref: >- + #/components/x-stackQL-resources/batch_prediction_jobs/methods/create update: [] delete: - - $ref: '#/components/x-stackQL-resources/featurestores/methods/delete' - featurestores_iam_policies: - id: aiplatform.featurestores_iam_policies - name: featurestores_iam_policies - title: Featurestores_iam_policies + - $ref: >- + #/components/x-stackQL-resources/batch_prediction_jobs/methods/delete + specialist_pools: + id: google.aiplatform.specialist_pools + name: specialist_pools + title: Specialist_pools methods: - set_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - _get_iam_policy: + _list: operation: &ref_49 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:getIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools/get response: &ref_50 mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - get_iam_policy: + objectKey: $.specialistPools + list: operation: *ref_49 response: *ref_50 - test_iam_permissions: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/featurestores_iam_policies/methods/get_iam_policy - insert: [] - update: [] - delete: [] - features: - id: aiplatform.features - name: features - title: Features - methods: - batch_create: + patch: 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}~1specialistPools~1{specialistPoolsId}/patch response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_51 + delete: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features/get - response: &ref_52 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools~1{specialistPoolsId}/delete + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.features - list: - operation: *ref_51 - response: *ref_52 - create: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools~1{specialistPoolsId}/get 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' delete: + - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/delete' + endpoints: + id: google.aiplatform.endpoints + name: endpoints + title: Endpoints + methods: + count_tokens: 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}~1endpoints~1{endpointsId}:countTokens/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}/delete 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}~1endpoints~1{endpointsId}/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 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}/patch response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/features/methods/list' - - $ref: '#/components/x-stackQL-resources/features/methods/get' - - $ref: '#/components/x-stackQL-resources/features/methods/list' - - $ref: '#/components/x-stackQL-resources/features/methods/get' - insert: - - $ref: '#/components/x-stackQL-resources/features/methods/create' - - $ref: '#/components/x-stackQL-resources/features/methods/create' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/features/methods/delete' - - $ref: '#/components/x-stackQL-resources/features/methods/delete' - entity_types: - id: aiplatform.entity_types - name: entity_types - title: Entity_types - methods: - import_feature_values: + generate_content: 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}~1endpoints~1{endpointsId}:generateContent/post response: mediaType: application/json openAPIDocKey: '200' - export_feature_values: + mutate_deployed_model: 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}~1endpoints~1{endpointsId}:mutateDeployedModel/post response: mediaType: application/json openAPIDocKey: '200' - read_feature_values: + compute_tokens: 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}~1endpoints~1{endpointsId}:computeTokens/post response: mediaType: application/json openAPIDocKey: '200' - create: + undeploy_model: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:undeployModel/post + response: + mediaType: application/json + openAPIDocKey: '200' + explain: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:explain/post response: mediaType: application/json openAPIDocKey: '200' _list: - operation: &ref_53 + operation: &ref_51 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes/get - response: &ref_54 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints/get + response: &ref_52 mediaType: application/json openAPIDocKey: '200' - objectKey: $.entityTypes + objectKey: $.endpoints list: - operation: *ref_53 - response: *ref_54 - streaming_read_feature_values: + operation: *ref_51 + response: *ref_52 + 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}~1endpoints/post response: mediaType: application/json openAPIDocKey: '200' - delete: + direct_predict: 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}~1endpoints~1{endpointsId}:directPredict/post response: mediaType: application/json openAPIDocKey: '200' - patch: + server_streaming_predict: 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}~1endpoints~1{endpointsId}:serverStreamingPredict/post response: mediaType: application/json openAPIDocKey: '200' - get: + stream_raw_predict: 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}~1endpoints~1{endpointsId}:streamRawPredict/post response: mediaType: application/json openAPIDocKey: '200' - write_feature_values: + deploy_model: 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}~1endpoints~1{endpointsId}:deployModel/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/entity_types/methods/list' - - $ref: '#/components/x-stackQL-resources/entity_types/methods/get' - insert: - - $ref: '#/components/x-stackQL-resources/entity_types/methods/create' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/entity_types/methods/delete' - entity_types_feature_values: - id: aiplatform.entity_types_feature_values - name: entity_types_feature_values - title: Entity_types_feature_values - methods: - delete_feature_values: + raw_predict: 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}~1endpoints~1{endpointsId}:rawPredict/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - entity_types_iam_policies: - id: aiplatform.entity_types_iam_policies - name: entity_types_iam_policies - title: Entity_types_iam_policies - methods: - _get_iam_policy: - operation: &ref_55 + predict: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:getIamPolicy/post - response: &ref_56 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:predict/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - get_iam_policy: - operation: *ref_55 - response: *ref_56 - set_iam_policy: + direct_raw_predict: 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}~1endpoints~1{endpointsId}:directRawPredict/post response: mediaType: application/json openAPIDocKey: '200' - test_iam_permissions: + stream_generate_content: 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}~1endpoints~1{endpointsId}:streamGenerateContent/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/entity_types_iam_policies/methods/get_iam_policy - insert: [] - update: [] - delete: [] - custom_jobs: - id: aiplatform.custom_jobs - name: custom_jobs - title: Custom_jobs + - $ref: '#/components/x-stackQL-resources/endpoints/methods/get' + - $ref: '#/components/x-stackQL-resources/endpoints/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/patch' + delete: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/delete' + notebook_runtimes: + id: google.aiplatform.notebook_runtimes + name: notebook_runtimes + title: Notebook_runtimes methods: - create: + upgrade: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}:upgrade/post response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_57 + delete: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs/get - response: &ref_58 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}/delete + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.customJobs - list: - operation: *ref_57 - response: *ref_58 - delete: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs~1{customJobsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}/get response: mediaType: application/json openAPIDocKey: '200' - get: + assign: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs~1{customJobsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes:assign/post response: mediaType: application/json openAPIDocKey: '200' - cancel: + start: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs~1{customJobsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}:start/post response: mediaType: application/json openAPIDocKey: '200' + _list: + operation: &ref_53 + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes/get + response: &ref_54 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.notebookRuntimes + list: + operation: *ref_53 + response: *ref_54 sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/list' - - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/get' - insert: - - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/create' + - $ref: '#/components/x-stackQL-resources/notebook_runtimes/methods/get' + - $ref: '#/components/x-stackQL-resources/notebook_runtimes/methods/list' + insert: [] update: [] delete: - - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/delete' - notebook_runtimes: - id: aiplatform.notebook_runtimes - name: notebook_runtimes - title: Notebook_runtimes + - $ref: '#/components/x-stackQL-resources/notebook_runtimes/methods/delete' + custom_jobs: + id: google.aiplatform.custom_jobs + name: custom_jobs + title: Custom_jobs methods: _list: - operation: &ref_59 + operation: &ref_55 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes/get - response: &ref_60 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs/get + response: &ref_56 mediaType: application/json openAPIDocKey: '200' - objectKey: $.notebookRuntimes + objectKey: $.customJobs list: - operation: *ref_59 - response: *ref_60 - start: + operation: *ref_55 + response: *ref_56 + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}:start/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs/post response: mediaType: application/json openAPIDocKey: '200' - upgrade: + cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}:upgrade/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs~1{customJobsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs~1{customJobsId}/get response: mediaType: application/json openAPIDocKey: '200' - assign: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes:assign/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/custom_jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/create' + update: [] delete: + - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/delete' + migratable_resources: + id: google.aiplatform.migratable_resources + name: migratable_resources + title: Migratable_resources + methods: + search: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1migratableResources:search/post response: mediaType: application/json openAPIDocKey: '200' - get: + batch_migrate: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1migratableResources:batchMigrate/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/notebook_runtimes/methods/list' - - $ref: '#/components/x-stackQL-resources/notebook_runtimes/methods/get' + select: [] insert: [] update: [] - delete: - - $ref: '#/components/x-stackQL-resources/notebook_runtimes/methods/delete' - deployment_resource_pools: - id: aiplatform.deployment_resource_pools - name: deployment_resource_pools - title: Deployment_resource_pools + delete: [] + operations_wait: + id: google.aiplatform.operations_wait + name: operations_wait + title: Operations_wait methods: - query_deployed_models: - operation: + _list_wait: + operation: &ref_57 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools~1{deploymentResourcePoolsId}:queryDeployedModels/get - response: + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1operations~1{operationsId}:wait/get + response: &ref_58 mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_61 + objectKey: $.operations + list_wait: + operation: *ref_57 + response: *ref_58 + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/operations_wait/methods/list_wait' + - $ref: '#/components/x-stackQL-resources/operations_wait/methods/list_wait' + - $ref: '#/components/x-stackQL-resources/operations_wait/methods/list_wait' + - $ref: '#/components/x-stackQL-resources/operations_wait/methods/list_wait' + insert: [] + update: [] + delete: [] + feature_groups: + id: google.aiplatform.feature_groups + name: feature_groups + title: Feature_groups + methods: + get: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools/get - response: &ref_62 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deploymentResourcePools - list: - operation: *ref_61 - response: *ref_62 - create: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools/post + #/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}~1deploymentResourcePools~1{deploymentResourcePoolsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}/delete response: mediaType: application/json openAPIDocKey: '200' - get: + _list: + operation: &ref_59 + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups/get + response: &ref_60 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.featureGroups + list: + operation: *ref_59 + response: *ref_60 + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools~1{deploymentResourcePoolsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/deployment_resource_pools/methods/list - - $ref: >- - #/components/x-stackQL-resources/deployment_resource_pools/methods/get + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/get' + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/list' insert: - - $ref: >- - #/components/x-stackQL-resources/deployment_resource_pools/methods/create - update: [] + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/patch' delete: - - $ref: >- - #/components/x-stackQL-resources/deployment_resource_pools/methods/delete - trials: - id: aiplatform.trials - name: trials - title: Trials + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/delete' + nas_trial_details: + id: google.aiplatform.nas_trial_details + name: nas_trial_details + title: Nas_trial_details methods: - check_trial_early_stopping_state: - operation: + _list: + operation: &ref_61 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:checkTrialEarlyStoppingState/post - response: + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}~1nasTrialDetails/get + response: &ref_62 mediaType: application/json openAPIDocKey: '200' - stop: + objectKey: $.nasTrialDetails + list: + operation: *ref_61 + response: *ref_62 + get: 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~1{nasJobsId}~1nasTrialDetails~1{nasTrialDetailsId}/get response: mediaType: application/json openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/nas_trial_details/methods/get' + - $ref: '#/components/x-stackQL-resources/nas_trial_details/methods/list' + insert: [] + update: [] + delete: [] + nas_jobs: + id: google.aiplatform.nas_jobs + name: nas_jobs + title: Nas_jobs + methods: _list: operation: &ref_63 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs/get response: &ref_64 mediaType: application/json openAPIDocKey: '200' - objectKey: $.trials + objectKey: $.nasJobs list: operation: *ref_63 response: *ref_64 create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs/post response: mediaType: application/json openAPIDocKey: '200' - suggest: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials:suggest/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}/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}/delete response: mediaType: application/json openAPIDocKey: '200' - complete: + cancel: 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}~1nasJobs~1{nasJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/trials/methods/list' - - $ref: '#/components/x-stackQL-resources/trials/methods/get' + - $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: [] delete: - - $ref: '#/components/x-stackQL-resources/trials/methods/delete' - trials_optimal_trials: - id: 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: [] - insert: [] - update: [] - delete: [] - trials_trial_measurement: - id: 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}~1studies~1{studiesId}~1trials~1{trialsId}:addTrialMeasurement/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - studies: - id: aiplatform.studies - name: studies - title: Studies + - $ref: '#/components/x-stackQL-resources/nas_jobs/methods/delete' + datasets: + id: google.aiplatform.datasets + name: datasets + title: Datasets methods: - get: + export: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}:export/post response: mediaType: application/json openAPIDocKey: '200' - delete: + search_data_items: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}:searchDataItems/get response: mediaType: application/json openAPIDocKey: '200' create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets/post response: mediaType: application/json openAPIDocKey: '200' _list: operation: &ref_65 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets/get response: &ref_66 mediaType: application/json openAPIDocKey: '200' - objectKey: $.studies + objectKey: $.datasets list: operation: *ref_65 response: *ref_66 - lookup: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies:lookup/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}/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' - insert: - - $ref: '#/components/x-stackQL-resources/studies/methods/create' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/studies/methods/delete' - tuning_jobs: - id: aiplatform.tuning_jobs - name: tuning_jobs - title: Tuning_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}~1datasets~1{datasetsId}/get response: mediaType: application/json openAPIDocKey: '200' - create: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}/patch response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_67 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs/get - response: &ref_68 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.tuningJobs - list: - operation: *ref_67 - response: *ref_68 - cancel: + import: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs~1{tuningJobsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}:import/post 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' + - $ref: '#/components/x-stackQL-resources/datasets/methods/get' + - $ref: '#/components/x-stackQL-resources/datasets/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/tuning_jobs/methods/create' - update: [] - delete: [] - migratable_resources: - id: aiplatform.migratable_resources - name: migratable_resources - title: Migratable_resources + - $ref: '#/components/x-stackQL-resources/datasets/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/datasets/methods/patch' + delete: + - $ref: '#/components/x-stackQL-resources/datasets/methods/delete' + annotation_specs: + id: google.aiplatform.annotation_specs + name: annotation_specs + title: Annotation_specs methods: - batch_migrate: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1migratableResources:batchMigrate/post - response: - mediaType: application/json - openAPIDocKey: '200' - 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' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/annotation_specs/methods/get' insert: [] update: [] delete: [] - notebook_runtime_templates_iam_policies: - id: aiplatform.notebook_runtime_templates_iam_policies - name: notebook_runtime_templates_iam_policies - title: Notebook_runtime_templates_iam_policies + dataset_versions: + id: google.aiplatform.dataset_versions + name: dataset_versions + title: Dataset_versions methods: - test_iam_permissions: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_69 + get: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}:getIamPolicy/post - response: &ref_70 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - get_iam_policy: - operation: *ref_69 - response: *ref_70 - set_iam_policy: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}/patch response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/notebook_runtime_templates_iam_policies/methods/get_iam_policy - insert: [] - update: [] - delete: [] - notebook_runtime_templates: - id: aiplatform.notebook_runtime_templates - name: notebook_runtime_templates - title: Notebook_runtime_templates - methods: - patch: + _list: + operation: &ref_67 + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1datasetVersions/get + response: &ref_68 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.datasetVersions + list: + operation: *ref_67 + response: *ref_68 + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1datasetVersions/post response: mediaType: application/json openAPIDocKey: '200' - get: + restore: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}:restore/get 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' delete: - operation: + - $ref: '#/components/x-stackQL-resources/dataset_versions/methods/delete' + annotations: + id: google.aiplatform.annotations + name: annotations + title: Annotations + methods: + _list: + operation: &ref_69 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}/delete - response: + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dataItems~1{dataItemsId}~1annotations/get + response: &ref_70 mediaType: application/json openAPIDocKey: '200' + objectKey: $.annotations + list: + operation: *ref_69 + response: *ref_70 + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/annotations/methods/list' + insert: [] + update: [] + delete: [] + data_items: + id: google.aiplatform.data_items + name: data_items + title: Data_items + methods: _list: operation: &ref_71 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dataItems/get response: &ref_72 mediaType: application/json openAPIDocKey: '200' - objectKey: $.notebookRuntimeTemplates + objectKey: $.dataItems list: operation: *ref_71 response: *ref_72 - create: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/data_items/methods/list' + insert: [] + update: [] + delete: [] + saved_queries: + id: google.aiplatform.saved_queries + name: saved_queries + title: Saved_queries + methods: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates/post + #/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/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: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/notebook_runtime_templates/methods/delete - schedules: - id: aiplatform.schedules - name: schedules - title: Schedules - methods: _list: operation: &ref_73 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1savedQueries/get response: &ref_74 mediaType: application/json openAPIDocKey: '200' - objectKey: $.schedules + objectKey: $.savedQueries list: operation: *ref_73 response: *ref_74 - create: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/saved_queries/methods/list' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/saved_queries/methods/delete' + model_deployment_monitoring_jobs: + id: google.aiplatform.model_deployment_monitoring_jobs + name: model_deployment_monitoring_jobs + title: Model_deployment_monitoring_jobs + methods: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}/delete + 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}~1schedules~1{schedulesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}/patch response: mediaType: application/json openAPIDocKey: '200' - delete: + pause: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}:pause/post response: mediaType: application/json openAPIDocKey: '200' - get: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs/post response: mediaType: application/json openAPIDocKey: '200' - pause: + _list: + operation: &ref_75 + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs/get + response: &ref_76 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.modelDeploymentMonitoringJobs + list: + operation: *ref_75 + response: *ref_76 + search_model_deployment_monitoring_stats_anomalies: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}:pause/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}:searchModelDeploymentMonitoringStatsAnomalies/post response: mediaType: application/json openAPIDocKey: '200' resume: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}:resume/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}:resume/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/schedules/methods/list' - - $ref: '#/components/x-stackQL-resources/schedules/methods/get' + - $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/schedules/methods/create' - update: [] + - $ref: >- + #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/create + update: + - $ref: >- + #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/patch delete: - - $ref: '#/components/x-stackQL-resources/schedules/methods/delete' - feature_online_stores: - id: aiplatform.feature_online_stores - name: feature_online_stores - title: Feature_online_stores + - $ref: >- + #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/delete + feature_views: + id: google.aiplatform.feature_views + name: feature_views + title: Feature_views methods: - delete: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews/post response: mediaType: application/json openAPIDocKey: '200' - get: + _list: + operation: &ref_77 + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews/get + response: &ref_78 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.featureViews + list: + operation: *ref_77 + response: *ref_78 + search_nearest_entities: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:searchNearestEntities/post + response: + mediaType: application/json + openAPIDocKey: '200' + sync: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:sync/post response: mediaType: application/json openAPIDocKey: '200' patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}/patch response: mediaType: application/json openAPIDocKey: '200' - create: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}/delete response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_75 + get: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores/get - response: &ref_76 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.featureOnlineStores - list: - operation: *ref_75 - response: *ref_76 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/feature_views/methods/get' + - $ref: '#/components/x-stackQL-resources/feature_views/methods/list' insert: - - $ref: >- - #/components/x-stackQL-resources/feature_online_stores/methods/create - update: [] + - $ref: '#/components/x-stackQL-resources/feature_views/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/feature_views/methods/patch' delete: - - $ref: >- - #/components/x-stackQL-resources/feature_online_stores/methods/delete - operations_wait: - id: aiplatform.operations_wait - name: operations_wait - title: Operations_wait + - $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: - _list_wait: - operation: &ref_77 + fetch_feature_values: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1operations~1{operationsId}:wait/get - response: &ref_78 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:fetchFeatureValues/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations - list_wait: - operation: *ref_77 - response: *ref_78 sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/operations_wait/methods/list_wait' - - $ref: '#/components/x-stackQL-resources/operations_wait/methods/list_wait' - - $ref: '#/components/x-stackQL-resources/operations_wait/methods/list_wait' - - $ref: '#/components/x-stackQL-resources/operations_wait/methods/list_wait' + select: [] insert: [] update: [] delete: [] feature_view_syncs: - id: aiplatform.feature_view_syncs + id: google.aiplatform.feature_view_syncs name: feature_view_syncs title: Feature_view_syncs methods: @@ -25102,164 +25061,147 @@ components: insert: [] update: [] delete: [] - feature_views_feature_values: - id: 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}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:fetchFeatureValues/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - feature_views: - id: aiplatform.feature_views - name: feature_views - title: Feature_views + feature_online_stores: + id: google.aiplatform.feature_online_stores + name: feature_online_stores + title: Feature_online_stores methods: 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}~1featureOnlineStores~1{featureOnlineStoresId}/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}~1featureOnlineStores~1{featureOnlineStoresId}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - search_nearest_entities: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:searchNearestEntities/post - response: - mediaType: application/json - openAPIDocKey: '200' - sync: - 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}~1featureOnlineStores~1{featureOnlineStoresId}/delete response: mediaType: application/json openAPIDocKey: '200' create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores/post response: mediaType: application/json openAPIDocKey: '200' _list: operation: &ref_81 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores/get response: &ref_82 mediaType: application/json openAPIDocKey: '200' - objectKey: $.featureViews + objectKey: $.featureOnlineStores list: operation: *ref_81 response: *ref_82 sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/feature_views/methods/get' - - $ref: '#/components/x-stackQL-resources/feature_views/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/feature_views/methods/create' - update: [] + - $ref: >- + #/components/x-stackQL-resources/feature_online_stores/methods/create + update: + - $ref: >- + #/components/x-stackQL-resources/feature_online_stores/methods/patch delete: - - $ref: '#/components/x-stackQL-resources/feature_views/methods/delete' - persistent_resources: - id: aiplatform.persistent_resources - name: persistent_resources - title: Persistent_resources + - $ref: >- + #/components/x-stackQL-resources/feature_online_stores/methods/delete + indexes: + id: google.aiplatform.indexes + name: indexes + title: Indexes methods: - patch: - operation: + _list: + operation: &ref_83 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}/patch - response: + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes/get + response: &ref_84 mediaType: application/json openAPIDocKey: '200' - get: + objectKey: $.indexes + list: + operation: *ref_83 + response: *ref_84 + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes/post response: mediaType: application/json openAPIDocKey: '200' - delete: + upsert_datapoints: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}:upsertDatapoints/post response: mediaType: application/json openAPIDocKey: '200' - create: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}/get response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_83 + patch: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources/get - response: &ref_84 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}/patch + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.persistentResources - list: - operation: *ref_83 - response: *ref_84 - 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}~1indexes~1{indexesId}/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' + - $ref: '#/components/x-stackQL-resources/indexes/methods/get' + - $ref: '#/components/x-stackQL-resources/indexes/methods/list' insert: - - $ref: >- - #/components/x-stackQL-resources/persistent_resources/methods/create - update: [] + - $ref: '#/components/x-stackQL-resources/indexes/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/indexes/methods/patch' delete: - - $ref: >- - #/components/x-stackQL-resources/persistent_resources/methods/delete - data_labeling_jobs: - id: 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: [] + delete: [] + data_labeling_jobs: + id: google.aiplatform.data_labeling_jobs + name: data_labeling_jobs + title: Data_labeling_jobs + methods: get: operation: $ref: >- @@ -25274,6 +25216,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs~1{dataLabelingJobsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' _list: operation: &ref_85 $ref: >- @@ -25301,573 +25250,653 @@ components: update: [] delete: - $ref: '#/components/x-stackQL-resources/data_labeling_jobs/methods/delete' - batch_prediction_jobs: - id: aiplatform.batch_prediction_jobs - name: batch_prediction_jobs - title: Batch_prediction_jobs + artifacts: + id: google.aiplatform.artifacts + name: artifacts + title: Artifacts methods: + purge: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts:purge/post + 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' + 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' + 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_87 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts/get response: &ref_88 mediaType: application/json openAPIDocKey: '200' - objectKey: $.batchPredictionJobs + objectKey: $.artifacts list: operation: *ref_87 response: *ref_88 - create: + query_artifact_lineage_subgraph: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts~1{artifactsId}:queryArtifactLineageSubgraph/get response: mediaType: application/json openAPIDocKey: '200' - cancel: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/artifacts/methods/get' + - $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' + delete: + - $ref: '#/components/x-stackQL-resources/artifacts/methods/delete' + 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}~1batchPredictionJobs~1{batchPredictionJobsId}:cancel/post + #/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: [] + update: [] + delete: [] + executions: + id: google.aiplatform.executions + name: executions + title: Executions + methods: + _list: + operation: &ref_89 + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions/get + response: &ref_90 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.executions + list: + operation: *ref_89 + response: *ref_90 + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions/post response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs~1{batchPredictionJobsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}/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}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + query_execution_inputs_and_outputs: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}:queryExecutionInputsAndOutputs/get + response: + mediaType: application/json + openAPIDocKey: '200' + purge: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions:purge/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/batch_prediction_jobs/methods/list - - $ref: '#/components/x-stackQL-resources/batch_prediction_jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/executions/methods/get' + - $ref: '#/components/x-stackQL-resources/executions/methods/list' insert: - - $ref: >- - #/components/x-stackQL-resources/batch_prediction_jobs/methods/create - update: [] + - $ref: '#/components/x-stackQL-resources/executions/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/executions/methods/patch' delete: - - $ref: >- - #/components/x-stackQL-resources/batch_prediction_jobs/methods/delete - pipeline_jobs: - id: aiplatform.pipeline_jobs - name: pipeline_jobs - title: Pipeline_jobs + - $ref: '#/components/x-stackQL-resources/executions/methods/delete' + contexts: + id: google.aiplatform.contexts + name: contexts + title: Contexts methods: - delete: + get: 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}/get response: mediaType: application/json openAPIDocKey: '200' - get: + delete: 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}/delete response: mediaType: application/json openAPIDocKey: '200' - batch_cancel: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs:batchCancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}/patch response: mediaType: application/json openAPIDocKey: '200' _list: - operation: &ref_89 + operation: &ref_91 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs/get - response: &ref_90 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts/get + response: &ref_92 mediaType: application/json openAPIDocKey: '200' - objectKey: $.pipelineJobs + objectKey: $.contexts list: - operation: *ref_89 - response: *ref_90 + operation: *ref_91 + response: *ref_92 create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts/post response: mediaType: application/json openAPIDocKey: '200' - batch_delete: + purge: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs:batchDelete/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts:purge/post response: mediaType: application/json openAPIDocKey: '200' - cancel: + query_context_lineage_subgraph: 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}:queryContextLineageSubgraph/get 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/contexts/methods/get' + - $ref: '#/components/x-stackQL-resources/contexts/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/create' - update: [] + - $ref: '#/components/x-stackQL-resources/contexts/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/contexts/methods/patch' delete: - - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/delete' - specialist_pools: - id: aiplatform.specialist_pools - name: specialist_pools - title: Specialist_pools + - $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 methods: - get: + remove_context_children: 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}:removeContextChildren/post response: mediaType: application/json openAPIDocKey: '200' - patch: + add_context_children: 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}:addContextChildren/post response: mediaType: application/json openAPIDocKey: '200' - delete: + sqlVerbs: + select: [] + insert: [] + update: [] + 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: + add_context_artifacts_and_executions: 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~1{contextsId}:addContextArtifactsAndExecutions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + metadata_schemas: + id: google.aiplatform.metadata_schemas + name: metadata_schemas + title: Metadata_schemas + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1metadataSchemas/post response: mediaType: application/json openAPIDocKey: '200' _list: - operation: &ref_91 + operation: &ref_93 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools/get - response: &ref_92 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1metadataSchemas/get + response: &ref_94 mediaType: application/json openAPIDocKey: '200' - objectKey: $.specialistPools + objectKey: $.metadataSchemas list: - operation: *ref_91 - response: *ref_92 - create: + operation: *ref_93 + response: *ref_94 + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1metadataSchemas~1{metadataSchemasId}/get 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/metadata_schemas/methods/get' + - $ref: '#/components/x-stackQL-resources/metadata_schemas/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/create' + - $ref: '#/components/x-stackQL-resources/metadata_schemas/methods/create' update: [] - delete: - - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/delete' - model_deployment_monitoring_jobs: - id: aiplatform.model_deployment_monitoring_jobs - name: model_deployment_monitoring_jobs - title: Model_deployment_monitoring_jobs + delete: [] + metadata_stores: + id: google.aiplatform.metadata_stores + name: metadata_stores + title: Metadata_stores methods: - pause: - operation: + _list: + operation: &ref_95 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}:pause/post - response: + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores/get + response: &ref_96 mediaType: application/json openAPIDocKey: '200' - search_model_deployment_monitoring_stats_anomalies: + objectKey: $.metadataStores + list: + operation: *ref_95 + response: *ref_96 + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}:searchModelDeploymentMonitoringStatsAnomalies/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores/post response: mediaType: application/json openAPIDocKey: '200' - patch: + get: 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}/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}~1metadataStores~1{metadataStoresId}/delete response: mediaType: application/json openAPIDocKey: '200' - get: + 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: [] + delete: + - $ref: '#/components/x-stackQL-resources/metadata_stores/methods/delete' + notebook_runtime_templates: + id: google.aiplatform.notebook_runtime_templates + name: notebook_runtime_templates + title: Notebook_runtime_templates + methods: + _list: + operation: &ref_97 + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates/get + response: &ref_98 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.notebookRuntimeTemplates + list: + operation: *ref_97 + response: *ref_98 + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates/post response: mediaType: application/json openAPIDocKey: '200' - resume: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}:resume/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_93 + patch: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs/get - response: &ref_94 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}/patch + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.modelDeploymentMonitoringJobs - list: - operation: *ref_93 - response: *ref_94 - create: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/get + #/components/x-stackQL-resources/notebook_runtime_templates/methods/get - $ref: >- - #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/list + #/components/x-stackQL-resources/notebook_runtime_templates/methods/list insert: - $ref: >- - #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/create - update: [] + #/components/x-stackQL-resources/notebook_runtime_templates/methods/create + update: + - $ref: >- + #/components/x-stackQL-resources/notebook_runtime_templates/methods/patch delete: - $ref: >- - #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/delete - feature_groups: - id: aiplatform.feature_groups - name: feature_groups - title: Feature_groups + #/components/x-stackQL-resources/notebook_runtime_templates/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 methods: - _list: - operation: &ref_95 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups/get - response: &ref_96 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.featureGroups - list: - operation: *ref_95 - response: *ref_96 - create: - operation: + _get_iam_policy: + operation: &ref_99 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups/post - response: + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}:getIamPolicy/post + response: &ref_100 mediaType: application/json openAPIDocKey: '200' - delete: + objectKey: $.bindings + get_iam_policy: + operation: *ref_99 + response: *ref_100 + set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - patch: + test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/notebook_runtime_templates_iam_policies/methods/get_iam_policy + insert: [] + update: [] + 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}~1featureGroups~1{featureGroupsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs~1{pipelineJobsId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/feature_groups/methods/list' - - $ref: '#/components/x-stackQL-resources/feature_groups/methods/get' - insert: - - $ref: '#/components/x-stackQL-resources/feature_groups/methods/create' - update: [] delete: - - $ref: '#/components/x-stackQL-resources/feature_groups/methods/delete' - indexes: - id: aiplatform.indexes - name: indexes - title: Indexes - methods: - create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs~1{pipelineJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' _list: - operation: &ref_97 + operation: &ref_101 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes/get - response: &ref_98 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs/get + response: &ref_102 mediaType: application/json openAPIDocKey: '200' - objectKey: $.indexes + objectKey: $.pipelineJobs list: - operation: *ref_97 - response: *ref_98 - get: + operation: *ref_101 + response: *ref_102 + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs/post response: mediaType: application/json openAPIDocKey: '200' - patch: + cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs~1{pipelineJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' - delete: + batch_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs:batchDelete/post response: mediaType: application/json openAPIDocKey: '200' - upsert_datapoints: + batch_cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}:upsertDatapoints/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs:batchCancel/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/indexes/methods/list' - - $ref: '#/components/x-stackQL-resources/indexes/methods/get' + - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/indexes/methods/create' + - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/create' update: [] delete: - - $ref: '#/components/x-stackQL-resources/indexes/methods/delete' - indexes_datapoints: - id: aiplatform.indexes_datapoints - name: indexes_datapoints - title: Indexes_datapoints + - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/delete' + schedules: + id: google.aiplatform.schedules + name: schedules + title: Schedules methods: - remove_datapoints: + pause: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}:removeDatapoints/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}:pause/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - slices: - id: aiplatform.slices - name: slices - title: Slices - methods: - get: + delete: 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}~1schedules~1{schedulesId}/delete response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_99 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}~1slices/get - response: &ref_100 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.modelEvaluationSlices - list: - operation: *ref_99 - response: *ref_100 - batch_import: + get: 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}~1schedules~1{schedulesId}/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: [] - delete: [] - evaluations: - id: 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}~1schedules~1{schedulesId}/patch response: mediaType: application/json openAPIDocKey: '200' - import: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations:import/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules/post response: mediaType: application/json openAPIDocKey: '200' _list: - operation: &ref_101 + operation: &ref_103 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations/get - response: &ref_102 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules/get + response: &ref_104 mediaType: application/json openAPIDocKey: '200' - objectKey: $.modelEvaluations + objectKey: $.schedules list: - operation: *ref_101 - response: *ref_102 - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/evaluations/methods/get' - - $ref: '#/components/x-stackQL-resources/evaluations/methods/list' - insert: [] - update: [] - delete: [] - models_explanation_dataset: - id: aiplatform.models_explanation_dataset - name: models_explanation_dataset - title: Models_explanation_dataset - methods: - update_explanation_dataset: + operation: *ref_103 + response: *ref_104 + resume: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:updateExplanationDataset/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}:resume/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - models_versions: - id: aiplatform.models_versions - name: models_versions - title: Models_versions - methods: - _list_versions: - operation: &ref_103 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:listVersions/get - response: &ref_104 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.models - list_versions: - operation: *ref_103 - response: *ref_104 sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/models_versions/methods/list_versions - insert: [] - update: [] - delete: [] - models_iam_policies: - id: aiplatform.models_iam_policies - name: models_iam_policies - title: Models_iam_policies + - $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' + delete: + - $ref: '#/components/x-stackQL-resources/schedules/methods/delete' + hyperparameter_tuning_jobs: + id: google.aiplatform.hyperparameter_tuning_jobs + name: hyperparameter_tuning_jobs + title: Hyperparameter_tuning_jobs methods: - set_iam_policy: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs/post response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: + _list: operation: &ref_105 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:getIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs/get response: &ref_106 mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - get_iam_policy: + objectKey: $.hyperparameterTuningJobs + list: operation: *ref_105 response: *ref_106 - test_iam_permissions: + cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:testIamPermissions/post + #/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/models_iam_policies/methods/get_iam_policy - insert: [] - update: [] - delete: [] - models_version: - id: 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}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] + 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: [] delete: - $ref: >- - #/components/x-stackQL-resources/models_version/methods/delete_version + #/components/x-stackQL-resources/hyperparameter_tuning_jobs/methods/delete paths: /v1/publishers/{publishersId}/models/{modelsId}: parameters: &ref_107 - - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/access_token' get: description: Gets a Model Garden publisher model. @@ -25883,31 +25912,285 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PublisherModel' + $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: view + schema: + type: string + - in: query + name: languageCode + schema: + type: string + /v1/projects/{projectsId}/locations: + parameters: *ref_107 + 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: 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}: + parameters: *ref_107 + 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/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations: + parameters: *ref_107 + 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 + security: + - Oauth2: + - https://www.googleapis.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: trainingPipelinesId + 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}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel: + parameters: *ref_107 + 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 + security: + - Oauth2: + - https://www.googleapis.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 + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait: + parameters: *ref_107 + 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 + 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: trainingPipelinesId + 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}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}: + parameters: *ref_107 + 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 + 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: publishersId + name: projectsId required: true schema: type: string - in: path - name: modelsId + name: locationsId required: true schema: type: string - - in: query - name: view + - in: path + name: trainingPipelinesId + required: true schema: type: string - - in: query - name: languageCode + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_107 get: - description: Gets information about a location. - operationId: aiplatform.projects.locations.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 @@ -25919,7 +26202,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudLocationLocation' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -25931,11 +26214,54 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations: + - in: path + name: trainingPipelinesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines: parameters: *ref_107 + 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' + security: + - Oauth2: + - https://www.googleapis.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 + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string get: - description: Lists information about the supported locations for this service. - operationId: aiplatform.projects.locations.list + description: Lists TrainingPipelines in a Location. + operationId: aiplatform.projects.locations.trainingPipelines.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -25947,19 +26273,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudLocationListLocationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListTrainingPipelinesResponse 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: pageToken + name: filter schema: type: string - in: query @@ -25967,16 +26295,20 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:import: + - 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_107 - post: - description: Imports data into a Dataset. - operationId: aiplatform.projects.locations.datasets.import - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ImportDataRequest' + delete: + description: Deletes a TrainingPipeline. + operationId: aiplatform.projects.locations.trainingPipelines.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -26001,15 +26333,61 @@ paths: schema: type: string - in: path - name: datasetsId + name: trainingPipelinesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}: + 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 + 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}/trainingPipelines/{trainingPipelinesId}:cancel: parameters: *ref_107 - delete: - description: Deletes a Dataset. - operationId: aiplatform.projects.locations.datasets.delete + 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 + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CancelTrainingPipelineRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -26021,7 +26399,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -26034,13 +26412,15 @@ paths: schema: type: string - in: path - name: datasetsId + name: trainingPipelinesId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}: + parameters: *ref_107 get: - description: Gets a Dataset. - operationId: aiplatform.projects.locations.datasets.get + description: Gets a ModelEvaluationSlice. + operationId: aiplatform.projects.locations.models.evaluations.slices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -26052,7 +26432,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSlice parameters: - in: path name: projectsId @@ -26065,23 +26446,31 @@ paths: schema: type: string - in: path - name: datasetsId + name: modelsId required: true schema: type: string - - in: query - name: readMask + - in: path + name: evaluationsId + required: true schema: type: string - format: google-fieldmask - patch: - description: Updates a Dataset. - operationId: aiplatform.projects.locations.datasets.patch + - in: path + name: slicesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}:batchImport: + parameters: *ref_107 + post: + description: Imports a list of externally generated EvaluatedAnnotations. + operationId: aiplatform.projects.locations.models.evaluations.slices.batchImport requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -26093,7 +26482,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse parameters: - in: path name: projectsId @@ -26106,20 +26496,25 @@ paths: schema: type: string - in: path - name: datasetsId + name: modelsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: evaluationsId + required: true schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/datasets: + - in: path + name: slicesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices: parameters: *ref_107 get: - description: Lists Datasets in a Location. - operationId: aiplatform.projects.locations.datasets.list + description: Lists ModelEvaluationSlices in a ModelEvaluation. + operationId: aiplatform.projects.locations.models.evaluations.slices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -26132,7 +26527,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListDatasetsResponse + #/components/schemas/GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse parameters: - in: path name: projectsId @@ -26144,36 +26539,42 @@ paths: required: true schema: type: string - - in: query - name: orderBy + - in: path + name: modelsId + required: true schema: type: string - - in: query - name: readMask + - in: path + name: evaluationsId + required: true schema: type: string - 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 - in: query - name: pageSize + name: readMask schema: - type: integer - format: int32 - post: - description: Creates a Dataset. - operationId: aiplatform.projects.locations.datasets.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}: + parameters: *ref_107 + 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 @@ -26197,11 +26598,80 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:searchDataItems: + - 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 + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait: parameters: *ref_107 - get: - description: Searches DataItems in a Dataset. - operationId: aiplatform.projects.locations.datasets.searchDataItems + 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 @@ -26213,8 +26683,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchDataItemsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -26227,42 +26696,71 @@ paths: schema: type: string - in: path - name: datasetsId + name: modelsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: evaluationsId + required: true schema: type: string - - in: query - name: fieldMask + - in: path + name: operationsId + required: true schema: type: string - format: google-fieldmask - in: query - name: annotationFilters + name: timeout schema: type: string - - in: query - name: orderByAnnotation.savedQuery + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations: + parameters: *ref_107 + 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 + 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: query - name: dataItemFilter + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: annotationsLimit + - in: path + name: modelsId + required: true schema: - type: integer - format: int32 + type: string + - in: path + name: evaluationsId + required: true + schema: + type: string - in: query - name: savedQuery + name: filter schema: type: string - in: query - name: annotationsFilter + name: pageToken schema: type: string - in: query @@ -26270,32 +26768,69 @@ paths: schema: type: integer format: int32 - - in: query - name: orderByDataItem + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel: + parameters: *ref_107 + 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 + security: + - Oauth2: + - https://www.googleapis.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: orderByAnnotation.orderBy + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: orderBy + - in: path + name: modelsId + required: true schema: type: string - - in: query - name: dataLabelingJob + - in: path + name: evaluationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:export: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations:import: parameters: *ref_107 post: - description: Exports data from a Dataset. - operationId: aiplatform.projects.locations.datasets.export + description: Imports an externally generated ModelEvaluation. + operationId: aiplatform.projects.locations.models.evaluations.import requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportDataRequest' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ImportModelEvaluationRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -26307,7 +26842,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' parameters: - in: path name: projectsId @@ -26320,15 +26855,15 @@ paths: schema: type: string - in: path - name: datasetsId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations: parameters: *ref_107 get: - description: Gets an AnnotationSpec. - operationId: aiplatform.projects.locations.datasets.annotationSpecs.get + description: Lists ModelEvaluations in a Model. + operationId: aiplatform.projects.locations.models.evaluations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -26340,7 +26875,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1AnnotationSpec' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListModelEvaluationsResponse parameters: - in: path name: projectsId @@ -26353,13 +26889,21 @@ paths: schema: type: string - in: path - name: datasetsId + name: modelsId required: true schema: type: string - - in: path - name: annotationSpecsId - 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 @@ -26367,20 +26911,11 @@ paths: schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}: parameters: *ref_107 - 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 + get: + description: Gets a ModelEvaluation. + operationId: aiplatform.projects.locations.models.evaluations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -26392,7 +26927,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' parameters: - in: path name: projectsId @@ -26405,39 +26940,23 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: annotationSpecsId + name: modelsId required: true schema: type: string - in: path - name: operationsId + name: evaluationsId 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}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}: parameters: *ref_107 - 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.datasets.annotationSpecs.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.models.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -26449,7 +26968,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -26462,12 +26981,7 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: annotationSpecsId + name: modelsId required: true schema: type: string @@ -26476,15 +26990,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}: - parameters: *ref_107 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 + operationId: aiplatform.projects.locations.models.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -26509,12 +27021,7 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: annotationSpecsId + name: modelsId required: true schema: type: string @@ -26523,12 +27030,20 @@ paths: required: true schema: type: string - get: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:cancel: + parameters: *ref_107 + 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.annotationSpecs.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.models.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -26540,7 +27055,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -26553,12 +27068,7 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: annotationSpecsId + name: modelsId required: true schema: type: string @@ -26567,13 +27077,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations: parameters: *ref_107 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 + operationId: aiplatform.projects.locations.models.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -26598,12 +27108,7 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: annotationSpecsId + name: modelsId required: true schema: type: string @@ -26620,20 +27125,20 @@ paths: name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:wait: parameters: *ref_107 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 + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It 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 @@ -26645,7 +27150,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -26658,27 +27163,25 @@ paths: schema: type: string - in: path - name: datasetsId + name: modelsId required: true schema: type: string - in: path - name: dataItemsId + 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}/dataItems/{dataItemsId}/operations: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}: parameters: *ref_107 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 + description: Gets a Model. + operationId: aiplatform.projects.locations.models.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -26690,7 +27193,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' parameters: - in: path name: projectsId @@ -26703,36 +27206,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: 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}/dataItems/{dataItemsId}/operations/{operationsId}: - parameters: *ref_107 - 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.datasets.dataItems.operations.get + 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 @@ -26757,27 +27239,18 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: dataItemsId - 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.dataItems.operations.delete + patch: + description: Updates a Model. + operationId: aiplatform.projects.locations.models.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -26789,7 +27262,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' parameters: - in: path name: projectsId @@ -26802,34 +27275,30 @@ 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: operationsId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait: + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/models:copy: parameters: *ref_107 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 + 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 @@ -26853,35 +27322,13 @@ paths: 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: operationsId - 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/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:getIamPolicy: parameters: *ref_107 - 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.dataItems.annotations.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.models.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -26893,7 +27340,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -26906,33 +27353,28 @@ paths: 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 + name: modelsId 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}/models/{modelsId}:setIamPolicy: + parameters: *ref_107 + 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.datasets.dataItems.annotations.operations.delete + 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 @@ -26944,7 +27386,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -26957,40 +27399,15 @@ paths: 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: modelsId 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}:listVersions: parameters: *ref_107 - 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: Lists versions of the specified model. + operationId: aiplatform.projects.locations.models.listVersions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27002,7 +27419,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListModelVersionsResponse parameters: - in: path name: projectsId @@ -27015,45 +27433,42 @@ paths: schema: type: string - in: path - name: datasetsId + name: modelsId required: true schema: type: string - - in: path - name: dataItemsId - required: true + - in: query + name: orderBy schema: type: string - - in: path - name: annotationsId - required: true + - in: query + name: readMask schema: type: string - - in: path - name: operationsId - required: true + format: google-fieldmask + - 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}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/models:upload: parameters: *ref_107 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: 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 @@ -27065,7 +27480,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -27077,34 +27492,58 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:export: + parameters: *ref_107 + 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: datasetsId - required: true - schema: - type: string - - in: path - name: dataItemsId + name: projectsId required: true schema: type: string - in: path - name: annotationsId + name: locationsId required: true schema: type: string - in: path - name: operationsId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:updateExplanationDataset: parameters: *ref_107 - 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 + 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 @@ -27116,7 +27555,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -27129,38 +27568,21 @@ paths: 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 + 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}/dataItems/{dataItemsId}/annotations: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:mergeVersionAliases: parameters: *ref_107 - get: - description: Lists Annotations belongs to a dataitem - operationId: aiplatform.projects.locations.datasets.dataItems.annotations.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 @@ -27172,8 +27594,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListAnnotationsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' parameters: - in: path name: projectsId @@ -27186,42 +27607,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: query - name: filter - schema: - type: string - - 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: readMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems: + /v1/projects/{projectsId}/locations/{locationsId}/models: parameters: *ref_107 get: - description: Lists DataItems in a Dataset. - operationId: aiplatform.projects.locations.datasets.dataItems.list + description: Lists Models in a Location. + operationId: aiplatform.projects.locations.models.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27233,8 +27627,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListDataItemsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1ListModelsResponse' parameters: - in: path name: projectsId @@ -27246,13 +27639,12 @@ paths: required: true schema: type: string - - in: path - name: datasetsId - required: true + - in: query + name: pageToken schema: type: string - in: query - name: pageToken + name: filter schema: type: string - in: query @@ -27261,27 +27653,22 @@ paths: type: integer format: int32 - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: filter + name: orderBy schema: type: string - in: query - name: orderBy + name: readMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}: + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:deleteVersion: parameters: *ref_107 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 + 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 @@ -27293,7 +27680,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -27306,26 +27693,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 - get: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:testIamPermissions: + parameters: *ref_107 + 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 + 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 @@ -27337,7 +27718,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -27350,34 +27731,26 @@ 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: path - name: operationsId - required: true + - in: query + name: permissions schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/studies:lookup: parameters: *ref_107 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 + 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 @@ -27389,7 +27762,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' parameters: - in: path name: projectsId @@ -27401,28 +27774,11 @@ 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 - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/studies: parameters: *ref_107 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 + 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 @@ -27434,7 +27790,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListStudiesResponse parameters: - in: path name: projectsId @@ -27446,43 +27803,25 @@ 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: 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 - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait: - parameters: *ref_107 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 + 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' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27494,7 +27833,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' parameters: - in: path name: projectsId @@ -27506,31 +27845,42 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}: + parameters: *ref_107 + get: + description: Gets a Study by name. + operationId: aiplatform.projects.locations.studies.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/GoogleCloudAiplatformV1Study' + parameters: - in: path - name: datasetsId + name: projectsId required: true schema: type: string - in: path - name: savedQueriesId + name: locationsId required: true schema: type: string - in: path - name: operationsId + name: studiesId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries: - parameters: *ref_107 - get: - description: Lists SavedQueries in a Dataset. - operationId: aiplatform.projects.locations.datasets.savedQueries.list + delete: + description: Deletes a Study. + operationId: aiplatform.projects.locations.studies.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27542,8 +27892,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListSavedQueriesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -27556,37 +27905,58 @@ paths: schema: type: string - in: path - name: datasetsId + name: studiesId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: readMask + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}: + parameters: *ref_107 + 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 + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true schema: type: string - format: google-fieldmask - - in: query - name: pageToken + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: filter + - in: path + name: studiesId + required: true schema: type: string - - in: query - name: orderBy + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}: - parameters: *ref_107 - delete: - description: Deletes a SavedQuery. - operationId: aiplatform.projects.locations.datasets.savedQueries.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.studies.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27611,22 +27981,22 @@ paths: schema: type: string - in: path - name: datasetsId + name: studiesId required: true schema: type: string - in: path - name: savedQueriesId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations: parameters: *ref_107 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.studies.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27651,12 +28021,12 @@ paths: schema: type: string - in: path - name: datasetsId + name: studiesId required: true schema: type: string - in: query - name: pageToken + name: filter schema: type: string - in: query @@ -27665,10 +28035,10 @@ paths: type: integer format: int32 - in: query - name: filter + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:cancel: parameters: *ref_107 post: description: >- @@ -27681,7 +28051,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.studies.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27706,7 +28076,7 @@ paths: schema: type: string - in: path - name: datasetsId + name: studiesId required: true schema: type: string @@ -27715,7 +28085,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:wait: parameters: *ref_107 post: description: >- @@ -27728,7 +28098,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.datasets.operations.wait + operationId: aiplatform.projects.locations.studies.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27753,7 +28123,7 @@ paths: schema: type: string - in: path - name: datasetsId + name: studiesId required: true schema: type: string @@ -27767,14 +28137,11 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}: parameters: *ref_107 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 + description: Gets a Trial. + operationId: aiplatform.projects.locations.studies.trials.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27786,7 +28153,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' parameters: - in: path name: projectsId @@ -27799,22 +28166,18 @@ paths: schema: type: string - in: path - name: datasetsId + name: studiesId required: true schema: type: string - in: path - name: operationsId + name: trialsId 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 + description: Deletes a Trial. + operationId: aiplatform.projects.locations.studies.trials.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27839,20 +28202,29 @@ paths: schema: type: string - in: path - name: datasetsId + name: studiesId required: true schema: type: string - in: path - name: operationsId + name: trialsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials: parameters: *ref_107 - delete: - description: Deletes a Dataset version. - operationId: aiplatform.projects.locations.datasets.datasetVersions.delete + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27864,7 +28236,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListOptimalTrialsResponse parameters: - in: path name: projectsId @@ -27877,18 +28250,15 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: datasetVersionsId + name: studiesId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials: + parameters: *ref_107 get: - description: Gets a Dataset version. - operationId: aiplatform.projects.locations.datasets.datasetVersions.get + description: Lists the Trials associated with a Study. + operationId: aiplatform.projects.locations.studies.trials.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27900,7 +28270,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + $ref: '#/components/schemas/GoogleCloudAiplatformV1ListTrialsResponse' parameters: - in: path name: projectsId @@ -27913,28 +28283,27 @@ paths: schema: type: string - in: path - name: datasetsId + name: studiesId required: true schema: type: string - - in: path - name: datasetVersionsId - required: true + - in: query + name: pageToken schema: type: string - in: query - name: readMask + name: pageSize schema: - type: string - format: google-fieldmask - patch: - description: Updates a DatasetVersion. - operationId: aiplatform.projects.locations.datasets.datasetVersions.patch + type: integer + format: int32 + post: + description: Adds a user provided Trial to a Study. + operationId: aiplatform.projects.locations.studies.trials.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27946,7 +28315,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' parameters: - in: path name: projectsId @@ -27959,30 +28328,20 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: datasetVersionsId + name: studiesId 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}/studies/{studiesId}/trials/{trialsId}:complete: parameters: *ref_107 post: - description: Create a version from a Dataset. - operationId: aiplatform.projects.locations.datasets.datasetVersions.create + description: Marks a Trial as complete. + operationId: aiplatform.projects.locations.studies.trials.complete requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + $ref: '#/components/schemas/GoogleCloudAiplatformV1CompleteTrialRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27994,7 +28353,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' parameters: - in: path name: projectsId @@ -28007,69 +28366,25 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - get: - description: Lists DatasetVersions in a Dataset. - operationId: aiplatform.projects.locations.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: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: studiesId required: true schema: type: string - in: path - name: datasetsId + name: trialsId 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}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop: parameters: *ref_107 - get: - description: Restores a dataset version. - operationId: aiplatform.projects.locations.datasets.datasetVersions.restore + 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 @@ -28081,7 +28396,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' parameters: - in: path name: projectsId @@ -28094,29 +28409,28 @@ paths: schema: type: string - in: path - name: datasetsId + name: studiesId required: true schema: type: string - in: path - name: datasetVersionsId + name: trialsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addTrialMeasurement: parameters: *ref_107 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 + 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 @@ -28128,7 +28442,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' parameters: - in: path name: projectsId @@ -28141,34 +28455,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 - - 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:suggest: parameters: *ref_107 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 + 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' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28180,7 +28489,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -28193,23 +28502,25 @@ paths: schema: type: string - in: path - name: trainingPipelinesId - required: true - schema: - type: string - - in: path - name: operationsId + name: studiesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkTrialEarlyStoppingState: parameters: *ref_107 - 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.trainingPipelines.operations.get + 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 @@ -28234,22 +28545,24 @@ 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}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}: + parameters: *ref_107 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 + operationId: aiplatform.projects.locations.studies.trials.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28274,7 +28587,12 @@ paths: schema: type: string - in: path - name: trainingPipelinesId + name: studiesId + required: true + schema: + type: string + - in: path + name: trialsId required: true schema: type: string @@ -28283,13 +28601,12 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations: - parameters: *ref_107 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 + Gets the latest 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 @@ -28301,7 +28618,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -28314,43 +28631,27 @@ paths: schema: type: string - in: path - name: trainingPipelinesId + name: studiesId required: true schema: type: string - - in: query - name: filter + - in: path + name: trialsId + 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 - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations: parameters: *ref_107 - post: + get: 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/GoogleCloudAiplatformV1CancelTrainingPipelineRequest + 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 @@ -28362,7 +28663,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -28375,37 +28676,17 @@ paths: schema: type: string - in: path - name: trainingPipelinesId + name: studiesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines: - parameters: *ref_107 - get: - description: Lists TrainingPipelines in a Location. - operationId: aiplatform.projects.locations.trainingPipelines.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/GoogleCloudAiplatformV1ListTrainingPipelinesResponse - parameters: - in: path - name: projectsId + name: trialsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: pageToken schema: type: string - in: query @@ -28417,25 +28698,20 @@ paths: name: filter 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}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait: + parameters: *ref_107 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' + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It 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 @@ -28447,7 +28723,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -28459,42 +28735,40 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}: - parameters: *ref_107 - 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: studiesId required: true schema: type: string - in: path - name: locationsId + name: trialsId required: true schema: type: string - in: path - name: trainingPipelinesId + name: operationsId required: true schema: type: string - get: - description: Gets a TrainingPipeline. - operationId: aiplatform.projects.locations.trainingPipelines.get + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel: + parameters: *ref_107 + 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 @@ -28506,7 +28780,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -28519,49 +28793,33 @@ paths: schema: type: string - in: path - name: trainingPipelinesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readSize: - parameters: *ref_107 - 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 - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardSizeResponse - 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: tensorboardsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}: + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:serverStreamingPredict: parameters: *ref_107 - get: - description: Gets a Tensorboard. - operationId: aiplatform.projects.locations.tensorboards.get + 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 @@ -28577,7 +28835,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StreamingPredictResponse parameters: - in: path name: projectsId @@ -28590,25 +28849,43 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: publishersId required: true schema: type: string - delete: - description: Deletes a Tensorboard. - operationId: aiplatform.projects.locations.tensorboards.delete + - in: path + name: modelsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:generateContent: + parameters: *ref_107 + 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 content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse parameters: - in: path name: projectsId @@ -28621,18 +28898,25 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: publishersId required: true schema: type: string - patch: - description: Updates a Tensorboard. - operationId: aiplatform.projects.locations.tensorboards.patch + - in: path + name: modelsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:countTokens: + parameters: *ref_107 + post: + description: Perform a token counting. + operationId: aiplatform.projects.locations.publishers.models.countTokens requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' + $ref: '#/components/schemas/GoogleCloudAiplatformV1CountTokensRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28644,7 +28928,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CountTokensResponse parameters: - in: path name: projectsId @@ -28657,20 +28942,26 @@ paths: schema: type: string - in: path - name: tensorboardsId + 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}/tensorboards: + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamRawPredict: parameters: *ref_107 - get: - description: Lists Tensorboards in a Location. - operationId: aiplatform.projects.locations.tensorboards.list + 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 @@ -28686,8 +28977,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListTensorboardsResponse + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: projectsId @@ -28699,48 +28989,47 @@ 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: orderBy - schema: - type: string - - in: query - name: pageToken + - in: path + name: publishersId + required: true schema: type: string - - in: query - name: readMask + - in: path + name: modelsId + required: true schema: type: string - format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:rawPredict: + parameters: *ref_107 post: - description: Creates a Tensorboard. - operationId: aiplatform.projects.locations.tensorboards.create + 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/GoogleCloudAiplatformV1Tensorboard' + $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 @@ -28752,55 +29041,36 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readUsage: - parameters: *ref_107 - 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 - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardUsageResponse - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - in: path - name: locationsId + name: publishersId required: true schema: type: string - in: path - name: tensorboardsId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:batchRead: + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamGenerateContent: parameters: *ref_107 - 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 + 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 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 @@ -28808,7 +29078,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse parameters: - in: path name: projectsId @@ -28821,41 +29091,41 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: publishersId required: true schema: type: string - - in: query - name: timeSeries + - in: path + name: modelsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predict: parameters: *ref_107 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.operations.wait + 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 @@ -28868,38 +29138,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: 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}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:computeTokens: parameters: *ref_107 - 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 + 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 @@ -28911,7 +29168,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ComputeTokensResponse parameters: - in: path name: projectsId @@ -28924,34 +29182,16 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: publishersId required: true schema: type: string - in: path - name: runsId + 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}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}: parameters: *ref_107 delete: description: >- @@ -28959,8 +29199,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.operations.delete + operationId: aiplatform.projects.locations.indexEndpoints.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28985,17 +29224,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: indexEndpointsId required: true schema: type: string @@ -29009,8 +29238,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.tensorboards.experiments.runs.operations.get + operationId: aiplatform.projects.locations.indexEndpoints.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29035,17 +29263,54 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: indexEndpointsId required: true schema: type: string - in: path - name: experimentsId + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:wait: + parameters: *ref_107 + 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 + 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: runsId + name: locationsId + required: true + schema: + type: string + - in: path + name: indexEndpointsId required: true schema: type: string @@ -29054,7 +29319,12 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel: + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:cancel: parameters: *ref_107 post: description: >- @@ -29067,8 +29337,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.tensorboards.experiments.runs.operations.cancel + operationId: aiplatform.projects.locations.indexEndpoints.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29093,17 +29362,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: indexEndpointsId required: true schema: type: string @@ -29112,20 +29371,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:exportTensorboardTimeSeries: + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations: parameters: *ref_107 - post: + get: 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 + 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 @@ -29137,8 +29389,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -29151,31 +29402,33 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: indexEndpointsId 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: filter schema: type: string - - in: path - name: timeSeriesId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}: + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:mutateDeployedIndex: parameters: *ref_107 - delete: - description: Deletes a TensorboardTimeSeries. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete + post: + description: Update an existing DeployedIndex under an IndexEndpoint. + operationId: aiplatform.projects.locations.indexEndpoints.mutateDeployedIndex + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29200,46 +29453,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 - required: true - schema: - type: string - - in: path - name: timeSeriesId + name: indexEndpointsId required: true schema: type: string - get: - description: Gets a TensorboardTimeSeries. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:undeployIndex: + parameters: *ref_107 + 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 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 @@ -29252,35 +29493,51 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: indexEndpointsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}: + parameters: *ref_107 + delete: + description: Deletes an IndexEndpoint. + operationId: aiplatform.projects.locations.indexEndpoints.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: indexEndpointsId required: true schema: type: string patch: - description: Updates a TensorboardTimeSeries. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch + description: Updates an IndexEndpoint. + operationId: aiplatform.projects.locations.indexEndpoints.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29292,8 +29549,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' parameters: - in: path name: projectsId @@ -29306,50 +29562,64 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: indexEndpointsId required: true schema: type: string - - in: path - name: experimentsId - required: true + - in: query + name: updateMask schema: type: string + format: google-fieldmask + get: + description: Gets an IndexEndpoint. + operationId: aiplatform.projects.locations.indexEndpoints.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/GoogleCloudAiplatformV1IndexEndpoint' + parameters: - in: path - name: runsId + name: projectsId required: true schema: type: string - in: path - name: timeSeriesId + 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}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:read: + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:readIndexDatapoints: parameters: *ref_107 - 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 + 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 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 @@ -29357,7 +29627,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse + #/components/schemas/GoogleCloudAiplatformV1ReadIndexDatapointsResponse parameters: - in: path name: projectsId @@ -29370,46 +29640,65 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: indexEndpointsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints: + parameters: *ref_107 + 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 + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListIndexEndpointsResponse + parameters: - in: path - name: runsId + name: projectsId required: true schema: type: string - in: path - name: timeSeriesId + name: locationsId required: true schema: type: string - in: query - name: maxDataPoints + name: pageSize 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: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries: - parameters: *ref_107 post: - description: Creates a TensorboardTimeSeries. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create + description: Creates an IndexEndpoint. + operationId: aiplatform.projects.locations.indexEndpoints.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29421,8 +29710,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -29434,46 +29722,69 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:findNeighbors: + parameters: *ref_107 + 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' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FindNeighborsResponse + parameters: - in: path - name: tensorboardsId + name: projectsId required: true schema: type: string - in: path - name: experimentsId + name: locationsId required: true schema: type: string - in: path - name: runsId + name: indexEndpointsId required: true schema: type: string - - in: query - name: tensorboardTimeSeriesId - schema: - type: string - get: - description: Lists TensorboardTimeSeries in a Location. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:deployIndex: + parameters: *ref_107 + 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 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 @@ -29486,68 +29797,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: indexEndpointsId 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: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:readBlobData: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}: parameters: *ref_107 - 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. + Deletes a long-running operation. This method indicates that the client + is no longer interested 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.readBlobData + aiplatform.projects.locations.tensorboards.experiments.runs.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 @@ -29575,29 +29850,17 @@ paths: 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}/operations/{operationsId}:wait: - parameters: *ref_107 - 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. + Gets the latest 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.wait + aiplatform.projects.locations.tensorboards.experiments.runs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29636,29 +29899,19 @@ paths: 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: 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}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations: parameters: *ref_107 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 + aiplatform.projects.locations.tensorboards.experiments.runs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29697,33 +29950,34 @@ paths: required: true schema: type: string - - in: path - name: timeSeriesId - required: true - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - in: query - name: pageToken + name: filter schema: type: string - in: query - name: filter + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait: parameters: *ref_107 - 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. + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It 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.get + aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29763,23 +30017,30 @@ paths: schema: type: string - in: path - name: timeSeriesId + name: operationsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: timeout schema: type: string - delete: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel: + parameters: *ref_107 + 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`. + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is 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.delete + aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29818,31 +30079,17 @@ paths: 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}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}: parameters: *ref_107 - 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`. + delete: + description: Deletes a TensorboardTimeSeries. operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29854,7 +30101,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -29886,16 +30133,10 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs: - parameters: *ref_107 get: - description: Lists TensorboardRuns in a Location. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.list + description: Gets a TensorboardTimeSeries. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29912,7 +30153,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListTensorboardRunsResponse + #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries parameters: - in: path name: projectsId @@ -29934,86 +30175,26 @@ paths: 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 - - in: query - name: orderBy - schema: - type: string - post: - description: Creates a TensorboardRun. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: tensorboardsId + name: runsId required: true schema: type: string - in: path - name: experimentsId + name: timeSeriesId required: true schema: type: string - - in: query - name: tensorboardRunId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}:write: - parameters: *ref_107 - 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 + patch: + description: Updates a TensorboardTimeSeries. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardRunDataRequest + #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30026,7 +30207,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardRunDataResponse + #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries parameters: - in: path name: projectsId @@ -30053,16 +30234,28 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}: + - in: path + name: timeSeriesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries: parameters: *ref_107 - patch: - description: Updates a TensorboardRun. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.patch + post: + description: Creates a TensorboardTimeSeries. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30074,7 +30267,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries parameters: - in: path name: projectsId @@ -30102,13 +30296,13 @@ paths: schema: type: string - in: query - name: updateMask + name: tensorboardTimeSeriesId schema: type: string - format: google-fieldmask get: - description: Gets a TensorboardRun. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.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 @@ -30124,7 +30318,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse parameters: - in: path name: projectsId @@ -30151,21 +30346,54 @@ paths: required: true schema: type: string - delete: - description: Deletes a TensorboardRun. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.delete + - 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: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:readBlobData: + parameters: *ref_107 + 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 @@ -30192,22 +30420,35 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs:batchCreate: + - 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}:read: parameters: *ref_107 - post: - description: Batch create TensorboardRuns. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest + 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 @@ -30215,7 +30456,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse + #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse parameters: - in: path name: projectsId @@ -30237,20 +30478,39 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel: + - 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}/timeSeries/{timeSeriesId}:exportTensorboardTimeSeries: parameters: *ref_107 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 + 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 @@ -30262,7 +30522,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse parameters: - in: path name: projectsId @@ -30285,24 +30546,23 @@ paths: schema: type: string - in: path - name: operationsId + name: runsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait: + - in: path + name: timeSeriesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations: parameters: *ref_107 - 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.tensorboards.experiments.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.tensorboards.experiments.runs.timeSeries.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30314,7 +30574,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -30337,16 +30597,29 @@ paths: schema: type: string - in: path - name: operationsId + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId required: true schema: type: string - in: query - name: timeout + name: filter schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}: + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}: parameters: *ref_107 delete: description: >- @@ -30354,7 +30627,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.tensorboards.experiments.operations.delete + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30388,6 +30662,16 @@ paths: 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 @@ -30398,7 +30682,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.tensorboards.experiments.operations.get + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30432,18 +30717,36 @@ paths: 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}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait: parameters: *ref_107 - 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 + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It 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 @@ -30455,7 +30758,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -30477,88 +30780,41 @@ 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}/tensorboards/{tensorboardsId}/experiments: - parameters: *ref_107 - get: - 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/GoogleCloudAiplatformV1ListTensorboardExperimentsResponse - parameters: - in: path - name: projectsId + name: runsId required: true schema: type: string - in: path - name: locationsId + name: timeSeriesId required: true schema: type: string - in: path - name: tensorboardsId + name: operationsId 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: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy + name: timeout schema: type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel: + parameters: *ref_107 post: - description: Creates a TensorboardExperiment. - operationId: aiplatform.projects.locations.tensorboards.experiments.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment + 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 @@ -30570,8 +30826,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -30588,75 +30843,47 @@ paths: required: true schema: type: string - - in: query - name: tensorboardExperimentId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}: - parameters: *ref_107 - 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/GoogleCloudAiplatformV1TensorboardExperiment - 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: tensorboardsId + name: timeSeriesId required: true schema: type: string - in: path - name: experimentsId + name: operationsId 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 + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}: + parameters: *ref_107 + 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/GoogleCloudAiplatformV1TensorboardExperiment + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' parameters: - in: path name: projectsId @@ -30678,14 +30905,14 @@ paths: required: true schema: type: string - - in: query - name: updateMask + - in: path + name: runsId + required: true schema: type: string - format: google-fieldmask delete: - description: Deletes a TensorboardExperiment. - operationId: aiplatform.projects.locations.tensorboards.experiments.delete + description: Deletes a TensorboardRun. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30719,20 +30946,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:write: - parameters: *ref_107 - 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 + - in: path + name: runsId + required: true + schema: + type: string + patch: + description: Updates a TensorboardRun. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30744,8 +30970,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' parameters: - in: path name: projectsId @@ -30767,19 +30992,29 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:batchCreate: + - in: path + name: runsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}:write: parameters: *ref_107 post: description: >- - Batch create TensorboardTimeSeries that belong to a - TensorboardExperiment. - operationId: aiplatform.projects.locations.tensorboards.experiments.batchCreate + 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/GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest + #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardRunDataRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30792,7 +31027,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse + #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardRunDataResponse parameters: - in: path name: projectsId @@ -30814,26 +31049,33 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}: + - in: path + name: runsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs: parameters: *ref_107 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 + 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/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListTensorboardRunsResponse parameters: - in: path name: projectsId @@ -30851,57 +31093,40 @@ paths: 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.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 + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: filter schema: type: string - - in: path - name: tensorboardsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: readMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations: - parameters: *ref_107 - 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 + format: google-fieldmask + post: + description: Creates a TensorboardRun. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30913,7 +31138,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' parameters: - in: path name: projectsId @@ -30930,33 +31155,26 @@ paths: required: true schema: type: string - - 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: tensorboardRunId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs:batchCreate: parameters: *ref_107 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: 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 @@ -30968,7 +31186,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse parameters: - in: path name: projectsId @@ -30986,11 +31205,11 @@ paths: schema: type: string - in: path - name: operationsId + name: experimentsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait: parameters: *ref_107 post: description: >- @@ -31003,7 +31222,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.tensorboards.experiments.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31032,6 +31251,11 @@ paths: required: true schema: type: string + - in: path + name: experimentsId + required: true + schema: + type: string - in: path name: operationsId required: true @@ -31042,13 +31266,13 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations: parameters: *ref_107 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.tensorboards.experiments.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31073,12 +31297,13 @@ paths: schema: type: string - in: path - name: hyperparameterTuningJobsId + name: tensorboardsId required: true schema: type: string - - in: query - name: filter + - in: path + name: experimentsId + required: true schema: type: string - in: query @@ -31090,59 +31315,11 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait: - parameters: *ref_107 - 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 - security: - - Oauth2: - - https://www.googleapis.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 - - in: path - name: operationsId - required: true - schema: - type: string - in: query - name: timeout + name: filter schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}: parameters: *ref_107 delete: description: >- @@ -31150,7 +31327,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.hyperparameterTuningJobs.operations.delete + operationId: aiplatform.projects.locations.tensorboards.experiments.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31175,7 +31352,12 @@ paths: schema: type: string - in: path - name: hyperparameterTuningJobsId + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId required: true schema: type: string @@ -31189,7 +31371,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.hyperparameterTuningJobs.operations.get + operationId: aiplatform.projects.locations.tensorboards.experiments.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31214,7 +31396,12 @@ paths: schema: type: string - in: path - name: hyperparameterTuningJobsId + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId required: true schema: type: string @@ -31223,7 +31410,7 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel: parameters: *ref_107 post: description: >- @@ -31236,7 +31423,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.tensorboards.experiments.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31261,7 +31448,12 @@ paths: schema: type: string - in: path - name: hyperparameterTuningJobsId + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId required: true schema: type: string @@ -31270,16 +31462,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}: parameters: *ref_107 get: - description: Gets a HyperparameterTuningJob - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.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 @@ -31287,7 +31483,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob + #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment parameters: - in: path name: projectsId @@ -31300,52 +31496,24 @@ paths: schema: type: string - in: path - 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: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: tensorboardsId required: true schema: type: string - in: path - name: hyperparameterTuningJobsId + name: experimentsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs: - parameters: *ref_107 - post: - description: Creates a HyperparameterTuningJob - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.create + patch: + description: Updates a TensorboardExperiment. + operationId: aiplatform.projects.locations.tensorboards.experiments.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob + #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31358,7 +31526,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob + #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment parameters: - in: path name: projectsId @@ -31370,72 +31538,24 @@ paths: required: true schema: type: string - get: - description: Lists HyperparameterTuningJobs in a Location. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.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/GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse - parameters: - in: path - name: projectsId + name: tensorboardsId required: true schema: type: string - in: path - name: locationsId + name: experimentsId 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: readMask + name: updateMask schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}:cancel: - parameters: *ref_107 - 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 + delete: + description: Deletes a TensorboardExperiment. + operationId: aiplatform.projects.locations.tensorboards.experiments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31447,7 +31567,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -31460,20 +31580,28 @@ paths: schema: type: string - in: path - name: hyperparameterTuningJobsId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}: + - in: path + name: experimentsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:batchCreate: parameters: *ref_107 - patch: - description: Updates an Endpoint. - operationId: aiplatform.projects.locations.endpoints.patch + post: + description: >- + Batch create TensorboardTimeSeries that belong to a + TensorboardExperiment. + operationId: aiplatform.projects.locations.tensorboards.experiments.batchCreate requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31485,7 +31613,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse parameters: - in: path name: projectsId @@ -31498,61 +31627,37 @@ paths: schema: type: string - in: path - name: endpointsId - required: true - schema: - type: string - - 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 - 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: endpointsId + name: experimentsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments: + parameters: *ref_107 get: - description: Gets an Endpoint. - operationId: aiplatform.projects.locations.endpoints.get + 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/GoogleCloudAiplatformV1Endpoint' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListTensorboardExperimentsResponse parameters: - in: path name: projectsId @@ -31565,72 +31670,16 @@ paths: schema: type: string - in: path - name: endpointsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints: - parameters: *ref_107 - 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 - 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: query - name: endpointId - schema: - type: string - get: - description: Lists Endpoints in a Location. - operationId: aiplatform.projects.locations.endpoints.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/GoogleCloudAiplatformV1ListEndpointsResponse - parameters: - - in: path - name: projectsId - required: true + name: filter schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: orderBy schema: type: string - in: query @@ -31638,43 +31687,29 @@ paths: 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: orderBy - schema: - type: string - - in: query - name: filter + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamGenerateContent: - parameters: *ref_107 post: - description: Generate content with multimodal inputs with streaming support. - operationId: aiplatform.projects.locations.endpoints.streamGenerateContent + description: Creates a TensorboardExperiment. + operationId: aiplatform.projects.locations.tensorboards.experiments.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest + #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment 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 @@ -31682,7 +31717,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse + #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment parameters: - in: path name: projectsId @@ -31695,41 +31730,41 @@ paths: schema: type: string - in: path - name: endpointsId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:rawPredict: + - in: query + name: tensorboardExperimentId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:write: parameters: *ref_107 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 + 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/GoogleCloudAiplatformV1RawPredictRequest' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest 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/GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse parameters: - in: path name: projectsId @@ -31742,20 +31777,23 @@ paths: schema: type: string - in: path - name: endpointsId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:countTokens: + - in: path + name: experimentsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}: parameters: *ref_107 - post: - description: Perform a token counting. - operationId: aiplatform.projects.locations.endpoints.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.tensorboards.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31767,8 +31805,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CountTokensResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -31781,22 +31818,22 @@ paths: schema: type: string - in: path - name: endpointsId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:undeployModel: - parameters: *ref_107 - post: + - in: path + name: operationsId + required: true + schema: + type: string + delete: 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' + Deletes a long-running operation. This method indicates that the client + is no longer interested 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 @@ -31808,7 +31845,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -31821,20 +31858,29 @@ paths: schema: type: string - in: path - name: endpointsId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:deployModel: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:wait: parameters: *ref_107 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.tensorboards.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31859,37 +31905,39 @@ paths: schema: type: string - in: path - name: endpointsId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamRawPredict: + - 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}/operations: parameters: *ref_107 - 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 + 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 - - 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/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -31902,40 +31950,49 @@ paths: schema: type: string - in: path - name: endpointsId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:serverStreamingPredict: + - 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}/operations/{operationsId}:cancel: parameters: *ref_107 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 + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is 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 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/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -31948,30 +32005,30 @@ paths: schema: type: string - in: path - name: endpointsId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:generateContent: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:batchRead: parameters: *ref_107 - post: - description: Generate content with multimodal inputs. - operationId: aiplatform.projects.locations.endpoints.generateContent - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest + 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 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 @@ -31979,7 +32036,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse + #/components/schemas/GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse parameters: - in: path name: projectsId @@ -31992,39 +32049,36 @@ paths: schema: type: string - in: path - name: endpointsId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directPredict: + - in: query + name: timeSeries + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards: parameters: *ref_107 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: Creates a Tensorboard. + operationId: aiplatform.projects.locations.tensorboards.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DirectPredictRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' 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/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -32036,26 +32090,18 @@ paths: required: true schema: type: string - - in: path - name: endpointsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:computeTokens: - parameters: *ref_107 - 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' + 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 @@ -32063,7 +32109,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ComputeTokensResponse + #/components/schemas/GoogleCloudAiplatformV1ListTensorboardsResponse parameters: - in: path name: projectsId @@ -32075,33 +32121,38 @@ paths: required: true schema: type: string - - in: path - name: endpointsId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directRawPredict: + - in: query + name: orderBy + 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}:readUsage: parameters: *ref_107 - 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 + 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 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 @@ -32109,7 +32160,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DirectRawPredictResponse + #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardUsageResponse parameters: - in: path name: projectsId @@ -32122,25 +32173,15 @@ paths: schema: type: string - in: path - name: endpointsId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:mutateDeployedModel: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}: parameters: *ref_107 - 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 a Tensorboard. + operationId: aiplatform.projects.locations.tensorboards.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32165,20 +32206,13 @@ paths: schema: type: string - in: path - name: endpointsId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predict: - parameters: *ref_107 - post: - description: Perform an online prediction. - operationId: aiplatform.projects.locations.endpoints.predict - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictRequest' + get: + description: Gets a Tensorboard. + operationId: aiplatform.projects.locations.tensorboards.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32194,7 +32228,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' parameters: - in: path name: projectsId @@ -32207,40 +32241,30 @@ paths: schema: type: string - in: path - name: endpointsId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:explain: - parameters: *ref_107 - 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 + patch: + description: Updates a Tensorboard. + operationId: aiplatform.projects.locations.tensorboards.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplainRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' 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/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -32253,19 +32277,20 @@ paths: schema: type: string - in: path - name: endpointsId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readSize: parameters: *ref_107 - 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 + 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 @@ -32277,7 +32302,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardSizeResponse parameters: - in: path name: projectsId @@ -32290,21 +32316,24 @@ paths: schema: type: string - in: path - name: endpointsId - required: true - schema: - type: string - - in: path - name: operationsId + name: tensorboardsId required: true schema: type: string - get: + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait: + parameters: *ref_107 + 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.endpoints.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.persistentResources.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32329,7 +32358,7 @@ paths: schema: type: string - in: path - name: endpointsId + name: persistentResourcesId required: true schema: type: string @@ -32338,7 +32367,12 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:cancel: + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel: parameters: *ref_107 post: description: >- @@ -32351,7 +32385,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 @@ -32376,7 +32410,7 @@ paths: schema: type: string - in: path - name: endpointsId + name: persistentResourcesId required: true schema: type: string @@ -32385,13 +32419,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations: parameters: *ref_107 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 @@ -32416,7 +32450,7 @@ paths: schema: type: string - in: path - name: endpointsId + name: persistentResourcesId required: true schema: type: string @@ -32424,29 +32458,24 @@ 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}/endpoints/{endpointsId}/operations/{operationsId}:wait: + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}: parameters: *ref_107 - 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.endpoints.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.persistentResources.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32458,7 +32487,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -32471,7 +32500,7 @@ paths: schema: type: string - in: path - name: endpointsId + name: persistentResourcesId required: true schema: type: string @@ -32480,16 +32509,12 @@ paths: required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails: - parameters: *ref_107 get: - description: List top NasTrialDetails of a NasJob. - operationId: aiplatform.projects.locations.nasJobs.nasTrialDetails.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.persistentResources.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32501,8 +32526,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListNasTrialDetailsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -32515,24 +32539,20 @@ paths: schema: type: string - in: path - name: nasJobsId + name: persistentResourcesId 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 - /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails/{nasTrialDetailsId}: + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}: parameters: *ref_107 get: - description: Gets a NasTrialDetail. - operationId: aiplatform.projects.locations.nasJobs.nasTrialDetails.get + description: Gets a PersistentResource. + operationId: aiplatform.projects.locations.persistentResources.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32544,7 +32564,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrialDetail' + $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' parameters: - in: path name: projectsId @@ -32557,33 +32577,18 @@ paths: schema: type: string - in: path - name: nasJobsId - required: true - schema: - type: string - - in: path - name: nasTrialDetailsId + name: persistentResourcesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}:cancel: - parameters: *ref_107 - 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 + patch: + description: Updates a PersistentResource. + operationId: aiplatform.projects.locations.persistentResources.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CancelNasJobRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32595,7 +32600,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -32608,15 +32613,18 @@ paths: schema: type: string - in: path - name: nasJobsId + name: persistentResourcesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}: - parameters: *ref_107 + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask delete: - description: Deletes a NasJob. - operationId: aiplatform.projects.locations.nasJobs.delete + description: Deletes a PersistentResource. + operationId: aiplatform.projects.locations.persistentResources.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32641,29 +32649,32 @@ paths: schema: type: string - in: path - name: nasJobsId + name: persistentResourcesId required: true schema: type: string - get: - description: Gets a NasJob - operationId: aiplatform.projects.locations.nasJobs.get + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources: + parameters: *ref_107 + post: + description: Creates a PersistentResource. + operationId: aiplatform.projects.locations.persistentResources.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' 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 @@ -32675,21 +32686,57 @@ paths: required: true schema: type: string + - 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 + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListPersistentResourcesResponse + parameters: - in: path - name: nasJobsId + name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/nasJobs: + - 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 + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}:reboot: parameters: *ref_107 post: - description: Creates a NasJob - operationId: aiplatform.projects.locations.nasJobs.create + description: Reboots a PersistentResource. + operationId: aiplatform.projects.locations.persistentResources.reboot requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RebootPersistentResourceRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32701,7 +32748,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -32713,9 +32760,18 @@ paths: required: true schema: type: string + - in: path + name: persistentResourcesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations: + parameters: *ref_107 get: - description: Lists NasJobs in a Location. - operationId: aiplatform.projects.locations.nasJobs.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.deploymentResourcePools.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32727,8 +32783,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListNasJobsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -32740,6 +32795,11 @@ paths: required: true schema: type: string + - in: path + name: deploymentResourcePoolsId + required: true + schema: + type: string - in: query name: pageToken schema: @@ -32753,23 +32813,20 @@ paths: schema: type: integer format: int32 - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:deployIndex: + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel: parameters: *ref_107 - 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' + 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 @@ -32781,7 +32838,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -32794,20 +32851,24 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: deploymentResourcePoolsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:findNeighbors: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}: parameters: *ref_107 - 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.deploymentResourcePools.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32819,8 +32880,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FindNeighborsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -32833,15 +32893,21 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: deploymentResourcePoolsId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints: - parameters: *ref_107 get: - description: Lists IndexEndpoints in a Location. - operationId: aiplatform.projects.locations.indexEndpoints.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.deploymentResourcePools.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32853,8 +32919,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListIndexEndpointsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -32866,32 +32931,30 @@ 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 + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:wait: + parameters: *ref_107 post: - description: Creates an IndexEndpoint. - operationId: aiplatform.projects.locations.indexEndpoints.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32915,56 +32978,32 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:mutateDeployedIndex: - parameters: *ref_107 - post: - description: Update an existing DeployedIndex under an IndexEndpoint. - operationId: aiplatform.projects.locations.indexEndpoints.mutateDeployedIndex - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' - security: - - Oauth2: - - https://www.googleapis.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: deploymentResourcePoolsId required: true schema: type: string - in: path - name: locationsId + name: operationsId required: true schema: type: string - - in: path - name: indexEndpointsId - required: true + - in: query + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:undeployIndex: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools: parameters: *ref_107 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: Create a DeploymentResourcePool. + operationId: aiplatform.projects.locations.deploymentResourcePools.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1UndeployIndexRequest' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32988,16 +33027,9 @@ paths: required: true schema: type: string - - in: path - name: indexEndpointsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}: - parameters: *ref_107 get: - description: Gets an IndexEndpoint. - operationId: aiplatform.projects.locations.indexEndpoints.get + description: List DeploymentResourcePools in a location. + operationId: aiplatform.projects.locations.deploymentResourcePools.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33009,7 +33041,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse parameters: - in: path name: projectsId @@ -33021,19 +33054,20 @@ paths: required: true schema: type: string - - in: path - name: indexEndpointsId - required: true + - in: query + name: pageToken schema: type: string - patch: - description: Updates an IndexEndpoint. - operationId: aiplatform.projects.locations.indexEndpoints.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}: + parameters: *ref_107 + delete: + description: Delete a DeploymentResourcePool. + operationId: aiplatform.projects.locations.deploymentResourcePools.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33045,7 +33079,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -33058,18 +33092,13 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: deploymentResourcePoolsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes an IndexEndpoint. - operationId: aiplatform.projects.locations.indexEndpoints.delete + get: + description: Get a DeploymentResourcePool. + operationId: aiplatform.projects.locations.deploymentResourcePools.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33081,7 +33110,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool parameters: - in: path name: projectsId @@ -33094,23 +33124,18 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: deploymentResourcePoolsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:readIndexDatapoints: + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}:queryDeployedModels: parameters: *ref_107 - post: + get: 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 + List DeployedModels that have been deployed on this + DeploymentResourcePool. + operationId: >- + aiplatform.projects.locations.deploymentResourcePools.queryDeployedModels security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33123,7 +33148,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadIndexDatapointsResponse + #/components/schemas/GoogleCloudAiplatformV1QueryDeployedModelsResponse parameters: - in: path name: projectsId @@ -33136,24 +33161,28 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: deploymentResourcePoolsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:wait: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}: parameters: *ref_107 - 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.indexEndpoints.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.featurestores.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33165,7 +33194,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -33178,7 +33207,7 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: featurestoresId required: true schema: type: string @@ -33187,19 +33216,12 @@ paths: required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}: - parameters: *ref_107 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 + operationId: aiplatform.projects.locations.featurestores.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33224,7 +33246,7 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: featurestoresId required: true schema: type: string @@ -33233,13 +33255,20 @@ paths: required: true schema: type: string - delete: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:cancel: + parameters: *ref_107 + 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.featurestores.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33264,7 +33293,7 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: featurestoresId required: true schema: type: string @@ -33273,20 +33302,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:wait: parameters: *ref_107 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 + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It 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 @@ -33298,7 +33327,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -33311,7 +33340,7 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: featurestoresId required: true schema: type: string @@ -33320,13 +33349,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations: + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations: parameters: *ref_107 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.featurestores.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33351,28 +33385,33 @@ paths: schema: type: string - in: path - name: indexEndpointsId + 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: pageToken schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}: parameters: *ref_107 - 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.featurestores.entityTypes.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33384,8 +33423,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListMetadataStoresResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -33397,23 +33435,27 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: featurestoresId + required: true schema: type: string - - in: query - name: pageSize + - in: path + name: entityTypesId + 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 + - 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.featurestores.entityTypes.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33437,15 +33479,35 @@ paths: required: true schema: type: string - - in: query - name: metadataStoreId + - in: path + name: featurestoresId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}: + - 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}:wait: parameters: *ref_107 - get: - description: Retrieves a specific MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.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.featurestores.entityTypes.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33457,7 +33519,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataStore' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -33470,15 +33532,32 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featurestoresId required: true schema: type: string - delete: + - 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_107 + get: description: >- - Deletes a single MetadataStore and all its child resources (Artifacts, - Executions, and Contexts). - operationId: aiplatform.projects.locations.metadataStores.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.featurestores.entityTypes.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33490,7 +33569,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -33503,19 +33582,43 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId required: true schema: type: string - in: query - name: force + name: pageSize schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas: + 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}/operations/{operationsId}:cancel: parameters: *ref_107 - get: - description: Lists MetadataSchemas. - operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.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.featurestores.entityTypes.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33527,8 +33630,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListMetadataSchemasResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -33541,31 +33643,35 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featurestoresId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: entityTypesId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: operationsId + required: true schema: type: string - post: - description: Creates a MetadataSchema. - operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel: + parameters: *ref_107 + 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 @@ -33577,7 +33683,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -33590,19 +33696,35 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featurestoresId required: true schema: type: string - - in: query - name: metadataSchemaId + - in: path + name: entityTypesId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas/{metadataSchemasId}: + - 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}: parameters: *ref_107 - get: - description: Retrieves a specific MetadataSchema. - operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.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.featurestores.entityTypes.features.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33614,7 +33736,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -33627,23 +33749,32 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featurestoresId required: true schema: type: string - in: path - name: metadataSchemasId + 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}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}: - parameters: *ref_107 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 + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.features.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33668,12 +33799,17 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featurestoresId required: true schema: type: string - in: path - name: contextsId + name: entityTypesId + required: true + schema: + type: string + - in: path + name: featuresId required: true schema: type: string @@ -33682,13 +33818,14 @@ paths: required: true schema: type: string - delete: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations: + parameters: *ref_107 + 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.metadataStores.contexts.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.featurestores.entityTypes.features.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33700,7 +33837,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -33713,21 +33850,34 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featurestoresId required: true schema: type: string - in: path - name: contextsId + name: entityTypesId required: true schema: type: string - in: path - name: operationsId + name: featuresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait: + - 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}/features/{featuresId}/operations/{operationsId}:wait: parameters: *ref_107 post: description: >- @@ -33740,7 +33890,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.metadataStores.contexts.operations.wait + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.features.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33765,12 +33916,17 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featurestoresId required: true schema: type: string - in: path - name: contextsId + name: entityTypesId + required: true + schema: + type: string + - in: path + name: featuresId required: true schema: type: string @@ -33784,13 +33940,16 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}: parameters: *ref_107 - 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 + 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' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33802,7 +33961,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' parameters: - in: path name: projectsId @@ -33815,42 +33974,69 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featurestoresId required: true schema: type: string - in: path - name: contextsId + name: entityTypesId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: featuresId + required: true schema: type: string - in: query - name: filter + name: updateMask schema: type: string - - in: query - name: pageSize + 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 + 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 - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel: - parameters: *ref_107 - 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 + 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: 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 @@ -33862,7 +34048,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' parameters: - in: path name: projectsId @@ -33875,30 +34061,30 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featurestoresId required: true schema: type: string - in: path - name: contextsId + name: entityTypesId required: true schema: type: string - in: path - name: operationsId + name: featuresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts:purge: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features: parameters: *ref_107 post: - description: Purges Contexts. - operationId: aiplatform.projects.locations.metadataStores.contexts.purge + 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/GoogleCloudAiplatformV1PurgeContextsRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33923,15 +34109,22 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts: - parameters: *ref_107 + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: query + name: featureId + schema: + type: string get: - description: Lists Contexts on the MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.contexts.list + description: Lists Features in a given EntityType. + operationId: aiplatform.projects.locations.featurestores.entityTypes.features.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33944,7 +34137,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListContextsResponse + #/components/schemas/GoogleCloudAiplatformV1ListFeaturesResponse parameters: - in: path name: projectsId @@ -33957,7 +34150,12 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId required: true schema: type: string @@ -33966,26 +34164,40 @@ paths: schema: type: string - in: query - name: pageSize + name: pageToken schema: - type: integer - format: int32 + type: string - in: query - name: pageToken + name: readMask schema: type: string + format: google-fieldmask - in: query name: filter schema: type: string + - in: query + name: latestStatsCount + schema: + type: integer + format: int32 + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features:batchCreate: + parameters: *ref_107 post: - description: Creates a Context associated with a MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.contexts.create + 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/GoogleCloudAiplatformV1Context' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchCreateFeaturesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33997,7 +34209,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -34010,30 +34222,27 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featurestoresId required: true schema: type: string - - in: query - name: contextId + - in: path + name: entityTypesId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextChildren: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:exportFeatureValues: parameters: *ref_107 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 + 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/GoogleCloudAiplatformV1AddContextChildrenRequest + #/components/schemas/GoogleCloudAiplatformV1ExportFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34045,8 +34254,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AddContextChildrenResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -34059,30 +34267,20 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featurestoresId required: true schema: type: string - in: path - name: contextsId + name: entityTypesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextArtifactsAndExecutions: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}: parameters: *ref_107 - 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 details of a single EntityType. + operationId: aiplatform.projects.locations.featurestores.entityTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34094,8 +34292,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' parameters: - in: path name: projectsId @@ -34108,23 +34305,20 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featurestoresId required: true schema: type: string - in: path - name: contextsId + name: entityTypesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:queryContextLineageSubgraph: - parameters: *ref_107 - get: + delete: 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 + 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 @@ -34136,7 +34330,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -34149,25 +34343,27 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featurestoresId required: true schema: type: string - in: path - name: contextsId + name: entityTypesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}: - parameters: *ref_107 + - in: query + name: force + schema: + type: boolean patch: - description: Updates a stored Context. - operationId: aiplatform.projects.locations.metadataStores.contexts.patch + description: Updates the parameters of a single EntityType. + operationId: aiplatform.projects.locations.featurestores.entityTypes.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' + $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34179,7 +34375,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' + $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' parameters: - in: path name: projectsId @@ -34192,27 +34388,31 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featurestoresId required: true schema: type: string - in: path - name: contextsId + name: entityTypesId required: true schema: type: string - - in: query - name: allowMissing - schema: - type: boolean - in: query name: updateMask schema: type: string format: google-fieldmask - delete: - description: Deletes a stored Context. - operationId: aiplatform.projects.locations.metadataStores.contexts.delete + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:testIamPermissions: + parameters: *ref_107 + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34224,7 +34424,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -34237,26 +34437,45 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featurestoresId required: true schema: type: string - in: path - name: contextsId + name: entityTypesId required: true schema: type: string - in: query - name: force - schema: - type: boolean - - in: query - name: etag + name: permissions schema: type: string - get: - description: Retrieves a specific Context. - operationId: aiplatform.projects.locations.metadataStores.contexts.get + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:importFeatureValues: + parameters: *ref_107 + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34268,7 +34487,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -34281,30 +34500,30 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featurestoresId required: true schema: type: string - in: path - name: contextsId + name: entityTypesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:removeContextChildren: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:readFeatureValues: parameters: *ref_107 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. + 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.metadataStores.contexts.removeContextChildren + aiplatform.projects.locations.featurestores.entityTypes.readFeatureValues requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1RemoveContextChildrenRequest + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34317,7 +34536,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1RemoveContextChildrenResponse + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponse parameters: - in: path name: projectsId @@ -34330,24 +34549,74 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featurestoresId required: true schema: type: string - in: path - name: contextsId + name: entityTypesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:queryExecutionInputsAndOutputs: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:getIamPolicy: parameters: *ref_107 - 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. + 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 + 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: featurestoresId + required: true + schema: + type: string + - 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}:streamingReadFeatureValues: + parameters: *ref_107 + 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.metadataStores.executions.queryExecutionInputsAndOutputs + aiplatform.projects.locations.featurestores.entityTypes.streamingReadFeatureValues + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34359,7 +34628,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponse parameters: - in: path name: projectsId @@ -34372,26 +34642,25 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featurestoresId required: true schema: type: string - in: path - name: executionsId + name: entityTypesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions:purge: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes: parameters: *ref_107 post: - description: Purges Executions. - operationId: aiplatform.projects.locations.metadataStores.executions.purge + description: Creates a new EntityType in a given Featurestore. + operationId: aiplatform.projects.locations.featurestores.entityTypes.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PurgeExecutionsRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34416,15 +34685,17 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}: - parameters: *ref_107 + - in: query + name: entityTypeId + schema: + type: string get: - description: Retrieves a specific Execution. - operationId: aiplatform.projects.locations.metadataStores.executions.get + description: Lists EntityTypes in a given Featurestore. + operationId: aiplatform.projects.locations.featurestores.entityTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34436,7 +34707,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListEntityTypesResponse parameters: - in: path name: projectsId @@ -34449,18 +34721,45 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featurestoresId required: true schema: type: string - - in: path - name: executionsId - required: true + - in: query + name: orderBy schema: type: string - delete: - description: Deletes an Execution. - operationId: aiplatform.projects.locations.metadataStores.executions.delete + - 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: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:setIamPolicy: + parameters: *ref_107 + 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 @@ -34472,7 +34771,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -34485,27 +34784,31 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featurestoresId required: true schema: type: string - in: path - name: executionsId + name: entityTypesId required: true schema: type: string - - in: query - name: etag - schema: - type: string - patch: - description: Updates a stored Execution. - operationId: aiplatform.projects.locations.metadataStores.executions.patch + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:writeFeatureValues: + parameters: *ref_107 + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34517,7 +34820,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteFeatureValuesResponse parameters: - in: path name: projectsId @@ -34530,29 +34834,35 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featurestoresId required: true schema: type: string - in: path - name: executionsId + name: entityTypesId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - - in: query - name: allowMissing - schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:deleteFeatureValues: parameters: *ref_107 - get: - description: Lists Executions in the MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.executions.list + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34564,8 +34874,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListExecutionsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -34578,35 +34887,25 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featurestoresId 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: entityTypesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:testIamPermissions: + parameters: *ref_107 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: >- + 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 @@ -34618,7 +34917,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -34631,30 +34930,21 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featurestoresId required: true schema: type: string - in: query - name: executionId + name: permissions schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:addExecutionEvents: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}: parameters: *ref_107 - post: + delete: 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 + 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 @@ -34666,8 +34956,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AddExecutionEventsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -34680,29 +34969,17 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featurestoresId required: true schema: type: string - - in: path - name: executionsId - required: true + - in: query + name: force schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait: - parameters: *ref_107 - 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 + 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 @@ -34714,7 +34991,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' parameters: - in: path name: projectsId @@ -34727,32 +35004,56 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featurestoresId + required: true + schema: + type: string + 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 + 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: executionsId + name: locationsId required: true schema: type: string - in: path - name: operationsId + name: featurestoresId required: true schema: type: string - in: query - name: timeout + name: updateMask schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations: + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/featurestores:searchFeatures: parameters: *ref_107 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: Searches Features matching a query in a given project. + operationId: aiplatform.projects.locations.featurestores.searchFeatures security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34764,7 +35065,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchFeaturesResponse parameters: - in: path name: projectsId @@ -34776,16 +35078,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: pageSize schema: @@ -34796,19 +35088,19 @@ paths: schema: type: string - in: query - name: filter + name: query schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores: parameters: *ref_107 - 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 + 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 @@ -34820,7 +35112,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -34832,27 +35124,13 @@ 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: path - name: operationsId - required: true + - in: query + name: featurestoreId 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.executions.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 @@ -34864,7 +35142,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListFeaturestoresResponse parameters: - in: path name: projectsId @@ -34876,36 +35155,35 @@ paths: required: true schema: type: string - - in: path - name: metadataStoresId - required: true + - in: query + name: filter schema: type: string - - in: path - name: executionsId - required: true + - in: query + name: readMask schema: type: string - - in: path - name: operationsId - required: true + format: google-fieldmask + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel: + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:getIamPolicy: parameters: *ref_107 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 + 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 @@ -34917,7 +35195,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -34930,34 +35208,28 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: executionsId + name: featurestoresId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: options.requestedPolicyVersion schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:setIamPolicy: parameters: *ref_107 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 + 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 @@ -34969,7 +35241,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -34982,32 +35254,26 @@ paths: 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 + name: featurestoresId 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: + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:batchReadFeatureValues: parameters: *ref_107 - 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.artifacts.operations.list + 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 @@ -35019,7 +35285,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -35032,36 +35298,15 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: artifactsId + name: featurestoresId 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}: + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}: parameters: *ref_107 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 TuningJob. + operationId: aiplatform.projects.locations.tuningJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35073,7 +35318,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' parameters: - in: path name: projectsId @@ -35086,27 +35331,15 @@ paths: 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 + name: tuningJobsId 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 + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs: + parameters: *ref_107 + get: + description: Lists TuningJobs in a Location. + operationId: aiplatform.projects.locations.tuningJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35118,7 +35351,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListTuningJobsResponse parameters: - in: path name: projectsId @@ -35130,35 +35364,29 @@ paths: required: true schema: type: string - - in: path - name: metadataStoresId - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: artifactsId - 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}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel: - parameters: *ref_107 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 + 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 @@ -35170,7 +35398,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' parameters: - in: path name: projectsId @@ -35182,26 +35410,60 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel: + parameters: *ref_107 + 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: metadataStoresId + name: projectsId required: true schema: type: string - in: path - name: artifactsId + name: locationsId required: true schema: type: string - in: path - name: operationsId + name: tuningJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}: + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations: parameters: *ref_107 get: - description: Retrieves a specific Artifact. - operationId: aiplatform.projects.locations.metadataStores.artifacts.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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35213,7 +35475,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -35226,23 +35488,31 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: tuningJobsId required: true schema: type: string - - in: path - name: artifactsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter 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' + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}: + parameters: *ref_107 + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35254,7 +35524,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -35267,27 +35537,29 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: tuningJobsId required: true schema: type: string - in: path - name: artifactsId + name: operationsId required: true schema: type: string - - in: query - name: updateMask - 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 + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel: + parameters: *ref_107 + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35299,7 +35571,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -35312,29 +35584,27 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: tuningJobsId required: true schema: type: string - in: path - name: artifactsId + name: operationsId required: true schema: type: string - - in: query - name: etag - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts: + /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs: parameters: *ref_107 post: - description: Creates an Artifact associated with a MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.artifacts.create + 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/GoogleCloudAiplatformV1Artifact' + $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35346,7 +35616,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' parameters: - in: path name: projectsId @@ -35358,18 +35628,9 @@ paths: required: true schema: type: string - - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: query - name: artifactId - schema: - type: string get: - description: Lists Artifacts in the MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.artifacts.list + description: Lists BatchPredictionJobs in a Location. + operationId: aiplatform.projects.locations.batchPredictionJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35382,7 +35643,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListArtifactsResponse + #/components/schemas/GoogleCloudAiplatformV1ListBatchPredictionJobsResponse parameters: - in: path name: projectsId @@ -35394,39 +35655,43 @@ paths: required: true schema: type: string - - in: path - name: metadataStoresId - required: true - schema: - type: string - in: query - name: orderBy + name: readMask schema: type: string + format: google-fieldmask - 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/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts:purge: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}:cancel: parameters: *ref_107 post: - description: Purges Artifacts. - operationId: aiplatform.projects.locations.metadataStores.artifacts.purge + 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 requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PurgeArtifactsRequest + #/components/schemas/GoogleCloudAiplatformV1CancelBatchPredictionJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35438,7 +35703,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -35451,18 +35716,17 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: batchPredictionJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}:queryArtifactLineageSubgraph: + /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}: parameters: *ref_107 - get: + delete: 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 + 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 @@ -35474,7 +35738,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -35487,38 +35751,13 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: artifactsId + name: batchPredictionJobsId 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}/operations/{operationsId}:wait: - parameters: *ref_107 - 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: Gets a BatchPredictionJob + operationId: aiplatform.projects.locations.batchPredictionJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35530,7 +35769,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' parameters: - in: path name: projectsId @@ -35543,29 +35782,18 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: operationsId + name: batchPredictionJobsId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}: parameters: *ref_107 - 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.metadataStores.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 @@ -35577,7 +35805,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -35590,7 +35818,7 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: specialistPoolsId required: true schema: type: string @@ -35599,12 +35827,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.metadataStores.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 @@ -35616,7 +35845,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -35629,7 +35858,7 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: specialistPoolsId required: true schema: type: string @@ -35638,13 +35867,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait: parameters: *ref_107 - 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.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.specialistPools.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35656,7 +35892,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -35669,24 +35905,21 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: specialistPoolsId 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}/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel: parameters: *ref_107 post: description: >- @@ -35699,7 +35932,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.metadataStores.operations.cancel + operationId: aiplatform.projects.locations.specialistPools.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35724,7 +35957,7 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: specialistPoolsId required: true schema: type: string @@ -35733,16 +35966,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores: + /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations: parameters: *ref_107 - 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' + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35754,7 +35984,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -35766,13 +35996,29 @@ paths: required: true schema: type: string + - in: path + name: specialistPoolsId + required: true + schema: + type: string - in: query - name: featurestoreId + 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}/specialistPools: + parameters: *ref_107 get: - description: Lists Featurestores in a given project and location. - operationId: aiplatform.projects.locations.featurestores.list + description: Lists SpecialistPools in a Location. + operationId: aiplatform.projects.locations.specialistPools.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35785,7 +36031,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeaturestoresResponse + #/components/schemas/GoogleCloudAiplatformV1ListSpecialistPoolsResponse parameters: - in: path name: projectsId @@ -35807,31 +36053,18 @@ paths: schema: type: string format: google-fieldmask - - in: query - name: orderBy - schema: - type: string - - in: query - name: filter - schema: - type: string - in: query name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:setIamPolicy: - parameters: *ref_107 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 + description: Creates a SpecialistPool. + operationId: aiplatform.projects.locations.specialistPools.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35843,7 +36076,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -35855,52 +36088,16 @@ paths: required: true schema: type: string - - in: path - name: featurestoresId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}: + /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}: parameters: *ref_107 - 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: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: featurestoresId - required: true - schema: - type: string patch: - description: Updates the parameters of a single Featurestore. - operationId: aiplatform.projects.locations.featurestores.patch + description: Updates a SpecialistPool. + operationId: aiplatform.projects.locations.specialistPools.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' + $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35925,7 +36122,7 @@ paths: schema: type: string - in: path - name: featurestoresId + name: specialistPoolsId required: true schema: type: string @@ -35935,10 +36132,8 @@ paths: type: string format: google-fieldmask 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 + 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 @@ -35963,7 +36158,7 @@ paths: schema: type: string - in: path - name: featurestoresId + name: specialistPoolsId required: true schema: type: string @@ -35971,13 +36166,9 @@ paths: name: force schema: type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:getIamPolicy: - parameters: *ref_107 - 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 + get: + description: Gets a SpecialistPool. + operationId: aiplatform.projects.locations.specialistPools.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35989,7 +36180,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' parameters: - in: path name: projectsId @@ -36002,25 +36193,24 @@ paths: schema: type: string - in: path - name: featurestoresId + name: specialistPoolsId required: true schema: type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:testIamPermissions: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:cancel: parameters: *ref_107 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 + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is 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 @@ -36032,7 +36222,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -36045,19 +36235,23 @@ paths: schema: type: string - in: path - name: featurestoresId + name: endpointsId required: true schema: type: string - - in: query - name: permissions + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores:searchFeatures: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}: parameters: *ref_107 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.endpoints.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36069,8 +36263,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchFeaturesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -36082,35 +36275,23 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: endpointsId + required: true schema: type: string - - in: query - name: query + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:batchReadFeatureValues: - parameters: *ref_107 - post: + delete: 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 + Deletes a long-running operation. This method indicates that the client + is no longer interested 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 @@ -36122,7 +36303,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -36135,24 +36316,22 @@ paths: schema: type: string - in: path - name: featurestoresId + name: endpointsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:cancel: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations: parameters: *ref_107 - 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.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.endpoints.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36164,7 +36343,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -36177,16 +36356,24 @@ paths: schema: type: string - in: path - name: featurestoresId + name: endpointsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:wait: + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:wait: parameters: *ref_107 post: description: >- @@ -36199,7 +36386,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.featurestores.operations.wait + operationId: aiplatform.projects.locations.endpoints.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36224,7 +36411,7 @@ paths: schema: type: string - in: path - name: featurestoresId + name: endpointsId required: true schema: type: string @@ -36238,14 +36425,16 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:countTokens: parameters: *ref_107 - 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 + post: + description: Perform a token counting. + operationId: aiplatform.projects.locations.endpoints.countTokens + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CountTokensRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36257,7 +36446,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CountTokensResponse parameters: - in: path name: projectsId @@ -36270,22 +36460,15 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: operationsId + name: endpointsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}: + parameters: *ref_107 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 + description: Deletes an Endpoint. + operationId: aiplatform.projects.locations.endpoints.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36297,7 +36480,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -36310,22 +36493,13 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: operationsId + name: endpointsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations: - parameters: *ref_107 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 + description: Gets an Endpoint. + operationId: aiplatform.projects.locations.endpoints.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36337,7 +36511,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' parameters: - in: path name: projectsId @@ -36350,33 +36524,18 @@ paths: schema: type: string - in: path - name: featurestoresId + name: endpointsId 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}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}: - parameters: *ref_107 - 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 + 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 @@ -36388,7 +36547,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' parameters: - in: path name: projectsId @@ -36401,38 +36560,43 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: endpointsId 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.featurestores.entityTypes.operations.get + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:generateContent: + parameters: *ref_107 + 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 content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse parameters: - in: path name: projectsId @@ -36445,35 +36609,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: operationsId + name: endpointsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:mutateDeployedModel: parameters: *ref_107 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 + 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 @@ -36485,7 +36639,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -36498,34 +36652,20 @@ 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: operationsId + name: endpointsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:computeTokens: parameters: *ref_107 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 + 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 @@ -36537,7 +36677,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ComputeTokensResponse parameters: - in: path name: projectsId @@ -36550,32 +36691,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: operationsId + name: endpointsId 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: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:undeployModel: parameters: *ref_107 - 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 + 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' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36587,7 +36718,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -36600,52 +36731,40 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: endpointsId 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}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features:batchCreate: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:explain: parameters: *ref_107 post: - description: Creates a batch of Features in a given EntityType. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.features.batchCreate + 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/GoogleCloudAiplatformV1BatchCreateFeaturesRequest + $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/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplainResponse' parameters: - in: path name: projectsId @@ -36658,20 +36777,15 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: endpointsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints: parameters: *ref_107 get: - description: Lists Features in a given EntityType. - operationId: aiplatform.projects.locations.featurestores.entityTypes.features.list + description: Lists Endpoints in a Location. + operationId: aiplatform.projects.locations.endpoints.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36684,7 +36798,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeaturesResponse + #/components/schemas/GoogleCloudAiplatformV1ListEndpointsResponse parameters: - in: path name: projectsId @@ -36696,16 +36810,6 @@ 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: pageToken schema: @@ -36715,32 +36819,27 @@ paths: schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + name: readMask schema: type: string + format: google-fieldmask - in: query - name: latestStatsCount + name: pageSize schema: type: integer format: int32 - in: query - name: readMask + name: filter schema: type: string - format: google-fieldmask post: - description: Creates a new Feature in a given EntityType. - operationId: aiplatform.projects.locations.featurestores.entityTypes.features.create + description: Creates an Endpoint. + operationId: aiplatform.projects.locations.endpoints.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36764,37 +36863,39 @@ 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: featureId + name: endpointId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directPredict: parameters: *ref_107 - delete: - description: Deletes a single Feature. - operationId: aiplatform.projects.locations.featurestores.entityTypes.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 @@ -36807,81 +36908,83 @@ 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: endpointsId required: true schema: type: string - get: - description: Gets details of a single Feature. - operationId: aiplatform.projects.locations.featurestores.entityTypes.features.get + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:serverStreamingPredict: + parameters: *ref_107 + 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/GoogleCloudAiplatformV1Feature' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StreamingPredictResponse + 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: endpointsId required: true schema: type: string - patch: - description: Updates the parameters of a single Feature. - operationId: aiplatform.projects.locations.featurestores.entityTypes.features.patch + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamRawPredict: + parameters: *ref_107 + 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/GoogleCloudAiplatformV1Feature' + $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/GoogleCloudAiplatformV1Feature' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: projectsId @@ -36894,40 +36997,20 @@ 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: endpointsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:deployModel: parameters: *ref_107 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 + 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 @@ -36952,50 +37035,41 @@ 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 - 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}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:rawPredict: parameters: *ref_107 - 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.features.operations.list + 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/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: projectsId @@ -37008,55 +37082,36 @@ 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: 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}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predict: parameters: *ref_107 - 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 + 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/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictResponse' parameters: - in: path name: projectsId @@ -37069,44 +37124,40 @@ 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 - required: true - schema: - type: string - - in: path - name: operationsId + name: endpointsId required: true schema: type: string - get: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directRawPredict: + parameters: *ref_107 + 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 + 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 content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DirectRawPredictResponse parameters: - in: path name: projectsId @@ -37119,52 +37170,38 @@ 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 - required: true - schema: - type: string - - in: path - name: operationsId + name: endpointsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamGenerateContent: parameters: *ref_107 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 + 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 @@ -37177,51 +37214,21 @@ 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 - required: true - schema: - type: string - - in: path - name: operationsId + name: endpointsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:importFeatureValues: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:upgrade: parameters: *ref_107 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 + description: Upgrades a NotebookRuntime. + operationId: aiplatform.projects.locations.notebookRuntimes.upgrade requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ImportFeatureValuesRequest + #/components/schemas/GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37246,35 +37253,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 - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:deleteFeatureValues: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}: parameters: *ref_107 - 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 + delete: + description: Deletes a NotebookRuntime. + operationId: aiplatform.projects.locations.notebookRuntimes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37299,27 +37286,13 @@ 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}:exportFeatureValues: - parameters: *ref_107 - 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 + get: + description: Gets a NotebookRuntime. + operationId: aiplatform.projects.locations.notebookRuntimes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37331,7 +37304,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookRuntime' parameters: - in: path name: projectsId @@ -37344,30 +37317,24 @@ 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}:readFeatureValues: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes:assign: parameters: *ref_107 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 + 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/GoogleCloudAiplatformV1ReadFeatureValuesRequest + #/components/schemas/GoogleCloudAiplatformV1AssignNotebookRuntimeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37379,8 +37346,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -37392,26 +37358,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: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:start: parameters: *ref_107 post: - description: Creates a new EntityType in a given Featurestore. - operationId: aiplatform.projects.locations.featurestores.entityTypes.create + description: Starts a NotebookRuntime. + operationId: aiplatform.projects.locations.notebookRuntimes.start requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StartNotebookRuntimeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37436,17 +37393,15 @@ paths: schema: type: string - in: path - name: featurestoresId + name: notebookRuntimesId required: true schema: type: string - - in: query - name: entityTypeId - schema: - type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes: + parameters: *ref_107 get: - description: Lists EntityTypes in a given Featurestore. - operationId: aiplatform.projects.locations.featurestores.entityTypes.list + description: Lists NotebookRuntimes in a Location. + operationId: aiplatform.projects.locations.notebookRuntimes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37459,7 +37414,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListEntityTypesResponse + #/components/schemas/GoogleCloudAiplatformV1ListNotebookRuntimesResponse parameters: - in: path name: projectsId @@ -37471,47 +37426,85 @@ paths: required: true schema: type: string - - in: path - name: featurestoresId - required: true - 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 - in: query name: pageToken schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/customJobs: + parameters: *ref_107 + get: + description: Lists CustomJobs in a Location. + operationId: aiplatform.projects.locations.customJobs.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/GoogleCloudAiplatformV1ListCustomJobsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + 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: orderBy + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:streamingReadFeatureValues: - parameters: *ref_107 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 + 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/GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37523,8 +37516,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' parameters: - in: path name: projectsId @@ -37536,23 +37528,58 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}:cancel: + parameters: *ref_107 + 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 + 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: featurestoresId + name: locationsId required: true schema: type: string - in: path - name: entityTypesId + name: customJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}: + /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}: parameters: *ref_107 - 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 + get: + description: Gets a CustomJob. + operationId: aiplatform.projects.locations.customJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37564,7 +37591,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' parameters: - in: path name: projectsId @@ -37577,27 +37604,13 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: customJobsId required: true schema: type: string - - in: query - name: force - 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' + delete: + description: Deletes a CustomJob. + operationId: aiplatform.projects.locations.customJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37609,7 +37622,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -37622,23 +37635,19 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: customJobsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: Gets details of a single EntityType. - operationId: aiplatform.projects.locations.featurestores.entityTypes.get + /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}: + parameters: *ref_107 + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37650,7 +37659,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -37663,22 +37672,21 @@ paths: schema: type: string - in: path - name: featurestoresId + name: customJobsId 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}:getIamPolicy: - parameters: *ref_107 - 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 + Gets the latest 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 @@ -37690,7 +37698,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -37703,33 +37711,29 @@ paths: schema: type: string - in: path - name: featurestoresId + name: customJobsId required: true schema: type: string - in: path - name: entityTypesId + name: operationsId required: true schema: type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:setIamPolicy: + /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:wait: parameters: *ref_107 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' + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It 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 @@ -37741,7 +37745,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -37754,31 +37758,34 @@ paths: schema: type: string - in: path - name: featurestoresId + name: customJobsId 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}:writeFeatureValues: + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:cancel: parameters: *ref_107 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 - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteFeatureValuesRequest + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is 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 @@ -37790,8 +37797,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteFeatureValuesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -37804,26 +37810,22 @@ paths: schema: type: string - in: path - name: featurestoresId + name: customJobsId 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}/customJobs/{customJobsId}/operations: parameters: *ref_107 - 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 + 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 @@ -37835,7 +37837,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -37848,26 +37850,32 @@ paths: schema: type: string - in: path - name: featurestoresId + name: customJobsId required: true schema: type: string - - in: path - name: entityTypesId - required: true + - in: query + name: pageToken schema: type: string - in: query - name: permissions + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}: parameters: *ref_107 - 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.customJobs.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.migratableResources.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37879,7 +37887,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -37892,37 +37900,21 @@ paths: schema: type: string - in: path - name: customJobsId + name: migratableResourcesId 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}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:cancel: - parameters: *ref_107 - 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.customJobs.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.migratableResources.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37934,7 +37926,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -37947,7 +37939,7 @@ paths: schema: type: string - in: path - name: customJobsId + name: migratableResourcesId required: true schema: type: string @@ -37956,15 +37948,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel: parameters: *ref_107 - 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.customJobs.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.migratableResources.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37989,7 +37986,7 @@ paths: schema: type: string - in: path - name: customJobsId + name: migratableResourcesId required: true schema: type: string @@ -37998,12 +37995,13 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations: + parameters: *ref_107 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 + 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 @@ -38015,7 +38013,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -38028,16 +38026,24 @@ paths: schema: type: string - in: path - name: customJobsId + name: migratableResourcesId required: true 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}:wait: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait: parameters: *ref_107 post: description: >- @@ -38050,7 +38056,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.migratableResources.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38075,7 +38081,7 @@ paths: schema: type: string - in: path - name: customJobsId + name: migratableResourcesId required: true schema: type: string @@ -38089,18 +38095,20 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/customJobs: + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources:search: parameters: *ref_107 post: description: >- - Creates a CustomJob. A created CustomJob right away will be attempted to - be run. - operationId: aiplatform.projects.locations.customJobs.create + 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/GoogleCloudAiplatformV1CustomJob' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchMigratableResourcesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38112,7 +38120,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchMigratableResourcesResponse parameters: - in: path name: projectsId @@ -38124,9 +38133,19 @@ paths: required: true schema: type: string - get: - description: Lists CustomJobs in a Location. - operationId: aiplatform.projects.locations.customJobs.list + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources:batchMigrate: + parameters: *ref_107 + 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/GoogleCloudAiplatformV1BatchMigrateResourcesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38138,8 +38157,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListCustomJobsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -38151,29 +38169,13 @@ 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 - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}: + /v1/projects/{projectsId}/locations/{locationsId}/operations: parameters: *ref_107 - delete: - description: Deletes a CustomJob. - operationId: aiplatform.projects.locations.customJobs.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.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38185,7 +38187,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -38197,14 +38199,28 @@ paths: required: true schema: type: string - - in: path - name: customJobsId - required: true + - in: query + name: filter schema: type: string - get: - description: Gets a CustomJob. - operationId: aiplatform.projects.locations.customJobs.get + - 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_107 + 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 @@ -38216,7 +38232,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -38229,29 +38245,16 @@ paths: schema: type: string - in: path - name: customJobsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}:cancel: - parameters: *ref_107 - 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 + Gets the latest 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 @@ -38263,7 +38266,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -38276,15 +38279,24 @@ paths: schema: type: string - in: path - name: customJobsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes: + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait: parameters: *ref_107 - get: - description: Lists NotebookRuntimes in a Location. - operationId: aiplatform.projects.locations.notebookRuntimes.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.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38296,8 +38308,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListNotebookRuntimesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -38309,39 +38320,30 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: readMask + - in: path + name: operationsId + required: true schema: type: string - format: google-fieldmask - in: query - name: orderBy + name: timeout schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:start: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: parameters: *ref_107 post: - description: Starts a NotebookRuntime. - operationId: aiplatform.projects.locations.notebookRuntimes.start - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StartNotebookRuntimeRequest + 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 @@ -38353,7 +38355,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -38366,21 +38368,15 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:upgrade: + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}: parameters: *ref_107 - post: - description: Upgrades a NotebookRuntime. - operationId: aiplatform.projects.locations.notebookRuntimes.upgrade - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest + delete: + description: Deletes a single Feature. + operationId: aiplatform.projects.locations.featureGroups.features.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38405,24 +38401,18 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: featureGroupsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes:assign: - parameters: *ref_107 - 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 - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AssignNotebookRuntimeRequest + - 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 @@ -38434,7 +38424,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' parameters: - in: path name: projectsId @@ -38446,11 +38436,24 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}: - parameters: *ref_107 - delete: - description: Deletes a NotebookRuntime. - operationId: aiplatform.projects.locations.notebookRuntimes.delete + - in: path + name: featureGroupsId + required: true + schema: + type: string + - 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/GoogleCloudAiplatformV1Feature' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38475,13 +38478,30 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: featureGroupsId required: true schema: type: string - get: - description: Gets a NotebookRuntime. - operationId: aiplatform.projects.locations.notebookRuntimes.get + - 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_107 + 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 @@ -38493,7 +38513,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookRuntime' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -38506,18 +38526,17 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: featureGroupsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}: - parameters: *ref_107 + - in: query + name: featureId + 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.deploymentResourcePools.operations.get + description: Lists Features in a given FeatureGroup. + operationId: aiplatform.projects.locations.featureGroups.features.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38529,7 +38548,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListFeaturesResponse parameters: - in: path name: projectsId @@ -38542,22 +38562,46 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: featureGroupsId required: true schema: type: string - - in: path - name: operationsId - required: true + - 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 + schema: + type: string + - in: query + name: latestStatsCount + schema: + type: integer + format: int32 + - in: query + name: readMask schema: type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}: + parameters: *ref_107 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 + operationId: aiplatform.projects.locations.featureGroups.features.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38582,7 +38626,12 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: featureGroupsId + required: true + schema: + type: string + - in: path + name: featuresId required: true schema: type: string @@ -38591,20 +38640,12 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel: - parameters: *ref_107 - 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.deploymentResourcePools.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.featureGroups.features.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38616,7 +38657,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -38629,7 +38670,12 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: featureGroupsId + required: true + schema: + type: string + - in: path + name: featuresId required: true schema: type: string @@ -38638,13 +38684,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait: parameters: *ref_107 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 + operationId: aiplatform.projects.locations.featureGroups.features.operations.listWait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38669,25 +38715,33 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: featureGroupsId required: true schema: type: string - - in: query - name: filter + - 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 - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:wait: - parameters: *ref_107 post: description: >- Waits until the specified long-running operation is done or reaches at @@ -38699,7 +38753,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.deploymentResourcePools.operations.wait + operationId: aiplatform.projects.locations.featureGroups.features.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38724,7 +38778,12 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: featureGroupsId + required: true + schema: + type: string + - in: path + name: featuresId required: true schema: type: string @@ -38738,14 +38797,14 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}:queryDeployedModels: + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}: parameters: *ref_107 get: description: >- - List DeployedModels that have been deployed on this - DeploymentResourcePool. - operationId: >- - aiplatform.projects.locations.deploymentResourcePools.queryDeployedModels + Gets the latest 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 @@ -38757,8 +38816,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QueryDeployedModelsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -38771,24 +38829,22 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: featureGroupsId 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_107 - 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.featureGroups.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38800,8 +38856,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -38813,24 +38868,23 @@ 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: Create a DeploymentResourcePool. - operationId: aiplatform.projects.locations.deploymentResourcePools.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait: + parameters: *ref_107 + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38842,7 +38896,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -38854,11 +38908,41 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}: - parameters: *ref_107 - delete: - description: Delete a DeploymentResourcePool. - operationId: aiplatform.projects.locations.deploymentResourcePools.delete + - in: path + name: featureGroupsId + required: true + schema: + type: string + - in: path + 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 + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38883,13 +38967,25 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: featureGroupsId + 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}/featureGroups/{featureGroupsId}: + parameters: *ref_107 get: - description: Get a DeploymentResourcePool. - operationId: aiplatform.projects.locations.deploymentResourcePools.get + description: Gets details of a single FeatureGroup. + operationId: aiplatform.projects.locations.featureGroups.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38901,8 +38997,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' parameters: - in: path name: projectsId @@ -38915,25 +39010,18 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: featureGroupsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkTrialEarlyStoppingState: - parameters: *ref_107 - 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 + patch: + description: Updates the parameters of a single FeatureGroup. + operationId: aiplatform.projects.locations.featureGroups.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38958,25 +39046,18 @@ paths: schema: type: string - in: path - name: studiesId + name: featureGroupsId 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}:stop: - parameters: *ref_107 - post: - description: Stops a Trial. - operationId: aiplatform.projects.locations.studies.trials.stop - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StopTrialRequest' + format: google-fieldmask + delete: + description: Deletes a single FeatureGroup. + operationId: aiplatform.projects.locations.featureGroups.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38988,7 +39069,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -39001,20 +39082,19 @@ paths: schema: type: string - in: path - name: studiesId + name: featureGroupsId required: true schema: type: string - - in: path - name: trialsId - required: true + - in: query + name: force schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups: parameters: *ref_107 get: - description: Lists the Trials associated with a Study. - operationId: aiplatform.projects.locations.studies.trials.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 @@ -39026,7 +39106,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ListTrialsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListFeatureGroupsResponse parameters: - in: path name: projectsId @@ -39038,13 +39119,16 @@ paths: required: true schema: type: string - - in: path - name: studiesId - required: true + - in: query + name: pageToken schema: type: string - in: query - name: pageToken + name: orderBy + schema: + type: string + - in: query + name: filter schema: type: string - in: query @@ -39053,13 +39137,13 @@ paths: type: integer format: int32 post: - description: Adds a user provided Trial to a Study. - operationId: aiplatform.projects.locations.studies.trials.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/GoogleCloudAiplatformV1Trial' + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39071,7 +39155,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -39083,25 +39167,15 @@ paths: required: true schema: type: string - - in: path - name: studiesId - required: true + - in: query + name: featureGroupId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials: + /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails: parameters: *ref_107 - 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 + get: + description: List top NasTrialDetails of a NasJob. + operationId: aiplatform.projects.locations.nasJobs.nasTrialDetails.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39114,7 +39188,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListOptimalTrialsResponse + #/components/schemas/GoogleCloudAiplatformV1ListNasTrialDetailsResponse parameters: - in: path name: projectsId @@ -39127,65 +39201,24 @@ paths: schema: type: string - in: path - name: studiesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest: - parameters: *ref_107 - 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' - security: - - Oauth2: - - https://www.googleapis.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: nasJobsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: studiesId - required: true + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addTrialMeasurement: + /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails/{nasTrialDetailsId}: parameters: *ref_107 - 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 + get: + description: Gets a NasTrialDetail. + operationId: aiplatform.projects.locations.nasJobs.nasTrialDetails.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39197,7 +39230,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrialDetail' parameters: - in: path name: projectsId @@ -39210,20 +39243,20 @@ paths: schema: type: string - in: path - name: studiesId + name: nasJobsId required: true schema: type: string - in: path - name: trialsId + name: nasTrialDetailsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}: + /v1/projects/{projectsId}/locations/{locationsId}/nasJobs: parameters: *ref_107 - delete: - description: Deletes a Trial. - operationId: aiplatform.projects.locations.studies.trials.delete + get: + description: Lists NasJobs in a Location. + operationId: aiplatform.projects.locations.nasJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39235,7 +39268,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListNasJobsResponse parameters: - in: path name: projectsId @@ -39247,19 +39281,32 @@ paths: required: true schema: type: string - - in: path - name: studiesId - required: true + - in: query + name: filter schema: type: string - - in: path - name: trialsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: readMask schema: type: string - get: - description: Gets a Trial. - operationId: aiplatform.projects.locations.studies.trials.get + format: google-fieldmask + - in: query + name: pageToken + schema: + type: string + 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 @@ -39271,7 +39318,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' parameters: - in: path name: projectsId @@ -39283,38 +39330,27 @@ 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}:complete: + /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}: parameters: *ref_107 - 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 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/GoogleCloudAiplatformV1Trial' + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' parameters: - in: path name: projectsId @@ -39327,23 +39363,13 @@ paths: schema: type: string - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: trialsId + name: nasJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}: - parameters: *ref_107 - 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 + delete: + description: Deletes a NasJob. + operationId: aiplatform.projects.locations.nasJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39368,27 +39394,28 @@ 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: nasJobsId required: true schema: type: string - delete: + /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}:cancel: + parameters: *ref_107 + 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.trials.operations.delete + 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 @@ -39413,34 +39440,20 @@ 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: nasJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:export: parameters: *ref_107 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 + 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 @@ -39452,7 +39465,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -39465,27 +39478,15 @@ 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: datasetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:searchDataItems: parameters: *ref_107 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 + description: Searches DataItems in a Dataset. + operationId: aiplatform.projects.locations.datasets.searchDataItems security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39497,7 +39498,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchDataItemsResponse parameters: - in: path name: projectsId @@ -39510,17 +39512,16 @@ paths: schema: type: string - in: path - name: studiesId + name: datasetsId required: true schema: type: string - - in: path - name: trialsId - required: true + - in: query + name: pageToken schema: type: string - in: query - name: filter + name: annotationsFilter schema: type: string - in: query @@ -39529,23 +39530,57 @@ paths: type: integer format: int32 - in: query - name: pageToken + name: savedQuery schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait: + - in: query + name: orderByAnnotation.savedQuery + schema: + type: string + - in: query + name: dataItemFilter + schema: + type: string + - in: query + name: orderByDataItem + schema: + type: string + - in: query + name: annotationsLimit + schema: + type: integer + format: int32 + - in: query + name: fieldMask + schema: + type: string + format: google-fieldmask + - in: query + name: orderByAnnotation.orderBy + schema: + type: string + - in: query + name: dataLabelingJob + schema: + type: string + - in: query + name: annotationFilters + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets: parameters: *ref_107 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 + 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 @@ -39569,40 +39604,60 @@ paths: 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: studiesId + name: projectsId required: true schema: type: string - in: path - name: trialsId + name: locationsId required: true 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}/studies/{studiesId}/operations/{operationsId}:cancel: + - 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}/datasets/{datasetsId}: parameters: *ref_107 - 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.operations.cancel + delete: + description: Deletes a Dataset. + operationId: aiplatform.projects.locations.datasets.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39614,7 +39669,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -39627,23 +39682,13 @@ paths: schema: type: string - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: operationsId + name: datasetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}: - parameters: *ref_107 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 + description: Gets a Dataset. + operationId: aiplatform.projects.locations.datasets.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39655,7 +39700,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' parameters: - in: path name: projectsId @@ -39668,22 +39713,23 @@ paths: schema: type: string - in: path - name: studiesId + name: datasetsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: readMask 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 + 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 @@ -39695,7 +39741,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' parameters: - in: path name: projectsId @@ -39708,29 +39754,25 @@ paths: schema: type: string - in: path - name: studiesId + name: datasetsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:wait: + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:import: parameters: *ref_107 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 + 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 @@ -39755,27 +39797,17 @@ paths: schema: type: string - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: operationsId + name: datasetsId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations: parameters: *ref_107 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 + operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39800,12 +39832,13 @@ paths: schema: type: string - in: path - name: studiesId + name: datasetsId required: true schema: type: string - - in: query - name: filter + - in: path + name: annotationSpecsId + required: true schema: type: string - in: query @@ -39817,11 +39850,24 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}: + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:cancel: parameters: *ref_107 - get: - description: Gets a Study by name. - operationId: aiplatform.projects.locations.studies.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.annotationSpecs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39833,7 +39879,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -39846,53 +39892,34 @@ paths: schema: type: string - in: path - name: studiesId - required: true - schema: - type: string - 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 - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - 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: studiesId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait: parameters: *ref_107 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' + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It 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 @@ -39904,7 +39931,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -39916,54 +39943,35 @@ paths: required: true schema: type: string - get: - 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 - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListStudiesResponse - parameters: - in: path - name: projectsId + name: datasetsId required: true schema: type: string - in: path - name: locationsId + name: annotationSpecsId required: true schema: type: string - - in: query - name: pageToken + - 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}/studies:lookup: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}: parameters: *ref_107 - post: + delete: 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' + Deletes a long-running operation. This method indicates that the client + is no longer interested 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 @@ -39975,7 +39983,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -39987,11 +39995,27 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}: - parameters: *ref_107 + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: annotationSpecsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string get: - description: Gets a TuningJob. - operationId: aiplatform.projects.locations.tuningJobs.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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40003,7 +40027,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -40016,48 +40040,25 @@ paths: schema: type: string - in: path - name: tuningJobsId + name: datasetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs: - parameters: *ref_107 - 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 - 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 + name: annotationSpecsId required: true schema: type: string - in: path - name: locationsId + name: operationsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}: + parameters: *ref_107 get: - description: Lists TuningJobs in a Location. - operationId: aiplatform.projects.locations.tuningJobs.list + description: Gets an AnnotationSpec. + operationId: aiplatform.projects.locations.datasets.annotationSpecs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40069,8 +40070,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListTuningJobsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1AnnotationSpec' parameters: - in: path name: projectsId @@ -40082,38 +40082,26 @@ paths: required: true schema: type: string - - in: query - name: filter + - in: path + name: datasetsId + required: true schema: type: string - - in: query - name: pageSize + - in: path + name: annotationSpecsId + required: true schema: - type: integer - format: int32 + type: string - in: query - name: pageToken + name: readMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel: + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}: parameters: *ref_107 - 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 + delete: + description: Deletes a Dataset version. + operationId: aiplatform.projects.locations.datasets.datasetVersions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40125,7 +40113,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -40138,18 +40126,18 @@ paths: schema: type: string - in: path - name: tuningJobsId + name: datasetsId + required: true + schema: + type: string + - in: path + name: datasetVersionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}: - parameters: *ref_107 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 Dataset version. + operationId: aiplatform.projects.locations.datasets.datasetVersions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40161,7 +40149,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' parameters: - in: path name: projectsId @@ -40174,29 +40162,28 @@ paths: schema: type: string - in: path - name: tuningJobsId + 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/{operationsId}:cancel: - parameters: *ref_107 - 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 + - 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 @@ -40208,7 +40195,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' parameters: - in: path name: projectsId @@ -40221,22 +40208,25 @@ paths: schema: type: string - in: path - name: tuningJobsId + 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: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions: parameters: *ref_107 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 + description: Lists DatasetVersions in a Dataset. + operationId: aiplatform.projects.locations.datasets.datasetVersions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40248,7 +40238,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListDatasetVersionsResponse parameters: - in: path name: projectsId @@ -40261,10 +40252,19 @@ paths: schema: type: string - in: path - name: tuningJobsId + name: datasetsId required: true schema: type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: orderBy + schema: + type: string - in: query name: filter schema: @@ -40278,15 +40278,14 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}: - parameters: *ref_107 - 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 + post: + description: Create a version from a Dataset. + operationId: aiplatform.projects.locations.datasets.datasetVersions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40298,7 +40297,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -40311,21 +40310,15 @@ paths: schema: type: string - in: path - name: migratableResourcesId - required: true - schema: - type: string - - in: path - name: operationsId + name: datasetsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore: + parameters: *ref_107 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 + description: Restores a dataset version. + operationId: aiplatform.projects.locations.datasets.datasetVersions.restore security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40350,29 +40343,24 @@ 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/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}: parameters: *ref_107 - 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.migratableResources.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.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40397,7 +40385,7 @@ paths: schema: type: string - in: path - name: migratableResourcesId + name: datasetsId required: true schema: type: string @@ -40406,13 +40394,12 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations: - parameters: *ref_107 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 + Gets the latest 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 @@ -40424,7 +40411,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -40437,24 +40424,16 @@ paths: schema: type: string - in: path - name: migratableResourcesId + name: datasetsId 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}/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:wait: parameters: *ref_107 post: description: >- @@ -40467,7 +40446,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.datasets.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40492,7 +40471,7 @@ paths: schema: type: string - in: path - name: migratableResourcesId + name: datasetsId required: true schema: type: string @@ -40506,19 +40485,13 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/migratableResources:batchMigrate: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations: parameters: *ref_107 - post: + get: 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/GoogleCloudAiplatformV1BatchMigrateResourcesRequest + 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 @@ -40530,7 +40503,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -40542,20 +40515,38 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/migratableResources:search: + - in: path + name: datasetsId + 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}/operations/{operationsId}:cancel: parameters: *ref_107 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 + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is 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 @@ -40567,8 +40558,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchMigratableResourcesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -40580,14 +40570,31 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + - in: path + name: datasetsId + required: true + schema: + type: string + - 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_107 - 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.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.dataItems.annotations.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40611,18 +40618,41 @@ paths: 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 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/{operationsId}: + parameters: *ref_107 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 + operationId: >- + aiplatform.projects.locations.datasets.dataItems.annotations.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40646,25 +40676,33 @@ paths: 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 required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait: - parameters: *ref_107 - 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.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.dataItems.annotations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40689,16 +40727,26 @@ paths: schema: type: string - in: path - name: operationsId + name: datasetsId required: true schema: type: string - - in: query - name: timeout + - in: path + name: dataItemsId + required: true schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + - 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}/annotations/{annotationsId}/operations/{operationsId}:cancel: parameters: *ref_107 post: description: >- @@ -40711,7 +40759,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.operations.cancel + operationId: >- + aiplatform.projects.locations.datasets.dataItems.annotations.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40735,18 +40784,34 @@ paths: 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 required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations: parameters: *ref_107 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 + operationId: >- + aiplatform.projects.locations.datasets.dataItems.annotations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40770,73 +40835,39 @@ 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}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:testIamPermissions: - parameters: *ref_107 - 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 - 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: projectsId + name: datasetsId required: true schema: type: string - in: path - name: locationsId + name: dataItemsId required: true schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: annotationsId required: true schema: type: string - in: query - name: permissions + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}: - parameters: *ref_107 - patch: - description: Updates a NotebookRuntimeTemplate. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations: + parameters: *ref_107 + get: + description: Lists Annotations belongs to a dataitem + operationId: aiplatform.projects.locations.datasets.dataItems.annotations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40849,7 +40880,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate + #/components/schemas/GoogleCloudAiplatformV1ListAnnotationsResponse parameters: - in: path name: projectsId @@ -40862,18 +40893,44 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: datasetsId + required: true + schema: + type: string + - in: path + name: dataItemsId required: true schema: type: string - in: query - name: updateMask + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: readMask schema: type: string format: google-fieldmask + - 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}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations: + parameters: *ref_107 get: - description: Gets a NotebookRuntimeTemplate. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40885,8 +40942,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -40899,13 +40955,42 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: datasetsId required: true schema: type: string - delete: - description: Deletes a NotebookRuntimeTemplate. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.delete + - in: path + name: dataItemsId + 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}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel: + parameters: *ref_107 + 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 @@ -40917,7 +41002,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -40930,15 +41015,29 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: datasetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates: + - in: path + name: dataItemsId + 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}: parameters: *ref_107 - get: - description: Lists NotebookRuntimeTemplates in a Location. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.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.datasets.dataItems.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40950,8 +41049,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -40963,37 +41061,27 @@ paths: 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: orderBy + - in: path + name: datasetsId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: dataItemsId + required: true schema: type: string - - in: query - name: filter + - in: path + name: operationsId + 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 + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41017,17 +41105,35 @@ paths: required: true schema: type: string - - in: query - name: notebookRuntimeTemplateId + - in: path + name: datasetsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:getIamPolicy: + - in: path + name: dataItemsId + 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}:wait: parameters: *ref_107 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 + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It 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 @@ -41039,7 +41145,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -41052,28 +41158,30 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: datasetsId + required: true + schema: + type: string + - in: path + name: dataItemsId + 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}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:setIamPolicy: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems: parameters: *ref_107 - 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' + get: + description: Lists DataItems in a Dataset. + operationId: aiplatform.projects.locations.datasets.dataItems.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41085,7 +41193,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListDataItemsResponse parameters: - in: path name: projectsId @@ -41098,24 +41207,37 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: datasetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:wait: + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy + 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}/datasets/{datasetsId}/savedQueries/{savedQueriesId}: parameters: *ref_107 - 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 + delete: + description: Deletes a SavedQuery. + operationId: aiplatform.projects.locations.datasets.savedQueries.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41140,34 +41262,20 @@ paths: schema: type: string - in: path - name: schedulesId + name: datasetsId required: true schema: type: string - in: path - name: operationsId + name: savedQueriesId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries: parameters: *ref_107 - 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 + get: + description: Lists SavedQueries in a Dataset. + operationId: aiplatform.projects.locations.datasets.savedQueries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41179,7 +41287,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListSavedQueriesResponse parameters: - in: path name: projectsId @@ -41192,16 +41301,33 @@ paths: schema: type: string - in: path - name: schedulesId + name: datasetsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: orderBy schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}: + - 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 + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}: parameters: *ref_107 delete: description: >- @@ -41209,7 +41335,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.schedules.operations.delete + operationId: aiplatform.projects.locations.datasets.savedQueries.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41234,7 +41360,12 @@ paths: schema: type: string - in: path - name: schedulesId + name: datasetsId + required: true + schema: + type: string + - in: path + name: savedQueriesId required: true schema: type: string @@ -41248,7 +41379,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.schedules.operations.get + operationId: aiplatform.projects.locations.datasets.savedQueries.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41273,7 +41404,12 @@ paths: schema: type: string - in: path - name: schedulesId + name: datasetsId + required: true + schema: + type: string + - in: path + name: savedQueriesId required: true schema: type: string @@ -41282,13 +41418,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel: parameters: *ref_107 - 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.schedules.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.datasets.savedQueries.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41300,7 +41443,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -41313,28 +41456,27 @@ paths: schema: type: string - in: path - name: schedulesId + name: datasetsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: savedQueriesId + required: true 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}/schedules: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations: parameters: *ref_107 get: - description: Lists Schedules in a Location. - operationId: aiplatform.projects.locations.schedules.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.datasets.savedQueries.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41346,8 +41488,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListSchedulesResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -41359,12 +41500,14 @@ paths: required: true schema: type: string - - in: query - name: orderBy + - in: path + name: datasetsId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: savedQueriesId + required: true schema: type: string - in: query @@ -41376,14 +41519,24 @@ paths: name: filter schema: type: string + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait: + parameters: *ref_107 post: - description: Creates a Schedule. - operationId: aiplatform.projects.locations.schedules.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41395,7 +41548,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -41407,21 +41560,31 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}: + - 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}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}: parameters: *ref_107 - patch: - 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' + delete: + description: Deletes a ModelDeploymentMonitoringJob. + operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41433,7 +41596,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -41446,18 +41609,13 @@ paths: schema: type: string - in: path - name: schedulesId + name: modelDeploymentMonitoringJobsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a Schedule. - operationId: aiplatform.projects.locations.schedules.delete + get: + description: Gets a ModelDeploymentMonitoringJob. + operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41469,7 +41627,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob parameters: - in: path name: projectsId @@ -41482,13 +41641,19 @@ paths: schema: type: string - in: path - name: schedulesId + name: modelDeploymentMonitoringJobsId required: true schema: type: string - get: - description: Gets a Schedule. - operationId: aiplatform.projects.locations.schedules.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 @@ -41500,7 +41665,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -41513,23 +41678,29 @@ paths: schema: type: string - in: path - name: schedulesId + name: modelDeploymentMonitoringJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:pause: parameters: *ref_107 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 + 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/GoogleCloudAiplatformV1PauseScheduleRequest' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41554,27 +41725,23 @@ paths: schema: type: string - in: path - name: schedulesId + name: modelDeploymentMonitoringJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:resume: + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs: parameters: *ref_107 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 + 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/GoogleCloudAiplatformV1ResumeScheduleRequest + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41586,7 +41753,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob parameters: - in: path name: projectsId @@ -41598,18 +41766,9 @@ paths: required: true schema: type: string - - in: path - name: schedulesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}: - parameters: *ref_107 - delete: - description: >- - Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not - contain any FeatureViews. - operationId: aiplatform.projects.locations.featureOnlineStores.delete + get: + description: Lists ModelDeploymentMonitoringJobs in a Location. + operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41621,7 +41780,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse parameters: - in: path name: projectsId @@ -41633,18 +41793,38 @@ paths: required: true schema: type: string - - in: path - name: featureOnlineStoresId - required: true + - in: query + name: readMask schema: type: string + format: google-fieldmask - in: query - name: force + name: filter schema: - type: boolean - get: - description: Gets details of a single FeatureOnlineStore. - operationId: aiplatform.projects.locations.featureOnlineStores.get + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:searchModelDeploymentMonitoringStatsAnomalies: + parameters: *ref_107 + 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 @@ -41656,7 +41836,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse parameters: - in: path name: projectsId @@ -41669,18 +41850,24 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: modelDeploymentMonitoringJobsId required: true schema: type: string - patch: - description: Updates the parameters of a single FeatureOnlineStore. - operationId: aiplatform.projects.locations.featureOnlineStores.patch + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:resume: + parameters: *ref_107 + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41692,7 +41879,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -41705,25 +41892,25 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: modelDeploymentMonitoringJobsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores: + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait: parameters: *ref_107 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' + 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 @@ -41747,13 +41934,36 @@ paths: required: true schema: type: string + - in: path + name: modelDeploymentMonitoringJobsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string - in: query - name: featureOnlineStoreId + name: timeout schema: type: string - get: - description: Lists FeatureOnlineStores in a given project and location. - operationId: aiplatform.projects.locations.featureOnlineStores.list + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel: + parameters: *ref_107 + 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 @@ -41765,8 +41975,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -41778,31 +41987,24 @@ paths: required: true schema: type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: modelDeploymentMonitoringJobsId + 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}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations: parameters: *ref_107 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 + aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41827,18 +42029,12 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId - required: true - schema: - type: string - - in: path - name: featureViewsId + name: modelDeploymentMonitoringJobsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageToken schema: type: string - in: query @@ -41850,23 +42046,16 @@ paths: schema: type: integer format: int32 - - in: query - name: pageToken - schema: - type: string - post: + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}: + parameters: *ref_107 + 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. + Deletes a long-running operation. This method indicates that the client + is no longer interested 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.wait + aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41878,7 +42067,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -41891,12 +42080,7 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId - required: true - schema: - type: string - - in: path - name: featureViewsId + name: modelDeploymentMonitoringJobsId required: true schema: type: string @@ -41905,20 +42089,13 @@ paths: required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}: - parameters: *ref_107 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 + aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41943,12 +42120,7 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId - required: true - schema: - type: string - - in: path - name: featureViewsId + name: modelDeploymentMonitoringJobsId required: true schema: type: string @@ -41957,14 +42129,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.featureOnlineStores.featureViews.operations.delete + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews: + parameters: *ref_107 + 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 @@ -41976,7 +42150,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -41993,22 +42167,17 @@ paths: required: true schema: type: string - - in: path - name: featureViewsId - 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}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs/{featureViewSyncsId}: - parameters: *ref_107 + type: boolean get: - description: Gets details of a single FeatureViewSync. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.get + description: Lists FeatureViews in a given FeatureOnlineStore. + operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42020,7 +42189,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewSync' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListFeatureViewsResponse parameters: - in: path name: projectsId @@ -42037,22 +42207,38 @@ paths: required: true schema: type: string - - in: path - name: featureViewsId - required: true + - in: query + name: orderBy schema: type: string - - in: path - name: featureViewSyncsId - required: true + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs: + - 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}:searchNearestEntities: parameters: *ref_107 - get: - description: Lists FeatureViewSyncs in a given FeatureView. + 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. operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.list + aiplatform.projects.locations.featureOnlineStores.featureViews.searchNearestEntities + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchNearestEntitiesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42065,7 +42251,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeatureViewSyncsResponse + #/components/schemas/GoogleCloudAiplatformV1SearchNearestEntitiesResponse parameters: - in: path name: projectsId @@ -42087,35 +42273,17 @@ 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: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:fetchFeatureValues: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:sync: parameters: *ref_107 post: - description: Fetch feature values under a FeatureView. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.fetchFeatureValues + description: Triggers on-demand sync for the FeatureView. + operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.sync requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesRequest + #/components/schemas/GoogleCloudAiplatformV1SyncFeatureViewRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42128,7 +42296,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponse + #/components/schemas/GoogleCloudAiplatformV1SyncFeatureViewResponse parameters: - in: path name: projectsId @@ -42198,9 +42366,9 @@ paths: schema: type: string format: google-fieldmask - get: - description: Gets details of a single FeatureView. - operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.get + delete: + description: Deletes a single FeatureView. + operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42212,7 +42380,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -42234,9 +42402,9 @@ paths: required: true schema: type: string - delete: - description: Deletes a single FeatureView. - operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.delete + get: + description: Gets details of a single FeatureView. + operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42248,7 +42416,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' parameters: - in: path name: projectsId @@ -42270,21 +42438,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:searchNearestEntities: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:fetchFeatureValues: parameters: *ref_107 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. + description: Fetch feature values under a FeatureView. operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.searchNearestEntities + aiplatform.projects.locations.featureOnlineStores.featureViews.fetchFeatureValues requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchNearestEntitiesRequest + #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42297,7 +42462,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchNearestEntitiesResponse + #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponse parameters: - in: path name: projectsId @@ -42318,18 +42483,16 @@ paths: name: featureViewsId required: true schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:sync: - parameters: *ref_107 - 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 + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}: + parameters: *ref_107 + 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 @@ -42341,8 +42504,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SyncFeatureViewResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -42364,16 +42526,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews: - parameters: *ref_107 - 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' + - 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.featureOnlineStores.featureViews.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42385,7 +42550,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -42402,17 +42567,24 @@ paths: required: true schema: type: string - - in: query - name: runSyncImmediately + - in: path + name: featureViewsId + required: true schema: - type: boolean - - in: query - name: featureViewId + type: string + - in: path + name: operationsId + required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait: + parameters: *ref_107 get: - description: Lists FeatureViews in a given FeatureOnlineStore. - operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.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.featureOnlineStores.featureViews.operations.listWait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42424,8 +42596,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeatureViewsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -42442,6 +42613,16 @@ paths: 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: pageSize schema: @@ -42451,16 +42632,10 @@ paths: 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}/operations/{operationsId}:wait: - parameters: *ref_107 post: description: >- Waits until the specified long-running operation is done or reaches at @@ -42472,7 +42647,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.featureOnlineStores.operations.wait + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42501,6 +42677,11 @@ paths: required: true schema: type: string + - in: path + name: featureViewsId + required: true + schema: + type: string - in: path name: operationsId required: true @@ -42511,11 +42692,12 @@ paths: schema: type: string format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs/{featureViewSyncsId}: + parameters: *ref_107 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 details of a single FeatureViewSync. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42527,7 +42709,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewSync' parameters: - in: path name: projectsId @@ -42545,31 +42727,21 @@ paths: schema: type: string - in: path - name: operationsId + name: featureViewsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: featureViewSyncsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs: parameters: *ref_107 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.operations.get + description: Lists FeatureViewSyncs in a given FeatureView. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42581,7 +42753,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListFeatureViewSyncsResponse parameters: - in: path name: projectsId @@ -42599,59 +42772,35 @@ paths: schema: type: string - in: path - name: operationsId + name: featureViewsId 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.featureOnlineStores.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 + - in: query + name: filter schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: featureOnlineStoresId - 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 - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}: parameters: *ref_107 - 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.persistentResources.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.featureOnlineStores.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42663,7 +42812,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -42676,7 +42825,7 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: featureOnlineStoresId required: true schema: type: string @@ -42685,12 +42834,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.persistentResources.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.featureOnlineStores.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42702,7 +42852,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -42715,7 +42865,7 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: featureOnlineStoresId required: true schema: type: string @@ -42724,13 +42874,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait: parameters: *ref_107 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.featureOnlineStores.operations.listWait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42755,12 +42905,13 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: featureOnlineStoresId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: operationsId + required: true schema: type: string - in: query @@ -42768,12 +42919,14 @@ 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}/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait: - parameters: *ref_107 post: description: >- Waits until the specified long-running operation is done or reaches at @@ -42785,7 +42938,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.persistentResources.operations.wait + operationId: aiplatform.projects.locations.featureOnlineStores.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42810,7 +42963,7 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: featureOnlineStoresId required: true schema: type: string @@ -42824,20 +42977,16 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}: parameters: *ref_107 - 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 + 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 @@ -42849,7 +42998,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -42862,25 +43011,18 @@ paths: schema: type: string - in: path - name: persistentResourcesId + 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}/persistentResources/{persistentResourcesId}: - parameters: *ref_107 - patch: - description: Updates a PersistentResource. - operationId: aiplatform.projects.locations.persistentResources.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' + 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 @@ -42892,7 +43034,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' parameters: - in: path name: projectsId @@ -42905,18 +43047,15 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: featureOnlineStoresId 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 + delete: + description: >- + 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 @@ -42928,7 +43067,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -42941,13 +43080,24 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: featureOnlineStoresId required: true schema: type: string - delete: - description: Deletes a PersistentResource. - operationId: aiplatform.projects.locations.persistentResources.delete + - in: query + name: force + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores: + parameters: *ref_107 + 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 @@ -42971,21 +43121,13 @@ paths: required: true schema: type: string - - in: path - name: persistentResourcesId - required: true + - in: query + name: featureOnlineStoreId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources: - parameters: *ref_107 - post: - description: Creates a PersistentResource. - operationId: aiplatform.projects.locations.persistentResources.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' + 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 @@ -42997,7 +43139,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse parameters: - in: path name: projectsId @@ -43010,12 +43153,29 @@ paths: schema: type: string - in: query - name: persistentResourceId + 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 + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations: + parameters: *ref_107 get: - description: Lists PersistentResources in a Location. - operationId: aiplatform.projects.locations.persistentResources.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.indexes.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43027,8 +43187,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListPersistentResourcesResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -43040,26 +43199,32 @@ paths: required: true schema: type: string + - in: path + name: indexesId + 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 - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}:reboot: + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}: parameters: *ref_107 - post: - description: Reboots a PersistentResource. - operationId: aiplatform.projects.locations.persistentResources.reboot - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1RebootPersistentResourceRequest + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43084,19 +43249,22 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: indexesId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}: - parameters: *ref_107 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 + operationId: aiplatform.projects.locations.indexes.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43121,7 +43289,7 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: indexesId required: true schema: type: string @@ -43130,12 +43298,20 @@ paths: required: true schema: type: string - get: + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:wait: + parameters: *ref_107 + 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 + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43160,7 +43336,7 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: indexesId required: true schema: type: string @@ -43169,7 +43345,12 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:cancel: + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:cancel: parameters: *ref_107 post: description: >- @@ -43182,7 +43363,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.indexes.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43207,7 +43388,7 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: indexesId required: true schema: type: string @@ -43216,20 +43397,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/indexes: parameters: *ref_107 - 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: Lists Indexes in a Location. + operationId: aiplatform.projects.locations.indexes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43241,7 +43413,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListIndexesResponse parameters: - in: path name: projectsId @@ -43253,28 +43426,32 @@ paths: required: true schema: type: string - - in: path - name: dataLabelingJobsId - 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: filter schema: type: string - in: query - name: timeout + name: readMask schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations: - parameters: *ref_107 - 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 + format: google-fieldmask + 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 @@ -43286,7 +43463,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -43298,35 +43475,17 @@ 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: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:upsertDatapoints: parameters: *ref_107 post: - description: Cancels a DataLabelingJob. Success of cancellation is not guaranteed. - operationId: aiplatform.projects.locations.dataLabelingJobs.cancel + description: Add/update Datapoints into an Index. + operationId: aiplatform.projects.locations.indexes.upsertDatapoints requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelDataLabelingJobRequest + #/components/schemas/GoogleCloudAiplatformV1UpsertDatapointsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43338,7 +43497,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1UpsertDatapointsResponse parameters: - in: path name: projectsId @@ -43351,15 +43511,21 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: indexesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}: + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:removeDatapoints: parameters: *ref_107 - get: - description: Gets a DataLabelingJob. - operationId: aiplatform.projects.locations.dataLabelingJobs.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 @@ -43371,7 +43537,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RemoveDatapointsResponse parameters: - in: path name: projectsId @@ -43384,13 +43551,15 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: indexesId required: true schema: type: string - delete: - description: Deletes a DataLabelingJob. - operationId: aiplatform.projects.locations.dataLabelingJobs.delete + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}: + parameters: *ref_107 + get: + description: Gets an Index. + operationId: aiplatform.projects.locations.indexes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43402,7 +43571,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' parameters: - in: path name: projectsId @@ -43415,15 +43584,18 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: indexesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs: - parameters: *ref_107 - get: - description: Lists DataLabelingJobs in a Location. - operationId: aiplatform.projects.locations.dataLabelingJobs.list + 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 @@ -43435,8 +43607,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListDataLabelingJobsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -43448,36 +43619,21 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: indexesId + required: true schema: type: string - in: query - name: readMask + name: updateMask schema: type: string format: google-fieldmask - - in: query - name: orderBy - 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' + 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 @@ -43489,7 +43645,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -43501,11 +43657,25 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs: + - in: path + name: indexesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:cancel: parameters: *ref_107 - get: - description: Lists BatchPredictionJobs in a Location. - operationId: aiplatform.projects.locations.batchPredictionJobs.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.dataLabelingJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43517,8 +43687,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListBatchPredictionJobsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -43530,34 +43699,30 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: dataLabelingJobsId + 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}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait: + parameters: *ref_107 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' + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It 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 @@ -43569,7 +43734,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -43581,58 +43746,28 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}:cancel: - parameters: *ref_107 - 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 - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelBatchPredictionJobRequest - security: - - Oauth2: - - https://www.googleapis.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: dataLabelingJobsId required: true schema: type: string - in: path - name: locationsId + name: operationsId required: true schema: type: string - - in: path - name: batchPredictionJobsId - required: true + - in: query + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations: parameters: *ref_107 get: - description: Gets a BatchPredictionJob - operationId: aiplatform.projects.locations.batchPredictionJobs.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 @@ -43644,7 +43779,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -43657,15 +43792,31 @@ paths: schema: type: string - in: path - name: batchPredictionJobsId + name: dataLabelingJobsId required: true schema: type: string - delete: + - 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}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}: + parameters: *ref_107 + get: description: >- - Deletes a BatchPredictionJob. Can only be called on jobs that already - finished. - operationId: aiplatform.projects.locations.batchPredictionJobs.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.dataLabelingJobs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43690,20 +43841,22 @@ paths: schema: type: string - in: path - name: batchPredictionJobsId + name: dataLabelingJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:computeTokens: - parameters: *ref_107 - 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' + - 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.dataLabelingJobs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43715,8 +43868,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ComputeTokensResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -43729,45 +43881,32 @@ paths: schema: type: string - in: path - name: publishersId + name: dataLabelingJobsId 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}:serverStreamingPredict: + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}: parameters: *ref_107 - 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 + get: + description: Gets a DataLabelingJob. + operationId: aiplatform.projects.locations.dataLabelingJobs.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/GoogleCloudAiplatformV1StreamingPredictResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' parameters: - in: path name: projectsId @@ -43780,43 +43919,25 @@ paths: schema: type: string - in: path - name: publishersId - required: true - schema: - type: string - - in: path - name: modelsId + name: dataLabelingJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:generateContent: - parameters: *ref_107 - 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 DataLabelingJob. + operationId: aiplatform.projects.locations.dataLabelingJobs.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/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -43829,41 +43950,33 @@ paths: schema: type: string - in: path - name: publishersId - required: true - schema: - type: string - - in: path - name: modelsId + name: dataLabelingJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predict: + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}:cancel: parameters: *ref_107 post: - description: Perform an online prediction. - operationId: aiplatform.projects.locations.publishers.models.predict + description: Cancels a DataLabelingJob. Success of cancellation is not guaranteed. + operationId: aiplatform.projects.locations.dataLabelingJobs.cancel requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictRequest' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CancelDataLabelingJobRequest 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 @@ -43876,42 +43989,28 @@ paths: schema: type: string - in: path - name: publishersId - required: true - schema: - type: string - - in: path - name: modelsId + name: dataLabelingJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamRawPredict: + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs: parameters: *ref_107 - 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 + get: + description: Lists DataLabelingJobs in a Location. + operationId: aiplatform.projects.locations.dataLabelingJobs.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/GoogleCloudAiplatformV1ListDataLabelingJobsResponse parameters: - in: path name: projectsId @@ -43923,47 +44022,48 @@ paths: required: true schema: type: string - - in: path - name: publishersId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: modelsId - required: true + - 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}/publishers/{publishersId}/models/{modelsId}:rawPredict: - parameters: *ref_107 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 + description: Creates a DataLabelingJob. + operationId: aiplatform.projects.locations.dataLabelingJobs.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1RawPredictRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' 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/GoogleCloudAiplatformV1DataLabelingJob' parameters: - in: path name: projectsId @@ -43975,44 +44075,25 @@ 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}:streamGenerateContent: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations: parameters: *ref_107 - 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: >- + 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/GoogleCloudAiplatformV1GenerateContentResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -44025,25 +44106,37 @@ paths: schema: type: string - in: path - name: publishersId + name: metadataStoresId required: true schema: type: string - in: path - name: modelsId + name: artifactsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:countTokens: + - 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}: parameters: *ref_107 - post: - description: Perform a token counting. - operationId: aiplatform.projects.locations.publishers.models.countTokens - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CountTokensRequest' + 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 @@ -44055,8 +44148,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CountTokensResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -44069,22 +44161,26 @@ paths: schema: type: string - in: path - name: publishersId + name: metadataStoresId required: true schema: type: string - in: path - name: modelsId + name: artifactsId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations: - parameters: *ref_107 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 + Gets the latest 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 @@ -44096,7 +44192,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -44109,24 +44205,21 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: metadataStoresId required: true schema: type: string - - 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}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait: parameters: *ref_107 post: description: >- @@ -44139,7 +44232,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.artifacts.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44164,7 +44257,12 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: artifactsId required: true schema: type: string @@ -44178,14 +44276,20 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel: parameters: *ref_107 - 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.pipelineJobs.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.metadataStores.artifacts.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44197,7 +44301,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -44210,7 +44314,12 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: artifactsId required: true schema: type: string @@ -44219,13 +44328,17 @@ 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.pipelineJobs.operations.delete + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts:purge: + parameters: *ref_107 + post: + 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 @@ -44237,7 +44350,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -44250,29 +44363,15 @@ 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/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}: parameters: *ref_107 - 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 + get: + description: Retrieves a specific Artifact. + operationId: aiplatform.projects.locations.metadataStores.artifacts.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44284,7 +44383,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' parameters: - in: path name: projectsId @@ -44297,20 +44396,18 @@ 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 - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}: - parameters: *ref_107 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 @@ -44335,13 +44432,27 @@ 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: artifactsId + required: true + schema: + type: string + - in: query + name: etag + 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' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44353,7 +44464,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' parameters: - in: path name: projectsId @@ -44366,27 +44477,34 @@ 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: artifactsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: allowMissing + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts: parameters: *ref_107 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 + description: Creates an Artifact associated with a MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.artifacts.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44398,7 +44516,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' parameters: - in: path name: projectsId @@ -44410,11 +44528,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs: - parameters: *ref_107 + - in: path + name: metadataStoresId + required: true + schema: + type: string + - in: query + name: artifactId + schema: + type: string 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 @@ -44427,7 +44552,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListPipelineJobsResponse + #/components/schemas/GoogleCloudAiplatformV1ListArtifactsResponse parameters: - in: path name: projectsId @@ -44439,36 +44564,36 @@ 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 + name: filter schema: - type: integer - format: int32 + type: string - in: query name: orderBy schema: type: string - in: query - name: filter + name: pageToken schema: type: string - in: query - name: pageToken + name: pageSize schema: - type: string - 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' + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}:queryArtifactLineageSubgraph: + parameters: *ref_107 + 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 @@ -44480,7 +44605,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' + $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' parameters: - in: path name: projectsId @@ -44492,24 +44617,41 @@ 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: pipelineJobId + name: maxHops + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchDelete: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:addExecutionEvents: parameters: *ref_107 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 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/GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest + #/components/schemas/GoogleCloudAiplatformV1AddExecutionEventsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44521,7 +44663,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AddExecutionEventsResponse parameters: - in: path name: projectsId @@ -44533,26 +44676,21 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}:cancel: + - in: path + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: executionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions: parameters: *ref_107 - 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 - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelPipelineJobRequest + get: + description: Lists Executions in the MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.executions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44564,7 +44702,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListExecutionsResponse parameters: - in: path name: projectsId @@ -44577,19 +44716,35 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}: - parameters: *ref_107 - 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 + - 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 + 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' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44601,7 +44756,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' parameters: - in: path name: projectsId @@ -44614,21 +44769,19 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: metadataStoresId 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}: + parameters: *ref_107 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 + description: Retrieves a specific Execution. + operationId: aiplatform.projects.locations.metadataStores.executions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44640,7 +44793,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' parameters: - in: path name: projectsId @@ -44653,22 +44806,18 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: metadataStoresId required: true schema: type: string - in: path - name: operationsId + name: executionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations: - parameters: *ref_107 - 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 + delete: + description: Deletes an Execution. + operationId: aiplatform.projects.locations.metadataStores.executions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44680,7 +44829,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -44693,37 +44842,27 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: metadataStoresId required: true 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 - - in: query - name: pageToken + name: etag schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel: - parameters: *ref_107 - 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 + 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 @@ -44735,7 +44874,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' parameters: - in: path name: projectsId @@ -44748,29 +44887,33 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: metadataStoresId required: true schema: type: string - in: path - name: operationsId + name: executionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait: + - in: query + name: allowMissing + schema: + type: boolean + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:queryExecutionInputsAndOutputs: parameters: *ref_107 - 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 + 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 @@ -44782,7 +44925,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' parameters: - in: path name: projectsId @@ -44795,25 +44938,26 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: metadataStoresId required: true schema: type: string - in: path - name: operationsId + name: executionsId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions:purge: parameters: *ref_107 - get: - description: Gets a SpecialistPool. - operationId: aiplatform.projects.locations.specialistPools.get + 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 @@ -44825,7 +44969,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -44838,18 +44982,18 @@ 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' + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}: + parameters: *ref_107 + 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 @@ -44874,18 +45018,28 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: metadataStoresId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: executionsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true 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 + 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 @@ -44897,7 +45051,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -44910,19 +45064,34 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: metadataStoresId required: true schema: type: string - - in: query - name: force + - in: path + name: executionsId + required: true schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait: parameters: *ref_107 - get: - description: Lists SpecialistPools in a Location. - operationId: aiplatform.projects.locations.specialistPools.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.executions.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44934,8 +45103,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListSpecialistPoolsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -44947,59 +45115,41 @@ 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: metadataStoresId + required: true schema: type: string - 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: projectsId + name: executionsId required: true schema: type: string - in: path - name: locationsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations: + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel: parameters: *ref_107 - get: + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is 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.list + aiplatform.projects.locations.metadataStores.executions.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45011,7 +45161,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -45024,38 +45174,27 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: metadataStoresId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: executionsId + 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 - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations: parameters: *ref_107 - 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 + 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 @@ -45067,7 +45206,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -45080,30 +45219,33 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: metadataStoresId required: true schema: type: string - in: path - name: operationsId + name: executionsId required: true 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}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}: + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}: parameters: *ref_107 - 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.modelDeploymentMonitoringJobs.operations.delete + get: + description: Retrieves a specific Context. + operationId: aiplatform.projects.locations.metadataStores.contexts.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45115,7 +45257,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' parameters: - in: path name: projectsId @@ -45128,22 +45270,18 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: metadataStoresId required: true schema: type: string - in: path - name: operationsId + name: contextsId 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.modelDeploymentMonitoringJobs.operations.get + delete: + description: Deletes a stored Context. + operationId: aiplatform.projects.locations.metadataStores.contexts.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45168,30 +45306,31 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: metadataStoresId required: true schema: type: string - in: path - name: operationsId + name: contextsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel: - parameters: *ref_107 - 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 + - 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/GoogleCloudAiplatformV1Context' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45203,7 +45342,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' parameters: - in: path name: projectsId @@ -45216,29 +45355,39 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: metadataStoresId required: true schema: type: string - in: path - name: operationsId + name: contextsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:pause: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: allowMissing + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:removeContextChildren: parameters: *ref_107 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 + 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/GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest + #/components/schemas/GoogleCloudAiplatformV1RemoveContextChildrenRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45250,7 +45399,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RemoveContextChildrenResponse parameters: - in: path name: projectsId @@ -45263,24 +45413,30 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:searchModelDeploymentMonitoringStatsAnomalies: + - in: path + name: contextsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextArtifactsAndExecutions: parameters: *ref_107 post: description: >- - Searches Model Monitoring Statistics generated within a given time - window. + 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.modelDeploymentMonitoringJobs.searchModelDeploymentMonitoringStatsAnomalies + aiplatform.projects.locations.metadataStores.contexts.addContextArtifactsAndExecutions requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest + #/components/schemas/GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45293,7 +45449,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse + #/components/schemas/GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse parameters: - in: path name: projectsId @@ -45306,21 +45462,20 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}: + - in: path + name: contextsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts: parameters: *ref_107 - patch: - description: Updates a ModelDeploymentMonitoringJob. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob + get: + description: Lists Contexts on the MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.contexts.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45332,7 +45487,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListContextsResponse parameters: - in: path name: projectsId @@ -45345,18 +45501,35 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: metadataStoresId required: true schema: type: string - in: query - name: updateMask + name: filter schema: type: string - format: google-fieldmask - delete: - description: Deletes a ModelDeploymentMonitoringJob. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.delete + - 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 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 @@ -45368,7 +45541,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' parameters: - in: path name: projectsId @@ -45381,13 +45554,24 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: metadataStoresId required: true schema: type: string - get: - description: Gets a ModelDeploymentMonitoringJob. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.get + - in: query + name: contextId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts:purge: + parameters: *ref_107 + 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 @@ -45399,8 +45583,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -45413,24 +45596,26 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:resume: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextChildren: parameters: *ref_107 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 + 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/GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest + #/components/schemas/GoogleCloudAiplatformV1AddContextChildrenRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45442,7 +45627,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AddContextChildrenResponse parameters: - in: path name: projectsId @@ -45455,15 +45641,23 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs: + - in: path + name: contextsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:queryContextLineageSubgraph: parameters: *ref_107 get: - description: Lists ModelDeploymentMonitoringJobs in a Location. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.list + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45475,8 +45669,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' parameters: - in: path name: projectsId @@ -45488,35 +45681,25 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: metadataStoresId + required: true schema: type: string - - in: query - name: readMask + - in: path + name: contextsId + required: true schema: type: string - format: google-fieldmask - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}: + parameters: *ref_107 + delete: 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 + Deletes a long-running operation. This method indicates that the client + is no longer interested 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 @@ -45528,8 +45711,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -45541,11 +45723,27 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups: - parameters: *ref_107 + - 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 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.metadataStores.contexts.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45557,8 +45755,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeatureGroupsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -45570,31 +45767,35 @@ paths: required: true schema: type: string - - in: query - name: filter + - in: path + name: metadataStoresId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy + - in: path + name: contextsId + 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/{contextsId}/operations/{operationsId}:cancel: + parameters: *ref_107 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' + 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 @@ -45606,7 +45807,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -45618,15 +45819,28 @@ paths: required: true schema: type: string - - in: query - name: featureGroupId + - in: path + name: metadataStoresId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}: + - 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_107 - delete: - description: Deletes a single FeatureGroup. - operationId: aiplatform.projects.locations.featureGroups.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.metadataStores.contexts.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45638,7 +45852,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -45651,22 +45865,42 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: contextsId required: true schema: type: string - in: query - name: force + name: pageToken schema: - type: boolean - patch: - description: Updates the parameters of a single FeatureGroup. - operationId: aiplatform.projects.locations.featureGroups.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' + 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}/contexts/{contextsId}/operations/{operationsId}:wait: + parameters: *ref_107 + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45691,18 +45925,39 @@ paths: schema: type: string - in: path - name: featureGroupsId + 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 - in: query - name: updateMask + name: timeout schema: type: string - format: google-fieldmask - get: - description: Gets details of a single FeatureGroup. - operationId: aiplatform.projects.locations.featureGroups.get + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel: + parameters: *ref_107 + 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 @@ -45714,7 +45969,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -45727,15 +45982,22 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations: parameters: *ref_107 get: - description: Lists Features in a given FeatureGroup. - operationId: aiplatform.projects.locations.featureGroups.features.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.metadataStores.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45747,8 +46009,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeaturesResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -45761,45 +46022,37 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: metadataStoresId required: true schema: type: string - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken + name: filter schema: type: string - - in: query - name: latestStatsCount - schema: - type: integer - format: int32 - in: query name: pageSize schema: type: integer format: int32 - in: query - name: filter + name: pageToken schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:wait: + parameters: *ref_107 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.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45824,19 +46077,29 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string - in: query - name: featureId + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}: parameters: *ref_107 - get: - description: Gets details of a single Feature. - operationId: aiplatform.projects.locations.featureGroups.features.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 @@ -45848,7 +46111,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -45861,18 +46124,21 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: metadataStoresId required: true schema: type: string - in: path - name: featuresId + name: operationsId required: true schema: type: string - delete: - description: Deletes a single Feature. - operationId: aiplatform.projects.locations.featureGroups.features.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.metadataStores.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45897,23 +46163,25 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: metadataStoresId required: true schema: type: string - in: path - name: featuresId + name: operationsId 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}/metadataSchemas: + parameters: *ref_107 + post: + description: Creates a MetadataSchema. + operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45925,7 +46193,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' parameters: - in: path name: projectsId @@ -45938,27 +46206,17 @@ 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: query - name: updateMask + name: metadataSchemaId schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait: - parameters: *ref_107 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 MetadataSchemas. + operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45970,7 +46228,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListMetadataSchemasResponse parameters: - in: path name: projectsId @@ -45983,45 +46242,28 @@ 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: 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 - 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 + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas/{metadataSchemasId}: + parameters: *ref_107 + get: + description: Retrieves a specific MetadataSchema. + operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46033,7 +46275,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' parameters: - in: path name: projectsId @@ -46046,33 +46288,20 @@ 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: metadataSchemasId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores: parameters: *ref_107 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 + description: Lists MetadataStores for a Location. + operationId: aiplatform.projects.locations.metadataStores.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46084,7 +46313,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListMetadataStoresResponse parameters: - in: path name: projectsId @@ -46096,28 +46326,23 @@ paths: required: true schema: type: string - - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: path - name: featuresId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageSize 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 + 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' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46129,7 +46354,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -46141,30 +46366,15 @@ 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 + - in: query + name: metadataStoreId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}: parameters: *ref_107 - 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 + get: + description: Retrieves a specific MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46176,7 +46386,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataStore' parameters: - in: path name: projectsId @@ -46189,21 +46399,15 @@ paths: schema: type: string - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: path - name: operationsId + name: metadataStoresId 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.featureGroups.operations.get + 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 @@ -46228,22 +46432,19 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: metadataStoresId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: force schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates: parameters: *ref_107 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 + description: Lists NotebookRuntimeTemplates in a Location. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46255,7 +46456,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse parameters: - in: path name: projectsId @@ -46267,20 +46469,15 @@ paths: required: true schema: type: string - - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true + - in: query + name: pageToken schema: type: string - in: query - name: pageToken + name: readMask schema: type: string + format: google-fieldmask - in: query name: filter schema: @@ -46290,70 +46487,19 @@ 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 - security: - - Oauth2: - - https://www.googleapis.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: featureGroupsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - in: query - name: timeout + name: orderBy schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:wait: - parameters: *ref_107 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.indexes.operations.wait + 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 @@ -46377,29 +46523,15 @@ paths: required: true schema: type: string - - in: path - name: indexesId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - in: query - name: timeout + name: notebookRuntimeTemplateId schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}: parameters: *ref_107 - 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 + delete: + description: Deletes a NotebookRuntimeTemplate. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46424,22 +46556,19 @@ paths: schema: type: string - in: path - name: indexesId - required: true - schema: - type: string - - in: path - name: operationsId + name: notebookRuntimeTemplatesId 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 + patch: + description: Updates a NotebookRuntimeTemplate. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46451,7 +46580,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate parameters: - in: path name: projectsId @@ -46464,29 +46594,18 @@ paths: schema: type: string - in: path - name: indexesId - required: true - schema: - type: string - - in: path - name: operationsId + name: notebookRuntimeTemplatesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:cancel: - parameters: *ref_107 - 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 + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: Gets a NotebookRuntimeTemplate. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46498,7 +46617,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate parameters: - in: path name: projectsId @@ -46511,22 +46631,17 @@ paths: schema: type: string - in: path - name: indexesId - required: true - schema: - type: string - - in: path - name: operationsId + name: notebookRuntimeTemplatesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:getIamPolicy: parameters: *ref_107 - 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.indexes.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.notebookRuntimeTemplates.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46538,7 +46653,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -46551,33 +46666,28 @@ paths: schema: type: string - in: path - name: indexesId + name: notebookRuntimeTemplatesId required: true schema: type: string - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize + name: options.requestedPolicyVersion schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:setIamPolicy: parameters: *ref_107 post: - description: Creates an Index. - operationId: aiplatform.projects.locations.indexes.create + 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/GoogleCloudAiplatformV1Index' + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46589,7 +46699,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -46601,9 +46711,22 @@ paths: required: true schema: type: string - get: - description: Lists Indexes in a Location. - operationId: aiplatform.projects.locations.indexes.list + - in: path + name: notebookRuntimeTemplatesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:testIamPermissions: + parameters: *ref_107 + 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 @@ -46615,8 +46738,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListIndexesResponse + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -46628,29 +46750,20 @@ paths: required: true schema: type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: filter + - in: path + name: notebookRuntimeTemplatesId + required: true schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + name: permissions schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}: + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}: parameters: *ref_107 get: - description: Gets an Index. - operationId: aiplatform.projects.locations.indexes.get + description: Gets a PipelineJob. + operationId: aiplatform.projects.locations.pipelineJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46662,7 +46775,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' parameters: - in: path name: projectsId @@ -46675,18 +46788,13 @@ paths: schema: type: string - in: path - name: indexesId + name: pipelineJobsId 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' + delete: + description: Deletes a PipelineJob. + operationId: aiplatform.projects.locations.pipelineJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46711,20 +46819,15 @@ paths: schema: type: string - in: path - name: indexesId + name: pipelineJobsId 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 + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs: + parameters: *ref_107 + get: + description: Lists PipelineJobs in a Location. + operationId: aiplatform.projects.locations.pipelineJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46736,7 +46839,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListPipelineJobsResponse parameters: - in: path name: projectsId @@ -46748,22 +46852,36 @@ paths: required: true schema: type: string - - in: path - name: indexesId - required: true + - in: query + name: filter + 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 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:removeDatapoints: - parameters: *ref_107 post: - description: Remove Datapoints from an Index. - operationId: aiplatform.projects.locations.indexes.removeDatapoints + 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/GoogleCloudAiplatformV1RemoveDatapointsRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46775,8 +46893,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1RemoveDatapointsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' parameters: - in: path name: projectsId @@ -46788,22 +46905,30 @@ paths: required: true schema: type: string - - in: path - name: indexesId - required: true + - in: query + name: pipelineJobId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:upsertDatapoints: + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}:cancel: parameters: *ref_107 post: - description: Add/update Datapoints into an Index. - operationId: aiplatform.projects.locations.indexes.upsertDatapoints + 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 requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1UpsertDatapointsRequest + #/components/schemas/GoogleCloudAiplatformV1CancelPipelineJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46815,8 +46940,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1UpsertDatapointsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -46829,18 +46953,24 @@ paths: schema: type: string - in: path - name: indexesId + name: pipelineJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchDelete: parameters: *ref_107 - 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.models.operations.get + 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 @@ -46864,23 +46994,23 @@ paths: required: true schema: type: string - - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - delete: + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchCancel: + parameters: *ref_107 + 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.models.operations.delete + 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 @@ -46892,7 +47022,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -46904,30 +47034,14 @@ paths: required: true schema: type: string - - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}: parameters: *ref_107 - 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.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.pipelineJobs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46952,7 +47066,7 @@ paths: schema: type: string - in: path - name: modelsId + name: pipelineJobsId required: true schema: type: string @@ -46961,25 +47075,13 @@ 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: - parameters: *ref_107 - 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.models.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.pipelineJobs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47004,7 +47106,7 @@ paths: schema: type: string - in: path - name: modelsId + name: pipelineJobsId required: true schema: type: string @@ -47013,13 +47115,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel: parameters: *ref_107 - 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.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.pipelineJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47031,7 +47140,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -47044,24 +47153,16 @@ paths: schema: type: string - in: path - name: modelsId + name: pipelineJobsId 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: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait: + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait: parameters: *ref_107 post: description: >- @@ -47074,7 +47175,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.pipelineJobs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47099,12 +47200,7 @@ paths: schema: type: string - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: evaluationsId + name: pipelineJobsId required: true schema: type: string @@ -47118,13 +47214,13 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations: parameters: *ref_107 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.pipelineJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47149,12 +47245,7 @@ paths: schema: type: string - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: evaluationsId + name: pipelineJobsId required: true schema: type: string @@ -47171,15 +47262,19 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause: parameters: *ref_107 - 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.models.evaluations.operations.delete + 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 @@ -47204,78 +47299,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: 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.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 + name: schedulesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}: parameters: *ref_107 - 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 Schedule. + operationId: aiplatform.projects.locations.schedules.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47287,7 +47319,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -47300,25 +47332,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: operationsId + name: schedulesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}: - parameters: *ref_107 get: - description: Gets a ModelEvaluationSlice. - operationId: aiplatform.projects.locations.models.evaluations.slices.get + description: Gets a Schedule. + operationId: aiplatform.projects.locations.schedules.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47330,8 +47350,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSlice + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' parameters: - in: path name: projectsId @@ -47344,25 +47363,23 @@ 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: schedulesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices: - parameters: *ref_107 - get: - description: Lists ModelEvaluationSlices in a ModelEvaluation. - operationId: aiplatform.projects.locations.models.evaluations.slices.list + patch: + 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' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47374,8 +47391,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' parameters: - in: path name: projectsId @@ -47383,49 +47399,30 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: modelsId + name: locationsId required: true schema: type: string - in: path - name: evaluationsId + name: schedulesId required: true schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: readMask + name: updateMask 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}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}:batchImport: + /v1/projects/{projectsId}/locations/{locationsId}/schedules: parameters: *ref_107 post: - description: Imports a list of externally generated EvaluatedAnnotations. - operationId: aiplatform.projects.locations.models.evaluations.slices.batchImport + description: Creates a Schedule. + operationId: aiplatform.projects.locations.schedules.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47437,8 +47434,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' parameters: - in: path name: projectsId @@ -47450,26 +47446,9 @@ 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}: - parameters: *ref_107 get: - description: Gets a ModelEvaluation. - operationId: aiplatform.projects.locations.models.evaluations.get + description: Lists Schedules in a Location. + operationId: aiplatform.projects.locations.schedules.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47481,7 +47460,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListSchedulesResponse parameters: - in: path name: projectsId @@ -47493,27 +47473,40 @@ paths: required: true schema: type: string - - in: path - name: modelsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: evaluationsId - required: true + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations:import: + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:resume: parameters: *ref_107 post: - description: Imports an externally generated ModelEvaluation. - operationId: aiplatform.projects.locations.models.evaluations.import + 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/GoogleCloudAiplatformV1ImportModelEvaluationRequest + #/components/schemas/GoogleCloudAiplatformV1ResumeScheduleRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47525,7 +47518,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -47538,15 +47531,18 @@ paths: schema: type: string - in: path - name: modelsId + name: schedulesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations: + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}: parameters: *ref_107 get: - description: Lists ModelEvaluations in a Model. - operationId: aiplatform.projects.locations.models.evaluations.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.schedules.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47558,8 +47554,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListModelEvaluationsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -47572,38 +47567,22 @@ paths: schema: type: string - in: path - name: modelsId + name: schedulesId 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: readMask + - in: path + name: operationsId + required: true schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}: - parameters: *ref_107 - patch: - description: Updates a Model. - operationId: aiplatform.projects.locations.models.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47615,7 +47594,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -47628,18 +47607,29 @@ paths: schema: type: string - in: path - name: modelsId + name: schedulesId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: operationsId + required: true schema: type: string - format: google-fieldmask - get: - description: Gets a Model. - operationId: aiplatform.projects.locations.models.get + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:wait: + parameters: *ref_107 + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47651,7 +47641,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -47664,15 +47654,27 @@ paths: schema: type: string - in: path - name: modelsId + name: schedulesId required: true schema: type: string - delete: + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations: + parameters: *ref_107 + 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.schedules.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47684,7 +47686,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -47697,23 +47699,37 @@ paths: schema: type: string - in: path - name: modelsId + name: schedulesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:export: + - 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}/schedules/{schedulesId}/operations/{operationsId}:cancel: parameters: *ref_107 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' + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is 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 @@ -47725,7 +47741,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -47738,20 +47754,23 @@ paths: schema: type: string - in: path - name: modelsId + name: schedulesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models:upload: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}: parameters: *ref_107 - post: - description: Uploads a Model artifact into Vertex AI. - operationId: aiplatform.projects.locations.models.upload - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1UploadModelRequest' + 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 @@ -47775,17 +47794,23 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:mergeVersionAliases: - parameters: *ref_107 - 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 + - 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 @@ -47797,7 +47822,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -47810,15 +47835,29 @@ paths: schema: type: string - in: path - name: modelsId + name: hyperparameterTuningJobsId 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}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel: parameters: *ref_107 - get: - description: Lists Models in a Location. - operationId: aiplatform.projects.locations.models.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.hyperparameterTuningJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47830,7 +47869,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ListModelsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -47842,39 +47881,30 @@ paths: required: true 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: readMask + - in: path + name: hyperparameterTuningJobsId + required: true schema: type: string - format: google-fieldmask - - in: query - name: filter + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:updateExplanationDataset: + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait: parameters: *ref_107 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: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It 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 @@ -47899,15 +47929,27 @@ paths: schema: type: string - in: path - name: modelsId + name: hyperparameterTuningJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listVersions: + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations: parameters: *ref_107 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.hyperparameterTuningJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47919,8 +47961,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListModelVersionsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -47933,19 +47974,14 @@ paths: schema: type: string - in: path - name: modelsId + name: hyperparameterTuningJobsId required: true schema: type: string - in: query - name: orderBy - schema: - type: string - - in: query - name: readMask + name: pageToken schema: type: string - format: google-fieldmask - in: query name: filter schema: @@ -47955,25 +47991,17 @@ paths: schema: type: integer format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/models:copy: + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs: parameters: *ref_107 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 + description: Creates a HyperparameterTuningJob + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CopyModelRequest' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47985,7 +48013,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob parameters: - in: path name: projectsId @@ -47997,19 +48026,9 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:setIamPolicy: - parameters: *ref_107 - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + get: + description: Lists HyperparameterTuningJobs in a Location. + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48021,7 +48040,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse parameters: - in: path name: projectsId @@ -48033,18 +48053,45 @@ paths: required: true schema: type: string - - in: path - name: modelsId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:getIamPolicy: + - 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}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}:cancel: parameters: *ref_107 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 + 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 @@ -48056,7 +48103,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -48069,25 +48116,15 @@ paths: schema: type: string - in: path - name: modelsId + name: hyperparameterTuningJobsId required: true schema: type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:testIamPermissions: + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}: parameters: *ref_107 - 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 + get: + description: Gets a HyperparameterTuningJob + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48099,7 +48136,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob parameters: - in: path name: projectsId @@ -48112,22 +48150,13 @@ paths: schema: type: string - in: path - name: modelsId + name: hyperparameterTuningJobsId required: true schema: type: string - - in: query - name: permissions - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:deleteVersion: - parameters: *ref_107 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 a HyperparameterTuningJob. + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48152,7 +48181,7 @@ paths: schema: type: string - in: path - name: modelsId + name: hyperparameterTuningJobsId 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 9e7f625d..30dd328d 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: '20240517' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/alloydb/ servers: @@ -3528,7 +3528,7 @@ components: - '2' x-stackQL-resources: locations: - id: alloydb.locations + id: google.alloydb.locations name: locations title: Locations methods: @@ -3550,13 +3550,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: alloydb.operations + id: google.alloydb.operations name: operations title: Operations methods: @@ -3594,14 +3594,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' clusters: - id: alloydb.clusters + id: google.alloydb.clusters name: clusters title: Clusters methods: @@ -3660,15 +3660,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/clusters/methods/list' - $ref: '#/components/x-stackQL-resources/clusters/methods/get' + - $ref: '#/components/x-stackQL-resources/clusters/methods/list' insert: - $ref: '#/components/x-stackQL-resources/clusters/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/clusters/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/clusters/methods/delete' clusters_secondary: - id: alloydb.clusters_secondary + id: google.alloydb.clusters_secondary name: clusters_secondary title: Clusters_secondary methods: @@ -3687,7 +3688,7 @@ components: update: [] delete: [] instances: - id: alloydb.instances + id: google.alloydb.instances name: instances title: Instances methods: @@ -3753,15 +3754,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/instances/methods/list' - $ref: '#/components/x-stackQL-resources/instances/methods/get' + - $ref: '#/components/x-stackQL-resources/instances/methods/list' insert: - $ref: '#/components/x-stackQL-resources/instances/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/instances/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/instances/methods/delete' instances_secondary: - id: alloydb.instances_secondary + id: google.alloydb.instances_secondary name: instances_secondary title: Instances_secondary methods: @@ -3780,7 +3782,7 @@ components: update: [] delete: [] instances_connection_info: - id: alloydb.instances_connection_info + id: google.alloydb.instances_connection_info name: instances_connection_info title: Instances_connection_info methods: @@ -3799,7 +3801,7 @@ components: update: [] delete: [] users: - id: alloydb.users + id: google.alloydb.users name: users title: Users methods: @@ -3844,15 +3846,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/users/methods/list' - $ref: '#/components/x-stackQL-resources/users/methods/get' + - $ref: '#/components/x-stackQL-resources/users/methods/list' insert: - $ref: '#/components/x-stackQL-resources/users/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/users/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/users/methods/delete' backups: - id: alloydb.backups + id: google.alloydb.backups name: backups title: Backups methods: @@ -3897,15 +3900,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/backups/methods/list' - $ref: '#/components/x-stackQL-resources/backups/methods/get' + - $ref: '#/components/x-stackQL-resources/backups/methods/list' insert: - $ref: '#/components/x-stackQL-resources/backups/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/backups/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/backups/methods/delete' supported_database_flags: - id: alloydb.supported_database_flags + id: google.alloydb.supported_database_flags name: supported_database_flags title: Supported_database_flags methods: 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 8353863e..d533cdc6 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: '20240527' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/bigquery/docs/analytics-hub-introduction servers: @@ -1219,7 +1219,7 @@ components: - '2' x-stackQL-resources: data_exchanges: - id: analyticshub.data_exchanges + id: google.analyticshub.data_exchanges name: data_exchanges title: Data_exchanges methods: @@ -1282,21 +1282,23 @@ components: response: *ref_4 sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/data_exchanges/methods/projects_locations_data_exchanges_list - $ref: >- #/components/x-stackQL-resources/data_exchanges/methods/projects_locations_data_exchanges_get + - $ref: >- + #/components/x-stackQL-resources/data_exchanges/methods/projects_locations_data_exchanges_list - $ref: >- #/components/x-stackQL-resources/data_exchanges/methods/organizations_locations_data_exchanges_list insert: - $ref: >- #/components/x-stackQL-resources/data_exchanges/methods/projects_locations_data_exchanges_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/data_exchanges/methods/projects_locations_data_exchanges_patch delete: - $ref: >- #/components/x-stackQL-resources/data_exchanges/methods/projects_locations_data_exchanges_delete data_exchanges_subscriptions: - id: analyticshub.data_exchanges_subscriptions + id: google.analyticshub.data_exchanges_subscriptions name: data_exchanges_subscriptions title: Data_exchanges_subscriptions methods: @@ -1319,7 +1321,7 @@ components: update: [] delete: [] data_exchanges_iam_policies: - id: analyticshub.data_exchanges_iam_policies + id: google.analyticshub.data_exchanges_iam_policies name: data_exchanges_iam_policies title: Data_exchanges_iam_policies methods: @@ -1356,7 +1358,7 @@ components: update: [] delete: [] listings: - id: analyticshub.listings + id: google.analyticshub.listings name: listings title: Listings methods: @@ -1408,19 +1410,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/listings/methods/projects_locations_data_exchanges_listings_list - $ref: >- #/components/x-stackQL-resources/listings/methods/projects_locations_data_exchanges_listings_get + - $ref: >- + #/components/x-stackQL-resources/listings/methods/projects_locations_data_exchanges_listings_list insert: - $ref: >- #/components/x-stackQL-resources/listings/methods/projects_locations_data_exchanges_listings_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/listings/methods/projects_locations_data_exchanges_listings_patch delete: - $ref: >- #/components/x-stackQL-resources/listings/methods/projects_locations_data_exchanges_listings_delete listings_subscriptions: - id: analyticshub.listings_subscriptions + id: google.analyticshub.listings_subscriptions name: listings_subscriptions title: Listings_subscriptions methods: @@ -1443,7 +1447,7 @@ components: update: [] delete: [] listings_iam_policies: - id: analyticshub.listings_iam_policies + id: google.analyticshub.listings_iam_policies name: listings_iam_policies title: Listings_iam_policies methods: @@ -1480,7 +1484,7 @@ components: update: [] delete: [] subscriptions: - id: analyticshub.subscriptions + id: google.analyticshub.subscriptions name: subscriptions title: Subscriptions methods: @@ -1535,7 +1539,7 @@ components: - $ref: >- #/components/x-stackQL-resources/subscriptions/methods/projects_locations_subscriptions_delete subscriptions_iam_policies: - id: analyticshub.subscriptions_iam_policies + id: google.analyticshub.subscriptions_iam_policies name: subscriptions_iam_policies title: Subscriptions_iam_policies methods: 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 a4936f78..5ad234a0 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/apigateway.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/apigateway.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1 x-discovery-doc-revision: '20240515' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/api-gateway/docs servers: @@ -986,7 +986,7 @@ components: - '2' x-stackQL-resources: locations: - id: apigateway.locations + id: google.apigateway.locations name: locations title: Locations methods: @@ -1008,13 +1008,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: apigateway.operations + id: google.apigateway.operations name: operations title: Operations methods: @@ -1052,14 +1052,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' gateways: - id: apigateway.gateways + id: google.apigateway.gateways name: gateways title: Gateways methods: @@ -1104,15 +1104,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/gateways/methods/list' - $ref: '#/components/x-stackQL-resources/gateways/methods/get' + - $ref: '#/components/x-stackQL-resources/gateways/methods/list' insert: - $ref: '#/components/x-stackQL-resources/gateways/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/gateways/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/gateways/methods/delete' gateways_iam_policies: - id: apigateway.gateways_iam_policies + id: google.apigateway.gateways_iam_policies name: gateways_iam_policies title: Gateways_iam_policies methods: @@ -1149,7 +1150,7 @@ components: update: [] delete: [] apis: - id: apigateway.apis + id: google.apigateway.apis name: apis title: Apis methods: @@ -1194,15 +1195,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/apis/methods/list' - $ref: '#/components/x-stackQL-resources/apis/methods/get' + - $ref: '#/components/x-stackQL-resources/apis/methods/list' insert: - $ref: '#/components/x-stackQL-resources/apis/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/apis/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/apis/methods/delete' apis_iam_policies: - id: apigateway.apis_iam_policies + id: google.apigateway.apis_iam_policies name: apis_iam_policies title: Apis_iam_policies methods: @@ -1239,7 +1241,7 @@ components: update: [] delete: [] configs: - id: apigateway.configs + id: google.apigateway.configs name: configs title: Configs methods: @@ -1284,15 +1286,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/configs/methods/list' - $ref: '#/components/x-stackQL-resources/configs/methods/get' + - $ref: '#/components/x-stackQL-resources/configs/methods/list' insert: - $ref: '#/components/x-stackQL-resources/configs/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/configs/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/configs/methods/delete' configs_iam_policies: - id: apigateway.configs_iam_policies + id: google.apigateway.configs_iam_policies name: configs_iam_policies title: Configs_iam_policies methods: 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 8a37b120..9b702194 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/apigee.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/apigee.yaml @@ -13,7 +13,7 @@ info: 60 days. version: v1 x-discovery-doc-revision: '20240517' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/apigee-api-management/ servers: @@ -39,1441 +39,995 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudApigeeV1Organization: + GoogleCloudApigeeV1DeveloperSubscription: + description: Structure of a DeveloperSubscription. properties: + createdAt: + description: >- + Output only. Time when the API product subscription was created in + milliseconds since epoch. + readOnly: true + type: string + format: int64 name: readOnly: true - description: Output only. Name of the Apigee organization. + description: Output only. Name of the API product subscription. 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. - enum: - - STATE_UNSPECIFIED - - CREATING - - ACTIVE - - DELETING - - UPDATING + startTime: + description: >- + Time when the API product subscription starts in milliseconds since + epoch. + format: int64 type: string + apiproduct: description: >- - Output only. State of the organization. Values other than ACTIVE - means the resource is not ready to use. - readOnly: true + Name of the API product for which the developer is purchasing a + subscription. + type: string + endTime: + format: int64 + type: string + description: >- + Time when the API product subscription ends in milliseconds since + epoch. lastModifiedAt: type: string description: >- - Output only. Time that the Apigee organization was last modified in - milliseconds since epoch. - readOnly: true + Output only. Time when the API product subscription was last + modified in milliseconds since epoch. format: int64 - runtimeDatabaseEncryptionKeyName: + readOnly: true + id: GoogleCloudApigeeV1DeveloperSubscription + type: object + GoogleCloudApigeeV1KeyValueMap: + id: GoogleCloudApigeeV1KeyValueMap + type: object + description: Collection of key/value string pairs. + properties: + encrypted: + type: boolean 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. + 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 - displayName: - description: >- - Display name for the Apigee organization. Unused, but reserved for - future use. + description: Required. ID of the key value map. + GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute: + properties: + environment: type: string - runtimeType: description: >- - Required. Runtime type of the Apigee organization based on the - Apigee subscription purchased. - enum: - - RUNTIME_TYPE_UNSPECIFIED - - CLOUD - - HYBRID - enumDescriptions: - - Runtime type not specified. - - Google-managed Apigee runtime. - - User-managed Apigee hybrid runtime. + Destination environment. This will be empty if the route is not yet + reported. + basepath: + description: Base path in the routing table. type: string - analyticsRegion: + percentage: + format: int32 + description: Percentage of ingress replicas reporting this route. + type: integer + envgroup: + description: Environment group where this route is installed. + type: string + description: Route deployed in the ingress routing table. + id: GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute + type: object + GoogleCloudApigeeV1GraphqlDocumentation: + id: GoogleCloudApigeeV1GraphqlDocumentation + properties: + endpointUri: 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). - deprecated: true - addonsConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' - description: Addon configurations of the Apigee organization. - type: - enum: - - TYPE_UNSPECIFIED - - TYPE_TRIAL - - TYPE_PAID - - TYPE_INTERNAL - description: Not used by Apigee. + Required. The GraphQL endpoint URI to be queried by API consumers. + Max length is 2,083 characters. + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DocumentationFile' + description: Required. The documentation file contents for the GraphQL schema. + description: GraphQL documentation for a catalog item. + type: object + GoogleCloudApigeeV1SecurityReport: + id: GoogleCloudApigeeV1SecurityReport + properties: + displayName: 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. - attributes: - description: Not used by Apigee. - items: - type: string - type: array - caCertificate: + description: Display Name specified by the user. + updated: + description: Output only. Last updated timestamp for the query. readOnly: true type: string - format: byte + created: + description: Creation time of the query. + type: string + error: + description: Error is set when query fails. + type: string + executionTime: + type: string + description: ExecutionTime is available only after the query is completed. + envgroupHostname: + description: Hostname is available only when query is executed at host level. + type: string + resultFileSize: + type: string + description: ResultFileSize is available only after the query is completed. + result: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportResultMetadata' + description: Result is available only after the query is completed. + queryParams: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportMetadata' description: >- - Output only. Base64-encoded public certificate for the root CA of - the Apigee organization. Valid only when [RuntimeType](#RuntimeType) - is `CLOUD`. - subscriptionType: - enum: - - SUBSCRIPTION_TYPE_UNSPECIFIED - - PAID - - TRIAL + Contains information like metrics, dimenstions etc of the Security + Report. + self: type: string 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/). - 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. - readOnly: true - billingType: + 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: type: string - enum: - - BILLING_TYPE_UNSPECIFIED - - SUBSCRIPTION - - EVALUATION - - PAYG - 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. + description: Report Definition ID. + state: description: >- - Billing type of the Apigee organization. See [Apigee - pricing](https://cloud.google.com/apigee/pricing). - description: + Query state could be "enqueued", "running", "completed", "expired" + and "failed". type: string - description: Description of the Apigee organization. - apiConsumerDataEncryptionKeyName: + resultRows: + description: ResultRows is available only after the query is completed. + format: int64 type: string + type: object + description: >- + SecurityReport saves all the information about the created security + report. + GoogleCloudApigeeV1QueryTabularStatsRequest: + properties: + dimensions: + description: Required. List of dimension names to group the aggregations by. + items: + type: string + type: array + pageToken: + type: string + description: Identifies a sequence of rows. + filter: 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/*` - 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. - portalDisabled: - description: Configuration for the Portals settings. - type: boolean - properties: - $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' - description: Properties defined in the Apigee organization profile. - 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 - controlPlaneEncryptionKeyName: - 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/*` - type: string - customerName: - type: string - description: Not used by Apigee. - subscriptionPlan: - enumDescriptions: - - Subscription plan not specified. - - Traditional subscription plan. - - >- - New subscription plan that provides standard proxy and scaled - proxy implementation. - description: >- - Output only. Subscription plan that the customer has purchased. - Output only. - type: string - enum: - - SUBSCRIPTION_PLAN_UNSPECIFIED - - SUBSCRIPTION_2021 - - SUBSCRIPTION_2024 - readOnly: true - 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: string - 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 - projectId: - type: string - description: Output only. Project ID associated with the Apigee organization. - readOnly: true - expiresAt: - format: int64 - readOnly: true - type: string - description: >- - Output only. Time that the Apigee organization is scheduled for - deletion. - createdAt: - description: >- - Output only. Time that the Apigee organization was created in - milliseconds since epoch. - format: int64 + 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 type: string - readOnly: true - environments: + metrics: type: array - description: Output only. List of environments in the Apigee organization. - readOnly: true items: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1MetricAggregation' + description: Required. List of metrics and their aggregations. + timeRange: + description: Time range for the stats. + $ref: '#/components/schemas/GoogleTypeInterval' + pageSize: + description: Page size represents the number of rows. + format: int32 + type: integer + id: GoogleCloudApigeeV1QueryTabularStatsRequest + description: >- + Request payload representing the query to be run for fetching security + statistics as rows. type: object - id: GoogleCloudApigeeV1Organization - GoogleCloudApigeeV1UpdateSecurityIncidentRequest: - description: Request for UpdateSecurityIncident. + GoogleIamV1AuditConfig: properties: - updateMask: + auditLogConfigs: + description: The configuration for logging of each type of permission. + type: array + items: + $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' + service: description: >- - Required. The list of fields to update. Allowed fields are: - LINT.IfChange(allowed_update_fields_comment) - observability - LINT.ThenChange() + 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 - format: google-fieldmask - securityIncident: - description: >- - Required. The security incident to update. Must contain all existing - populated fields of the current incident. - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' - type: object - id: GoogleCloudApigeeV1UpdateSecurityIncidentRequest - GoogleCloudApigeeV1ProfileConfigThreat: - properties: {} - id: GoogleCloudApigeeV1ProfileConfigThreat - type: object description: >- - By default, following policies will be included: - XMLThreatProtection - - JSONThreatProtection - GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence: - id: GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence - description: A sequence of time series. - properties: - dimensions: - type: object - description: >- - Map of dimensions and their values that uniquely identifies a time - series sequence. - additionalProperties: - type: string - points: - items: - type: array - items: - type: any - type: array - description: List of points. First value of each inner list is a timestamp. + 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 type: object - GoogleCloudApigeeV1DeleteCustomReportResponse: + GoogleCloudApigeeV1Attribute: properties: - message: - description: The response contains only a message field. + 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. + id: GoogleCloudApigeeV1Attribute type: object - id: GoogleCloudApigeeV1DeleteCustomReportResponse - GoogleCloudApigeeV1InstanceAttachment: - id: GoogleCloudApigeeV1InstanceAttachment + GoogleCloudApigeeV1RuntimeTraceConfig: description: >- - InstanceAttachment represents the installation of an environment onto an - instance. + NEXT ID: 8 RuntimeTraceConfig defines the configurations for distributed + trace in an environment. type: object properties: - name: - readOnly: true + samplingConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceSamplingConfig' + description: Trace configuration for all API proxies in an environment. + endpoint: type: string - description: Output only. ID of the attachment. - environment: - description: ID of the attached environment. + description: Endpoint of the exporter. + revisionCreateTime: type: string - createdAt: + format: google-datetime + description: The timestamp that the revision was created or updated. + overrides: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceConfigOverride' + type: array + description: List of trace configuration overrides for spicific API proxies. + name: type: string description: >- - Output only. Time the attachment was created in milliseconds since - epoch. - format: int64 - readOnly: true - GoogleCloudApigeeV1Environment: - properties: - createdAt: - readOnly: true - format: int64 + Name of the trace config in the following format: + `organizations/{org}/environment/{env}/traceConfig` + revisionId: type: string description: >- - Output only. Creation time of this environment as milliseconds since - epoch. - type: - enum: - - ENVIRONMENT_TYPE_UNSPECIFIED - - BASE - - INTERMEDIATE - - COMPREHENSIVE - 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. - type: string - apiProxyType: + Revision number which can be used by the runtime to detect if the + trace config has changed between two versions. + exporter: 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. - enum: - - API_PROXY_TYPE_UNSPECIFIED - - PROGRAMMABLE - - CONFIGURABLE - type: string - description: - description: Optional. Description of the environment. - type: string - lastModifiedAt: - type: string - format: int64 - readOnly: true - description: >- - Output only. Last modification time of this environment as - milliseconds since epoch. - displayName: - description: Optional. Display name for this environment. - type: string - hasAttachedFlowHooks: - type: boolean - deploymentType: + 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: - - 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 - type: string - enum: - - DEPLOYMENT_TYPE_UNSPECIFIED - - PROXY - - ARCHIVE - nodeConfig: - description: Optional. NodeConfig of the environment. - $ref: '#/components/schemas/GoogleCloudApigeeV1NodeConfig' - state: - description: >- - Output only. State of the environment. Values other than ACTIVE - means the resource is not ready to use. + - Exporter unspecified + - Jaeger exporter + - Cloudtrace exporter 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. + - EXPORTER_UNSPECIFIED + - JAEGER + - CLOUD_TRACE type: string - readOnly: true - properties: - description: >- - Optional. Key-value pairs that may be used for customizing the - environment. - $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' + id: GoogleCloudApigeeV1RuntimeTraceConfig + GoogleCloudApigeeV1AccessRemove: + properties: name: - description: >- - Required. Name of the environment. Values must match the regular - expression `^[.\\p{Alnum}-_]{1,255}$` - type: string - forwardProxyUri: 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. + success: + type: boolean + description: >- + Remove action. For example, "Remove" : { "name" : "target.name", + "success" : true } type: object - id: GoogleCloudApigeeV1Environment - GoogleCloudApigeeV1GrpcOperationGroup: + id: GoogleCloudApigeeV1AccessRemove + GoogleCloudApigeeV1IntegrationConfig: + type: object + id: GoogleCloudApigeeV1IntegrationConfig + description: Configuration for the Integration add-on. properties: - operationConfigs: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1GrpcOperationConfig' - description: >- - Required. List of operation configurations for either Apigee API - proxies that are associated with this API product. - type: array - description: >- - List of gRPC operation configuration details associated with Apigee API - proxies. + enabled: + description: Flag that specifies whether the Integration add-on is enabled. + type: boolean + GoogleCloudApigeeV1KeyAliasReference: type: object - id: GoogleCloudApigeeV1GrpcOperationGroup - GoogleCloudApigeeV1DeleteResponse: properties: - errorCode: - description: Unique error code for the request, if any. - type: string - status: - type: string - description: Status of the operation. - message: - type: string - description: Description of the operation. - requestId: + reference: type: string - description: Unique ID of the request. - gcpResource: + description: >- + Reference name in the following format: + `organizations/{org}/environments/{env}/references/{reference}` + aliasId: type: string - description: Google Cloud name of deleted resource. - id: GoogleCloudApigeeV1DeleteResponse - type: object - description: Response for certain delete operations. + description: Alias ID. Must exist in the keystore referred to by the reference. + id: GoogleCloudApigeeV1KeyAliasReference GoogleCloudApigeeV1ApiSecurityRuntimeConfig: + type: object id: GoogleCloudApigeeV1ApiSecurityRuntimeConfig description: >- Response for GetApiSecurityRuntimeConfig[EnvironmentService.GetApiSecurityRuntimeConfig]. properties: updateTime: - description: Time that the API Security Runtime configuration was updated. type: string + description: Time that the API Security Runtime configuration was updated. format: google-datetime uid: description: >- Unique ID for the API Security Runtime configuration. The ID will only change if the environment is deleted and recreated. type: string - name: - type: string - description: >- - Name of the environment API Security Runtime configuration resource. - Format: - `organizations/{org}/environments/{env}/apiSecurityRuntimeConfig` location: - description: A list of up to 5 Cloud Storage Blobs that contain SecurityActions. type: array items: type: string + description: A list of up to 5 Cloud Storage Blobs that contain SecurityActions. revisionId: - type: string description: >- Revision ID of the API Security Runtime configuration. The higher the value, the more recently the configuration was deployed. + type: string format: int64 + name: + description: >- + Name of the environment API Security Runtime configuration resource. + Format: + `organizations/{org}/environments/{env}/apiSecurityRuntimeConfig` + type: string + GoogleCloudApigeeV1Certificate: type: object - GoogleCloudApigeeV1Reference: + properties: + certInfo: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1CertInfo' + type: array + description: Chain of certificates under this name. + id: GoogleCloudApigeeV1Certificate + GoogleCloudApigeeV1ProfileConfigAuthorization: type: object + properties: {} + id: GoogleCloudApigeeV1ProfileConfigAuthorization description: >- - A Reference configuration. References must refer to a keystore that also - exists in the parent environment. + By default, following policies will be included: - JWS - JWT - OAuth - + BasicAuth - APIKey + GoogleCloudApigeeV1Operation: + id: GoogleCloudApigeeV1Operation properties: - resourceType: + resource: description: >- - The type of resource referred to by this reference. Valid values are - 'KeyStore' or 'TrustStore'. + Required. REST resource path associated with the API proxy or remote + service. type: string - description: + methods: + 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. + items: + type: string + description: >- + Represents the pairing of REST resource path and the actions (verbs) + allowed on the resource path. + type: object + GoogleCloudApigeeV1SecurityActionDeny: + description: Message that should be set in case of a Deny Action. + type: object + id: GoogleCloudApigeeV1SecurityActionDeny + properties: + responseCode: + description: Optional. The HTTP response code if the Action = DENY. + format: int32 + type: integer + GoogleCloudApigeeV1OrganizationProjectMapping: + id: GoogleCloudApigeeV1OrganizationProjectMapping + properties: + projectId: + description: Google Cloud project associated with the Apigee organization type: string - description: Optional. A human-readable description of this reference. - refers: + organization: + description: Name of the Apigee organization. type: string + projectIds: + type: array + deprecated: true + items: + type: string 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. - name: + DEPRECATED: Use `project_id`. An Apigee Organization is mapped to a + single project. + location: description: >- - Required. The resource id of this reference. Values must match the - regular expression [\w\s\-.]+. + Output only. The Google Cloud region where control plane data is + located. For more information, see + https://cloud.google.com/about/locations/. type: string - id: GoogleCloudApigeeV1Reference - GoogleCloudApigeeV1ApiProduct: + readOnly: true type: object + GoogleCloudApigeeV1DebugSessionTransaction: properties: - createdAt: - description: >- - Response only. Creation time of this environment as milliseconds - since epoch. - type: string - format: int64 - quotaInterval: + point: + type: array description: >- - Time interval over which the number of request messages is - calculated. - type: string + List of debug data collected by runtime plane at various defined + points in the flow. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Point' + completed: + description: Flag indicating whether a transaction is completed or not + type: boolean + type: object + description: >- + A transaction contains all of the debug information of the entire + message flow of an API call processed by the runtime plane. The + information is collected and recorded at critical points of the message + flow in the runtime apiproxy. + id: GoogleCloudApigeeV1DebugSessionTransaction + GoogleCloudApigeeV1DeveloperApp: + id: GoogleCloudApigeeV1DeveloperApp + properties: + attributes: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + description: List of attributes for the developer app. + type: array lastModifiedAt: - type: string + readOnly: true format: int64 description: >- - Response only. Modified time of this environment as milliseconds + Output only. Time the developer app was modified in milliseconds since epoch. - quota: - 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. type: string - 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. - type: string - approvalType: - type: string - 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. scopes: items: type: string type: array 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. - environments: + Scopes to apply to the developer app. The specified scopes must + already exist for the API product that you associate with the + developer app. + developerId: + type: string + description: ID of the developer. + credentials: 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`. items: - type: string - graphqlOperationGroup: - $ref: '#/components/schemas/GoogleCloudApigeeV1GraphQLOperationGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1Credential' 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. - operationGroup: + Output only. Set of credentials for the developer app consisting of + the consumer key/secret pairs associated with the API products. + readOnly: true + status: + type: string 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. - $ref: '#/components/schemas/GoogleCloudApigeeV1OperationGroup' - apiResources: + Status of the credential. Valid values include `approved` or + `revoked`. + name: + description: Name of the developer app. + type: string + callbackUrl: + type: string 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. + Callback URL used by OAuth 2.0 authorization servers to communicate + authorization codes back to developer apps. + apiProducts: items: type: string type: array - proxies: - 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. - type: array - items: - type: string - quotaCounterScope: - enum: - - QUOTA_COUNTER_SCOPE_UNSPECIFIED - - PROXY - - OPERATION + description: List of API products associated with the developer app. + appFamily: type: string - 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: Developer app family. + appId: + description: ID of the developer app. + type: string + createdAt: 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. - displayName: + Output only. Time the developer app was created in milliseconds + since epoch. + format: int64 + type: string + readOnly: true + keyExpiresIn: description: >- - Name displayed in the UI or developer portal to developers - registering for API access. + 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 - grpcOperationGroup: + type: object + GoogleCloudApigeeV1OperationConfig: + id: GoogleCloudApigeeV1OperationConfig + description: >- + Binds the resources in an API proxy or remote service with the allowed + REST methods and associated quota enforcement. + properties: + quota: + $ref: '#/components/schemas/GoogleCloudApigeeV1Quota' 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. - $ref: '#/components/schemas/GoogleCloudApigeeV1GrpcOperationGroup' - attributes: + 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: >- - 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. + 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. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - quotaTimeUnit: + $ref: '#/components/schemas/GoogleCloudApigeeV1Operation' + apiSource: type: string description: >- - Time unit defined for the `quotaInterval`. Valid values include - `minute`, `hour`, `day`, or `month`. - description: + Required. Name of the API proxy or remote service with which the + resources, methods, and quota are associated. + attributes: + description: Custom attributes associated with the operation. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + type: array + type: object + GoogleCloudApigeeV1ArchiveDeployment: + properties: + name: description: >- - Description of the API product. Include key information about the - API product that is not captured by other fields. - type: string - id: GoogleCloudApigeeV1ApiProduct - GoogleCloudApigeeV1GenerateDownloadUrlResponse: - id: GoogleCloudApigeeV1GenerateDownloadUrlResponse - type: object - properties: - downloadUri: - type: string - description: >- - The Google Cloud Storage signed URL that can be used to download the - Archive zip file. - description: Response for GenerateDownloadUrl method. - GoogleCloudApigeeV1SecurityReportQueryMetric: - id: GoogleCloudApigeeV1SecurityReportQueryMetric - properties: - 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: - type: string - description: One of `+`, `-`, `/`, `%`, `*`. - name: - description: Required. Metric name. - type: string - alias: + Name of the Archive Deployment in the following format: + `organizations/{org}/environments/{env}/archiveDeployments/{id}`. type: string + operation: + readOnly: true description: >- - Alias for the metric. Alias will be used to replace metric name in - query results. - description: Metric of the Query - type: object - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest: - description: Request for BatchComputeSecurityAssessmentResults. - id: GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest - type: object - properties: - pageToken: + Output only. A reference to the LRO that created this Archive + Deployment in the following format: + `organizations/{org}/operations/{id}` type: string + labels: + additionalProperties: + type: string description: >- - Optional. A page token, received from a previous - `BatchComputeSecurityAssessmentResults` call. Provide this to - retrieve the subsequent page. - includeAllResources: - description: Include all resources under the scope. - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll - pageSize: - type: integer - format: int32 + 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 + updatedAt: 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. - profile: + Output only. The time at which the Archive Deployment was updated in + milliseconds since the epoch. type: string - description: Required. Name of the profile that is used for computation. - include: - description: Include only these resources. - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray - scope: + readOnly: true + format: int64 + createdAt: + format: int64 + readOnly: true type: string description: >- - Required. Scope of the resources for the computation. For Apigee, - the environment is the scope of the resources. - GoogleCloudApigeeV1AsyncQueryResultView: - type: object - properties: - code: - description: Error code when there is a failure. - format: int32 - type: integer - rows: - items: - type: any - type: array + Output only. The time at which the Archive Deployment was created in + milliseconds since the epoch. + gcsUri: description: >- - Rows of query result. Each row is a JSON object. Example: - {sum(message_count): 1, developer_app: "(not set)",…} - error: - type: string - description: Error message when there is a failure. - state: - description: State of retrieving ResultView. + Input only. The Google Cloud Storage signed URL returned from + GenerateUploadUrl and used to upload the Archive zip file. type: string - metadata: - description: >- - Metadata contains information like metrics, dimenstions etc of the - AsyncQuery. - $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetadata' - id: GoogleCloudApigeeV1AsyncQueryResultView - GoogleCloudApigeeV1DisableSecurityActionRequest: - description: Message to disable an enabled SecurityAction. - id: GoogleCloudApigeeV1DisableSecurityActionRequest - type: object - properties: {} - 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 - GoogleCloudApigeeV1RoutingRule: + id: GoogleCloudApigeeV1ArchiveDeployment + description: Archive Deployment information. + GoogleCloudApigeeV1DebugMask: type: object 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 - type: string - otherTargets: - description: >- - Conflicting targets, which will be resource names specifying either - deployment groups or environments. + requestXPaths: items: type: string type: array - updateTime: - format: google-datetime - 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. - receiver: + List of XPaths that specify the XML elements to be filtered from XML + request message payloads. + responseXPaths: 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 + List of XPaths that specify the XML elements to be filtered from XML + response message payloads. + type: array + items: + type: string + faultJSONPaths: 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: - type: string + List of JSON paths that specify the JSON elements to be filtered + from JSON payloads in error flows. + items: + type: string + type: array + requestJSONPaths: + type: array + items: + type: string 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. - environment: + List of JSON paths that specify the JSON elements to be filtered + from JSON request message payloads. + faultXPaths: + description: >- + List of XPaths that specify the XML elements to be filtered from XML + payloads in error flows. + items: + type: string + type: array + variables: + description: List of variables that should be masked from the debug output. + type: array + items: + type: string + namespaces: + type: object + additionalProperties: + type: string + description: Map of namespaces to URIs. + name: + description: Name of the debug mask. type: string + responseJSONPaths: + items: + 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. - id: GoogleCloudApigeeV1RoutingRule - GoogleCloudApigeeV1ApiSecurityConfig: - type: object + List of JSON paths that specify the JSON elements to be filtered + from JSON response message payloads. + type: array + id: GoogleCloudApigeeV1DebugMask + GoogleCloudApigeeV1TlsInfo: properties: - 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. - type: string - format: int64 enabled: type: boolean - description: Flag that specifies whether the API security add-on is enabled. - id: GoogleCloudApigeeV1ApiSecurityConfig - description: Configurations of the API Security add-on. - GoogleCloudApigeeV1AppGroupAppKey: - id: GoogleCloudApigeeV1AppGroupAppKey - description: >- - AppGroupAppKey contains all the information associated with the - credentials. - properties: - expiresAt: - type: string - format: int64 - readOnly: true description: >- - Output only. Time the AppGroup app expires in milliseconds since - epoch. - status: + Required. Enables TLS. If false, neither one-way nor two-way TLS + will be enabled. + keyAlias: type: string description: >- - Status of the credential. Valid values include `approved` or - `revoked`. - apiProducts: - readOnly: true - 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. + Required if `client_auth_enabled` is true. The resource ID for the + alias containing the private key and cert. + commonName: + description: The TLS Common Name of the certificate. + $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfoCommonName' + ciphers: type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1APIProductAssociation' - scopes: + 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 - 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 - consumerSecret: - description: Secret key. + trustStore: + description: The resource ID of the truststore. type: string - expiresInSeconds: + enforce: + description: TLS is strictly enforced. + type: boolean + ignoreValidationErrors: + type: boolean 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 - format: int64 - issuedAt: - readOnly: true + 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: description: >- - Output only. Time the AppGroup app was created in milliseconds since - epoch. + Required if `client_auth_enabled` is true. The resource ID of the + keystore. type: string - format: int64 - attributes: - type: array - description: List of attributes associated with the credential. + clientAuthEnabled: + description: Optional. Enables two-way TLS. + type: boolean + protocols: + description: The TLS versioins to be used. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - consumerKey: - type: string - description: Immutable. Consumer key. + type: string + type: array + description: TLS configuration information for virtual hosts and TargetServers. type: object - GoogleCloudApigeeV1DeveloperSubscription: - description: Structure of a DeveloperSubscription. - id: GoogleCloudApigeeV1DeveloperSubscription + id: GoogleCloudApigeeV1TlsInfo + GoogleCloudApigeeV1ListOrganizationsResponse: type: object + id: GoogleCloudApigeeV1ListOrganizationsResponse properties: - endTime: + organizations: + description: List of Apigee organizations and associated Google Cloud projects. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1OrganizationProjectMapping' + type: array + GoogleCloudApigeeV1UpdateSecurityIncidentRequest: + type: object + description: Request for UpdateSecurityIncident. + id: GoogleCloudApigeeV1UpdateSecurityIncidentRequest + properties: + updateMask: description: >- - Time when the API product subscription ends in milliseconds since - epoch. - format: int64 - type: string - apiproduct: + Required. The list of fields to update. Allowed fields are: + LINT.IfChange(allowed_update_fields_comment) - observability + LINT.ThenChange() + format: google-fieldmask type: string + securityIncident: description: >- - Name of the API product for which the developer is purchasing a - subscription. - createdAt: - type: string + Required. The security incident to update. Must contain all existing + populated fields of the current incident. + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' + GoogleCloudApigeeV1GetSyncAuthorizationRequest: + description: Request for GetSyncAuthorization. + type: object + id: GoogleCloudApigeeV1GetSyncAuthorizationRequest + properties: {} + GoogleCloudApigeeV1OASDocumentation: + properties: + format: + enum: + - FORMAT_UNSPECIFIED + - YAML + - JSON readOnly: true - format: int64 + enumDescriptions: + - The format is not available. + - YAML format. + - JSON format. + type: string + description: Output only. The format of the input specification file contents. + spec: + $ref: '#/components/schemas/GoogleCloudApigeeV1DocumentationFile' description: >- - Output only. Time when the API product subscription was created in - milliseconds since epoch. - lastModifiedAt: - format: int64 - readOnly: true + Required. The documentation file contents for the OpenAPI + Specification. JSON and YAML file formats are supported. + description: OpenAPI Specification documentation for a catalog item. + id: GoogleCloudApigeeV1OASDocumentation + type: object + GoogleCloudApigeeV1OptimizedStatsResponse: + properties: + TimeUnit: + type: array + items: + type: string + format: int64 description: >- - Output only. Time when the API product subscription was last - modified in milliseconds since epoch. - type: string - startTime: + List of time unit values. Time unit refers to an epoch timestamp + value. + metaData: + $ref: '#/components/schemas/GoogleCloudApigeeV1Metadata' + description: Metadata information about the query executed. + stats: + description: '`stats` results.' + $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStatsNode' + resultTruncated: + type: boolean description: >- - Time when the API product subscription starts in milliseconds since - epoch. - format: int64 - type: string - name: - readOnly: true - type: string - description: Output only. Name of the API product subscription. - GoogleCloudApigeeV1KeyAliasReference: - id: GoogleCloudApigeeV1KeyAliasReference + Boolean flag that indicates whether the results were truncated based + on the limit parameter. + id: GoogleCloudApigeeV1OptimizedStatsResponse type: object + description: Encapsulates a response format for JavaScript Optimized Scenario. + GoogleCloudApigeeV1DateRange: + description: Date range of the data to export. + id: GoogleCloudApigeeV1DateRange properties: - aliasId: + 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 - description: Alias ID. Must exist in the keystore referred to by the reference. - reference: + start: description: >- - Reference name in the following format: - `organizations/{org}/environments/{env}/references/{reference}` + 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 - GoogleCloudApigeeV1AccessLoggingConfig: type: object - id: GoogleCloudApigeeV1AccessLoggingConfig + GoogleCloudApigeeV1Session: + description: Session carries the debug session id and its creation time. properties: - 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 ) + id: + type: string + description: The debug session ID. + timestampMs: + format: int64 type: string - enabled: description: >- - Optional. Boolean flag that specifies whether the customer access - log feature is enabled. - type: boolean - 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. - GoogleCloudApigeeV1EnvironmentGroupAttachment: - description: >- - EnvironmentGroupAttachment is a resource which defines an attachment of - an environment to an environment group. - id: GoogleCloudApigeeV1EnvironmentGroupAttachment + The first transaction creation timestamp in millisecond, recorded by + UAP. + type: object + id: GoogleCloudApigeeV1Session + GoogleCloudApigeeV1QueryMetric: properties: - environmentGroupId: - readOnly: true + function: + description: 'Aggregation function: avg, min, max, or sum.' type: string - description: Output only. ID of the environment group. + value: + type: string + description: Operand value should be provided when operator is set. name: - description: ID of the environment group attachment. type: string - createdAt: - description: >- - Output only. The time at which the environment group attachment was - created as milliseconds since epoch. + description: Required. Metric name. + operator: type: string - readOnly: true - format: int64 - environment: + description: One of `+`, `-`, `/`, `%`, `*`. + alias: + description: >- + Alias for the metric. Alias will be used to replace metric name in + query results. type: string - description: Required. ID of the attached environment. - type: object - GoogleCloudApigeeV1ProfileConfigMTLS: - id: GoogleCloudApigeeV1ProfileConfigMTLS - type: object - properties: {} - description: Checks to see if you have configured mTLS for the target server. - GoogleCloudApigeeV1QueryTabularStatsRequest: - properties: - dimensions: - items: - type: string - description: Required. List of dimension names to group the aggregations by. - type: array - metrics: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1MetricAggregation' - type: array - description: Required. List of metrics and their aggregations. - pageToken: - type: string - description: Identifies a sequence of rows. - timeRange: - description: Time range for the stats. - $ref: '#/components/schemas/GoogleTypeInterval' - 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 - description: Page size represents the number of rows. - type: integer type: object + id: GoogleCloudApigeeV1QueryMetric description: >- - Request payload representing the query to be run for fetching security - statistics as rows. - id: GoogleCloudApigeeV1QueryTabularStatsRequest - GoogleCloudApigeeV1ApiCategory: - type: object + More info about Metric: + https://docs.apigee.com/api-platform/analytics/analytics-reference#metrics + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink: + id: >- + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink properties: - name: - type: string - description: Name of the category. - updateTime: - format: int64 - description: Time the category was last modified in milliseconds since epoch. - type: string - siteId: + text: type: string - description: Name of the portal. - id: + description: 'The text of the url. (ie: "Learn more")' + uri: type: string - description: ID of the category (a UUID). - 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. - GoogleCloudApigeeV1RuntimeAnalyticsConfig: - properties: - enabled: - type: boolean - description: If the Analytics is enabled or not. - billingPipelineEnabled: - description: If Runtime should send billing data to AX or not. - type: boolean - type: object - id: GoogleCloudApigeeV1RuntimeAnalyticsConfig - description: Runtime configuration for the Analytics add-on. - GoogleCloudApigeeV1GrpcOperationConfig: + description: The link itself. type: object + description: The format for a link in the recommendation. + GoogleCloudApigeeV1GraphQLOperationGroup: + id: GoogleCloudApigeeV1GraphQLOperationGroup description: >- - Binds the resources in a proxy or remote service with the gRPC operation - and its associated quota enforcement. - id: GoogleCloudApigeeV1GrpcOperationConfig + 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: - methods: - items: - type: string + operationConfigs: type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1GraphQLOperationConfig' 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: >- - Required. gRPC Service name associated to be associated with the API - proxy, on which quota rules can be applied upon. - type: string - apiSource: + Required. List of operation configurations for either Apigee API + proxies or other remote services that are associated with this API + product. + operationConfigType: type: string description: >- - Required. Name of the API proxy with which the gRPC operation and - quota are associated. - attributes: - description: Custom attributes associated with the operation. - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - GoogleCloudApigeeV1Score: - properties: - timeRange: - description: Start and end time for the score. - $ref: '#/components/schemas/GoogleTypeInterval' - component: - $ref: '#/components/schemas/GoogleCloudApigeeV1ScoreComponent' - description: Component containing score, recommendations and actions. - subcomponents: - description: List of all the drilldown score components. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ScoreComponent' - type: array + 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: object - description: Represents Security Score. - id: GoogleCloudApigeeV1Score - GoogleIamV1TestIamPermissionsResponse: + GoogleCloudApigeeV1ListHybridIssuersResponse: type: object + id: GoogleCloudApigeeV1ListHybridIssuersResponse properties: - permissions: + issuers: + description: Lists of hybrid services and its trusted issuer email ids. type: array - description: >- - A subset of `TestPermissionsRequest.permissions` that the caller is - allowed. items: - type: string - id: GoogleIamV1TestIamPermissionsResponse - description: Response message for `TestIamPermissions` method. - GoogleCloudApigeeV1ListSharedFlowsResponse: - description: >- - To change this message, in the same CL add a change log in - go/changing-api-proto-breaks-ui + $ref: '#/components/schemas/GoogleCloudApigeeV1ServiceIssuersMapping' + GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext: properties: - sharedFlows: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' - id: GoogleCloudApigeeV1ListSharedFlowsResponse + documentationLink: + type: string + description: Documentation link for the action. + id: GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext + type: object + description: Action context are all the relevant details for the action. + GoogleCloudApigeeV1EndpointAttachment: type: object - GoogleCloudApigeeV1EnvironmentGroup: - description: >- - EnvironmentGroup configuration. An environment group is used to group - one or more Apigee environments under a single host name. properties: - lastModifiedAt: + serviceAttachment: + description: 'Format: projects/*/regions/*/serviceAttachments/*' type: string + state: + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - UPDATING description: >- - Output only. The time at which the environment group was last - updated as milliseconds since epoch. - readOnly: true - format: int64 - hostnames: - items: - type: string - description: Required. Host names for this environment group. - type: array - createdAt: + Output only. State of the endpoint attachment. Values other than + `ACTIVE` mean the resource is not ready to use. type: string - description: >- - Output only. The time at which the environment group was created as - milliseconds since epoch. - format: int64 readOnly: true - 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. - readOnly: true + connectionState: + description: >- + Output only. State of the endpoint attachment connection to the + service attachment. enum: - - STATE_UNSPECIFIED - - CREATING - - ACTIVE - - DELETING - - UPDATING + - CONNECTION_STATE_UNSPECIFIED + - UNAVAILABLE + - PENDING + - ACCEPTED + - REJECTED + - CLOSED + - FROZEN + - NEEDS_ATTENTION + type: string + 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. + location: + description: Required. Location of the endpoint attachment. + type: string + host: + readOnly: true description: >- - Output only. State of the environment group. Values other than - ACTIVE means the resource is not ready to use. + Output only. Host that can be used in either the HTTP target + endpoint directly or as the host in target server. + type: string name: type: string - description: ID of the environment group. - type: object - id: GoogleCloudApigeeV1EnvironmentGroup - GoogleCloudApigeeV1DatastoreConfig: - description: Configuration detail for datastore - type: object - id: GoogleCloudApigeeV1DatastoreConfig - properties: - path: - type: string - description: Path of Cloud Storage bucket Required for `gcs` target_type. - bucketName: - description: Name of the Cloud Storage bucket. Required for `gcs` target_type. - type: string - datasetName: - type: string - description: BigQuery dataset name Required for `bigquery` target_type. - tablePrefix: - type: string - description: Prefix of BigQuery table Required for `bigquery` target_type. - projectId: - description: Required. GCP project in which the datastore exists - type: string - GoogleCloudApigeeV1Attribute: - type: object - id: GoogleCloudApigeeV1Attribute - description: Key-value pair to store extra metadata. - properties: - value: - type: string - description: Value of the attribute. - name: - description: API key of the attribute. - type: string - GoogleCloudApigeeV1DebugSession: - properties: - tracesize: - type: integer - format: int32 - description: >- - Optional. The maximum number of bytes captured from the response - payload. Min = 0, Max = 5120, Default = 5120. - validity: - 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. - type: integer - format: int32 - createTime: - type: string - description: >- - Output only. The first transaction creation timestamp, recorded by - UAP. - format: google-datetime - readOnly: true - count: - type: integer - format: int32 - description: >- - Optional. The number of request to be traced. Min = 1, Max = 15, - Default = 10. - 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. - 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 - name: - type: string - description: A unique ID for this DebugSession. - type: object - id: GoogleCloudApigeeV1DebugSession - GoogleCloudApigeeV1ListOfDevelopersResponse: + Name of the endpoint attachment. Use the following structure in your + request: + `organizations/{org}/endpointAttachments/{endpoint_attachment}` + 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). + 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 - id: GoogleCloudApigeeV1ListOfDevelopersResponse properties: - developer: - description: List of developers. + categoryIds: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + type: string type: array - GoogleCloudApigeeV1SyncAuthorization: - type: object - properties: - 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: - type: array + Optional. The IDs of the API categories to which this catalog item + belongs. + title: 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 - id: GoogleCloudApigeeV1SyncAuthorization - GoogleCloudApigeeV1Session: - description: Session carries the debug session id and its creation time. - properties: - id: - type: string - description: The debug session ID. - timestampMs: - format: int64 + 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 - description: >- - The first transaction creation timestamp in millisecond, recorded by - UAP. - id: GoogleCloudApigeeV1Session - type: object - GoogleCloudApigeeV1ApiDoc: - properties: - visibility: - type: boolean - description: 'Optional. DEPRECATED: use the `published` field instead' - specId: - description: 'Optional. DEPRECATED: DO NOT USE' + graphqlEndpointUrl: deprecated: true + description: >- + Optional. DEPRECATED: manage documentation through the + `getDocumentation` and `updateDocumentation` methods type: string - id: - description: Output only. The ID of the catalog item. - format: int64 - type: string - readOnly: true 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 @@ -1486,49 +1040,66 @@ components: 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 - description: - description: >- - Optional. Description of the catalog item. Max length is 10,000 - characters. + id: + format: int64 + description: Output only. The ID of the catalog item. + readOnly: true type: string - graphqlEndpointUrl: + specId: + deprecated: true + description: 'Optional. DEPRECATED: DO NOT USE' + type: string + graphqlSchemaDisplayName: + type: string + deprecated: true description: >- Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods - deprecated: true - type: string siteId: - type: string - readOnly: true description: Output only. The ID of the parent portal. - edgeAPIProductName: + readOnly: true type: string + visibility: + type: boolean + description: 'Optional. DEPRECATED: use the `published` field instead' + graphqlSchema: description: >- - Optional. Immutable. DEPRECATED: use the `apiProductName` field - instead + Optional. DEPRECATED: manage documentation through the + `getDocumentation` and `updateDocumentation` methods + type: string + deprecated: true modified: + format: int64 + type: string + readOnly: true description: >- Output only. Time the catalog item was last modified in milliseconds since epoch. - readOnly: true + 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). + apiProductName: type: string - format: int64 - graphqlSchema: description: >- - Optional. DEPRECATED: manage documentation through the - `getDocumentation` and `updateDocumentation` methods - deprecated: true + 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: type: string - categoryIds: description: >- - Optional. The IDs of the API categories to which this catalog item - belongs. - type: array - items: - type: string + Optional. Description of the catalog item. Max length is 10,000 + characters. + edgeAPIProductName: + type: string + description: >- + Optional. Immutable. DEPRECATED: use the `apiProductName` field + instead 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 @@ -1542,12 +1113,9 @@ 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. - 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 + type: boolean imageUrl: + type: string 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 @@ -1560,120 +1128,160 @@ components: [content security policies](/apigee/docs/api-platform/publish/portal/csp). Max length of file path is 2,083 characters. - type: string - apiProductName: + id: GoogleCloudApigeeV1ApiDoc + GoogleCloudApigeeV1ListInstanceAttachmentsResponse: + id: GoogleCloudApigeeV1ListInstanceAttachmentsResponse + description: Response for ListInstanceAttachments. + properties: + attachments: + type: array + description: Attachments for the instance. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceAttachment' + nextPageToken: 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: - 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). - graphqlSchemaDisplayName: - deprecated: true + 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 - description: >- - Optional. DEPRECATED: manage documentation through the - `getDocumentation` and `updateDocumentation` methods type: object - 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. - id: GoogleCloudApigeeV1ApiDoc - GoogleCloudApigeeV1OptimizedStatsNode: - id: GoogleCloudApigeeV1OptimizedStatsNode - properties: - data: - items: - type: any - type: array + GoogleCloudApigeeV1Result: + id: GoogleCloudApigeeV1Result 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. - GoogleCloudApigeeV1ListAppsResponse: - id: GoogleCloudApigeeV1ListAppsResponse - type: object + 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 properties: - totalSize: - type: integer - format: int32 - description: Total count of Apps. - nextPageToken: + verb: + type: string + description: HTTP method verb + timestamp: 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: + 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"` + reasonPhrase: + description: HTTP response phrase + type: string + content: + type: string + description: >- + Error message content. for example, "content" : + "{\"fault\":{\"faultstring\":\"API timed + out\",\"detail\":{\"errorcode\":\"flow.APITimedOut\"}}}" + ActionResult: + type: string + description: >- + Type of the action result. Can be one of the five: DebugInfo, + RequestMessage, ResponseMessage, ErrorMessage, VariableAccess + headers: type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1App' - GoogleCloudApigeeV1DeploymentGroupConfig: - description: >- - DeploymentGroupConfig represents a deployment group that should be - present in a particular environment. - type: object - properties: - deploymentGroupType: - enumDescriptions: - - Unspecified type - - Standard type - - Extensible Type + $ref: '#/components/schemas/GoogleCloudApigeeV1Property' + description: >- + A list of HTTP headers. for example, '"headers" : [ { "name" : + "Content-Length", "value" : "83" }, { "name" : "Content-Type", + "value" : "application/json" } ]' + uRI: type: string - enum: - - DEPLOYMENT_GROUP_TYPE_UNSPECIFIED - - STANDARD - - EXTENSIBLE description: >- - Type of the deployment group, which will be either Standard or - Extensible. - revisionId: - format: int64 + The relative path of the api proxy. for example, `"uRI" : + "/iloveapis"` + statusCode: + description: HTTP response code type: string + properties: + description: Name value pairs used for DebugInfo ActionResult. + $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' + accessList: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Access' description: >- - Revision number which can be used by the runtime to detect if the - deployment group has changed between two versions. - name: + A list of variable access actions agaist the api proxy. Supported + values: Get, Set, Remove. + type: array + GoogleCloudApigeeV1TraceSamplingConfig: + type: 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: + enum: + - SAMPLER_UNSPECIFIED + - 'OFF' + - PROBABILITY 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. + description: Sampler of distributed tracing. OFF is the default value. + samplingRate: description: >- - Name of the deployment group in the following format: - `organizations/{org}/environments/{env}/deploymentGroups/{group}`. - uid: + Field sampling rate. This value is only applicable when using the + PROBABILITY sampler. The supported values are > 0 and <= 0.5. + type: number + format: float + id: GoogleCloudApigeeV1TraceSamplingConfig + GoogleCloudApigeeV1ListApiDocsResponse: + id: GoogleCloudApigeeV1ListApiDocsResponse + properties: + message: type: string + description: Description of the operation. + nextPageToken: description: >- - Unique ID. The ID will only change if the deployment group is - deleted and recreated. - id: GoogleCloudApigeeV1DeploymentGroupConfig - GoogleCloudApigeeV1AliasRevisionConfig: + 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 + status: + description: Status of the operation. + type: string + data: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' + type: array + description: The catalog item resources. + errorCode: + type: string + description: Unique error code for the request, if any. + requestId: + description: Unique ID of the request. + type: string type: object + GoogleCloudApigeeV1AliasRevisionConfig: + id: GoogleCloudApigeeV1AliasRevisionConfig properties: + location: + description: Location of the alias file. For example, a Google Cloud Storage URI. + type: string 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}` - location: - type: string - description: Location of the alias file. For example, a Google Cloud Storage URI. type: - type: string enumDescriptions: - Alias type is not specified. - Certificate. @@ -1682,536 +1290,567 @@ components: - ALIAS_TYPE_UNSPECIFIED - CERT - KEY_CERT - id: GoogleCloudApigeeV1AliasRevisionConfig - GoogleCloudApigeeV1ApiDocDocumentationResponse: - type: object - properties: - requestId: - description: Output only. Unique ID of the request. - type: string - readOnly: true - data: - description: Output only. The documentation resource. - readOnly: true - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocDocumentation' - message: - readOnly: true - description: Output only. Description of the operation. - type: string - errorCode: - type: string - readOnly: true - description: Output only. Unique error code for the request, if any. - status: type: string - readOnly: true - description: Output only. Status of the operation. + type: object + GoogleProtobufEmpty: + type: object description: >- - The catalog item documentation wrapped with response status, error_code, - etc. - id: GoogleCloudApigeeV1ApiDocDocumentationResponse - GoogleCloudApigeeV1ListApiDocsResponse: + 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: {} + GoogleCloudApigeeV1InstanceDeploymentStatus: type: object - id: GoogleCloudApigeeV1ListApiDocsResponse + description: The status of a deployment as reported by a single instance. + id: GoogleCloudApigeeV1InstanceDeploymentStatus 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 - status: - description: Status of the operation. + deployedRevisions: + description: Revisions currently deployed in MPs. + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision + type: array + instance: type: string - message: - description: Description of the operation. - type: string - errorCode: - description: Unique error code for the request, if any. - type: string - requestId: - description: Unique ID of the request. - type: string - data: + description: ID of the instance reporting the status. + deployedRoutes: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' - description: The catalog item resources. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute type: array - GoogleCloudApigeeV1QueryTabularStatsResponse: + description: >- + Current routes deployed in the ingress routing table. A route which + is missing will appear in `missing_routes`. + GoogleCloudApigeeV1DeploymentChangeReportRoutingChange: + description: >- + Describes a potential routing change that may occur as a result of some + deployment operation. properties: - columns: + environmentGroup: + description: Name of the environment group affected by this routing change. + type: string + 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 + description: + type: string + description: Human-readable description of this routing change. + fromDeployment: + description: Base path/deployment that may stop receiving some traffic. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment + toDeployment: + description: >- + Base path/deployment that may start receiving that traffic. May be + null if no deployment is able to receive the traffic. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment + type: object + id: GoogleCloudApigeeV1DeploymentChangeReportRoutingChange + GoogleCloudApigeeV1DimensionMetric: + id: GoogleCloudApigeeV1DimensionMetric + description: Encapsulates a metric grouped by dimension. + properties: + metrics: + description: List of metrics. items: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' type: array + name: + deprecated: true description: >- - Column names corresponding to the same order as the inner values in - the stats field. - values: + 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. + type: string + individualNames: + description: Individual dimension names. E.g. ["dim1_name", "dim2_name"]. type: array items: - type: array - items: - type: any - description: Resultant rows from the executed query. - nextPageToken: - type: string - description: Next page token. - 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. - id: GoogleCloudApigeeV1QueryTabularStatsResponse - type: object - GoogleCloudApigeeV1ReportInstanceStatusResponse: - description: Placeholder for future enhancements to status reporting protocol - type: object - properties: {} - id: GoogleCloudApigeeV1ReportInstanceStatusResponse - GoogleCloudApigeeV1GetSyncAuthorizationRequest: - properties: {} + type: string type: object - description: Request for GetSyncAuthorization. - id: GoogleCloudApigeeV1GetSyncAuthorizationRequest - GoogleCloudApigeeV1SecurityActionHttpHeader: + GoogleCloudApigeeV1SecurityIncident: type: object + id: GoogleCloudApigeeV1SecurityIncident properties: - value: - description: The header value to be sent to the target. - type: string name: - description: The header name to be sent to the target. type: string - description: An HTTP header. - id: GoogleCloudApigeeV1SecurityActionHttpHeader - GoogleCloudApigeeV1OrganizationProjectMapping: - type: object - id: GoogleCloudApigeeV1OrganizationProjectMapping - properties: - projectId: - description: Google Cloud project associated with the Apigee organization + 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: type: string - organization: + format: int64 + description: Total traffic detected as part of the incident. + firstDetectedTime: + format: google-datetime type: string - description: Name of the Apigee organization. - location: + description: >- + Output only. The time when events associated with the incident were + first detected. readOnly: true - type: string + lastObservabilityChangeTime: description: >- - Output only. The Google Cloud region where control plane data is - located. For more information, see - https://cloud.google.com/about/locations/. - projectIds: - type: array + Output only. The time when the incident observability was last + changed. + format: google-datetime + type: string + readOnly: true + detectionTypes: + readOnly: true description: >- - DEPRECATED: Use `project_id`. An Apigee Organization is mapped to a - single project. + Output only. Detection types which are part of the incident. + Examples: Flooder, OAuth Abuser, Static Content Scraper, Anomaly + Detection. items: type: string - deprecated: true - GoogleCloudApigeeV1DeveloperAppKey: - type: object - properties: - consumerKey: + type: array + riskLevel: + enum: + - RISK_LEVEL_UNSPECIFIED + - LOW + - MODERATE + - SEVERE + 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. + readOnly: true type: string - description: Consumer key. - expiresAt: - format: int64 + description: Output only. Risk level of the incident. + 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: Time the developer app expires in milliseconds since epoch. - status: + displayName: type: string + description: Optional. Display name of the security incident. + lastDetectedTime: description: >- - Status of the credential. Valid values include `approved` or - `revoked`. - expiresInSeconds: + Output only. The time when events associated with the incident were + last detected. type: string - format: int64 + format: google-datetime + readOnly: true + description: Represents an SecurityIncident resource. + GoogleCloudApigeeV1ListTraceConfigOverridesResponse: + id: GoogleCloudApigeeV1ListTraceConfigOverridesResponse + type: object + description: Response for ListTraceConfigOverrides. + properties: + nextPageToken: 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. - consumerSecret: - description: Secret key. + Token value that can be passed as `page_token` to retrieve the next + page of content. type: string - apiProducts: + traceConfigOverrides: + description: List all trace configuration overrides in an environment. type: array - description: >- - List of API products for which the credential can be used. **Note**: - Do not specify the list of API products when creating a consumer key - and secret for a developer app. Instead, use the - UpdateDeveloperAppKey API to make the association after the consumer - key and secret are created. - items: - type: any - attributes: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - type: array - description: List of attributes associated with the credential. - scopes: - type: array + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + GoogleCloudApigeeV1SetAddonsRequest: + type: object + description: Request for SetAddons. + properties: + addonsConfig: + description: Required. Add-on configurations. + $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' + id: GoogleCloudApigeeV1SetAddonsRequest + GoogleIamV1TestIamPermissionsResponse: + description: Response message for `TestIamPermissions` method. + id: GoogleIamV1TestIamPermissionsResponse + type: object + properties: + permissions: 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. + A subset of `TestPermissionsRequest.permissions` that the caller is + allowed. + type: array items: type: string - issuedAt: - type: string - description: Time the developer app was created in milliseconds since epoch. - format: int64 - id: GoogleCloudApigeeV1DeveloperAppKey - GoogleCloudApigeeV1EnvironmentGroupConfig: - id: GoogleCloudApigeeV1EnvironmentGroupConfig + GoogleCloudApigeeV1TlsInfoConfig: + id: GoogleCloudApigeeV1TlsInfoConfig properties: - endpointChainingRules: - type: array - description: A list of proxies in each deployment group for proxy chaining calls. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointChainingRule' - uid: + trustStore: + type: string description: >- - A unique id for the environment group config that will only change - if the environment group is deleted and recreated. + 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}` + commonName: + description: Common name to validate the target server against. + $ref: '#/components/schemas/GoogleCloudApigeeV1CommonNameConfig' + clientAuthEnabled: + type: boolean + description: >- + Flag that specifies whether client-side authentication is enabled + for the target server. Enables two-way TLS. + keyAliasReference: + description: Reference name and alias pair to use for client-side authentication. + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyAliasReference' + 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 - hostnames: - description: Host names for the environment group. + enforce: + description: Flag that enforces TLS settings + type: boolean + ignoreValidationErrors: + description: >- + Flag that specifies whether to ignore TLS certificate validation + errors. Set to `true` to ignore errors. + type: boolean + protocols: + type: array + description: List of TLS protocols that are granted access. items: type: string - type: array - routingRules: - description: >- - Ordered list of routing rules defining how traffic to this - environment group's hostnames should be routed to different - environments. + ciphers: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1RoutingRule' + type: string + description: List of ciphers that are granted access. type: array - name: + enabled: description: >- - Name of the environment group in the following format: - `organizations/{org}/envgroups/{envgroup}`. + Flag that specifies whether one-way TLS is enabled. Set to `true` to + enable one-way TLS. + type: boolean + type: object + GoogleCloudApigeeV1ApiCategoryResponse: + properties: + requestId: type: string - revisionId: - description: >- - Revision id that defines the ordering of the EnvironmentGroupConfig - resource. The higher the revision, the more recently the - configuration was deployed. + description: Unique ID of the request. + data: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' + description: The API category resource. + status: type: string - format: int64 - location: + description: Status of the operation. + message: type: string - 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. + description: Description of the operation. + errorCode: + type: string + description: Unique error code for the request, if any. + id: GoogleCloudApigeeV1ApiCategoryResponse type: object + description: The API category resource wrapped with response status, error_code, etc. + GoogleCloudApigeeV1TraceConfigOverride: + type: object + properties: + samplingConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceSamplingConfig' + description: Trace configuration to override. + apiProxy: + type: string + description: >- + ID of the API proxy that will have its trace configuration + overridden. + name: + description: >- + ID of the trace configuration override specified as a + system-generated UUID. + type: string + id: GoogleCloudApigeeV1TraceConfigOverride + description: A representation of a configuration override. + GoogleCloudApigeeV1Datastore: + id: GoogleCloudApigeeV1Datastore description: >- - EnvironmentGroupConfig is a revisioned snapshot of an EnvironmentGroup - and its associated routing rules. - GoogleTypeMoney: - description: Represents an amount of money with its currency type. + The data store defines the connection to export data repository (Cloud + Storage, BigQuery), including the credentials used to access the data + repository. properties: - units: + lastUpdateTime: + type: string + readOnly: true + description: >- + Output only. Datastore last update time, in milliseconds since the + epoch of 1970-01-01T00:00:00Z format: int64 + displayName: + description: Required. Display name in UI + type: string + targetType: + description: Destination storage type. Supported types `gcs` or `bigquery`. + type: string + self: + type: string + readOnly: true description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. + Output only. Resource link of Datastore. Example: + `/organizations/{org}/analytics/datastores/{uuid}` + org: + type: string + readOnly: true + description: Output only. Organization that the datastore belongs to + datastoreConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1DatastoreConfig' + description: Datastore Configurations. + createTime: type: string - 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 - currencyCode: - description: The three-letter currency code defined in ISO 4217. + Output only. Datastore create time, in milliseconds since the epoch + of 1970-01-01T00:00:00Z + readOnly: true + format: int64 + type: object + GoogleCloudApigeeV1Subscription: + description: Pub/Sub subscription of an environment. + type: object + id: GoogleCloudApigeeV1Subscription + properties: + name: + description: >- + Full name of the Pub/Sub subcription. Use the following structure in + your request: `subscription "projects/foo/subscription/bar"` type: string + GoogleCloudApigeeV1EnvironmentConfig: + id: GoogleCloudApigeeV1EnvironmentConfig type: object - id: GoogleTypeMoney - GoogleCloudApigeeV1RatePlan: properties: - currencyCode: + featureFlags: + additionalProperties: + type: string + description: Feature flags inherited from the organization and environment. + type: object + arcConfigLocation: type: string 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. - lastModifiedAt: + 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. + pubsubTopic: type: string + description: Name of the PubSub topic for the environment. + flowhooks: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHookConfig' + type: array + description: List of flow hooks in the environment. + dataCollectors: + description: List of data collectors used by the deployments in the environment. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollectorConfig' + targets: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServerConfig' description: >- - Output only. Time the rate plan was last modified in milliseconds - since epoch. - readOnly: true + List of target servers in the environment. Disabled target servers + are not displayed. + type: array + sequenceNumber: format: int64 - 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 - paymentFundingModel: - deprecated: true - 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. + description: 'DEPRECATED: Use revision_id.' + provider: type: string - enum: - - PAYMENT_FUNDING_MODEL_UNSPECIFIED - - PREPAID - - POSTPAID 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. - revenueShareRates: + Used by the Control plane to add context information to help detect + the source of the document during diagnostics and debugging. + uid: + description: >- + Unique ID for the environment configuration. The ID will only change + if the environment is deleted and recreated. + type: string + debugMask: + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' + description: Debug mask that applies to all deployments in the environment. + keystores: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1RevenueShareRange' - description: Details of the revenue sharing model. + $ref: '#/components/schemas/GoogleCloudApigeeV1KeystoreConfig' + description: List of keystores in the environment. type: array - fixedFeeFrequency: - description: Frequency at which the fixed fee is charged. - type: integer - format: int32 - billingPeriod: - description: Frequency at which the customer will be billed. + forwardProxyUri: type: string - enumDescriptions: - - Billing period not specified. - - >- - Weekly billing period. **Note**: Not supported by Apigee at this - time. - - Monthly billing period. - enum: - - BILLING_PERIOD_UNSPECIFIED - - WEEKLY - - MONTHLY + 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. + deploymentGroups: + description: List of deployment groups in the environment. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentGroupConfig' name: - readOnly: true - description: Output only. Name of the rate plan. type: string - revenueShareType: - description: Method used to calculate the revenue that is shared with developers. - 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. - type: string - enum: - - REVENUE_SHARE_TYPE_UNSPECIFIED - - FIXED - - VOLUME_BANDED - apiproduct: - description: Name of the API product that the rate plan is associated with. + description: >- + Name of the environment configuration in the following format: + `organizations/{org}/environments/{env}/configs/{config}` + envScopedRevisionId: + 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. type: string - startTime: format: int64 - description: Time when the rate plan becomes active in milliseconds since epoch. + gatewayConfigLocation: type: string - createdAt: - readOnly: true description: >- - Output only. Time that the rate plan was created in milliseconds - since epoch. + The location for the gateway config blob as a URI, e.g. a Cloud + Storage URI. This is only used by Envoy-based gateways. + addonsConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeAddonsConfig' + description: The latest runtime configurations for add-ons. + revisionId: type: string + description: >- + Revision ID of the environment configuration. The higher the value, + the more recently the configuration was deployed. format: int64 - state: - 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`). + resources: + type: array + description: List of resource versions in the environment. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceConfig' + createTime: type: string - enum: - - STATE_UNSPECIFIED - - DRAFT - - PUBLISHED - description: Current state of the rate plan (draft or published). - setupFee: - description: Initial, one-time fee paid when purchasing the API product. - $ref: '#/components/schemas/GoogleTypeMoney' - fixedRecurringFee: - $ref: '#/components/schemas/GoogleTypeMoney' + format: google-datetime + description: Time that the environment configuration was created. + traceConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceConfig' 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. - consumptionPricingType: - 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.' - description: Pricing model used for consumption-based charges. - enum: - - CONSUMPTION_PRICING_TYPE_UNSPECIFIED - - FIXED_PER_UNIT - - BANDED - - TIERED - - STAIRSTEP - type: string - displayName: - type: string - description: Display name of the rate plan. - consumptionPricingRates: + Trace configurations. Contains config for the environment and config + overrides for specific API proxies. + resourceReferences: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ReferenceConfig' type: array + description: List of resource references in the environment. + deployments: items: - $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. - description: - type: string - description: Description of the rate plan. + $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentConfig' + type: array + description: List of deployments in the environment. + GoogleCloudApigeeV1ListDeveloperAppsResponse: + properties: + app: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + description: List of developer apps and their credentials. + id: GoogleCloudApigeeV1ListDeveloperAppsResponse type: object - description: Rate plan details. - id: GoogleCloudApigeeV1RatePlan - GoogleCloudApigeeV1QueryTimeSeriesStatsRequest: + GoogleCloudApigeeV1ListApiProxiesResponse: + properties: + proxies: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' + type: array type: object - id: GoogleCloudApigeeV1QueryTimeSeriesStatsRequest description: >- - QueryTimeSeriesStatsRequest represents a query that returns a collection - of time series sequences grouped by their values. + To change this message, in the same CL add a change log in + go/changing-api-proto-breaks-ui + id: GoogleCloudApigeeV1ListApiProxiesResponse + GoogleCloudApigeeV1Point: + 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. + type: object properties: - metrics: + id: + description: Name of a step in the transaction. + type: string + results: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1MetricAggregation' - description: Required. List of metrics and their aggregations. + $ref: '#/components/schemas/GoogleCloudApigeeV1Result' type: array - timeRange: - $ref: '#/components/schemas/GoogleTypeInterval' - description: Required. Time range for the stats. - windowSize: - enumDescriptions: - - Unspecified window size. Default is 1 hour. - - 1 Minute window - - 1 Hour window - - 1 Day window - - 1 Month window + description: List of results extracted from a given debug point. + id: GoogleCloudApigeeV1Point + GoogleCloudApigeeV1SecurityActionHttpHeader: + properties: + name: + description: The header name to be sent to the target. type: string - description: Time buckets to group the stats by. - enum: - - WINDOW_SIZE_UNSPECIFIED - - MINUTE - - HOUR - - DAY - - MONTH - pageSize: - format: int32 - description: >- - Page size represents the number of time series sequences, one per - unique set of dimensions and their values. - type: integer - filter: + value: 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 - dimensions: - type: array - 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. - timestampOrder: + description: The header value to be sent to the target. + type: object + id: GoogleCloudApigeeV1SecurityActionHttpHeader + description: An HTTP header. + GoogleCloudApigeeV1SchemaSchemaProperty: + description: Properties for the schema field. + type: object + properties: + type: type: string - enumDescriptions: - - Unspecified order. Default is Descending. - - Ascending sort order. - - Descending sort order. - enum: - - ORDER_UNSPECIFIED - - ASCENDING - - DESCENDING - description: >- - Order the sequences in increasing or decreasing order of timestamps. - Default is descending order of timestamps (latest first). - pageToken: + description: Data type of the field. + createTime: type: string description: >- - Page token stands for a specific collection of time series - sequences. - GoogleCloudApigeeV1CertInfo: - description: X.509 certificate as defined in RFC 5280. - id: GoogleCloudApigeeV1CertInfo - properties: - issuer: - type: string - description: X.509 issuer. - subject: - description: X.509 subject. + Time the field was created in RFC3339 string form. For example: + `2016-02-26T10:23:09.592Z`. + custom: + 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. type: string - isValid: + id: GoogleCloudApigeeV1SchemaSchemaProperty + GoogleCloudApigeeV1RateRange: + id: GoogleCloudApigeeV1RateRange + description: >- + API call volume range and the fees charged when the total number of API + calls is within the range. + type: object + properties: + start: + format: int64 + description: >- + Starting value of the range. Set to 0 or `null` for the initial + range of values. type: string + fee: 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. - version: - format: int32 - description: X.509 version. - type: integer - expiryDate: + Fee to charge when total number of API calls falls within this + range. + $ref: '#/components/schemas/GoogleTypeMoney' + end: format: int64 type: string - description: X.509 `notAfter` validity period in milliseconds since epoch. - subjectAlternativeNames: - description: X.509 subject alternative names (SANs) extension. + description: >- + Ending value of the range. Set to 0 or `null` for the last range of + values. + GoogleCloudApigeeV1ListExportsResponse: + description: The response for ListExports + id: GoogleCloudApigeeV1ListExportsResponse + properties: + exports: items: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1Export' + description: Details of the export jobs. type: array - publicKey: - type: string - description: Public key component of the X.509 subject public key info. - basicConstraints: - description: X.509 basic constraints extension. - type: string - serialNumber: - description: X.509 serial number. - type: string - validFrom: - description: X.509 `notBefore` validity period in milliseconds since epoch. - type: string - format: int64 - sigAlgName: - description: X.509 signatureAlgorithm. - type: string type: object GoogleCloudApigeeV1ReportProperty: id: GoogleCloudApigeeV1ReportProperty @@ -2223,1900 +1862,1960 @@ components: items: $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' property: + type: string description: name of the property + GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter: + properties: + scorePath: + description: >- + Optional. Return scores for this component. Example: + "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" type: string - GoogleCloudApigeeV1QueryMetric: type: object + id: GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter description: >- - More info about Metric: - https://docs.apigee.com/api-platform/analytics/analytics-reference#metrics + Filter scores by component path. Used custom filter instead of AIP-160 + as the use cases are highly constrained and predictable. + GoogleCloudApigeeV1ListApiProductsResponse: + properties: + apiProduct: + description: Lists all API product names defined for an organization. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + type: array + id: GoogleCloudApigeeV1ListApiProductsResponse + type: object + GoogleCloudApigeeV1Metric: + 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"] }``` properties: - value: - type: string - description: Operand value should be provided when operator is set. name: type: string - description: Required. Metric name. - function: - type: string - description: 'Aggregation function: avg, min, max, or sum.' - alias: - type: string + description: Metric name. + values: description: >- - Alias for the metric. Alias will be used to replace metric name in - query results. - operator: - type: string - description: One of `+`, `-`, `/`, `%`, `*`. - id: GoogleCloudApigeeV1QueryMetric - GoogleCloudApigeeV1ListKeyValueEntriesResponse: - description: >- - The request structure for listing key value map keys and its - corresponding values. - properties: - keyValueEntries: + List of metric values. Possible value formats include: + `"values":["39.0"]` or `"values":[ { "value": "39.0", "timestamp": + 1232434354} ]` type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' - description: One or more key value map keys and values. - nextPageToken: + type: any + type: object + GoogleCloudApigeeV1GraphQLOperation: + id: GoogleCloudApigeeV1GraphQLOperation + type: object + properties: + operation: 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. - id: GoogleCloudApigeeV1ListKeyValueEntriesResponse - type: object - GoogleCloudApigeeV1Properties: - id: GoogleCloudApigeeV1Properties + 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 description: >- - Message for compatibility with legacy Edge specification for Java - Properties object in JSON. + Represents the pairing of GraphQL operation types and the GraphQL + operation name. + GoogleCloudApigeeV1Properties: properties: property: - description: List of all properties in the object type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1Property' + description: List of all properties in the object + id: GoogleCloudApigeeV1Properties type: object - GoogleCloudApigeeV1NodeConfig: + description: >- + Message for compatibility with legacy Edge specification for Java + Properties object in JSON. + GoogleCloudApigeeV1ProvisionOrganizationRequest: properties: - minNodeCount: - 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. - format: int64 + authorizedNetwork: type: string - currentAggregateNodeCount: description: >- - Output only. The current total number of gateway nodes that each - environment currently has across all instances. - readOnly: true + 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` + 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 + analyticsRegion: type: string - format: int64 - maxNodeCount: - 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. + 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: + 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 - id: GoogleCloudApigeeV1NodeConfig - description: >- - NodeConfig for setting the min/max number of nodes associated with the - environment. + description: Request for ProvisionOrganization. + id: GoogleCloudApigeeV1ProvisionOrganizationRequest type: object - GoogleCloudApigeeV1ScoreComponent: - id: GoogleCloudApigeeV1ScoreComponent + GoogleCloudApigeeV1GrpcOperationGroup: + description: >- + List of gRPC operation configuration details associated with Apigee API + proxies. properties: - calculateTime: - format: google-datetime - type: string - description: Time when score was calculated. - score: - type: integer - format: int32 - description: Score for the component. - drilldownPaths: - description: List of paths for next components. - items: - type: string + operationConfigs: type: array - dataCaptureTime: - type: string - format: google-datetime - description: >- - Time in the requested time period when data was last captured to - compute the score. - recommendations: items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendation - description: List of recommendations to improve API security. - type: array - scorePath: + $ref: '#/components/schemas/GoogleCloudApigeeV1GrpcOperationConfig' description: >- - Path of the component. Example: - /org@myorg/envgroup@myenvgroup/proxies/proxy@myproxy - type: string + Required. List of operation configurations for either Apigee API + proxies that are associated with this API product. + id: GoogleCloudApigeeV1GrpcOperationGroup type: object - description: Component is an individual security element that is scored. - GoogleCloudApigeeV1ListEndpointAttachmentsResponse: + GoogleCloudApigeeV1GenerateDownloadUrlResponse: + description: Response for GenerateDownloadUrl method. + id: GoogleCloudApigeeV1GenerateDownloadUrlResponse + properties: + downloadUri: + description: >- + The Google Cloud Storage signed URL that can be used to download the + Archive zip file. + type: string type: object + GoogleCloudApigeeV1Organization: + id: GoogleCloudApigeeV1Organization properties: - endpointAttachments: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' - type: array - description: Endpoint attachments in the specified organization. - nextPageToken: + runtimeDatabaseEncryptionKeyName: type: string description: >- - Page token that you can include in an `ListEndpointAttachments` - request to retrieve the next page. If omitted, no subsequent pages - exist. - description: Response for ListEndpointAttachments method. - id: GoogleCloudApigeeV1ListEndpointAttachmentsResponse - 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. - id: GoogleIamV1AuditConfig - properties: - auditLogConfigs: - items: - $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' - description: The configuration for logging of each type of permission. - type: array - service: + 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. + description: + type: string + description: Description of the Apigee organization. + controlPlaneEncryptionKeyName: 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. - type: object - GoogleCloudApigeeV1Developer: - type: object - id: GoogleCloudApigeeV1Developer - properties: - apps: - type: array - description: List of apps associated with the developer. - items: - type: string - lastModifiedAt: + 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/*` + createdAt: format: int64 description: >- - Output only. Time at which the developer was last modified in + Output only. Time that the Apigee organization was created in milliseconds since epoch. + readOnly: true + type: string + addonsConfig: + description: Addon configurations of the Apigee organization. + $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' + apiConsumerDataEncryptionKeyName: type: string + 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/*` + state: readOnly: true - appFamily: type: string - description: Developer app family. - status: + 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. description: >- - Output only. Status of the developer. Valid values are `active` and - `inactive`. + Output only. State of the organization. Values other than ACTIVE + means the resource is not ready to use. + projectId: readOnly: true type: string - organizationName: + description: Output only. Project ID associated with the Apigee organization. + name: + description: Output only. Name of the Apigee organization. + type: string readOnly: true + 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. + lastModifiedAt: + readOnly: true + format: int64 description: >- - Output only. Name of the Apigee organization in which the developer - resides. - email: + Output only. Time that the Apigee organization was last modified in + milliseconds since epoch. + type: string + subscriptionType: 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. - accessType: - description: Access type. + 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/). + enum: + - SUBSCRIPTION_TYPE_UNSPECIFIED + - PAID + - TRIAL + 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. + readOnly: true + 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 - developerId: + readOnly: true + subscriptionPlan: type: string + readOnly: true description: >- - ID of the developer. **Note**: IDs are generated internally by - Apigee and are not guaranteed to stay the same over time. - createdAt: + Output only. Subscription plan that the customer has purchased. + Output only. + enum: + - SUBSCRIPTION_PLAN_UNSPECIFIED + - SUBSCRIPTION_2021 + - SUBSCRIPTION_2024 + enumDescriptions: + - Subscription plan not specified. + - Traditional subscription plan. + - >- + New subscription plan that provides standard proxy and scaled + proxy implementation. + 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 + portalDisabled: + description: Configuration for the Portals settings. + type: boolean + caCertificate: type: string - format: int64 description: >- - Output only. Time at which the developer was created in milliseconds - since epoch. + Output only. Base64-encoded public certificate for the root CA of + the Apigee organization. Valid only when [RuntimeType](#RuntimeType) + is `CLOUD`. + format: byte readOnly: true - companies: - items: - type: string - description: List of companies associated with the developer. - type: array - firstName: + analyticsRegion: + deprecated: true type: string - description: Required. First name of the developer. - attributes: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - type: array description: >- - Optional. Developer attributes (name/value pairs). The custom - attribute limit is 18. - userName: - description: Required. User name of the developer. Not used by Apigee hybrid. + 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). + displayName: type: string - lastName: - type: string - description: Required. Last name of the developer. - GoogleCloudApigeeV1MonetizationConfig: - id: GoogleCloudApigeeV1MonetizationConfig - properties: - enabled: - type: boolean - description: Flag that specifies whether the Monetization add-on is enabled. - type: object - description: Configuration for the Monetization add-on. - GoogleCloudApigeeV1SecurityActionsConfig: - properties: - name: + description: >- + Display name for the Apigee organization. Unused, but reserved for + future use. + properties: + $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' + description: Properties defined in the Apigee organization profile. + customerName: type: string + description: Not used by Apigee. + disableVpcPeering: 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: + 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. type: boolean + expiresAt: 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. - updateTime: + Output only. Time that the Apigee organization is scheduled for + deletion. + format: int64 readOnly: true - format: google-datetime type: string - description: Output only. The update time for configuration. - description: >- - SecurityActionsConfig reflects the current state of the SecurityActions - feature. This is a singleton resource: https://google.aip.dev/156 - id: GoogleCloudApigeeV1SecurityActionsConfig - type: object - GoogleCloudApigeeV1CustomReport: - properties: - fromTime: + authorizedNetwork: type: string - description: 'Legacy field: not used. Contains the from time for the report' - dimensions: - type: array + 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. + environments: + description: Output only. List of environments in the Apigee organization. + readOnly: true items: type: string - description: This contains the list of dimensions for the report - createdAt: - type: string - format: int64 - description: 'Output only. Unix time when the app was created json key: createdAt' - readOnly: true - lastModifiedAt: + type: array + billingType: description: >- - Output only. Modified time of this entity as milliseconds since - epoch. json key: lastModifiedAt - format: int64 - readOnly: true + Billing type of the Apigee organization. See [Apigee + pricing](https://cloud.google.com/apigee/pricing). + enum: + - BILLING_TYPE_UNSPECIFIED + - SUBSCRIPTION + - EVALUATION + - PAYG type: string - sortOrder: + 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. + runtimeType: + enum: + - RUNTIME_TYPE_UNSPECIFIED + - CLOUD + - HYBRID + enumDescriptions: + - Runtime type not specified. + - Google-managed Apigee runtime. + - User-managed Apigee hybrid runtime. description: >- - Legacy field: not used much. Contains the sort order for the sort - columns - type: string - timeUnit: - description: This field contains the time unit of aggregation for the report - type: string - offset: - type: string - description: 'Legacy field: not used. This field contains the offset for the data' - filter: + Required. Runtime type of the Apigee organization based on the + Apigee subscription purchased. type: string - description: This field contains the filter expression - sortByCols: - type: array + attributes: items: type: string - description: 'Legacy field: not used much. Contains the list of sort by columns' - name: + description: Not used by Apigee. + type: array + type: object + GoogleCloudApigeeV1SecurityReportResultMetadata: + id: GoogleCloudApigeeV1SecurityReportResultMetadata + type: object + properties: + self: type: string description: >- - Required. Unique identifier for the report T his is a legacy field - used to encode custom report unique id - chartType: - description: This field contains the chart type for the report - type: string - lastViewedAt: - format: int64 + 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: readOnly: true - type: string description: >- - Output only. Last viewed time of this entity as milliseconds since - epoch - displayName: - description: This is the display name for the report + 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" + type: string + description: Contains informations about the security report results. + GoogleCloudApigeeV1ScoreComponent: + type: object + id: GoogleCloudApigeeV1ScoreComponent + description: Component is an individual security element that is scored. + properties: + scorePath: type: string - comments: - type: array description: >- - Legacy field: not used. This field contains a list of comments - associated with custom report + Path of the component. Example: + /org@myorg/envgroup@myenvgroup/proxies/proxy@myproxy + drilldownPaths: + type: array items: type: string - toTime: - description: 'Legacy field: not used. Contains the end time for the report' - type: string - environment: - type: string - readOnly: true - description: Output only. Environment name - properties: + description: List of paths for next components. + score: + description: Score for the component. + type: integer + format: int32 + recommendations: + description: List of recommendations to improve API security. type: array - description: This field contains report properties such as ui metadata etc. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ReportProperty' - topk: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendation + calculateTime: + type: string + format: google-datetime + description: Time when score was calculated. + dataCaptureTime: + format: google-datetime + type: string description: >- - Legacy field: not used. This field contains the top k parameter - value for restricting the result + Time in the requested time period when data was last captured to + compute the score. + GoogleCloudApigeeV1OperationMetadataProgress: + id: GoogleCloudApigeeV1OperationMetadataProgress + description: Information about operation progress. + properties: + details: + type: object + additionalProperties: + description: Properties of the object. + type: any + description: The additional details of the progress. + state: + description: State of the operation. + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - STATE_UNSPECIFIED + - NOT_STARTED + - IN_PROGRESS + - FINISHED type: string - organization: + description: type: string - readOnly: true - description: Output only. Organization name - metrics: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReportMetric' - type: array - description: Required. This contains the list of metrics - tags: - type: array + description: Description of the operation's progress. + percentDone: + type: integer + format: int32 + description: The percentage of the operation progress. + type: object + GoogleIamV1TestIamPermissionsRequest: + properties: + permissions: description: >- - Legacy field: not used. This field contains a list of tags - associated with custom report + The set of permissions to check for the `resource`. Permissions with + wildcards (such as `*` or `storage.*`) are not allowed. For more + information see [IAM + Overview](https://cloud.google.com/iam/docs/overview#permissions). items: type: string - limit: - description: >- - Legacy field: not used This field contains the limit for the result - retrieved - type: string - type: object - id: GoogleCloudApigeeV1CustomReport - GoogleCloudApigeeV1SetAddonEnablementRequest: + type: array + description: Request message for `TestIamPermissions` method. type: object - id: GoogleCloudApigeeV1SetAddonEnablementRequest - properties: - apiSecurityEnabled: - description: If the API Security should be enabled in the environment. - type: boolean - analyticsEnabled: - description: If the Analytics should be enabled in the environment. - type: boolean - description: Request for SetAddonEnablement. - GoogleCloudApigeeV1RateRange: - id: GoogleCloudApigeeV1RateRange + id: GoogleIamV1TestIamPermissionsRequest + GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict: description: >- - API call volume range and the fees charged when the total number of API - calls is within the range. + Describes a routing conflict that may cause a deployment not to receive + traffic at some base path. properties: - fee: - $ref: '#/components/schemas/GoogleTypeMoney' - description: >- - 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. + conflictingDeployment: + description: Existing base path/deployment causing the conflict. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment + description: + description: Human-readable description of this conflict. type: string - format: int64 - start: + environmentGroup: type: string - format: int64 - description: >- - Starting value of the range. Set to 0 or `null` for the initial - range of values. - type: object - GoogleCloudApigeeV1ApiCategoryResponse: + description: Name of the environment group in which this conflict exists. + id: GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict type: object - description: The API category resource wrapped with response status, error_code, etc. - id: GoogleCloudApigeeV1ApiCategoryResponse - properties: - message: - description: Description of the operation. - type: string - errorCode: - type: string - description: Unique error code for the request, if any. - data: - description: The API category resource. - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' - status: - description: Status of the operation. - type: string - requestId: - type: string - description: Unique ID of the request. - GoogleCloudApigeeV1ListExportsResponse: + GoogleCloudApigeeV1Access: + id: GoogleCloudApigeeV1Access properties: - exports: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Export' - description: Details of the export jobs. + Get: + $ref: '#/components/schemas/GoogleCloudApigeeV1AccessGet' + Remove: + $ref: '#/components/schemas/GoogleCloudApigeeV1AccessRemove' + Set: + $ref: '#/components/schemas/GoogleCloudApigeeV1AccessSet' type: object - description: The response for ListExports - id: GoogleCloudApigeeV1ListExportsResponse - GoogleCloudApigeeV1SecuritySettings: - properties: - mlRetrainingFeedbackEnabled: - description: >- - Optional. If true the user consents to the use of ML models for - Abuse detection. - type: boolean - name: - description: >- - Identifier. Full resource name is always - `organizations/{org}/securitySettings`. - type: string - description: >- - SecuritySettings reflects the current state of the SecuritySettings - feature. - id: GoogleCloudApigeeV1SecuritySettings + GoogleCloudApigeeV1FlowHookConfig: type: object - GoogleTypeExpr: + id: GoogleCloudApigeeV1FlowHookConfig properties: - title: + sharedFlowName: 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 + Name of the shared flow to invoke in the following format: + `organizations/{org}/sharedflows/{sharedflow}` + name: 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: + 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 + continueOnError: + type: boolean 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 - 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. - GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict: - description: >- - Describes a routing conflict that may cause a deployment not to receive - traffic at some base path. - type: object - id: GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict - properties: - description: - description: Human-readable description of this conflict. - type: string - environmentGroup: - type: string - description: Name of the environment group in which this conflict exists. - conflictingDeployment: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment - description: Existing base path/deployment causing the conflict. - GoogleCloudApigeeV1ListArchiveDeploymentsResponse: - description: Response for ListArchiveDeployments method. + Flag that specifies whether the flow should abort after an error in + the flow hook. Defaults to `true` (continue on error). + GoogleCloudApigeeV1AsyncQueryResultView: properties: - nextPageToken: + state: type: string + description: State of retrieving ResultView. + metadata: description: >- - Page token that you can include in a ListArchiveDeployments request - to retrieve the next page. If omitted, no subsequent pages exist. - archiveDeployments: - description: Archive Deployments in the specified environment. - type: array + Metadata contains information like metrics, dimenstions etc of the + AsyncQuery. + $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetadata' + rows: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' - id: GoogleCloudApigeeV1ListArchiveDeploymentsResponse - type: object - GoogleCloudApigeeV1CanaryEvaluationMetricLabels: - id: GoogleCloudApigeeV1CanaryEvaluationMetricLabels - properties: - location: - description: Required. The location associated with the metrics. - type: string - env: - description: The environment ID associated with the metrics. - type: string - instance_id: - type: string + type: any description: >- - Required. The instance ID associated with the metrics. In Apigee - Hybrid, the value is configured during installation. - description: Labels that can be used to filter Apigee metrics. + Rows of query result. Each row is a JSON object. Example: + {sum(message_count): 1, developer_app: "(not set)",…} + type: array + error: + description: Error message when there is a failure. + type: string + code: + type: integer + format: int32 + description: Error code when there is a failure. + id: GoogleCloudApigeeV1AsyncQueryResultView type: object - GoogleCloudApigeeV1OperationMetadataProgress: - id: GoogleCloudApigeeV1OperationMetadataProgress - description: Information about operation progress. + GoogleCloudApigeeV1OperationMetadata: + type: object + description: Metadata describing an Operation. properties: - details: - description: The additional details of the progress. - additionalProperties: - type: any - description: Properties of the object. - type: object state: enum: - STATE_UNSPECIFIED - NOT_STARTED - IN_PROGRESS - FINISHED + enumDescriptions: + - '' + - '' + - '' + - '' type: string + progress: + description: Progress of the operation. + $ref: '#/components/schemas/GoogleCloudApigeeV1OperationMetadataProgress' + operationType: enumDescriptions: - '' - '' - '' - '' - description: State of the operation. - description: + enum: + - OPERATION_TYPE_UNSPECIFIED + - INSERT + - DELETE + - UPDATE type: string - description: Description of the operation's progress. - percentDone: - type: integer - description: The percentage of the operation progress. - format: int32 - type: object - GoogleCloudApigeeV1Quota: + targetResourceName: + description: Name of the resource for which the operation is operating on. + type: string + warnings: + type: array + items: + type: string + description: Warnings encountered while executing the operation. + id: GoogleCloudApigeeV1OperationMetadata + GoogleCloudApigeeV1Alias: properties: - timeUnit: + alias: 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: + Resource ID for this alias. Values must match the regular expression + `[^/]{1,255}`. + type: + description: Type of alias. type: string - description: >- - Required. Time interval over which the number of request messages is - calculated. - 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 - id: GoogleCloudApigeeV1Quota - GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment: + enumDescriptions: + - Alias type is not specified. + - Certificate. + - Key/certificate pair. + enum: + - ALIAS_TYPE_UNSPECIFIED + - CERT + - KEY_CERT + certsInfo: + $ref: '#/components/schemas/GoogleCloudApigeeV1Certificate' + description: Chain of certificates under this alias. + description: Reference to a certificate or key/certificate pair. type: object - description: Tuple representing a base path and the deployment containing it. - id: GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment + id: GoogleCloudApigeeV1Alias + GoogleCloudApigeeV1RatePlan: + description: Rate plan details. + id: GoogleCloudApigeeV1RatePlan properties: - basepath: - type: string - description: Base path receiving traffic. - apiProxy: - type: string - description: Name of the deployed API proxy revision containing the base path. - revision: + startTime: type: string - description: Name of the deployed API proxy revision containing the base path. - environment: + format: int64 + description: Time when the rate plan becomes active in milliseconds since epoch. + billingPeriod: + description: Frequency at which the customer will be billed. + enum: + - BILLING_PERIOD_UNSPECIFIED + - WEEKLY + - MONTHLY type: string - description: Name of the environment in which the proxy is deployed. - GoogleCloudApigeeV1APIProductAssociation: - description: >- - APIProductAssociation has the API product and its administrative state - association. - id: GoogleCloudApigeeV1APIProductAssociation - type: object - properties: - status: + enumDescriptions: + - Billing period not specified. + - >- + Weekly billing period. **Note**: Not supported by Apigee at this + time. + - Monthly billing period. + endTime: + format: int64 description: >- - The API product credential associated status. Valid values are - `approved` or `revoked`. + 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 - apiproduct: - description: API product to be associated with the credential. + createdAt: + description: >- + Output only. Time that the rate plan was created in milliseconds + since epoch. type: string - GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute: - type: object - description: Route deployed in the ingress routing table. - properties: - percentage: - type: integer - format: int32 - description: Percentage of ingress replicas reporting this route. - envgroup: + readOnly: true + format: int64 + 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 - description: Environment group where this route is installed. - basepath: - description: Base path in the routing table. + displayName: + description: Display name of the rate plan. type: string - environment: + description: type: string + description: Description of the rate plan. + lastModifiedAt: + format: int64 description: >- - Destination environment. This will be empty if the route is not yet - reported. - id: GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute - GoogleCloudApigeeV1AdjustDeveloperBalanceRequest: - properties: - adjustment: - 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. - $ref: '#/components/schemas/GoogleTypeMoney' - description: Request for AdjustDeveloperBalance. - id: GoogleCloudApigeeV1AdjustDeveloperBalanceRequest - type: object - GoogleCloudApigeeV1Export: - id: GoogleCloudApigeeV1Export - properties: - name: - type: string - description: Display name of the export job. - description: + Output only. Time the rate plan was last modified in milliseconds + since epoch. type: string - description: Description of the export job. - self: readOnly: true + apiproduct: type: string + description: Name of the API product that the rate plan is associated with. + fixedFeeFrequency: + format: int32 + type: integer + description: Frequency at which the fixed fee is charged. + fixedRecurringFee: + $ref: '#/components/schemas/GoogleTypeMoney' 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` - updated: + 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. + 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 - readOnly: true - description: Output only. Time the export job was last updated. - state: + description: Pricing model used for consumption-based charges. + setupFee: + $ref: '#/components/schemas/GoogleTypeMoney' + description: Initial, one-time fee paid when purchasing the API product. + revenueShareRates: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1RevenueShareRange' + description: Details of the revenue sharing model. + name: + description: Output only. Name of the rate plan. readOnly: true type: string + consumptionPricingRates: + type: array description: >- - Output only. Status of the export job. Valid values include - `enqueued`, `running`, `completed`, and `failed`. - error: - type: string - readOnly: true - description: Output only. Error is set when export fails - executionTime: - readOnly: true + 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' + paymentFundingModel: type: string + enum: + - PAYMENT_FUNDING_MODEL_UNSPECIFIED + - PREPAID + - POSTPAID + 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. 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. - created: - readOnly: true - description: Output only. Time the export job was created. + 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. + deprecated: true + revenueShareType: + 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. + description: Method used to calculate the revenue that is shared with developers. type: string - datastoreName: + 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`). type: string - description: >- - Name of the datastore that is the destination of the export job - [datastore] + enum: + - STATE_UNSPECIFIED + - DRAFT + - PUBLISHED type: object - description: Details of an export job. - GoogleCloudApigeeV1RevenueShareRange: - 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. + GoogleCloudApigeeV1SecurityReportQuery: + description: Body structure when user makes a request to create a security report. type: object + id: GoogleCloudApigeeV1SecurityReportQuery properties: - end: + timeRange: + type: any description: >- - Ending value of the range. Set to 0 or `null` for the last range of - values. - format: int64 + 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" } + filter: type: string - sharePercentage: - type: number - 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. - format: double - start: description: >- - Starting value of the range. Set to 0 or `null` for the initial - range of values. + 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: + description: Security Report display name which users can specify. type: string - format: int64 - 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 - GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest: - description: Request for BatchUpdateSecurityIncident. - id: GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest - type: object - properties: - requests: + limit: + description: Maximum number of rows that can be returned in the result. + type: integer + format: int32 + metrics: + type: array + description: A list of Metrics. items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1UpdateSecurityIncidentRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQueryMetric' + csvDelimiter: + type: string description: >- - Optional. Required. The request message specifying the resources to - update. A maximum of 1000 can be modified in a batch. + 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`). + 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. + dimensions: + items: + type: string type: array - GoogleCloudApigeeV1DataCollectorConfig: - type: object - properties: - type: - enum: - - TYPE_UNSPECIFIED - - INTEGER - - FLOAT - - STRING - - BOOLEAN - - DATETIME - 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. + description: >- + A list of dimensions. + https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions + mimeType: type: string - name: description: >- - Name of the data collector in the following format: - `organizations/{org}/datacollectors/{datacollector}` + Valid values include: `csv` or `json`. Defaults to `json`. Note: + Configure the delimiter for CSV output using the csvDelimiter + property. + reportDefinitionId: + description: Report Definition ID. type: string - description: Data collector and its configuration. - id: GoogleCloudApigeeV1DataCollectorConfig - GoogleCloudApigeeV1SetAddonsRequest: - type: object - description: Request for SetAddons. - id: GoogleCloudApigeeV1SetAddonsRequest - properties: - addonsConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' - description: Required. Add-on configurations. - GoogleCloudApigeeV1MetricAggregation: - description: The optionally aggregated metric to query with its ordering. - properties: - name: + 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. type: string - description: Name of the metric - order: - enumDescriptions: - - Unspecified order. Default is Descending. - - Ascending sort order. - - Descending sort order. + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest: + description: Request for BatchComputeSecurityAssessmentResults. + properties: + pageToken: type: string 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 - aggregation: - enum: - - AGGREGATION_FUNCTION_UNSPECIFIED - - AVG - - SUM - - MIN - - MAX - - COUNT_DISTINCT - enumDescriptions: - - Unspecified Aggregation function. - - Average. - - Summation. - - Min. - - Max. - - Count distinct + 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. + profile: + description: Required. Name of the profile that is used for computation. type: string - description: Aggregation function associated with the metric. - type: object - id: GoogleCloudApigeeV1MetricAggregation - GoogleCloudApigeeV1Subscription: - description: Pub/Sub subscription of an environment. - properties: - name: + include: + description: Include only these resources. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray + scope: description: >- - Full name of the Pub/Sub subcription. Use the following structure in - your request: `subscription "projects/foo/subscription/bar"` + Required. Scope of the resources for the computation. For Apigee, + the environment is the scope of the resources. type: string - id: GoogleCloudApigeeV1Subscription - type: object - GoogleCloudApigeeV1OperationGroup: - 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. + pageSize: + 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. + type: integer type: object + id: GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest + GoogleCloudApigeeV1Metadata: + description: Encapsulates additional information about query execution. 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: - type: array + errors: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1OperationConfig' + type: string + description: List of error messages as strings. + type: array + notices: description: >- - Required. List of operation configurations for either Apigee API - proxies or other remote services that are associated with this API - product. - GoogleCloudApigeeV1Instance: - description: Apigee runtime instance. + 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" ]``` + items: + type: string + type: array + id: GoogleCloudApigeeV1Metadata + type: object + GoogleCloudApigeeV1PodStatus: properties: - 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. - port: - type: string - description: Output only. Port number of the exposed Apigee endpoint. - readOnly: true - name: - description: >- - Required. Resource ID of the instance. Values must match the regular - expression `^a-z{0,30}[a-z\d]$`. - type: string - host: - readOnly: true - description: >- - Output only. Internal hostname or IP address of the Apigee endpoint - used by clients to connect to the service. - type: string - 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. - description: + statusCode: type: string - description: Optional. Description of the instance. - createdAt: + description: Code associated with the deployment status. + podName: type: string - readOnly: true + description: Name of the pod which is reporting the status. + deploymentStatusTime: format: int64 - description: >- - Output only. Time the instance was created in milliseconds since - epoch. - displayName: - description: Optional. Display name for the instance. - type: string - 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` - serviceAttachment: type: string - readOnly: true - 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. - location: + description: Time the deployment status was reported in milliseconds since epoch. + appVersion: + description: Version of the application running in the pod. type: string - description: Required. Compute Engine location where the instance resides. - 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/([^/]+)` + statusCodeDetails: + description: Human-readable message associated with the status code. type: string - runtimeVersion: + podStatusTime: + description: Time the pod status was reported in milliseconds since epoch. + format: int64 type: string - readOnly: true - 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. - state: - readOnly: true + deploymentStatus: type: string - 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. - lastModifiedAt: + Status of the deployment. Valid values include: - `deployed`: + Successful. - `error` : Failed. - `pending` : Pod has not yet + reported on the deployment. + deploymentTime: format: int64 - description: >- - Output only. Time the instance was last modified in milliseconds - since epoch. - readOnly: true - type: string - peeringCidrRange: - 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`. - deprecated: true type: string - enum: - - CIDR_RANGE_UNSPECIFIED - - SLASH_16 - - SLASH_17 - - SLASH_18 - - SLASH_19 - - SLASH_20 - - SLASH_22 - - SLASH_23 - id: GoogleCloudApigeeV1Instance - type: object - GoogleCloudApigeeV1DateRange: - type: object - description: Date range of the data to export. - properties: - 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. + description: Time the proxy was deployed in milliseconds since epoch. + podStatus: type: string - 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 - id: GoogleCloudApigeeV1DateRange - GoogleCloudApigeeV1SchemaSchemaProperty: - description: Properties for the schema field. + 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. + id: GoogleCloudApigeeV1PodStatus type: object - id: GoogleCloudApigeeV1SchemaSchemaProperty + GoogleCloudApigeeV1ProfileConfigThreat: + type: object + description: >- + By default, following policies will be included: - XMLThreatProtection - + JSONThreatProtection + properties: {} + id: GoogleCloudApigeeV1ProfileConfigThreat + GoogleCloudApigeeV1ComputeEnvironmentScoresResponse: + description: Response for ComputeEnvironmentScores. + id: GoogleCloudApigeeV1ComputeEnvironmentScoresResponse properties: - custom: - type: string - 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. - type: - type: string - description: Data type of the field. - createTime: + nextPageToken: type: string description: >- - Time the field was created in RFC3339 string form. For example: - `2016-02-26T10:23:09.592Z`. - GoogleCloudApigeeV1ComputeEnvironmentScoresResponse: - properties: + A page token, received from a previous `ComputeScore` call. Provide + this to retrieve the subsequent page. scores: type: array description: List of scores. One score per day. items: $ref: '#/components/schemas/GoogleCloudApigeeV1Score' - nextPageToken: - description: >- - A page token, received from a previous `ComputeScore` call. Provide - this to retrieve the subsequent page. - type: string - id: GoogleCloudApigeeV1ComputeEnvironmentScoresResponse - description: Response for ComputeEnvironmentScores. type: object - GoogleCloudApigeeV1GraphqlDocumentation: + GoogleCloudApigeeV1RuntimeTraceConfigOverride: + id: GoogleCloudApigeeV1RuntimeTraceConfigOverride type: object - id: GoogleCloudApigeeV1GraphqlDocumentation - description: GraphQL documentation for a catalog item. properties: - schema: - description: Required. The documentation file contents for the GraphQL schema. - $ref: '#/components/schemas/GoogleCloudApigeeV1DocumentationFile' - endpointUri: + apiProxy: + type: string description: >- - Required. The GraphQL endpoint URI to be queried by API consumers. - Max length is 2,083 characters. + Name of the API proxy that will have its trace configuration + overridden following format: `organizations/{org}/apis/{api}` + samplingConfig: + description: >- + Trace configuration override for a specific API proxy in an + environment. + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceSamplingConfig' + uid: + 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. type: string - GoogleCloudApigeeV1TargetServerConfig: - type: object - id: GoogleCloudApigeeV1TargetServerConfig + revisionId: + type: string + description: >- + Revision number which can be used by the runtime to detect if the + trace config override has changed between two versions. + revisionCreateTime: + description: The timestamp that the revision was created or updated. + type: string + format: google-datetime + name: + description: >- + Name of the trace config override in the following format: + `organizations/{org}/environment/{env}/traceConfig/overrides/{override}` + type: string + description: >- + NEXT ID: 7 Trace configuration override for a specific API proxy in an + environment. + GoogleCloudApigeeV1TestDatastoreResponse: properties: - host: - description: Host name of the target server. + state: type: string - protocol: + description: Output only. It could be `completed` or `failed` + readOnly: true + error: 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 - enum: - - PROTOCOL_UNSPECIFIED - - HTTP - - HTTP2 - - GRPC_TARGET - - GRPC - - EXTERNAL_CALLOUT - port: - format: int32 - type: integer - description: Port number for the target server. - tlsInfo: - description: TLS settings for the target server. - $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfoConfig' - name: - type: string - description: >- - Target server revision name in the following format: - `organizations/{org}/environments/{env}/targetservers/{targetserver}/revisions/{rev}` - enabled: - type: boolean - description: >- - Whether the target server is enabled. An empty/omitted value for - this field should be interpreted as true. - GoogleCloudApigeeV1DeploymentChangeReport: - type: object - 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. - properties: - routingConflicts: - type: array - description: All base path conflicts detected for a deployment request. - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict - validationErrors: - description: >- - Validation errors that would cause the deployment change request to - be rejected. - $ref: '#/components/schemas/GoogleRpcPreconditionFailure' - routingChanges: - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingChange - type: array - description: All routing changes that may result from a deployment request. - GoogleCloudApigeeV1RuntimeAddonsConfig: + description: Output only. Error message of test connection failure + readOnly: true + description: The response for TestDatastore type: object - description: >- - RuntimeAddonsConfig defines the runtime configurations for add-ons in an - environment. - id: GoogleCloudApigeeV1RuntimeAddonsConfig + id: GoogleCloudApigeeV1TestDatastoreResponse + GoogleCloudApigeeV1AsyncQuery: properties: - analyticsConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeAnalyticsConfig' - description: Runtime configuration for Analytics add-on. - name: + resultRows: + format: int64 + description: ResultRows is available only after the query is completed. + type: string + self: description: >- - Name of the addons config in the format: - `organizations/{org}/environments/{env}/addonsConfig` + 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` type: string - revisionId: - description: Revision number used by the runtime to detect config changes. + envgroupHostname: + description: Hostname is available only when query is executed at host level. type: string - uid: - 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. + result: + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQueryResult' + description: Result is available only after the query is completed. + resultFileSize: type: string - apiSecurityConfig: - description: Runtime configuration for API Security add-on. - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeApiSecurityConfig' - GoogleCloudApigeeV1InstanceDeploymentStatus: - properties: - instance: + description: ResultFileSize is available only after the query is completed. + created: type: string - description: ID of the instance reporting the status. - deployedRoutes: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute + description: Creation time of the query. + queryParams: + $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetadata' description: >- - 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 - type: object - id: GoogleCloudApigeeV1InstanceDeploymentStatus - description: The status of a deployment as reported by a single instance. - GoogleCloudApigeeV1EnableSecurityActionRequest: + Contains information like metrics, dimenstions etc of the + AsyncQuery. + name: + type: string + description: Asynchronous Query Name. + state: + description: Query state could be "enqueued", "running", "completed", "failed". + type: string + reportDefinitionId: + description: Asynchronous Report ID. + type: string + updated: + type: string + description: Last updated timestamp for the query. + executionTime: + type: string + description: ExecutionTime is available only after the query is completed. + error: + description: Error is set when query fails. + type: string type: object - description: Message to enable a disabled SecurityAction. - id: GoogleCloudApigeeV1EnableSecurityActionRequest - properties: {} - GoogleCloudApigeeV1OptimizedStatsResponse: - id: GoogleCloudApigeeV1OptimizedStatsResponse + id: GoogleCloudApigeeV1AsyncQuery + GoogleCloudApigeeV1ListAsyncQueriesResponse: type: object - description: Encapsulates a response format for JavaScript Optimized Scenario. + id: GoogleCloudApigeeV1ListAsyncQueriesResponse properties: - resultTruncated: - description: >- - Boolean flag that indicates whether the results were truncated based - on the limit parameter. - type: boolean - TimeUnit: - items: - format: int64 - type: string - description: >- - List of time unit values. Time unit refers to an epoch timestamp - value. + queries: type: array - stats: - description: '`stats` results.' - $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStatsNode' - metaData: - description: Metadata information about the query executed. - $ref: '#/components/schemas/GoogleCloudApigeeV1Metadata' - GoogleCloudApigeeV1GraphQLOperation: - 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: >- - 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. + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' + description: The asynchronous queries belong to requested resource name. + description: The response for ListAsyncQueries. + GoogleCloudApigeeV1DisableSecurityActionRequest: + description: Message to disable an enabled SecurityAction. + properties: {} + id: GoogleCloudApigeeV1DisableSecurityActionRequest type: object - description: >- - Represents the pairing of GraphQL operation types and the GraphQL - operation name. - id: GoogleCloudApigeeV1GraphQLOperation - GoogleCloudApigeeV1ListEnvironmentResourcesResponse: + GoogleIamV1Binding: properties: - resourceFile: - description: List of resources files. + members: type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' - type: object - id: GoogleCloudApigeeV1ListEnvironmentResourcesResponse - description: Response for ListEnvironmentResources - GoogleCloudApigeeV1DeveloperBalanceWallet: - type: object - id: GoogleCloudApigeeV1DeveloperBalanceWallet - properties: - lastCreditTime: - type: string - format: int64 - readOnly: true - 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' - description: Wallet used to manage an account balance for a particular currency. - GoogleCloudApigeeV1ListAppGroupAppsResponse: - type: object - id: GoogleCloudApigeeV1ListAppGroupAppsResponse - description: Response for ListAppGroupApps - properties: - 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: string - appGroupApps: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' - description: List of AppGroup apps and their credentials. - GoogleCloudApigeeV1AddonsConfig: - id: GoogleCloudApigeeV1AddonsConfig - description: Add-on configurations for the Apigee organization. - properties: - advancedApiOpsConfig: - description: Configuration for the Advanced API Ops add-on. - $ref: '#/components/schemas/GoogleCloudApigeeV1AdvancedApiOpsConfig' - integrationConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1IntegrationConfig' - description: Configuration for the Integration add-on. - analyticsConfig: - description: Configuration for the Analytics add-on. - $ref: '#/components/schemas/GoogleCloudApigeeV1AnalyticsConfig' - monetizationConfig: - description: Configuration for the Monetization add-on. - $ref: '#/components/schemas/GoogleCloudApigeeV1MonetizationConfig' - 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. + 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). + 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 + description: Associates `members`, or principals, with a `role`. type: object - GoogleCloudApigeeV1AppGroupApp: - id: GoogleCloudApigeeV1AppGroupApp + GoogleLongrunningListOperationsResponse: + properties: + nextPageToken: + type: string + description: The standard List next-page token. + operations: + description: >- + A list of operations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' + id: GoogleLongrunningListOperationsResponse + description: The response message for Operations.ListOperations. + type: object + GoogleCloudApigeeV1QueryTimeSeriesStatsResponse: + description: >- + Represents security stats result as a collection of time series + sequences. type: object properties: - lastModifiedAt: + values: + description: Results of the query returned as a JSON array. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence + columns: description: >- - Output only. Time the AppGroup app was modified in milliseconds - since epoch. - readOnly: true + Column names corresponding to the same order as the inner values in + the stats field. + items: + type: string + type: array + nextPageToken: + type: string + description: Next page token. + id: GoogleCloudApigeeV1QueryTimeSeriesStatsResponse + GoogleCloudApigeeV1DeveloperBalanceWallet: + id: GoogleCloudApigeeV1DeveloperBalanceWallet + description: Wallet used to manage an account balance for a particular currency. + properties: + balance: + $ref: '#/components/schemas/GoogleTypeMoney' + description: >- + Current remaining balance of the developer for a particular + currency. + lastCreditTime: type: string format: int64 - scopes: 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. + Output only. Time at which the developer last added credit to the + account in milliseconds since epoch. + readOnly: true + type: object + GoogleCloudApigeeV1CustomReport: + type: object + id: GoogleCloudApigeeV1CustomReport + properties: + sortByCols: + description: 'Legacy field: not used much. Contains the list of sort by columns' items: type: string type: array - keyExpiresIn: + sortOrder: + description: >- + Legacy field: not used much. Contains the sort order for the sort + columns + type: string + limit: + type: string + description: >- + Legacy field: not used This field contains the limit for the result + retrieved + timeUnit: + type: string + description: This field contains the time unit of aggregation for the report + properties: + description: This field contains report properties such as ui metadata etc. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ReportProperty' + type: array + offset: type: string + description: 'Legacy field: not used. This field contains the offset for the data' + lastViewedAt: 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. - status: + Output only. Last viewed time of this entity as milliseconds since + epoch + readOnly: true type: string - description: Status of the App. Valid values include `approved` or `revoked`. - apiProducts: - description: List of API products associated with the AppGroup app. + dimensions: items: type: string + description: This contains the list of dimensions for the report type: array - appId: + environment: type: string - description: Immutable. ID of the AppGroup app. - credentials: readOnly: true - 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' - callbackUrl: + description: Output only. Environment name + fromTime: + description: 'Legacy field: not used. Contains the from time for the report' type: string - description: >- - Callback URL used by OAuth 2.0 authorization servers to communicate - authorization codes back to AppGroup apps. - name: + createdAt: + format: int64 + readOnly: true type: string - description: >- - Immutable. Name of the AppGroup app whose resource name format is of - syntax (organizations/*/appgroups/*/apps/*). - attributes: + description: 'Output only. Unix time when the app was created json key: createdAt' + tags: type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - description: List of attributes for the AppGroup app. - createdAt: + type: string description: >- - Output only. Time the AppGroup app was created in milliseconds since - epoch. - format: int64 + Legacy field: not used. This field contains a list of tags + associated with custom report + chartType: type: string - readOnly: true - appGroup: + description: This field contains the chart type for the report + metrics: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReportMetric' + description: Required. This contains the list of metrics + type: array + topk: type: string description: >- - Immutable. Name of the parent AppGroup whose resource name format is - of syntax (organizations/*/appgroups/*). - description: >- - Response for [GetAppGroupApp].[AppGroupApps.GetAppGroupApp], - [CreateAppGroupAppRequest].[AppGroupApp.CreateAppGroupAppRequest] and - [DeleteAppGroupApp].[AppGroupApp.DeleteAppGroupApp] - GoogleCloudApigeeV1SharedFlowRevision: - id: GoogleCloudApigeeV1SharedFlowRevision - type: object - description: The metadata describing a shared flow revision. - properties: + Legacy field: not used. This field contains the top k parameter + value for restricting the result displayName: type: string - description: The human readable name of this shared flow. - resourceFiles: - description: The resource files included in this shared flow revision. - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFiles' + description: This is the display name for the report + organization: + type: string + description: Output only. Organization name + readOnly: true + toTime: + description: 'Legacy field: not used. Contains the end time for the report' + type: string + filter: + type: string + description: This field contains the filter expression + name: + description: >- + Required. Unique identifier for the report T his is a legacy field + used to encode custom report unique id + type: string lastModifiedAt: format: int64 + readOnly: true description: >- - Time at which this shared flow revision was most recently modified, - in milliseconds since epoch. + Output only. Modified time of this entity as milliseconds since + epoch. json key: lastModifiedAt type: string - sharedFlows: - items: - type: string - description: >- - A list of the shared flow names included in this shared flow - revision. + comments: type: array - entityMetaDataAsProperties: - type: object - description: A Key-Value map of metadata about this shared flow revision. - additionalProperties: - 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' - type: - type: string - description: The string "Application" - contextInfo: - type: string - description: A textual description of the shared flow revision. - resources: + Legacy field: not used. This field contains a list of comments + associated with custom report items: type: string - type: array - description: >- - A list of the resources included in this shared flow revision - formatted as "{type}://{name}". - name: - type: string - description: The resource ID of the parent shared flow. - revision: + GoogleCloudApigeeV1SecurityProfileScoringConfig: + id: GoogleCloudApigeeV1SecurityProfileScoringConfig + properties: + description: + description: Description of the config. type: string - description: The resource ID of this revision. - createdAt: + scorePath: + description: Path of the component config used for scoring. type: string - format: int64 - description: >- - Time at which this shared flow revision was created, in milliseconds - since epoch. - description: - description: Description of the shared flow revision. + title: + description: Title of the config. type: string - policies: - items: - type: string - description: A list of policy names included in this shared flow revision. - type: array - GoogleCloudApigeeV1ProfileConfigMediation: - id: GoogleCloudApigeeV1ProfileConfigMediation - properties: {} type: object + description: Security configurations to manage scoring. + GoogleApiHttpBody: description: >- - By default, following policies will be included: - OASValidation - - SOAPMessageValidation - GoogleCloudApigeeV1EndpointAttachment: + 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: GoogleCloudApigeeV1EndpointAttachment properties: - host: - readOnly: true + data: type: string - description: >- - Output only. Host that can be used in either the HTTP target - endpoint directly or as the host in target server. - connectionState: - 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. + format: byte + description: The HTTP request/response body as raw binary. + contentType: type: string description: >- - Output only. State of the endpoint attachment connection to the - service attachment. - state: - type: string - 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. + 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 description: >- - Output only. State of the endpoint attachment. Values other than - `ACTIVE` mean the resource is not ready to use. - serviceAttachment: - type: string - description: 'Format: projects/*/regions/*/serviceAttachments/*' - location: - type: string - description: Required. Location of the endpoint attachment. - name: + Application specific response metadata. Must be set in the first + response for streaming APIs. + id: GoogleApiHttpBody + GoogleCloudApigeeV1QueryTabularStatsResponse: + properties: + nextPageToken: + description: Next page token. type: string + values: + description: Resultant rows from the executed query. + type: array + items: + type: array + items: + type: any + columns: description: >- - Name of the endpoint attachment. Use the following structure in your - request: - `organizations/{org}/endpointAttachments/{endpoint_attachment}` + Column names corresponding to the same order as the inner values in + the stats field. + items: + type: string + type: array + id: GoogleCloudApigeeV1QueryTabularStatsResponse description: >- - Apigee endpoint attachment. For more information, see [Southbound - networking patterns] - (https://cloud.google.com/apigee/docs/api-platform/architecture/southbound-networking-patterns-endpoints). - GoogleCloudApigeeV1ResourceFiles: - id: GoogleCloudApigeeV1ResourceFiles + 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 + GoogleRpcPreconditionFailure: + id: GoogleRpcPreconditionFailure type: object properties: - resourceFile: - description: List of resource files. + violations: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' + $ref: '#/components/schemas/GoogleRpcPreconditionFailureViolation' + description: Describes all precondition violations. type: array - description: List of resource files. - GoogleCloudApigeeV1ListDataCollectorsResponse: + 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. + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendation: + description: The message format of a recommendation from the assessment. type: object - description: Response for ListDataCollectors. properties: - dataCollectors: - description: Data collectors in the specified organization. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + 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. + recommendations: type: array - nextPageToken: + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation + description: The recommended steps of the assessment. + weight: + description: The weight of the assessment which was set in the profile. type: string + enum: + - WEIGHT_UNSPECIFIED + - MINOR + - MODERATE + - MAJOR + enumDescriptions: + - The weight is unspecified. + - The weight is minor. + - The weight is moderate. + - The weight is major. + scoreImpact: description: >- - Page token that you can include in a ListDataCollectors request to - retrieve the next page. If omitted, no subsequent pages exist. - id: GoogleCloudApigeeV1ListDataCollectorsResponse - GoogleCloudApigeeV1AsyncQuery: - properties: - executionTime: - description: ExecutionTime is available only after the query is completed. - type: string - self: - 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` - type: string - resultRows: - description: ResultRows is available only after the query is completed. - format: int64 - type: string - reportDefinitionId: - description: Asynchronous Report ID. - type: string - updated: - type: string - description: Last updated timestamp for the query. - resultFileSize: - type: string - description: ResultFileSize is available only after the query is completed. - envgroupHostname: - description: Hostname is available only when query is executed at host level. - type: string - state: - type: string - description: Query state could be "enqueued", "running", "completed", "failed". - queryParams: - $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetadata' - description: >- - Contains information like metrics, dimenstions etc of the - AsyncQuery. - result: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQueryResult' - description: Result is available only after the query is completed. - name: - description: Asynchronous Query Name. - type: string - created: - type: string - description: Creation time of the query. - error: + Score impact indicates the impact on the overall score if the + assessment were to pass. + format: int32 + type: integer + displayName: + description: The display name of the assessment. type: string - description: Error is set when query fails. - type: object - id: GoogleCloudApigeeV1AsyncQuery - GoogleCloudApigeeV1ListDebugSessionsResponse: - id: GoogleCloudApigeeV1ListDebugSessionsResponse + id: >- + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendation + GoogleCloudApigeeV1ListSharedFlowsResponse: + id: GoogleCloudApigeeV1ListSharedFlowsResponse + description: >- + To change this message, in the same CL add a change log in + go/changing-api-proto-breaks-ui properties: - nextPageToken: - description: >- - Page token that you can include in a ListDebugSessionsRequest to - retrieve the next page. If omitted, no subsequent pages exist. - type: string - sessions: + sharedFlows: type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Session' - description: >- - Session info that includes debug session ID and the first - transaction creation timestamp. + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' + type: object + GoogleCloudApigeeV1ProfileConfigAbuse: + properties: {} + id: GoogleCloudApigeeV1ProfileConfigAbuse type: object - 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. + 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. + GoogleCloudApigeeV1Instance: type: object + id: GoogleCloudApigeeV1Instance + description: Apigee runtime instance. properties: - operationConfigs: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1GraphQLOperationConfig' - 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: + diskEncryptionKeyName: 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. + 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 - id: GoogleCloudApigeeV1GraphQLOperationGroup - GoogleCloudApigeeV1SharedFlow: - description: The metadata describing a shared flow - properties: - latestRevisionId: + lastModifiedAt: + readOnly: true + description: >- + Output only. Time the instance was last modified in milliseconds + since epoch. type: string - description: The id of the most recently created revision for this shared flow. - revision: - type: array - description: A list of revisions of this shared flow. - items: - type: string - metaData: - description: Metadata describing the shared flow. - $ref: '#/components/schemas/GoogleCloudApigeeV1EntityMetadata' - name: + format: int64 + 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. + displayName: + description: Optional. Display name for the instance. type: string - description: The ID of the shared flow. - id: GoogleCloudApigeeV1SharedFlow - type: object - GoogleCloudApigeeV1Query: - properties: - groupByTimeUnit: + location: + description: Required. Compute Engine location where the instance resides. type: string + host: + readOnly: true 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. - outputFormat: - description: >- - Valid values include: `csv` or `json`. Defaults to `json`. Note: - Configure the delimiter for CSV output using the csvDelimiter - property. + Output only. Internal hostname or IP address of the Apigee endpoint + used by clients to connect to the service. type: string - name: + serviceAttachment: type: string - description: Asynchronous Query Name. - reportDefinitionId: - description: Asynchronous Report ID. + 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 + port: + description: Output only. Port number of the exposed Apigee endpoint. type: string - csvDelimiter: + readOnly: true + runtimeVersion: 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`). + 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 - timeRange: - type: any + readOnly: true + state: + 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 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: - type: integer - format: int32 - description: Maximum number of rows that can be returned in the result. - filter: + Output only. State of the instance. Values other than `ACTIVE` means + the resource is not ready to use. + type: string + ipRange: 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 - dimensions: + 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` + name: + type: string description: >- - A list of dimensions. - https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions - items: - type: string + Required. Resource ID of the instance. Values must match the regular + expression `^a-z{0,30}[a-z\d]$`. + consumerAcceptList: type: array - metrics: - description: A list of Metrics. + 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. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetric' - type: array - envgroupHostname: + type: string + createdAt: + description: >- + Output only. Time the instance was created in milliseconds since + epoch. + type: string + format: int64 + readOnly: true + description: + type: string + description: Optional. Description of the instance. + peeringCidrRange: type: string + 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: >- - 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. - id: GoogleCloudApigeeV1Query + 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`. + GoogleCloudApigeeV1DatastoreConfig: + properties: + datasetName: + description: BigQuery dataset name Required for `bigquery` target_type. + type: string + tablePrefix: + description: Prefix of BigQuery table Required for `bigquery` target_type. + type: string + projectId: + type: string + description: Required. GCP project in which the datastore exists + bucketName: + type: string + description: Name of the Cloud Storage bucket. Required for `gcs` target_type. + path: + type: string + description: Path of Cloud Storage bucket Required for `gcs` target_type. + description: Configuration detail for datastore type: object - GoogleCloudApigeeV1Deployment: + id: GoogleCloudApigeeV1DatastoreConfig + 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. + type: object + id: GoogleCloudApigeeV1RevenueShareRange properties: - proxyDeploymentType: - enum: - - PROXY_DEPLOYMENT_TYPE_UNSPECIFIED - - STANDARD - - EXTENSIBLE + 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. + format: double + type: number + start: + description: >- + Starting value of the range. Set to 0 or `null` for the initial + range of values. + format: int64 + type: string + end: + type: string + description: >- + Ending value of the range. Set to 0 or `null` for the last range of + values. + format: int64 + GoogleCloudApigeeV1ConnectorsPlatformConfig: + type: object + id: GoogleCloudApigeeV1ConnectorsPlatformConfig + description: Configuration for the Connectors Platform add-on. + properties: + enabled: + description: >- + Flag that specifies whether the Connectors Platform add-on is + enabled. + type: boolean + expiresAt: readOnly: true - 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 type: string + format: int64 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 + Output only. Time at which the Connectors Platform add-on expires in + milliseconds since epoch. If unspecified, the add-on will never + expire. + GoogleCloudApigeeV1FlowHook: + id: GoogleCloudApigeeV1FlowHook + type: object + properties: + flowHookPoint: 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. - serviceAccount: + 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 + continueOnError: description: >- - The full resource name of Cloud IAM Service Account that this - deployment is using, eg, `projects/-/serviceAccounts/{email}`. + 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 - environment: + description: >- + Shared flow attached to this flow hook, or empty if there is none + attached. + description: type: string - description: Environment. + description: Description of the flow hook. + GoogleCloudApigeeV1Property: + properties: + value: + type: string + description: The property value + name: + type: string + description: The property key + description: A single property entry in the Properties message. + id: GoogleCloudApigeeV1Property + type: object + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray: + id: >- + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray + description: An array of resource messages. + type: object + properties: + resources: + description: >- + Required. The array of resources. For Apigee, the proxies are + resources. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource + GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision: + properties: + percentage: + format: int32 + description: Percentage of MP replicas reporting this revision. + type: integer revision: type: string - description: API proxy revision. - errors: + description: API proxy revision reported as deployed. + type: object + description: Revisions deployed in the MPs. + id: GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision + GoogleCloudApigeeV1ApiProxyRevision: + properties: + resources: type: array description: >- - Errors reported for this deployment. Populated only when state == - ERROR. **Note**: This field is displayed only when viewing - deployment status. + List of the resources included in the API proxy revision formatted + as "{type}://{name}". items: - $ref: '#/components/schemas/GoogleRpcStatus' - instances: + type: string + proxyEndpoints: description: >- - Status reported by each runtime instance. **Note**: This field is - displayed only when viewing deployment status. + 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 items: - $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatus' - apiProxy: + type: string + targetServers: + 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. + items: + type: string + name: + description: Name of the API proxy. type: string - description: API proxy. - deployStartTime: - format: int64 + archive: type: string + readOnly: true description: >- - Time the API proxy was marked `deployed` in the control plane in - millisconds since epoch. - state: + 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: description: >- - Current state of the deployment. **Note**: This field is displayed - only when viewing deployment status. - 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. + Type. Set to `Application`. Maintained for compatibility with the + Apigee Edge API. type: string - enum: - - RUNTIME_STATE_UNSPECIFIED - - READY - - PROGRESSING - - ERROR - routeConflicts: + hasExtensiblePolicy: + readOnly: true + description: >- + Output only. This field will be marked as true if revision contains + any policies marked as extensible. + type: boolean + integrationEndpoints: + items: + type: string + type: array + 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. + resourceFiles: + description: List of resource files included in the API proxy revision. + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFiles' + policies: type: array items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict + type: string + description: List of policy names included in the API proxy revision.. + teams: + items: + type: string + type: array + description: List of the teams included in the API proxy revision. + lastModifiedAt: + type: string + format: int64 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. - id: GoogleCloudApigeeV1Deployment - type: object - GoogleCloudApigeeV1ListDeveloperAppsResponse: - type: object - properties: - app: - description: List of developer apps and their credentials. + Time that the API proxy revision was last modified in milliseconds + since epoch. + 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 + targetEndpoints: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + 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 - id: GoogleCloudApigeeV1ListDeveloperAppsResponse - EdgeConfigstoreBundleBadBundleViolation: - type: object - properties: description: - description: A description of why the bundle is invalid and how to fix it. type: string - filename: + description: Description of the API proxy revision. + revision: type: string + description: API proxy revision. + sharedFlows: + description: List of the shared flows included in the API proxy revision. + items: + type: string + type: array + basepaths: + items: + type: string + description: Base URL of the API proxy. + type: array + entityMetaDataAsProperties: + additionalProperties: + type: string + type: object + description: Metadata describing the API proxy revision as a key-value map. + proxies: + type: array + items: + type: string + description: List of proxy names included in the API proxy revision. + configurationVersion: + $ref: '#/components/schemas/GoogleCloudApigeeV1ConfigVersion' description: >- - The filename (including relative path from the bundle root) in which - the error occurred. - id: EdgeConfigstoreBundleBadBundleViolation - description: A message type used to describe a single bundle validation error. - GoogleCloudApigeeV1TraceSamplingConfig: - id: GoogleCloudApigeeV1TraceSamplingConfig + 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. + createdAt: + format: int64 + description: >- + Time that the API proxy revision was created in milliseconds since + epoch. + type: string + targets: + items: + type: string + description: List of the targets included in the API proxy revision. + type: array + contextInfo: + type: string + description: Revision number, app name, and organization for the API proxy. + displayName: + type: string + description: Human-readable name of the API proxy. + id: GoogleCloudApigeeV1ApiProxyRevision + type: object + description: API proxy revision. + GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse: + id: GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse + description: Response for BatchUpdateSecurityIncident. + type: object + properties: + securityIncidents: + readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' + description: Output only. Updated security incidents + GoogleCloudApigeeV1ProfileConfig: + id: GoogleCloudApigeeV1ProfileConfig + type: object + properties: + categories: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigCategory' + type: array + description: List of categories of profile config. + description: >- + ProfileConfig defines a set of categories and policies which will be + used to compute security score. + GoogleCloudApigeeV1RuntimeTraceSamplingConfig: properties: sampler: - type: string enumDescriptions: - Sampler unspecified. - >- @@ -4126,11 +3825,12 @@ components: 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 + description: Sampler of distributed tracing. OFF is the default value. enum: - SAMPLER_UNSPECIFIED - 'OFF' - PROBABILITY - description: Sampler of distributed tracing. OFF is the default value. samplingRate: format: float type: number @@ -4138,232 +3838,375 @@ components: Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5. 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. - type: object - GoogleCloudApigeeV1ProfileConfigCORS: - description: Checks to see if you have CORS policy in place. + 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. type: object - properties: {} - id: GoogleCloudApigeeV1ProfileConfigCORS - GoogleCloudApigeeV1NatAddress: + id: GoogleCloudApigeeV1RuntimeTraceSamplingConfig + GoogleCloudApigeeV1SecurityAction: + id: GoogleCloudApigeeV1SecurityAction type: object description: >- - Apigee NAT(network address translation) address. A NAT address is a - static external IP address used for Internet egress traffic. + 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. properties: - ipAddress: + description: + description: >- + Optional. An optional user provided description of the + SecurityAction. + type: string + 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 + conditionConfig: + description: >- + Required. A valid SecurityAction must contain at least one + condition. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityActionConditionConfig + flag: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionFlag' + description: Flag a request through if it matches this SecurityAction. + updateTime: + format: google-datetime + description: >- + Output only. The update time for this SecurityAction. This reflects + when this SecurityAction changed states. readOnly: true type: string - description: Output only. The static IPV4 address. state: + description: >- + Required. Only an ENABLED SecurityAction is enforced. An ENABLED + SecurityAction past its expiration time will not be enforced. + 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. + type: string enum: - STATE_UNSPECIFIED - - CREATING - - RESERVED - - ACTIVE - - DELETING + - ENABLED + - DISABLED + createTime: type: string - 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. + format: google-datetime readOnly: true - description: Output only. State of the nat address. - name: + description: Output only. The create time for this SecurityAction. + ttl: + description: Input only. The TTL for this SecurityAction. + format: google-duration type: string - description: Required. Resource ID of the NAT address. - id: GoogleCloudApigeeV1NatAddress - GoogleCloudApigeeV1Stats: - description: Encapsulates a `stats` response. - id: GoogleCloudApigeeV1Stats - type: object - properties: - metaData: - $ref: '#/components/schemas/GoogleCloudApigeeV1Metadata' - description: Metadata information. - environments: - type: array - description: List of query results on the environment level. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1StatsEnvironmentStats' - hosts: - description: List of query results grouped by host. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1StatsHostStats' - type: array - GoogleCloudApigeeV1ListSecurityIncidentsResponse: + expireTime: + type: string + description: The expiration for this SecurityAction. + format: google-datetime + allow: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionAllow' + description: Allow a request through if it matches this SecurityAction. + deny: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionDeny' + description: Deny a request through if it matches this SecurityAction. + GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse: + id: GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse type: object - description: Response for ListSecurityIncidents. - id: GoogleCloudApigeeV1ListSecurityIncidentsResponse properties: - securityIncidents: - type: array + environmentGroupAttachments: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' - description: List of security incidents in the organization + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment' + type: array + description: EnvironmentGroupAttachments for the specified environment group. 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. - GoogleCloudApigeeV1TraceConfigOverride: + Page token that you can include in a ListEnvironmentGroupAttachments + request to retrieve the next page. If omitted, no subsequent pages + exist. + description: Response for ListEnvironmentGroupAttachments. + GoogleCloudApigeeV1KeystoreConfig: type: object - description: A representation of a configuration override. + id: GoogleCloudApigeeV1KeystoreConfig properties: - apiProxy: - 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. + Resource name in the following format: + `organizations/{org}/environments/{env}/keystores/{keystore}` type: string - id: GoogleCloudApigeeV1TraceConfigOverride - GoogleCloudApigeeV1ConfigVersion: - type: object - properties: - majorVersion: - description: Major version of the API proxy configuration schema. - format: int32 - type: integer - minorVersion: - format: int32 - description: Minor version of the API proxy configuration schema. - type: integer - id: GoogleCloudApigeeV1ConfigVersion - description: >- - Version of the API proxy configuration schema. Currently, only 4.0 is - supported. - GoogleCloudApigeeV1ReferenceConfig: + aliases: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1AliasRevisionConfig' + description: Aliases in the keystore. + GoogleCloudApigeeV1DeleteResponse: + description: Response for certain delete operations. properties: - name: + gcpResource: + description: Google Cloud name of deleted resource. type: string - description: >- - Name of the reference in the following format: - `organizations/{org}/environments/{env}/references/{reference}` - resourceName: + requestId: type: string - description: >- - Name of the referenced resource in the following format: - `organizations/{org}/environments/{env}/keystores/{keystore}` Only - references to keystore resources are supported. - id: GoogleCloudApigeeV1ReferenceConfig + description: Unique ID of the request. + message: + description: Description of the operation. + type: string + status: + description: Status of the operation. + type: string + errorCode: + type: string + description: Unique error code for the request, if any. type: object - GoogleCloudApigeeV1OASDocumentation: - id: GoogleCloudApigeeV1OASDocumentation + id: GoogleCloudApigeeV1DeleteResponse + GoogleIamV1Policy: type: object + id: GoogleIamV1Policy properties: - format: - type: string - description: Output only. The format of the input specification file contents. - enum: - - FORMAT_UNSPECIFIED - - YAML - - JSON - enumDescriptions: - - The format is not available. - - YAML format. - - JSON format. - readOnly: true - spec: - $ref: '#/components/schemas/GoogleCloudApigeeV1DocumentationFile' - description: >- - Required. The documentation file contents for the OpenAPI - Specification. JSON and YAML file formats are supported. - description: OpenAPI Specification documentation for a catalog item. - GoogleCloudApigeeV1IngressConfig: - id: GoogleCloudApigeeV1IngressConfig - properties: - revisionId: - description: >- - Revision id that defines the ordering on IngressConfig resources. - The higher the revision, the more recently the configuration was - deployed. - format: int64 - type: string - uid: + etag: description: >- - A unique id for the ingress config that will only change if the - organization is deleted and recreated. - type: string - revisionCreateTime: - format: google-datetime + `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: Time at which the IngressConfig revision was created. - environmentGroups: - description: List of environment groups in the organization. - type: array + format: byte + bindings: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupConfig' - name: - type: string + $ref: '#/components/schemas/GoogleIamV1Binding' + type: array description: >- - Name of the resource in the following format: - `organizations/{org}/deployedIngressConfig`. - type: object - GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse: - properties: - nextPageToken: + 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 + type: integer description: >- - Page token that you can include in a ListEnvironmentGroupAttachments - request to retrieve the next page. If omitted, no subsequent pages - exist. - type: string - environmentGroupAttachments: + 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: type: array + description: Specifies cloud audit logging configuration for this policy. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment' - description: EnvironmentGroupAttachments for the specified environment group. + $ref: '#/components/schemas/GoogleIamV1AuditConfig' + 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/). + GoogleCloudApigeeV1CertInfo: + description: X.509 certificate as defined in RFC 5280. type: object - description: Response for ListEnvironmentGroupAttachments. - id: GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse - GoogleCloudApigeeV1ResourceFile: properties: - type: + expiryDate: + description: X.509 `notAfter` validity period in milliseconds since epoch. type: string - description: Resource file type. {{ resource_file_type }} - name: + format: int64 + subjectAlternativeNames: + description: X.509 subject alternative names (SANs) extension. + items: + type: string + type: array + subject: type: string - description: ID of the resource file. + description: X.509 subject. + issuer: + description: X.509 issuer. + type: string + version: + format: int32 + description: X.509 version. + type: integer + publicKey: + type: string + description: Public key component of the X.509 subject public key info. + sigAlgName: + type: string + description: X.509 signatureAlgorithm. + basicConstraints: + description: X.509 basic constraints extension. + type: string + serialNumber: + type: string + description: X.509 serial number. + 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. + validFrom: + format: int64 + description: X.509 `notBefore` validity period in milliseconds since epoch. + type: string + id: GoogleCloudApigeeV1CertInfo + 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. + properties: + enabled: + description: >- + Optional. Boolean flag that specifies whether the customer access + log feature is enabled. + type: boolean + filter: + 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 ) type: object - id: GoogleCloudApigeeV1ResourceFile - description: Metadata about a resource file. - GoogleCloudApigeeV1Metadata: - description: Encapsulates additional information about query execution. + GoogleCloudApigeeV1APIProductAssociation: type: object + id: GoogleCloudApigeeV1APIProductAssociation properties: - errors: + status: + type: string + description: >- + The API product credential associated status. Valid values are + `approved` or `revoked`. + apiproduct: + description: API product to be associated with the credential. + type: string + description: >- + APIProductAssociation has the API product and its administrative state + association. + GoogleCloudApigeeV1ApiProductRef: + type: object + properties: + apiproduct: + type: string + description: Name of the API product. + status: + type: string + description: Status of the API product. Valid values are `approved` or `revoked`. + id: GoogleCloudApigeeV1ApiProductRef + GoogleCloudApigeeV1EnableSecurityActionRequest: + properties: {} + id: GoogleCloudApigeeV1EnableSecurityActionRequest + description: Message to enable a disabled SecurityAction. + type: object + GoogleCloudApigeeV1StatsEnvironmentStats: + type: object + id: GoogleCloudApigeeV1StatsEnvironmentStats + description: >- + Encapsulates the environment wrapper: ``` "environments": [ { "metrics": + [ { "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], + "name": "prod" } ]``` + properties: + dimensions: + description: List of metrics grouped under dimensions. type: array - description: List of error messages as strings. - items: - type: string - notices: 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" ]``` + $ref: '#/components/schemas/GoogleCloudApigeeV1DimensionMetric' + name: + type: string + description: Name of the environment. + metrics: type: array - id: GoogleCloudApigeeV1Metadata - GoogleCloudApigeeV1OptimizedStats: - id: GoogleCloudApigeeV1OptimizedStats + 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. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' + GoogleCloudApigeeV1AccessSet: + description: >- + Set action. For example, "Set" : { "name" : "target.name", "success" : + true, "value" : "default" } type: object + properties: + name: + type: string + value: + type: string + success: + type: boolean + id: GoogleCloudApigeeV1AccessSet + GoogleCloudApigeeV1OptimizedStats: properties: Response: - $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStatsResponse' description: >- Wraps the `stats` response for JavaScript Optimized Scenario with a response key. For example: ```{ "Response": { "TimeUnit": [], @@ -4375,2140 +4218,1878 @@ components: ], "values": [ "sirjee" ] }, "metric": [ { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] }, { "env": "prod", "name": "sum(is_error)", "values": [ 36.0 ] } ] } ] } } }``` - GoogleCloudApigeeV1SecurityReport: - description: >- - SecurityReport saves all the information about the created security - report. + $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStatsResponse' + type: object + id: GoogleCloudApigeeV1OptimizedStats + GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest: properties: - envgroupHostname: - type: string - description: Hostname is available only when query is executed at host level. - displayName: - type: string - description: Display Name specified by the user. - updated: - description: Output only. Last updated timestamp for the query. - type: string - readOnly: true - state: - type: string + apiProducts: + items: + type: string description: >- - Query state could be "enqueued", "running", "completed", "expired" - and "failed". - resultFileSize: - description: ResultFileSize is available only after the query is completed. - type: string - reportDefinitionId: + 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 + action: type: string - description: Report Definition ID. - queryParams: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportMetadata' description: >- - Contains information like metrics, dimenstions etc of the Security - Report. - self: + 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. + appGroupAppKey: + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' 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 - error: - type: string - description: Error is set when query fails. - created: - description: Creation time of the query. - type: string - result: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportResultMetadata' - description: Result is available only after the query is completed. - resultRows: - description: ResultRows is available only after the query is completed. - format: int64 - type: string - executionTime: - description: ExecutionTime is available only after the query is completed. - type: string - id: GoogleCloudApigeeV1SecurityReport + The new AppGroupKey to be amended. Note that the status can be + updated only via action. type: object - GoogleCloudApigeeV1Point: + description: Request for UpdateAppGroupAppKey + id: GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest + GoogleCloudApigeeV1GraphQLOperationConfig: + id: GoogleCloudApigeeV1GraphQLOperationConfig + description: >- + Binds the resources in a proxy or remote service with the GraphQL + operation and its associated quota enforcement. properties: - id: - type: string - description: Name of a step in the transaction. - results: - description: List of results extracted from a given debug point. + quota: + description: >- + 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: type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Result' - 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. - type: object - id: GoogleCloudApigeeV1Point - GoogleCloudApigeeV1SecurityActionDeny: - type: object - properties: - responseCode: - type: integer - format: int32 - description: Optional. The HTTP response code if the Action = DENY. - description: Message that should be set in case of a Deny Action. - id: GoogleCloudApigeeV1SecurityActionDeny - GoogleCloudApigeeV1Keystore: - description: Datastore for Certificates and Aliases. - id: GoogleCloudApigeeV1Keystore + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + description: Custom attributes associated with the operation. + operations: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1GraphQLOperation' + 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: + type: string + description: >- + Required. Name of the API proxy endpoint or remote service with + which the GraphQL operation and quota are associated. type: object + GoogleCloudApigeeV1SecurityProfile: + description: Represents a SecurityProfile resource. properties: - name: + revisionId: + description: Output only. Revision ID of the security profile. + format: int64 type: string - description: >- - Required. Resource ID for this keystore. Values must match the - regular expression `[\w[:space:].-]{1,255}`. - aliases: readOnly: true - description: Output only. Aliases in this keystore. + environments: items: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironment' type: array - GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse: - id: GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse - type: object - properties: - developerSubscriptions: - description: List of all subscriptions. + description: List of environments attached to security profile. + revisionPublishTime: + format: google-datetime + 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 + readOnly: true + revisionCreateTime: + format: google-datetime + description: Output only. The time when revision was created. + type: string + readOnly: true + scoringConfigs: type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' - nextStartKey: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityProfileScoringConfig + description: List of profile scoring configs in this revision. + revisionUpdateTime: 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. - description: Response for ListDeveloperSubscriptions. - GoogleCloudApigeeV1ScoreComponentRecommendationAction: - id: GoogleCloudApigeeV1ScoreComponentRecommendationAction - description: Action to improve security score. - properties: + readOnly: true + format: google-datetime + description: Output only. The time when revision was updated. description: + description: Description of the security profile. type: string - description: Description of the action. - actionContext: - description: Action context for the action. - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext - type: object - GoogleCloudApigeeV1TraceConfig: - description: >- - TraceConfig defines the configurations in an environment of distributed - trace. - type: object - id: GoogleCloudApigeeV1TraceConfig - properties: - samplingConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceSamplingConfig' + maxScore: + type: integer + format: int32 + readOnly: true 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. - exporter: - enumDescriptions: - - Exporter unspecified - - Jaeger exporter - - Cloudtrace exporter + Output only. Maximum security score that can be generated by this + profile. + minScore: + type: integer + description: >- + Output only. Minimum security score that can be generated by this + profile. + format: int32 + readOnly: true + name: type: string - 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. - endpoint: + Immutable. Name of the security profile resource. Format: + organizations/{org}/securityProfiles/{profile} + displayName: + deprecated: true type: string - description: Required. Endpoint of the exporter. - GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter: - id: GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter + description: 'DEPRECATED: DO NOT USE Display name of the security profile.' + profileConfig: + description: >- + Required. Customized profile configuration that computes the + security score. + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfig' type: object + id: GoogleCloudApigeeV1SecurityProfile + GoogleCloudApigeeV1ListKeyValueEntriesResponse: properties: - scorePath: + keyValueEntries: + description: One or more key value map keys and values. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + type: array + nextPageToken: type: string description: >- - Optional. Return scores for this component. Example: - "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" + 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 + id: GoogleCloudApigeeV1ListKeyValueEntriesResponse description: >- - Filter scores by component path. Used custom filter instead of AIP-160 - as the use cases are highly constrained and predictable. - GoogleCloudApigeeV1RuntimeApiSecurityConfig: + The request structure for listing key value map keys and its + corresponding values. + GoogleCloudApigeeV1AddonsConfig: + description: Add-on configurations for the Apigee organization. type: object - id: GoogleCloudApigeeV1RuntimeApiSecurityConfig - description: Runtime configuration for the API Security add-on. + id: GoogleCloudApigeeV1AddonsConfig properties: - enabled: - type: boolean - description: If the API Security is enabled or not. - GoogleCloudApigeeV1Operation: - id: GoogleCloudApigeeV1Operation + integrationConfig: + description: Configuration for the Integration add-on. + $ref: '#/components/schemas/GoogleCloudApigeeV1IntegrationConfig' + apiSecurityConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiSecurityConfig' + description: Configuration for the API Security add-on. + analyticsConfig: + description: Configuration for the Analytics add-on. + $ref: '#/components/schemas/GoogleCloudApigeeV1AnalyticsConfig' + connectorsPlatformConfig: + description: Configuration for the Connectors Platform add-on. + $ref: '#/components/schemas/GoogleCloudApigeeV1ConnectorsPlatformConfig' + advancedApiOpsConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1AdvancedApiOpsConfig' + description: Configuration for the Advanced API Ops add-on. + monetizationConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1MonetizationConfig' + description: Configuration for the Monetization add-on. + GoogleCloudApigeeV1SecurityReportMetadata: type: object - description: >- - Represents the pairing of REST resource path and the actions (verbs) - allowed on the resource path. properties: - resource: - description: >- - Required. REST resource path associated with the API proxy or remote - service. + dimensions: + type: array + description: Dimensions of the SecurityReport. + items: + type: string + startTimestamp: type: string - methods: + format: google-datetime + description: Start timestamp of the query range. + timeUnit: + description: 'Query GroupBy time unit. Example: "seconds", "minute", "hour"' + type: string + metrics: 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. - GoogleCloudApigeeV1TlsInfoConfig: - type: object - id: GoogleCloudApigeeV1TlsInfoConfig + Metrics of the SecurityReport. Example: + ["name:bot_count,func:sum,alias:sum_bot_count"] + endTimestamp: + description: End timestamp of the query range. + type: string + format: google-datetime + mimeType: + type: string + description: MIME type / Output format. + id: GoogleCloudApigeeV1SecurityReportMetadata + description: Metadata for the security report. + GoogleCloudApigeeV1DeveloperBalance: + description: Account balance for the developer. properties: - ciphers: - description: List of ciphers that are granted access. + wallets: items: - type: string - type: array - keyAliasReference: - description: Reference name and alias pair to use for client-side authentication. - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyAliasReference' - clientAuthEnabled: - type: boolean - description: >- - Flag that specifies whether client-side authentication is enabled - for the target server. Enables two-way TLS. - enabled: - description: >- - Flag that specifies whether one-way TLS is enabled. Set to `true` to - enable one-way TLS. - type: boolean - protocols: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalanceWallet' + readOnly: true type: array - items: - type: string - description: List of TLS protocols that are granted access. - enforce: - description: Flag that enforces TLS settings - type: boolean - commonName: - $ref: '#/components/schemas/GoogleCloudApigeeV1CommonNameConfig' - description: Common name to validate the target server against. - ignoreValidationErrors: description: >- - Flag that specifies whether to ignore TLS certificate validation - errors. Set to `true` to ignore errors. - type: boolean - 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}` + Output only. List of all wallets. Each individual wallet stores the + account balance for a particular currency. + type: object + id: GoogleCloudApigeeV1DeveloperBalance + GoogleCloudApigeeV1DataCollector: + properties: + description: type: string - keyAlias: + description: A description of the data collector. + type: + description: Immutable. The type of data this data collector will collect. + enum: + - TYPE_UNSPECIFIED + - INTEGER + - FLOAT + - STRING + - BOOLEAN + - DATETIME + enumDescriptions: + - For future compatibility. + - For integer values. + - For float values. + - For string values. + - For boolean values. + - For datetime values. + type: string + lastModifiedAt: + readOnly: true type: string description: >- - Name of the alias used for client-side authentication in the - following format: - `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}` - GoogleLongrunningListOperationsResponse: + Output only. The time at which the Data Collector was last updated + in milliseconds since the epoch. + format: int64 + createdAt: + readOnly: true + format: int64 + type: string + description: >- + Output only. The time at which the data collector was created in + milliseconds since the epoch. + name: + description: ID of the data collector. Must begin with `dc_`. + type: string + description: Data collector configuration. + id: GoogleCloudApigeeV1DataCollector type: object + GoogleCloudApigeeV1EndpointChainingRule: properties: - operations: - description: >- - A list of operations that matches the specified filter in the - request. - type: array + proxyIds: + description: List of proxy ids which may be found in the given deployment group. items: - $ref: '#/components/schemas/GoogleLongrunningOperation' - nextPageToken: - description: The standard List next-page token. + type: string + type: array + deploymentGroup: + description: >- + The deployment group to target for cross-shard chaining calls to + these proxies. type: string - description: The response message for Operations.ListOperations. - id: GoogleLongrunningListOperationsResponse - GoogleCloudApigeeV1CanaryEvaluation: + id: GoogleCloudApigeeV1EndpointChainingRule type: object - id: GoogleCloudApigeeV1CanaryEvaluation description: >- - CanaryEvaluation represents the canary analysis between two versions of - the runtime that is serving requests. + EndpointChainingRule specifies the proxies contained in a particular + deployment group, so that other deployment groups can find them in + chaining calls. + GoogleCloudApigeeV1SecurityAssessmentResultScoringResult: + type: object properties: - treatment: - description: Required. The newer version that is serving requests. - type: string - verdict: + assessmentRecommendations: description: >- - Output only. The resulting verdict of the canary evaluations: NONE, - PASS, or FAIL. + The recommendations of the assessment. The key is the "name" of the + assessment (not display_name), and the value are the + recommendations. + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendation + type: object + failedAssessmentPerWeight: + type: object + additionalProperties: + type: integer + format: int32 + description: >- + The number of failed assessments grouped by its weight. Keys are one + of the following: "MAJOR", "MODERATE", "MINOR". + dataUpdateTime: + format: google-datetime + 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. type: string + severity: enum: - - VERDICT_UNSPECIFIED - - NONE - - FAIL - - PASS + - SEVERITY_UNSPECIFIED + - LOW + - MEDIUM + - HIGH + - MINIMAL + description: The severity of the assessment. enumDescriptions: - - Verdict is not available yet. - - No verdict reached. - - Evaluation is not good. - - Evaluation is good. - readOnly: true - name: - readOnly: true - description: Output only. Name of the canary evalution. + - Severity is not defined. + - Severity is low. + - Severity is medium. + - Severity is high. + - Severity is minimal type: string - metricLabels: - $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluationMetricLabels' - description: >- - Required. Labels used to filter the metrics used for a canary - evaluation. - control: - description: Required. The stable version that is serving requests. + score: + type: integer + format: int32 + description: The security score of the assessment. + id: GoogleCloudApigeeV1SecurityAssessmentResultScoringResult + description: The result of the assessment. + 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. + id: GoogleTypeInterval + properties: + startTime: type: string - createTime: - readOnly: true - description: Output only. Create time of the canary evaluation. + 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 + endTime: + description: >- + Optional. Exclusive end of the interval. If specified, a Timestamp + matching this interval will have to be before the end. type: string - startTime: format: google-datetime + type: object + GoogleCloudApigeeV1TraceConfig: + description: >- + TraceConfig defines the configurations in an environment of distributed + trace. + properties: + samplingConfig: + 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. + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceSamplingConfig' + exporter: type: string - description: Required. Start time for the canary evaluation's analysis. - state: - readOnly: true enumDescriptions: - - No state has been specified. - - The canary evaluation is still in progress. - - The canary evaluation has finished. + - 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: - - STATE_UNSPECIFIED - - RUNNING - - SUCCEEDED - description: Output only. The current state of the canary evaluation. - type: string - endTime: + - EXPORTER_UNSPECIFIED + - JAEGER + - CLOUD_TRACE + endpoint: + description: Required. Endpoint of the exporter. type: string - description: Required. End time for the evaluation's analysis. - format: google-datetime - GoogleCloudApigeeV1EnvironmentConfig: + type: object + id: GoogleCloudApigeeV1TraceConfig + GoogleCloudApigeeV1Keystore: properties: - targets: - description: >- - List of target servers in the environment. Disabled target servers - are not displayed. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServerConfig' - type: array - addonsConfig: - description: The latest runtime configurations for add-ons. - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeAddonsConfig' - deployments: + aliases: + description: Output only. Aliases in this keystore. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentConfig' - description: List of deployments in the environment. + type: string + readOnly: true type: array - createTime: - description: Time that the environment configuration was created. - format: google-datetime + name: type: string - traceConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceConfig' - description: >- - Trace configurations. Contains config for the environment and config - overrides for specific API proxies. - resources: - type: array - description: List of resource versions in the environment. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceConfig' - deploymentGroups: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentGroupConfig' - description: List of deployment groups in the environment. - keystores: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeystoreConfig' - description: List of keystores in the environment. - type: array - 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 - name: + Required. Resource ID for this keystore. Values must match the + regular expression `[\w[:space:].-]{1,255}`. + description: Datastore for Certificates and Aliases. + type: object + id: GoogleCloudApigeeV1Keystore + GoogleCloudApigeeV1TargetServerConfig: + id: GoogleCloudApigeeV1TargetServerConfig + type: object + properties: + enabled: description: >- - Name of the environment configuration in the following format: - `organizations/{org}/environments/{env}/configs/{config}` + Whether the target server is enabled. An empty/omitted value for + this field should be interpreted as true. + type: boolean + protocol: + 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 - flowhooks: - description: List of flow hooks in the environment. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHookConfig' - type: array - provider: - description: >- - Used by the Control plane to add context information to help detect - the source of the document during diagnostics and debugging. + description: The protocol used by this target server. + enum: + - PROTOCOL_UNSPECIFIED + - HTTP + - HTTP2 + - GRPC_TARGET + - GRPC + - EXTERNAL_CALLOUT + tlsInfo: + $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfoConfig' + description: TLS settings for the target server. + host: + description: Host name of the target server. type: string - sequenceNumber: - format: int64 + port: + format: int32 + type: integer + description: Port number for the target server. + name: type: string - description: 'DEPRECATED: Use revision_id.' - uid: description: >- - Unique ID for the environment configuration. The ID will only change - if the environment is deleted and recreated. - type: string - revisionId: - type: string + Target server revision name in the following format: + `organizations/{org}/environments/{env}/targetservers/{targetserver}/revisions/{rev}` + GoogleCloudApigeeV1SecurityActionAllow: + type: object + properties: {} + id: GoogleCloudApigeeV1SecurityActionAllow + description: >- + Message that should be set in case of an Allow Action. This does not + have any fields. + GoogleCloudApigeeV1ProfileConfigMTLS: + id: GoogleCloudApigeeV1ProfileConfigMTLS + properties: {} + type: object + description: Checks to see if you have configured mTLS for the target server. + GoogleCloudApigeeV1ProfileConfigCORS: + properties: {} + id: GoogleCloudApigeeV1ProfileConfigCORS + description: Checks to see if you have CORS policy in place. + type: object + GoogleCloudApigeeV1ListRatePlansResponse: + properties: + nextStartKey: description: >- - Revision ID of the environment configuration. The higher the value, - the more recently the configuration was deployed. - format: int64 - resourceReferences: - description: List of resource references in the environment. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ReferenceConfig' - type: array - dataCollectors: + 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 + ratePlans: type: array - description: List of data collectors used by the deployments in the environment. + description: List of rate plans in an organization. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollectorConfig' - envScopedRevisionId: - 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. - format: int64 - type: string - debugMask: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' - description: Debug mask that applies to all deployments in the environment. - gatewayConfigLocation: + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + type: object + id: GoogleCloudApigeeV1ListRatePlansResponse + description: Response for ListRatePlans. + GoogleCloudApigeeV1ListSecurityProfilesResponse: + description: Response for ListSecurityProfiles. + id: GoogleCloudApigeeV1ListSecurityProfilesResponse + properties: + securityProfiles: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' 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. + 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. + type: array + nextPageToken: type: string - arcConfigLocation: 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. - type: string - pubsubTopic: - type: string - description: Name of the PubSub topic for the environment. - featureFlags: - additionalProperties: - type: string - type: object - description: Feature flags inherited from the organization and environment. - id: GoogleCloudApigeeV1EnvironmentConfig + 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: object - GoogleCloudApigeeV1SecurityProfile: - description: Represents a SecurityProfile resource. + GoogleCloudApigeeV1RuntimeApiSecurityConfig: + properties: + enabled: + type: boolean + description: If the API Security is enabled or not. type: object - id: GoogleCloudApigeeV1SecurityProfile + description: Runtime configuration for the API Security add-on. + id: GoogleCloudApigeeV1RuntimeApiSecurityConfig + GoogleCloudApigeeV1SecurityActionConditionConfig: properties: - revisionPublishTime: - format: google-datetime - type: string - readOnly: true - deprecated: true - 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. - minScore: - type: integer + accessTokens: + type: array + description: Optional. A list of access_tokens. Limit 1000 per action. + items: + type: string + asns: description: >- - Output only. Minimum security score that can be generated by this - profile. - readOnly: true - format: int32 - displayName: - deprecated: true - description: 'DEPRECATED: DO NOT USE Display name of the security profile.' - type: string - revisionId: - readOnly: true - type: string - format: int64 - description: Output only. Revision ID of the security profile. - revisionUpdateTime: - format: google-datetime - description: Output only. The time when revision was updated. - readOnly: true - type: string - scoringConfigs: - description: List of profile scoring configs in this revision. + 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 items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityProfileScoringConfig - maxScore: - type: integer + format: int64 + type: string + regionCodes: description: >- - Output only. Maximum security score that can be generated by this - profile. - readOnly: true - format: int32 - name: - type: string + 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 + type: array + ipAddressRanges: description: >- - Immutable. Name of the security profile resource. Format: - organizations/{org}/securityProfiles/{profile} - environments: + Optional. A list of IP addresses. This could be either IPv4 or IPv6. + Limited to 100 per action. + items: + type: string type: array - description: List of environments attached to security profile. + userAgents: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironment' - revisionCreateTime: - type: string - readOnly: true - format: google-datetime - description: Output only. The time when revision was created. - description: - description: Description of the security profile. - type: string - profileConfig: + type: string description: >- - Required. Customized profile configuration that computes the - security score. - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfig' - GoogleCloudApigeeV1RuntimeConfig: - type: object - id: GoogleCloudApigeeV1RuntimeConfig - description: >- - Runtime configuration for the organization. Response for - GetRuntimeConfig. - properties: - analyticsBucket: - description: Cloud Storage bucket used for uploading Analytics records. - type: string - traceBucket: - type: string - description: Cloud Storage bucket used for uploading Trace records. - name: + Optional. A list of user agents to deny. We look for exact matches. + Limit 50 per action. + type: array + developers: + items: + type: string + type: array + description: Optional. A list of developers. Limit 1000 per action. + httpMethods: + items: + type: string + type: array description: >- - Name of the resource in the following format: - `organizations/{org}/runtimeConfig`. - type: string - tenantProjectId: + 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. + apiProducts: + items: + type: string + description: Optional. A list of API Products. Limit 1000 per action. + type: array + apiKeys: + items: + type: string + description: Optional. A list of API keys. Limit 1000 per action. + type: array + developerApps: + items: + type: string + description: Optional. A list of developer apps. Limit 1000 per action. + type: array + botReasons: + type: array + items: + type: string 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 - GoogleCloudApigeeV1PodStatus: - id: GoogleCloudApigeeV1PodStatus + 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. + 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 + GoogleCloudApigeeV1CanaryEvaluationMetricLabels: type: object + id: GoogleCloudApigeeV1CanaryEvaluationMetricLabels properties: - appVersion: - type: string - description: Version of the application running in the pod. - deploymentTime: + instance_id: type: string - description: Time the proxy was deployed in milliseconds since epoch. - format: int64 - deploymentStatus: description: >- - Status of the deployment. Valid values include: - `deployed`: - Successful. - `error` : Failed. - `pending` : Pod has not yet - reported on the deployment. - type: string - statusCodeDetails: - description: Human-readable message associated with the status code. - type: string - deploymentStatusTime: - description: Time the deployment status was reported in milliseconds since epoch. - type: string - format: int64 - podName: + Required. The instance ID associated with the metrics. In Apigee + Hybrid, the value is configured during installation. + env: + description: The environment ID associated with the metrics. type: string - description: Name of the pod which is reporting the status. - podStatus: + location: type: string + description: Required. The location associated with the metrics. + description: Labels that can be used to filter Apigee metrics. + GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence: + id: GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence + description: A sequence of time series. + properties: + points: + type: array + description: List of points. First value of each inner list is a timestamp. + items: + items: + type: any + type: array + dimensions: 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. - statusCode: - type: string - description: Code associated with the deployment status. - podStatusTime: - format: int64 - type: string - description: Time the pod status was reported in milliseconds since epoch. - GoogleCloudApigeeV1Attributes: + Map of dimensions and their values that uniquely identifies a time + series sequence. + additionalProperties: + type: string + type: object + type: object + GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse: + description: Response for ListDeveloperSubscriptions. + type: object + id: GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse properties: - attribute: + developerSubscriptions: + description: List of all subscriptions. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - description: List of attributes. + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' type: array + 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. + type: string + GoogleCloudApigeeV1StatsHostStats: type: object - id: GoogleCloudApigeeV1Attributes - GoogleCloudApigeeV1AccessRemove: description: >- - Remove action. For example, "Remove" : { "name" : "target.name", - "success" : true } + Encapsulates the hostname wrapper: ``` "hosts": [ { "metrics": [ { + "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], "name": + "example.com" } ]``` properties: name: type: string - success: - type: boolean - id: GoogleCloudApigeeV1AccessRemove + description: Hostname used in query. + dimensions: + description: List of metrics grouped under dimensions. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1DimensionMetric' + type: array + 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 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 + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource: + id: >- + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource + properties: + name: + type: string + description: Required. Name of this resource. + type: + enum: + - RESOURCE_TYPE_UNSPECIFIED + - API_PROXY + description: Required. Type of this resource. + type: string + enumDescriptions: + - ResourceType not specified. + - Resource is an Apigee Proxy. type: object - EdgeConfigstoreBundleBadBundle: - description: Describes why a bundle is invalid. Intended for use in error details. - id: EdgeConfigstoreBundleBadBundle + description: Resource for which we are computing security assessment. + GoogleCloudApigeeV1Stats: properties: - violations: + metaData: + description: Metadata information. + $ref: '#/components/schemas/GoogleCloudApigeeV1Metadata' + environments: items: - $ref: '#/components/schemas/EdgeConfigstoreBundleBadBundleViolation' + $ref: '#/components/schemas/GoogleCloudApigeeV1StatsEnvironmentStats' + description: List of query results on the environment level. + type: array + hosts: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1StatsHostStats' + description: List of query results grouped by host. type: array - description: Describes all precondition violations. type: object - GoogleCloudApigeeV1DeploymentChangeReportRoutingChange: + description: Encapsulates a `stats` response. + id: GoogleCloudApigeeV1Stats + GoogleCloudApigeeV1SecurityActionsConfig: + id: GoogleCloudApigeeV1SecurityActionsConfig type: object - id: GoogleCloudApigeeV1DeploymentChangeReportRoutingChange properties: - fromDeployment: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment - description: Base path/deployment that may stop receiving some traffic. - shouldSequenceRollout: + enabled: + 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. type: boolean + name: 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: + 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 environment group affected by this routing change. - description: + updateTime: + readOnly: true type: string - description: Human-readable description of this routing change. - 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. + format: google-datetime + description: Output only. The update time for configuration. description: >- - Describes a potential routing change that may occur as a result of some - deployment operation. - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll: - type: object - id: >- - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll - properties: {} - description: Message for include_all option. - GoogleCloudApigeeV1ConnectorsPlatformConfig: + SecurityActionsConfig reflects the current state of the SecurityActions + feature. This is a singleton resource: https://google.aip.dev/156 + GoogleIamV1SetIamPolicyRequest: + description: Request message for `SetIamPolicy` method. + id: GoogleIamV1SetIamPolicyRequest type: object - description: Configuration for the Connectors Platform add-on. - id: GoogleCloudApigeeV1ConnectorsPlatformConfig properties: - expiresAt: + updateMask: description: >- - Output only. Time at which the Connectors Platform add-on expires in - milliseconds since epoch. If unspecified, the add-on will never - expire. - readOnly: true - format: int64 + 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 - enabled: - type: boolean + format: google-fieldmask + policy: description: >- - Flag that specifies whether the Connectors Platform add-on is - enabled. - GoogleCloudApigeeV1FlowHook: + 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' + 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 - id: GoogleCloudApigeeV1FlowHook - properties: - 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`. - description: - 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`. - type: boolean - sharedFlow: - type: string - description: >- - Shared flow attached to this flow hook, or empty if there is none - attached. - GoogleCloudApigeeV1KeystoreConfig: - id: GoogleCloudApigeeV1KeystoreConfig + id: GoogleCloudApigeeV1DeploymentChangeReport properties: - name: + routingConflicts: + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict + type: array + description: All base path conflicts detected for a deployment request. + validationErrors: + $ref: '#/components/schemas/GoogleRpcPreconditionFailure' description: >- - Resource name in the following format: - `organizations/{org}/environments/{env}/keystores/{keystore}` - type: string - aliases: + Validation errors that would cause the deployment change request to + be rejected. + routingChanges: type: array - description: Aliases in the keystore. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1AliasRevisionConfig' - type: object - GoogleCloudApigeeV1App: - id: GoogleCloudApigeeV1App + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingChange + description: All routing changes that may result from a deployment request. + GoogleCloudApigeeV1MetricAggregation: type: object properties: - callbackUrl: - description: >- - Callback URL used by OAuth 2.0 authorization servers to communicate - authorization codes back to apps. - type: string - keyExpiresIn: - format: int64 - 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 - type: string - lastModifiedAt: - format: int64 - type: string - readOnly: true - description: Output only. Last modified time as milliseconds since epoch. - createdAt: - description: Output only. Unix time when the app was created. - readOnly: true - format: int64 - type: string - companyName: - type: string - description: Name of the company that owns the app. - apiProducts: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProductRef' - type: array - description: List of API products associated with the app. - attributes: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - type: array - description: List of attributes. - credentials: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Credential' - type: array + order: description: >- - Output only. Set of credentials for the app. Credentials are API - key/secret pairs associated with API products. - readOnly: true - appGroup: + 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: Name of the AppGroup - appId: - description: ID of the app. + enumDescriptions: + - Unspecified order. Default is Descending. + - Ascending sort order. + - Descending sort order. + enum: + - ORDER_UNSPECIFIED + - ASCENDING + - DESCENDING + aggregation: type: string + description: Aggregation function associated with the metric. + enumDescriptions: + - Unspecified Aggregation function. + - Average. + - Summation. + - Min. + - Max. + - Count distinct + enum: + - AGGREGATION_FUNCTION_UNSPECIFIED + - AVG + - SUM + - MIN + - MAX + - COUNT_DISTINCT name: - description: Name of the app. type: string - status: - description: Status of the credential. + description: Name of the metric + id: GoogleCloudApigeeV1MetricAggregation + description: The optionally aggregated metric to query with its ordering. + GoogleCloudApigeeV1ProfileConfigCategory: + description: >- + Advanced API Security provides security profile that scores the + following categories. + properties: + 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. + cors: + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigCORS' + description: Checks to see if you have CORS policy in place. + mtls: + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigMTLS' + description: Checks to see if you have configured mTLS for the target server. + authorization: + description: Checks to see if you have an authorization policy in place. + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigAuthorization' + mediation: + description: Checks to see if you have a mediation policy in place. + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigMediation' + threat: + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigThreat' + description: Checks to see if you have a threat protection policy in place. + type: object + id: GoogleCloudApigeeV1ProfileConfigCategory + GoogleCloudApigeeV1ScoreComponentRecommendation: + properties: + description: type: string - scopes: + description: Description of the recommendation. + impact: description: >- - Scopes to apply to the app. The specified scope names must already - exist on the API product that you associate with the app. - items: - type: string + Potential impact of this recommendation on the overall score. This + denotes how important this recommendation is to improve the score. + format: int32 + type: integer + actions: + description: Actions for the recommendation to improve the security score. type: array - developerEmail: - type: string - description: Email of the developer. - developerId: - description: ID of the developer. + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendationAction + title: + description: Title represents recommendation title. type: string - GoogleCloudApigeeV1SecurityAction: - id: GoogleCloudApigeeV1SecurityAction + description: Recommendation based on security concerns and score. + id: GoogleCloudApigeeV1ScoreComponentRecommendation + type: object + GoogleCloudApigeeV1NatAddress: properties: 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} - description: + description: Required. Resource ID of the NAT address. + ipAddress: type: string - description: >- - Optional. An optional user provided description of the - SecurityAction. - createTime: - description: Output only. The create time for this SecurityAction. + description: Output only. The static IPV4 address. readOnly: true + state: type: string - format: google-datetime - deny: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionDeny' - description: Deny a request through if it matches this SecurityAction. - flag: - description: Flag a request through if it matches this SecurityAction. - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionFlag' - expireTime: - type: string - description: The expiration for this SecurityAction. - format: google-datetime - ttl: - format: google-duration - type: string - description: Input only. The TTL for this SecurityAction. - conditionConfig: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityActionConditionConfig - description: >- - Required. A valid SecurityAction must contain at least one - condition. - state: + 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 - - ENABLED - - DISABLED - 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. - description: >- - Required. Only an ENABLED SecurityAction is enforced. An ENABLED - SecurityAction past its expiration time will not be enforced. - type: string - updateTime: - format: google-datetime - readOnly: true - description: >- - Output only. The update time for this SecurityAction. This reflects - when this SecurityAction changed states. - type: string - allow: - description: Allow a request through if it matches this SecurityAction. - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionAllow' - 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. + - CREATING + - RESERVED + - ACTIVE + - DELETING type: object - GoogleCloudApigeeV1SecurityIncident: + description: >- + Apigee NAT(network address translation) address. A NAT address is a + static external IP address used for Internet egress traffic. + id: GoogleCloudApigeeV1NatAddress + GoogleCloudApigeeV1CustomReportMetric: + id: GoogleCloudApigeeV1CustomReportMetric + description: >- + This encapsulates a metric property of the form sum(message_count) where + name is message_count and function is sum type: object - description: Represents an SecurityIncident resource. - id: GoogleCloudApigeeV1SecurityIncident properties: - displayName: - type: string - description: Optional. Display name of the security incident. - observability: - 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. - enum: - - OBSERVABILITY_UNSPECIFIED - - ACTIVE - - ARCHIVED + name: type: string - trafficCount: - description: Total traffic detected as part of the incident. - format: int64 + description: name of the metric + function: type: string - name: + description: aggregate function + GoogleCloudApigeeV1EnvironmentGroupConfig: + properties: + hostnames: + items: + type: string + type: array + description: Host names for the environment group. + uid: type: string 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 - detectionTypes: + A unique id for the environment group config that will only change + if the environment group is deleted and recreated. + routingRules: type: array description: >- - Output only. Detection types which are part of the incident. - Examples: Flooder, OAuth Abuser, Static Content Scraper, Anomaly - Detection. - readOnly: true + Ordered list of routing rules defining how traffic to this + environment group's hostnames should be routed to different + environments. items: - type: string - lastObservabilityChangeTime: + $ref: '#/components/schemas/GoogleCloudApigeeV1RoutingRule' + endpointChainingRules: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointChainingRule' + type: array + description: A list of proxies in each deployment group for proxy chaining calls. + location: type: string description: >- - Output only. The time when the incident observability was last - changed. - readOnly: true - format: google-datetime - lastDetectedTime: + 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: description: >- - Output only. The time when events associated with the incident were - last detected. - format: google-datetime - readOnly: true + Name of the environment group in the following format: + `organizations/{org}/envgroups/{envgroup}`. type: string - riskLevel: - description: Output only. Risk level of the incident. - 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. - enum: - - RISK_LEVEL_UNSPECIFIED - - LOW - - MODERATE - - SEVERE + revisionId: + description: >- + Revision id that defines the ordering of the EnvironmentGroupConfig + resource. The higher the revision, the more recently the + configuration was deployed. type: string - firstDetectedTime: + format: int64 + type: object + description: >- + EnvironmentGroupConfig is a revisioned snapshot of an EnvironmentGroup + and its associated routing rules. + id: GoogleCloudApigeeV1EnvironmentGroupConfig + GoogleCloudApigeeV1EnvironmentGroupAttachment: + properties: + environment: + description: Required. ID of the attached environment. + type: string + name: + description: ID of the environment group attachment. + type: string + createdAt: + format: int64 type: string description: >- - Output only. The time when events associated with the incident were - first detected. + Output only. The time at which the environment group attachment was + created as milliseconds since epoch. readOnly: true - format: google-datetime - GoogleCloudApigeeV1StatsEnvironmentStats: - id: GoogleCloudApigeeV1StatsEnvironmentStats + environmentGroupId: + type: string + readOnly: true + description: Output only. ID of the environment group. + type: object + id: GoogleCloudApigeeV1EnvironmentGroupAttachment + description: >- + EnvironmentGroupAttachment is a resource which defines an attachment of + an environment to an environment group. + GoogleCloudApigeeV1Quota: properties: - metrics: - type: array + limit: 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. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' - name: - description: Name of the environment. + Required. Upper limit allowed for the time interval and time unit + specified. Requests exceeding this limit will be rejected. type: string - dimensions: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DimensionMetric' - type: array - description: List of metrics grouped under dimensions. + interval: + description: >- + Required. Time interval over which the number of request messages is + calculated. + type: string + 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. + type: object + id: GoogleCloudApigeeV1Quota description: >- - Encapsulates the environment wrapper: ``` "environments": [ { "metrics": - [ { "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], - "name": "prod" } ]``` + 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. + EdgeConfigstoreBundleBadBundle: + description: Describes why a bundle is invalid. Intended for use in error details. type: object - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray: - description: An array of resource messages. + id: EdgeConfigstoreBundleBadBundle properties: - resources: - description: >- - Required. The array of resources. For Apigee, the proxies are - resources. - type: array + violations: + description: Describes all precondition violations. items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource - id: >- - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray - type: object - GoogleCloudApigeeV1ListInstancesResponse: - id: GoogleCloudApigeeV1ListInstancesResponse - description: Response for ListInstances. - type: object - properties: - instances: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' - description: Instances in the specified organization. + $ref: '#/components/schemas/EdgeConfigstoreBundleBadBundleViolation' type: array - nextPageToken: - description: >- - Page token that you can include in a ListInstance request to - retrieve the next page of content. If omitted, no subsequent pages - exist. - type: string - GoogleCloudApigeeV1DocumentationFile: - description: Documentation file contents for a catalog item. + GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment: + description: Tuple representing a base path and the deployment containing it. type: object - id: GoogleCloudApigeeV1DocumentationFile - properties: - displayName: - description: >- - Required. A display name for the file, shown in the management UI. - Max length is 255 characters. - type: string - contents: - format: byte - description: Required. The file contents. The max size is 4 MB. - type: string - GoogleCloudApigeeV1DeploymentConfig: properties: - location: - description: Location of the API proxy bundle as a URI. - type: string - endpoints: - description: >- - A mapping from basepaths to proxy endpoint names in this proxy. Not - populated for shared flows. - type: object - additionalProperties: - type: string - name: + revision: 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}` - uid: + description: Name of the deployed API proxy revision containing the base path. + environment: type: string - description: >- - Unique ID. The ID will only change if the deployment is deleted and - recreated. - basePath: - description: Base path where the application will be hosted. Defaults to "/". + description: Name of the environment in which the proxy is deployed. + basepath: + description: Base path receiving traffic. type: string - proxyUid: - description: Unique ID of the API proxy revision. + apiProxy: + description: Name of the deployed API proxy revision containing the base path. type: string - attributes: - description: Additional key-value metadata for the deployment. - additionalProperties: - type: string - type: object - deploymentGroups: + id: GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment + GoogleCloudApigeeV1Attributes: + properties: + attribute: + description: List of attributes. items: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' type: array - description: >- - The list of deployment groups in which this proxy should be - deployed. Not currently populated for shared flows. - serviceAccount: + type: object + id: GoogleCloudApigeeV1Attributes + GoogleCloudApigeeV1ListSecurityActionsResponse: + properties: + securityActions: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' + type: array + description: The SecurityActions for the specified environment. + nextPageToken: type: string description: >- - The service account identity associated with this deployment. If - non-empty, will be in the following format: - `projects/-/serviceAccounts/{account_email}` + 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: object - description: 'NEXT ID: 11' - id: GoogleCloudApigeeV1DeploymentConfig - GoogleCloudApigeeV1SecurityReportQuery: + id: GoogleCloudApigeeV1ListSecurityActionsResponse + description: >- + Contains a list of SecurityActions in response to a + ListSecurityActionRequest. + GoogleCloudApigeeV1Score: + description: Represents Security Score. + id: GoogleCloudApigeeV1Score type: object properties: - limit: - format: int32 - description: Maximum number of rows that can be returned in the result. - type: integer - metrics: - description: A list of Metrics. + subcomponents: + description: List of all the drilldown score components. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQueryMetric' + $ref: '#/components/schemas/GoogleCloudApigeeV1ScoreComponent' type: array - dimensions: + component: + description: Component containing score, recommendations and actions. + $ref: '#/components/schemas/GoogleCloudApigeeV1ScoreComponent' + timeRange: + description: Start and end time for the score. + $ref: '#/components/schemas/GoogleTypeInterval' + GoogleCloudApigeeV1OptimizedStatsNode: + properties: + data: items: - type: string - description: >- - A list of dimensions. - https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions + type: any type: array - timeRange: - type: any + 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. + id: GoogleCloudApigeeV1OptimizedStatsNode + GoogleCloudApigeeV1ConfigVersion: + type: object + description: >- + Version of the API proxy configuration schema. Currently, only 4.0 is + supported. + id: GoogleCloudApigeeV1ConfigVersion + properties: + majorVersion: + format: int32 + type: integer + description: Major version of the API proxy configuration schema. + minorVersion: + format: int32 + type: integer + description: Minor version of the API proxy configuration schema. + GoogleCloudApigeeV1TargetServer: + description: >- + TargetServer configuration. TargetServers are used to decouple a proxy + TargetEndpoint HTTPTargetConnections from concrete URLs for backend + services. + type: object + id: GoogleCloudApigeeV1TargetServer + properties: + description: + description: Optional. A human-readable description of this TargetServer. + type: string + host: 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" } - displayName: + Required. The host name this target connects to. Value must be a + valid hostname as described by RFC-1123. type: string - description: Security Report display name which users can specify. - mimeType: + protocol: + 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 type: string - description: >- - Valid values include: `csv` or `json`. Defaults to `json`. Note: - Configure the delimiter for CSV output using the csvDelimiter - property. - filter: + name: 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 - groupByTimeUnit: - type: string + Required. The resource id of this target server. Values must match + the regular expression + isEnabled: + type: boolean 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. - csvDelimiter: - type: string + 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. + sSLInfo: 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`). - reportDefinitionId: - type: string - description: Report Definition ID. - envgroupHostname: - type: string + 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' + port: + type: integer 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. - id: GoogleCloudApigeeV1SecurityReportQuery - description: Body structure when user makes a request to create a security report. - GoogleCloudApigeeV1AsyncQueryResult: + Required. The port number this target connects to on the given host. + Value must be between 1 and 65535, inclusive. + format: int32 + GoogleCloudApigeeV1RoutingRule: + id: GoogleCloudApigeeV1RoutingRule properties: - expires: - description: Query result will be unaccessable after this time. - type: string - self: + basepath: 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 - type: object - id: GoogleCloudApigeeV1AsyncQueryResult - GoogleCloudApigeeV1UpdateError: - type: object - description: Details on why a resource update failed in the runtime. - id: GoogleCloudApigeeV1UpdateError - properties: - message: - type: string - description: User-friendly error message. - code: + URI path prefix used to route to the specified environment. May + contain one or more wildcards. For example, path segments consisting + of a single `*` character will match any string. type: string - 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 - 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 - description: Status code. - type: + updateTime: + format: google-datetime 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: + 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. + receiver: 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 - GoogleCloudApigeeV1ApiProxy: - id: GoogleCloudApigeeV1ApiProxy - description: Metadata describing the API proxy - properties: - metaData: - readOnly: true - description: Output only. Metadata describing the API proxy. - $ref: '#/components/schemas/GoogleCloudApigeeV1EntityMetadata' - apiProxyType: - 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. - readOnly: true - description: Output only. The type of the API proxy. - enum: - - API_PROXY_TYPE_UNSPECIFIED - - PROGRAMMABLE - - CONFIGURABLE - labels: - description: User labels applied to this API Proxy. - type: object - additionalProperties: - type: string - name: - description: Output only. Name of the API proxy. - readOnly: true + 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 - latestRevisionId: + 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 - readOnly: true + otherTargets: description: >- - Output only. The id of the most recently created revision for this - api proxy. - revision: + Conflicting targets, which will be resource names specifying either + deployment groups or environments. + type: array items: type: string - description: Output only. List of revisions defined for the API proxy. - readOnly: true - type: array - readOnly: + deploymentGroup: + type: string 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 - type: boolean + 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. + envGroupRevision: + format: int64 + 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. + type: string type: object - GoogleCloudApigeeV1OperationConfig: + GoogleCloudApigeeV1Deployment: + id: GoogleCloudApigeeV1Deployment properties: - apiSource: + environment: type: string + description: Environment. + revision: + description: API proxy revision. + type: string + deployStartTime: + type: string + format: int64 description: >- - Required. Name of the API proxy or remote service with which the - resources, methods, and quota are associated. - operations: + Time the API proxy was marked `deployed` in the control plane in + millisconds since epoch. + serviceAccount: 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. + The full resource name of Cloud IAM Service Account that this + deployment is using, eg, `projects/-/serviceAccounts/{email}`. + type: string + instances: + description: >- + Status reported by each runtime instance. **Note**: This field is + displayed only when viewing deployment status. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Operation' - type: array - attributes: + $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatus' type: array - description: Custom attributes associated with the operation. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - quota: + 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. + type: string + enum: + - RUNTIME_STATE_UNSPECIFIED + - READY + - PROGRESSING + - ERROR description: >- - 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' - id: GoogleCloudApigeeV1OperationConfig - type: object - description: >- - Binds the resources in an API proxy or remote service with the allowed - REST methods and associated quota enforcement. - GoogleIamV1Policy: - id: GoogleIamV1Policy - properties: - bindings: + Current state of the deployment. **Note**: This field is displayed + only when viewing deployment status. + errors: 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: + $ref: '#/components/schemas/GoogleRpcStatus' 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: + Errors reported for this deployment. Populated only when state == + ERROR. **Note**: This field is displayed only when viewing + deployment status. type: array - description: Specifies cloud audit logging configuration for this policy. - items: - $ref: '#/components/schemas/GoogleIamV1AuditConfig' - etag: + proxyDeploymentType: 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. + 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. + 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 type: string - format: byte - 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/). - GoogleCloudApigeeV1SecurityActionFlag: - properties: - headers: + enum: + - PROXY_DEPLOYMENT_TYPE_UNSPECIFIED + - STANDARD + - EXTENSIBLE + apiProxy: + type: string + description: API proxy. + routeConflicts: + type: array 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. + 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. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionHttpHeader' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict + pods: type: array - description: The message that should be set in the case of a Flag action. - id: GoogleCloudApigeeV1SecurityActionFlag + 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. type: object - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendation: - description: The message format of a recommendation from the assessment. - id: >- - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendation + GoogleCloudApigeeV1Developer: + id: GoogleCloudApigeeV1Developer type: object properties: - recommendations: - type: array - description: The recommended steps of the assessment. - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation - weight: - enum: - - WEIGHT_UNSPECIFIED - - MINOR - - MODERATE - - MAJOR + accessType: + description: Access type. type: string - 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. - verdict: - enumDescriptions: - - The verdict is unspecified. - - The assessment has passed. - - The assessment has failed. - description: Verdict indicates the assessment result. - enum: - - VERDICT_UNSPECIFIED - - PASS - - FAIL + status: + readOnly: true + description: >- + Output only. Status of the developer. Valid values are `active` and + `inactive`. type: string - scoreImpact: - type: integer - format: int32 + firstName: + description: Required. First name of the developer. + type: string + organizationName: description: >- - Score impact indicates the impact on the overall score if the - assessment were to pass. - displayName: + Output only. Name of the Apigee organization in which the developer + resides. type: string - description: The display name of the assessment. - 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 - type: object - properties: - exemptedMembers: - items: - type: string + readOnly: true + attributes: type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. - logType: - type: string - 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 - GoogleLongrunningOperation: - description: >- - This resource represents a long-running operation that is the result of - a network API call. - id: GoogleLongrunningOperation - type: object - properties: - name: + Optional. Developer attributes (name/value pairs). The custom + attribute limit is 18. + email: 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 - 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: - 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 - 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. - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - The error result of the operation in case of failure or - cancellation. - GoogleCloudApigeeV1AccessSet: - id: GoogleCloudApigeeV1AccessSet - description: >- - Set action. For example, "Set" : { "name" : "target.name", "success" : - true, "value" : "default" } - type: object - properties: - name: - type: string - value: + 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. + developerId: type: string - success: - type: boolean - GoogleCloudApigeeV1ApiProxyRevision: - description: API proxy revision. - type: object - id: GoogleCloudApigeeV1ApiProxyRevision - properties: - hasExtensiblePolicy: - type: boolean - readOnly: true description: >- - Output only. This field will be marked as true if revision contains - any policies marked as extensible. - name: - description: Name of the API proxy. - type: string - sharedFlows: - items: - type: string - type: array - description: List of the shared flows included in the API proxy revision. - type: + ID of the developer. **Note**: IDs are generated internally by + Apigee and are not guaranteed to stay the same over time. + lastModifiedAt: type: string + readOnly: true + format: int64 description: >- - Type. Set to `Application`. Maintained for compatibility with the - Apigee Edge API. - contextInfo: - description: Revision number, app name, and organization for the API proxy. + Output only. Time at which the developer was last modified in + milliseconds since epoch. + createdAt: 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. - resources: + Output only. Time at which the developer was created in milliseconds + since epoch. + readOnly: true + format: int64 + companies: + description: List of companies associated with the developer. items: type: string type: array - description: >- - List of the resources included in the API proxy revision formatted - as "{type}://{name}". - policies: - description: List of policy names included in the API proxy revision.. - type: array + apps: items: type: string - proxyEndpoints: + description: List of apps associated with the developer. type: array - items: - type: string - 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. - createdAt: - format: int64 - description: >- - Time that the API proxy revision was created in milliseconds since - epoch. + lastName: + description: Required. Last name of the developer. type: string - resourceFiles: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFiles' - description: List of resource files included in the API proxy revision. - targets: - type: array - description: List of the targets included in the API proxy revision. - items: - type: string - archive: - readOnly: true + appFamily: 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/*` - lastModifiedAt: - description: >- - Time that the API proxy revision was last modified in milliseconds - since epoch. + description: Developer app family. + userName: + description: Required. User name of the developer. Not used by Apigee hybrid. type: string - format: int64 - targetServers: + GoogleCloudApigeeV1ListCustomReportsResponse: + description: This message encapsulates a list of custom report definitions + type: object + properties: + qualifier: type: array items: - type: string - 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. - revision: - description: API proxy revision. + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' + id: GoogleCloudApigeeV1ListCustomReportsResponse + GoogleCloudApigeeV1ReportInstanceStatusResponse: + type: object + properties: {} + id: GoogleCloudApigeeV1ReportInstanceStatusResponse + description: Placeholder for future enhancements to status reporting protocol + EdgeConfigstoreBundleBadBundleViolation: + type: object + properties: + description: + description: A description of why the bundle is invalid and how to fix it. + type: string + filename: type: string - teams: - items: - type: string - description: List of the teams included in the API proxy revision. - type: array - entityMetaDataAsProperties: - type: object - description: Metadata describing the API proxy revision as a key-value map. - additionalProperties: - 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. + The filename (including relative path from the bundle root) in which + the error occurred. + id: EdgeConfigstoreBundleBadBundleViolation + description: A message type used to describe a single bundle validation error. + GoogleCloudApigeeV1ListInstancesResponse: + id: GoogleCloudApigeeV1ListInstancesResponse + description: Response for ListInstances. + type: object + properties: + nextPageToken: + description: >- + Page token that you can include in a ListInstance request to + retrieve the next page of content. If omitted, no subsequent pages + exist. type: string - targetEndpoints: + instances: items: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' type: array + description: Instances in the specified organization. + GoogleCloudApigeeV1UpdateError: + properties: + message: + description: User-friendly error message. + type: string + type: 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. - integrationEndpoints: + A string that uniquely identifies the type of error. This provides a + more reliable means to deduplicate errors across revisions and + instances. + type: string + resource: + type: string 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 - displayName: + 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. + code: type: string - description: Human-readable name of the API proxy. - proxies: - description: List of proxy names included in the API proxy revision. - type: array + 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 + 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 + id: GoogleCloudApigeeV1UpdateError + type: object + description: Details on why a resource update failed in the runtime. + GoogleCloudApigeeV1SharedFlow: + type: object + id: GoogleCloudApigeeV1SharedFlow + description: The metadata describing a shared flow + properties: + latestRevisionId: + description: The id of the most recently created revision for this shared flow. + type: string + name: + type: string + description: The ID of the shared flow. + revision: items: type: string - description: + description: A list of revisions of this shared flow. + type: array + metaData: + $ref: '#/components/schemas/GoogleCloudApigeeV1EntityMetadata' + description: Metadata describing the shared flow. + GoogleCloudApigeeV1SecurityReportResultView: + properties: + metadata: + description: >- + Metadata contains information like metrics, dimenstions etc of the + security report. + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportMetadata' + error: type: string - description: Description of the API proxy revision. - basepaths: - description: Base URL of the API proxy. + description: Error message when there is a failure. + state: + description: State of retrieving ResultView. + type: string + rows: items: - type: string + type: any type: array - GoogleCloudApigeeV1ProfileConfigCategory: - id: GoogleCloudApigeeV1ProfileConfigCategory + description: >- + Rows of security report result. Each row is a JSON object. Example: + {sum(message_count): 1, developer_app: "(not set)",…} + code: + description: Error code when there is a failure. + format: int32 + type: integer + id: GoogleCloudApigeeV1SecurityReportResultView + description: The response for security report result view APIs. + type: object + GoogleLongrunningOperation: + id: GoogleLongrunningOperation type: object description: >- - Advanced API Security provides security profile that scores the - following categories. + This resource represents a long-running operation that is the result of + a network API call. properties: - mediation: - description: Checks to see if you have a mediation policy in place. - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigMediation' - abuse: - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigAbuse' + response: 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. - cors: - description: Checks to see if you have CORS policy in place. - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigCORS' - mtls: - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigMTLS' - description: Checks to see if you have configured mTLS for the target server. - threat: - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigThreat' - description: Checks to see if you have a threat protection policy in place. - authorization: - description: Checks to see if you have an authorization policy in place. - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigAuthorization' - GoogleRpcPreconditionFailureViolation: - description: A message type used to describe a single precondition failure. - type: object - id: GoogleRpcPreconditionFailureViolation - properties: - subject: + 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: 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: - 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/GoogleRpcStatus' 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". - description: - type: string + The error result of the operation in case of failure or + cancellation. + done: 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". - GoogleCloudApigeeV1ListRatePlansResponse: - description: Response for ListRatePlans. - id: GoogleCloudApigeeV1ListRatePlansResponse - properties: - nextStartKey: - 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. + type: boolean + metadata: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any 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 - description: List of rate plans in an organization. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + 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. + GoogleCloudApigeeV1IngressConfig: type: object - GoogleCloudApigeeV1ListApiCategoriesResponse: - description: 'The response for `ListApiCategoriesRequest`. Next ID: 6' + id: GoogleCloudApigeeV1IngressConfig properties: - status: + uid: + description: >- + A unique id for the ingress config that will only change if the + organization is deleted and recreated. type: string - description: Status of the operation. - requestId: + revisionCreateTime: type: string - description: Unique ID of the request. - data: + format: google-datetime + description: Time at which the IngressConfig revision was created. + environmentGroups: type: array + description: List of environment groups in the organization. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' - description: The API category resources. - message: - description: Description of the operation. + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupConfig' + name: + description: >- + Name of the resource in the following format: + `organizations/{org}/deployedIngressConfig`. type: string - errorCode: - description: Unique error code for the request, if any. + revisionId: + description: >- + Revision id that defines the ordering on IngressConfig resources. + The higher the revision, the more recently the configuration was + deployed. + format: int64 + type: string + GoogleCloudApigeeV1DeploymentGroupConfig: + description: >- + DeploymentGroupConfig represents a deployment group that should be + present in a particular environment. + properties: + name: + type: string + description: >- + Name of the deployment group in the following format: + `organizations/{org}/environments/{env}/deploymentGroups/{group}`. + revisionId: + format: int64 + type: string + description: >- + Revision number which can be used by the runtime to detect if the + deployment group has changed between two versions. + uid: + description: >- + Unique ID. The ID will only change if the deployment group is + deleted and recreated. + type: string + deploymentGroupType: + enum: + - DEPLOYMENT_GROUP_TYPE_UNSPECIFIED + - STANDARD + - EXTENSIBLE + description: >- + Type of the deployment group, which will be either Standard or + Extensible. type: string + enumDescriptions: + - Unspecified type + - Standard type + - Extensible Type + id: GoogleCloudApigeeV1DeploymentGroupConfig type: object - id: GoogleCloudApigeeV1ListApiCategoriesResponse - GoogleCloudApigeeV1GraphQLOperationConfig: + GoogleCloudApigeeV1MonetizationConfig: + type: object + id: GoogleCloudApigeeV1MonetizationConfig properties: - operations: + enabled: + description: Flag that specifies whether the Monetization add-on is enabled. + type: boolean + description: Configuration for the Monetization add-on. + GoogleCloudApigeeV1Schema: + id: GoogleCloudApigeeV1Schema + properties: + dimensions: + description: List of schema fields grouped as dimensions. type: array - 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' - quota: - $ref: '#/components/schemas/GoogleCloudApigeeV1Quota' + $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaElement' + meta: 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: - description: Custom attributes associated with the operation. + Additional metadata associated with schema. This is a legacy field + and usually consists of an empty array of strings. + items: + type: string + type: array + metrics: 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`. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - apiSource: + $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaElement' + description: Response for Schema call + type: object + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation: + type: object + id: >- + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation + description: The format of the assessment recommendation. + properties: + link: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink + description: The link for the recommendation. + description: type: string - description: >- - Required. Name of the API proxy endpoint or remote service with - which the GraphQL operation and quota are associated. - description: >- - Binds the resources in a proxy or remote service with the GraphQL - operation and its associated quota enforcement. - id: GoogleCloudApigeeV1GraphQLOperationConfig + description: The description of the recommendation. + GoogleCloudApigeeV1GenerateDownloadUrlRequest: + id: GoogleCloudApigeeV1GenerateDownloadUrlRequest + description: Request for GenerateDownloadUrl method. + properties: {} type: object - GoogleCloudApigeeV1OperationMetadata: - description: Metadata describing an Operation. + GoogleCloudApigeeV1Reference: properties: - state: - enum: - - STATE_UNSPECIFIED - - NOT_STARTED - - IN_PROGRESS - - FINISHED + refers: type: string - enumDescriptions: - - '' - - '' - - '' - - '' - progress: - $ref: '#/components/schemas/GoogleCloudApigeeV1OperationMetadataProgress' - description: Progress of the operation. - targetResourceName: + 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. + description: type: string - description: Name of the resource for which the operation is operating on. - warnings: - type: array - description: Warnings encountered while executing the operation. - items: - type: string - operationType: + description: Optional. A human-readable description of this reference. + name: + description: >- + Required. The resource id of this reference. Values must match the + regular expression [\w\s\-.]+. type: string - enum: - - OPERATION_TYPE_UNSPECIFIED - - INSERT - - DELETE - - UPDATE - enumDescriptions: - - '' - - '' - - '' - - '' - id: GoogleCloudApigeeV1OperationMetadata + resourceType: + description: >- + The type of resource referred to by this reference. Valid values are + 'KeyStore' or 'TrustStore'. + type: string + id: GoogleCloudApigeeV1Reference + description: >- + A Reference configuration. References must refer to a keystore that also + exists in the parent environment. type: object GoogleCloudApigeeV1Credential: + id: GoogleCloudApigeeV1Credential properties: - expiresAt: - type: string - description: Time the credential will expire in milliseconds since epoch. - format: int64 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. items: type: string type: array - consumerSecret: - description: Secret key. + description: >- + 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 - consumerKey: - description: Consumer key. + format: int64 + status: type: string + description: >- + Status of the credential. Valid values include `approved` or + `revoked`. apiProducts: items: $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProductRef' type: array description: List of API products this credential can be used for. - status: - type: string - description: >- - Status of the credential. Valid values include `approved` or - `revoked`. - issuedAt: - type: string - format: int64 - description: Time the credential was issued in milliseconds since epoch. attributes: - description: List of attributes associated with this credential. type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - id: GoogleCloudApigeeV1Credential - type: object - GoogleCloudApigeeV1SecurityReportResultMetadata: - description: Contains informations about the security report results. - type: object - id: GoogleCloudApigeeV1SecurityReportResultMetadata - properties: - 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" - type: string - readOnly: true - 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 - GoogleCloudApigeeV1TestDatastoreResponse: - properties: - error: - readOnly: true - description: Output only. Error message of test connection failure - type: string - state: - description: Output only. It could be `completed` or `failed` - readOnly: true - type: string - id: GoogleCloudApigeeV1TestDatastoreResponse - type: object - description: The response for TestDatastore - GoogleCloudApigeeV1GenerateUploadUrlRequest: - properties: {} - type: object - description: Request for GenerateUploadUrl method. - id: GoogleCloudApigeeV1GenerateUploadUrlRequest - GoogleTypeInterval: - 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 - 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 - 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 - id: GoogleTypeInterval - GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest: - type: object - description: Request for UpdateAppGroupAppKey - properties: - apiProducts: - items: - type: string - type: array - 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. - 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 - appGroupAppKey: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' - description: >- - The new AppGroupKey to be amended. Note that the status can be - updated only via action. - id: GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest - GoogleCloudApigeeV1RevisionStatus: - id: GoogleCloudApigeeV1RevisionStatus - type: object - description: The status of a specific resource revision. - properties: - replicas: - description: The number of replicas that have successfully loaded this revision. - format: int32 - type: integer - jsonSpec: - description: >- - The json content of the resource revision. Large specs should be - sent individually via the spec field to avoid hitting request size - limits. + description: List of attributes associated with this credential. + consumerKey: type: string - revisionId: - description: The revision of the resource. + description: Consumer key. + expiresAt: + format: int64 type: string - errors: - type: array - description: Errors reported when attempting to load this revision. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1UpdateError' - GoogleCloudApigeeV1ProfileConfigAbuse: - type: object - 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. - properties: {} - GoogleCloudApigeeV1SecurityAssessmentResult: - description: The security assessment result for one resource. - type: object - id: GoogleCloudApigeeV1SecurityAssessmentResult - 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 + description: Time the credential will expire in milliseconds since epoch. + consumerSecret: type: string - scoringResult: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResult - description: The result of the assessment. - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The error status if scoring fails. - resource: - description: The assessed resource. - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultResource - GoogleCloudApigeeV1ProfileConfig: - properties: - categories: - description: List of categories of profile config. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigCategory' - type: array - description: >- - ProfileConfig defines a set of categories and policies which will be - used to compute security score. - id: GoogleCloudApigeeV1ProfileConfig + description: Secret key. type: object GoogleCloudApigeeV1ResourceStatus: - id: GoogleCloudApigeeV1ResourceStatus properties: revisions: + type: array + description: Revisions of the resource currently deployed in the instance. items: $ref: '#/components/schemas/GoogleCloudApigeeV1RevisionStatus' - description: Revisions of the resource currently deployed in the instance. - type: array resource: type: string description: >- @@ -6517,1441 +6098,1688 @@ components: EnvironmentConfig - organizations/{org}/environments/{environment}/deployedConfig totalReplicas: + type: integer format: int32 description: The total number of replicas that should have this resource. - type: integer 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. - description: The status of a resource loaded in the runtime. + id: GoogleCloudApigeeV1ResourceStatus type: object - GoogleCloudApigeeV1ListHybridIssuersResponse: - id: GoogleCloudApigeeV1ListHybridIssuersResponse + description: The status of a resource loaded in the runtime. + GoogleCloudApigeeV1SecurityActionFlag: type: object + id: GoogleCloudApigeeV1SecurityActionFlag + description: The message that should be set in the case of a Flag action. properties: - issuers: + 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. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ServiceIssuersMapping' - description: Lists of hybrid services and its trusted issuer email ids. + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionHttpHeader' type: array - GoogleIamV1SetIamPolicyRequest: - type: object - id: GoogleIamV1SetIamPolicyRequest + GoogleCloudApigeeV1ApiProduct: properties: - updateMask: + apiResources: + items: + type: string + type: array + 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. + description: 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 - policy: - $ref: '#/components/schemas/GoogleIamV1Policy' + Description of the API product. Include key information about the + API product that is not captured by other fields. + scopes: 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. - GoogleCloudApigeeV1ApiProductRef: - id: GoogleCloudApigeeV1ApiProductRef - properties: - apiproduct: - description: Name of the API product. - type: string - status: - type: string - description: Status of the API product. Valid values are `approved` or `revoked`. - type: object - GoogleCloudApigeeV1DataCollector: - type: object - properties: - type: - description: Immutable. The type of data this data collector will collect. + 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 + items: + type: string + createdAt: type: string - enum: - - TYPE_UNSPECIFIED - - INTEGER - - FLOAT - - STRING - - BOOLEAN - - DATETIME - enumDescriptions: - - For future compatibility. - - For integer values. - - For float values. - - For string values. - - For boolean values. - - For datetime values. - createdAt: - description: >- - Output only. The time at which the data collector was created in - milliseconds since the epoch. format: int64 + description: >- + Response only. Creation time of this environment as milliseconds + since epoch. + 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. + quota: + 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. type: string - readOnly: true - name: - type: string - description: ID of the data collector. Must begin with `dc_`. - lastModifiedAt: - format: int64 - readOnly: true + quotaCounterScope: description: >- - Output only. The time at which the Data Collector was last updated - in milliseconds since the epoch. + 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. type: string - description: + 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 + 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. + name: type: string - description: A description of the data collector. - description: Data collector configuration. - id: GoogleCloudApigeeV1DataCollector - GoogleCloudApigeeV1ScoreComponentRecommendation: - 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: + 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. + 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. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + type: array + proxies: type: array - description: Actions for the recommendation to improve the security score. items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendationAction - title: - description: Title represents recommendation title. - type: string - description: - type: string - description: Description of the recommendation. - description: Recommendation based on security concerns and score. - type: object - id: GoogleCloudApigeeV1ScoreComponentRecommendation - GoogleCloudApigeeV1RuntimeTraceConfigOverride: - properties: - apiProxy: + type: string + 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. + quotaTimeUnit: type: string description: >- - Name of the API proxy that will have its trace configuration - overridden following format: `organizations/{org}/apis/{api}` - samplingConfig: + Time unit defined for the `quotaInterval`. Valid values include + `minute`, `hour`, `day`, or `month`. + environments: + type: array + items: + type: string description: >- - Trace configuration override for a specific API proxy in an - environment. - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceSamplingConfig' - uid: + 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`. + grpcOperationGroup: 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. - type: string - name: + 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' + displayName: type: string description: >- - Name of the trace config override in the following format: - `organizations/{org}/environment/{env}/traceConfig/overrides/{override}` - revisionCreateTime: + Name displayed in the UI or developer portal to developers + registering for API access. + lastModifiedAt: + description: >- + Response only. Modified time of this environment as milliseconds + since epoch. type: string - description: The timestamp that the revision was created or updated. - format: google-datetime - revisionId: + format: int64 + approvalType: type: string description: >- - Revision number which can be used by the runtime to detect if the - trace config override has changed between two versions. - id: GoogleCloudApigeeV1RuntimeTraceConfigOverride + 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. + quotaInterval: + type: string + description: >- + Time interval over which the number of request messages is + calculated. type: object - description: >- - NEXT ID: 7 Trace configuration override for a specific API proxy in an - environment. - GoogleCloudApigeeV1QueryMetadata: + id: GoogleCloudApigeeV1ApiProduct + GoogleCloudApigeeV1ReferenceConfig: + id: GoogleCloudApigeeV1ReferenceConfig properties: - startTimestamp: - type: string - description: Start timestamp of the query range. - timeUnit: + name: type: string - description: Query GroupBy time unit. - metrics: - items: - type: string - type: array description: >- - Metrics of the AsyncQuery. Example: - ["name:message_count,func:sum,alias:sum_message_count"] - endTimestamp: - description: End timestamp of the query range. + Name of the reference in the following format: + `organizations/{org}/environments/{env}/references/{reference}` + resourceName: type: string - dimensions: + description: >- + Name of the referenced resource in the following format: + `organizations/{org}/environments/{env}/keystores/{keystore}` Only + references to keystore resources are supported. + type: object + GoogleCloudApigeeV1ProfileConfigMediation: + properties: {} + description: >- + By default, following policies will be included: - OASValidation - + SOAPMessageValidation + id: GoogleCloudApigeeV1ProfileConfigMediation + type: object + GoogleCloudApigeeV1AppGroup: + id: GoogleCloudApigeeV1AppGroup + type: object + 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: + attributes: type: array items: - type: string - description: Dimensions of the AsyncQuery. - outputFormat: - description: Output format. - type: string - type: object - id: GoogleCloudApigeeV1QueryMetadata - GoogleCloudApigeeV1AnalyticsConfig: - id: GoogleCloudApigeeV1AnalyticsConfig - properties: - updateTime: - format: google-datetime + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + description: A list of attributes + lastModifiedAt: + description: Output only. Modified time as milliseconds since epoch. readOnly: true - description: Output only. The latest update time. + format: int64 type: string - state: - readOnly: true - description: Output only. The state of the Analytics add-on. + organization: + description: Immutable. the org the app group is created 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: - type: boolean - description: Whether the Analytics add-on is enabled. - expireTimeMillis: + appGroupId: + description: Output only. Internal identifier that cannot be edited readOnly: true type: string - format: int64 + channelUri: + type: string + description: A reference to the associated storefront/marketplace. + name: 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 - description: Configuration for the Analytics add-on. - GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse: - id: GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse - properties: - securityIncidents: + Immutable. Name of the AppGroup. Characters you can use in the name + are restricted to: A-Z0-9._\-$ %. + type: string + channelId: + type: string + description: channel identifier identifies the owner maintaing this grouping. + displayName: + type: string + description: app group name displayed in the UI + status: + 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`. + createdAt: + description: Output only. Created time as milliseconds since epoch. + type: string readOnly: true - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' - description: Output only. Updated security incidents - description: Response for BatchUpdateSecurityIncident. + format: int64 + GoogleCloudApigeeV1ApiDocDocumentation: type: object - GoogleCloudApigeeV1ReportInstanceStatusRequest: - id: GoogleCloudApigeeV1ReportInstanceStatusRequest - description: Request for ReportInstanceStatus. + 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. + GoogleCloudApigeeV1AppGroupAppKey: + description: >- + AppGroupAppKey contains all the information associated with the + credentials. + id: GoogleCloudApigeeV1AppGroupAppKey type: object properties: - instanceUid: + attributes: + type: array + description: List of attributes associated with the credential. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + status: + description: >- + Status of the credential. Valid values include `approved` or + `revoked`. type: string + issuedAt: + readOnly: true 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: + Output only. Time the AppGroup app was created in milliseconds since + epoch. type: string - format: google-datetime + format: int64 + expiresInSeconds: + type: string + format: int64 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. - resources: - type: array + 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. + consumerKey: + description: Immutable. Consumer key. + type: string + 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. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceStatus' - description: Status for config resources - GoogleCloudApigeeV1ListSecurityReportsResponse: - type: object - id: GoogleCloudApigeeV1ListSecurityReportsResponse - description: The response for SecurityReports. - properties: - securityReports: - description: The security reports belong to requested resource name. + type: string type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' - nextPageToken: + apiProducts: 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. - type: string - GoogleCloudApigeeV1SecurityAssessmentResultResource: - description: Resource for which we are computing security assessment. - id: GoogleCloudApigeeV1SecurityAssessmentResultResource - properties: - name: - type: string - description: Required. Name of this resource. - resourceRevisionId: + 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. + readOnly: true + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1APIProductAssociation' + type: array + expiresAt: + readOnly: true + format: int64 type: string description: >- - The revision id for the resource. In case of Apigee, this is proxy - revision id. - type: - description: Required. Type of this resource. - enum: - - RESOURCE_TYPE_UNSPECIFIED - - API_PROXY + Output only. Time the AppGroup app expires in milliseconds since + epoch. + consumerSecret: type: string - enumDescriptions: - - ResourceType not specified. - - Resource is an Apigee Proxy. + description: Secret key. + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse: type: object - GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation: - description: Represents a SecurityProfileEnvironmentAssociation resource. properties: - securityProfileRevisionId: - description: 'DEPRECATED: DO NOT USE Revision ID of the security profile.' - format: int64 + securityAssessmentResults: + description: Default sort order is by resource name in alphabetic order. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResult' + type: array + nextPageToken: type: string - deprecated: true - attachTime: description: >- - Output only. The time when environment was attached to the security - profile. + A token that can be sent as `page_token` to retrieve the next page. + If this field is blank, there are no subsequent pages. + assessmentTime: + description: The time of the assessment api call. type: string format: google-datetime - readOnly: true - name: - type: string - description: Immutable. Name of the environment that the profile is attached to. - type: object - id: GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation - GoogleCloudApigeeV1Certificate: - id: GoogleCloudApigeeV1Certificate + id: GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse + description: Response for BatchComputeSecurityAssessmentResults. + GoogleCloudApigeeV1DeleteCustomReportResponse: + id: GoogleCloudApigeeV1DeleteCustomReportResponse type: object properties: - certInfo: - type: array - description: Chain of certificates under this name. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1CertInfo' - GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse: - id: GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse - description: The response for GetAsyncQueryResultUrl - type: object + message: + type: string + description: The response contains only a message field. + GoogleRpcStatus: properties: - urls: + 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: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo - description: The list of Signed URLs generated by the CreateAsyncQuery request - GoogleCloudApigeeV1SecurityReportResultView: - type: object - properties: - state: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + message: type: string - description: State of retrieving ResultView. + 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 - description: Error code when there is a failure. format: int32 - error: - description: Error message when there is a failure. - type: string - rows: - description: >- - Rows of security report result. Each row is a JSON object. Example: - {sum(message_count): 1, developer_app: "(not set)",…} - items: - type: any - type: array - metadata: - description: >- - Metadata contains information like metrics, dimenstions etc of the - security report. - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportMetadata' - id: GoogleCloudApigeeV1SecurityReportResultView - description: The response for security report result view APIs. - GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest: - id: GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest - description: Request for ExpireDeveloperSubscription. + 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: {} - GoogleCloudApigeeV1ListNatAddressesResponse: + GoogleCloudApigeeV1ScoreComponentRecommendationAction: + id: GoogleCloudApigeeV1ScoreComponentRecommendationAction + description: Action to improve security score. + properties: + description: + description: Description of the action. + type: string + actionContext: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext + description: Action context for the action. + type: object + GoogleCloudApigeeV1ListSecurityIncidentsResponse: type: object - id: GoogleCloudApigeeV1ListNatAddressesResponse - description: Response for ListNatAddresses. properties: - natAddresses: - type: array - description: List of NAT Addresses for the instance. + securityIncidents: + description: List of security incidents in the organization items: - $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' + type: array nextPageToken: - description: >- - 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 - GoogleCloudApigeeV1TargetServer: - description: >- - TargetServer configuration. TargetServers are used to decouple a proxy - TargetEndpoint HTTPTargetConnections from concrete URLs for backend - services. + 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. + description: Response for ListSecurityIncidents. + id: GoogleCloudApigeeV1ListSecurityIncidentsResponse + GoogleCloudApigeeV1AsyncQueryResult: properties: - isEnabled: - type: boolean + self: + 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. - host: + 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` + expires: + description: Query result will be unaccessable after this time. type: string + id: GoogleCloudApigeeV1AsyncQueryResult + type: object + GoogleCloudApigeeV1ExportRequest: + type: object + description: Request body for [CreateExportRequest] + id: GoogleCloudApigeeV1ExportRequest + properties: + csvDelimiter: description: >- - Required. The host name this target connects to. Value must be a - valid hostname as described by RFC-1123. - sSLInfo: - $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfo' + 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 + outputFormat: + type: string 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. - protocol: + 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. + datastoreName: type: string - 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 - enum: - - PROTOCOL_UNSPECIFIED - - HTTP - - HTTP2 - - GRPC_TARGET - - GRPC - - EXTERNAL_CALLOUT + description: Required. Name of the preconfigured datastore. name: + description: Required. Display name of the export job. type: string - description: >- - Required. The resource id of this target server. Values must match - the regular expression + dateRange: + description: Required. Date range of the data to export. + $ref: '#/components/schemas/GoogleCloudApigeeV1DateRange' description: + description: Optional. Description of the export job. type: string - description: Optional. A human-readable description of this TargetServer. - port: - description: >- - Required. The port number this target connects to on the given host. - Value must be between 1 and 65535, inclusive. - format: int32 - type: integer + GoogleCloudApigeeV1CreditDeveloperBalanceRequest: + id: GoogleCloudApigeeV1CreditDeveloperBalanceRequest type: object - id: GoogleCloudApigeeV1TargetServer - GoogleCloudApigeeV1ListApiProxiesResponse: + properties: + 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. + transactionId: + 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. + type: string + description: Request for CreditDeveloperBalance. + GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse: + description: The response for GetAsyncQueryResultUrl type: object properties: - proxies: + urls: type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' - id: GoogleCloudApigeeV1ListApiProxiesResponse - description: >- - To change this message, in the same CL add a change log in - go/changing-api-proto-breaks-ui - GoogleCloudApigeeV1ListAppGroupsResponse: - description: >- - ListAppGroupsResponse contains the 0 or more AppGroups, along with the - optional page token and the total count of apps. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo + description: The list of Signed URLs generated by the CreateAsyncQuery request + id: GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse + GoogleCloudApigeeV1AdjustDeveloperBalanceRequest: + id: GoogleCloudApigeeV1AdjustDeveloperBalanceRequest + description: Request for AdjustDeveloperBalance. + properties: + adjustment: + 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. + $ref: '#/components/schemas/GoogleTypeMoney' + type: object + GoogleCloudApigeeV1OperationGroup: type: object + description: >- + List of operation configuration details associated with Apigee API + proxies or remote services. Remote services are non-Apigee proxies, such + as Istio-Envoy. properties: - appGroups: - description: List of AppGroups. - type: array + operationConfigs: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' - nextPageToken: + $ref: '#/components/schemas/GoogleCloudApigeeV1OperationConfig' + type: array + description: >- + Required. List of operation configurations for either Apigee API + proxies or other remote services that are associated with this API + product. + operationConfigType: 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 - GoogleRpcStatus: + 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. + id: GoogleCloudApigeeV1OperationGroup + GoogleCloudApigeeV1ComputeEnvironmentScoresRequest: + description: Request for ComputeEnvironmentScores. 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: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - code: + pageSize: format: int32 - description: The status code, which should be an enum value of google.rpc.Code. type: integer - message: + 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. + 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 + timeRange: 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). + 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' + filters: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter + 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: object + id: GoogleCloudApigeeV1ComputeEnvironmentScoresRequest + GoogleCloudApigeeV1App: + id: GoogleCloudApigeeV1App type: object - id: GoogleRpcStatus - GoogleCloudApigeeV1DimensionMetric: - id: GoogleCloudApigeeV1DimensionMetric - description: Encapsulates a metric grouped by dimension. properties: - individualNames: + lastModifiedAt: + description: Output only. Last modified time as milliseconds since epoch. + type: string + format: int64 + readOnly: true + keyExpiresIn: + 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 + developerEmail: + type: string + description: Email of the developer. + companyName: + type: string + description: Name of the company that owns the app. + callbackUrl: + type: string + description: >- + Callback URL used by OAuth 2.0 authorization servers to communicate + authorization codes back to apps. + appGroup: + type: string + description: Name of the AppGroup + attributes: items: - type: string - description: Individual dimension names. E.g. ["dim1_name", "dim2_name"]. + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + description: List of attributes. + type: array + apiProducts: + description: List of API products associated with the app. type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProductRef' name: - 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. type: string - deprecated: true - metrics: - description: List of metrics. + description: Name of the app. + appId: + description: ID of the app. + type: string + credentials: type: array + readOnly: true items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' + $ref: '#/components/schemas/GoogleCloudApigeeV1Credential' + description: >- + Output only. Set of credentials for the app. Credentials are API + key/secret pairs associated with API products. + developerId: + type: string + description: ID of the developer. + createdAt: + format: int64 + type: string + description: Output only. Unix time when the app was created. + readOnly: true + scopes: + 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. + type: array + status: + description: Status of the credential. + type: string + GoogleCloudApigeeV1ListArchiveDeploymentsResponse: type: object - GoogleCloudApigeeV1EntityMetadata: properties: - lastModifiedAt: + archiveDeployments: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' + type: array + description: Archive Deployments in the specified environment. + nextPageToken: type: string - format: int64 description: >- - Time at which the API proxy was most recently modified, in - milliseconds since epoch. - createdAt: + Page token that you can include in a ListArchiveDeployments request + to retrieve the next page. If omitted, no subsequent pages exist. + id: GoogleCloudApigeeV1ListArchiveDeploymentsResponse + description: Response for ListArchiveDeployments method. + GoogleCloudApigeeV1RuntimeAddonsConfig: + description: >- + RuntimeAddonsConfig defines the runtime configurations for add-ons in an + environment. + properties: + name: + description: >- + Name of the addons config in the format: + `organizations/{org}/environments/{env}/addonsConfig` type: string - format: int64 + uid: description: >- - Time at which the API proxy was created, in milliseconds since - epoch. - subType: - description: The type of entity described + 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. type: string - description: Metadata common to many entities in this API. - id: GoogleCloudApigeeV1EntityMetadata + revisionId: + description: Revision number used by the runtime to detect config changes. + type: string + analyticsConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeAnalyticsConfig' + description: Runtime configuration for Analytics add-on. + apiSecurityConfig: + description: Runtime configuration for API Security add-on. + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeApiSecurityConfig' type: object + id: GoogleCloudApigeeV1RuntimeAddonsConfig GoogleCloudApigeeV1ServiceIssuersMapping: properties: - service: - type: string - description: String indicating the Apigee service name. emailIds: - description: List of trusted issuer email ids. type: array items: type: string + description: List of trusted issuer email ids. + service: + type: string + description: String indicating the Apigee service name. id: GoogleCloudApigeeV1ServiceIssuersMapping type: object - GoogleCloudApigeeV1ListDatastoresResponse: - type: object - properties: - datastores: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' - description: A list of datastores - description: The response for ListDatastores - id: GoogleCloudApigeeV1ListDatastoresResponse - GoogleCloudApigeeV1ListInstanceAttachmentsResponse: + GoogleTypeMoney: type: object - id: GoogleCloudApigeeV1ListInstanceAttachmentsResponse - description: Response for ListInstanceAttachments. + description: Represents an amount of money with its currency type. properties: - attachments: - type: array - description: Attachments for the instance. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceAttachment' - nextPageToken: + currencyCode: + description: The three-letter currency code defined in ISO 4217. + type: string + nanos: + format: int32 description: >- - Page token that you can include in a ListInstanceAttachments request - to retrieve the next page of content. If omitted, no subsequent - pages exist. + 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 + 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 - GoogleCloudApigeeV1ExportRequest: - description: Request body for [CreateExportRequest] - id: GoogleCloudApigeeV1ExportRequest + id: GoogleTypeMoney + GoogleCloudApigeeV1RuntimeConfig: + id: GoogleCloudApigeeV1RuntimeConfig properties: name: + description: >- + Name of the resource in the following format: + `organizations/{org}/runtimeConfig`. type: string - description: Required. Display name of the export job. - outputFormat: - type: string + tenantProjectId: 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: - $ref: '#/components/schemas/GoogleCloudApigeeV1DateRange' - description: Required. Date range of the data to export. - datastoreName: - description: Required. Name of the preconfigured datastore. + 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. + readOnly: true type: string - description: + analyticsBucket: type: string - description: Optional. Description of the export job. - csvDelimiter: + description: Cloud Storage bucket used for uploading Analytics records. + traceBucket: + description: Cloud Storage bucket used for uploading Trace records. 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`). + description: >- + Runtime configuration for the organization. Response for + GetRuntimeConfig. type: object - GoogleCloudApigeeV1TlsInfoCommonName: + GoogleCloudApigeeV1DebugSession: type: object properties: - wildcardMatch: - type: boolean + validity: + type: integer description: >- - Indicates whether the cert should be matched against as a wildcard - cert. - value: + 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: + format: int32 + type: integer + description: >- + Optional. The maximum number of bytes captured from the response + payload. Min = 0, Max = 5120, Default = 5120. + count: + type: integer + format: int32 + description: >- + Optional. The number of request to be traced. Min = 1, Max = 15, + Default = 10. + createTime: + readOnly: true + description: >- + Output only. The first transaction creation timestamp, recorded by + UAP. + format: google-datetime type: string - description: The TLS Common Name string of the certificate. - id: GoogleCloudApigeeV1TlsInfoCommonName - GoogleCloudApigeeV1EndpointChainingRule: - description: >- - EndpointChainingRule specifies the proxies contained in a particular - deployment group, so that other deployment groups can find them in - chaining calls. - type: object - id: GoogleCloudApigeeV1EndpointChainingRule - properties: - deploymentGroup: + name: + description: A unique ID for this DebugSession. + type: string + filter: description: >- - The deployment group to target for cross-shard chaining calls to - these proxies. + 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 - proxyIds: - type: array - description: List of proxy ids which may be found in the given deployment group. - items: - type: string - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation: - description: The format of the assessment recommendation. - id: >- - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation - properties: - link: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink - description: The link for the recommendation. - description: - description: The description of the recommendation. + timeout: 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 + id: GoogleCloudApigeeV1DebugSession + GoogleCloudApigeeV1ActivateNatAddressRequest: + id: GoogleCloudApigeeV1ActivateNatAddressRequest + properties: {} + description: Request for ActivateNatAddressRequest. Activate the nat address request. type: object - GoogleCloudApigeeV1ListOrganizationsResponse: + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll: + properties: {} type: object - id: GoogleCloudApigeeV1ListOrganizationsResponse - properties: - organizations: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1OrganizationProjectMapping' - description: List of Apigee organizations and associated Google Cloud projects. - type: array - GoogleCloudApigeeV1ApiDocResponse: - id: GoogleCloudApigeeV1ApiDocResponse + id: >- + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll + description: Message for include_all option. + GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation: + type: object + description: Represents a SecurityProfileEnvironmentAssociation resource. properties: - errorCode: - description: Unique error code for the request, if any. + attachTime: + format: google-datetime + description: >- + Output only. The time when environment was attached to the security + profile. type: string - message: + readOnly: true + name: type: string - description: Description of the operation. - status: - description: Status of the operation. + description: Immutable. Name of the environment that the profile is attached to. + securityProfileRevisionId: + description: 'DEPRECATED: DO NOT USE Revision ID of the security profile.' type: string - data: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' - description: The catalog item resource. - requestId: - description: Unique ID of the request. + format: int64 + deprecated: true + id: GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation + GoogleCloudApigeeV1GenerateUploadUrlResponse: + type: object + id: GoogleCloudApigeeV1GenerateUploadUrlResponse + properties: + uploadUri: type: string - description: The catalog item resource wrapped with response status, error_code, etc. + description: >- + The Google Cloud Storage signed URL that can be used to upload a new + Archive zip file. + description: Response for GenerateUploadUrl method. + 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. + type: string + format: google-datetime + error: + description: The error status if scoring fails. + $ref: '#/components/schemas/GoogleRpcStatus' + scoringResult: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResult + description: The result of the assessment. + resource: + description: The assessed resource. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultResource type: object - GoogleCloudApigeeV1SecurityProfileScoringConfig: + id: GoogleCloudApigeeV1SecurityAssessmentResult + GoogleCloudApigeeV1ApiCategory: properties: - description: + name: type: string - description: Description of the config. - title: + description: Name of the category. + id: type: string - description: Title of the config. - scorePath: + description: ID of the category (a UUID). + updateTime: + description: Time the category was last modified in milliseconds since epoch. + format: int64 type: string - description: Path of the component config used for scoring. - description: Security configurations to manage scoring. - id: GoogleCloudApigeeV1SecurityProfileScoringConfig + siteId: + type: string + description: Name of the portal. type: object - GoogleCloudApigeeV1CreditDeveloperBalanceRequest: + 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. + id: GoogleCloudApigeeV1ApiCategory + GoogleCloudApigeeV1DeploymentConfig: type: object - id: GoogleCloudApigeeV1CreditDeveloperBalanceRequest - description: Request for CreditDeveloperBalance. properties: - 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. - transactionId: + endpoints: + additionalProperties: + type: string + type: object 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. - type: string - GoogleCloudApigeeV1DeveloperApp: - properties: - attributes: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - description: List of attributes for the developer app. - type: array - lastModifiedAt: + A mapping from basepaths to proxy endpoint names in this proxy. Not + populated for shared flows. + location: type: string - format: int64 - readOnly: true + description: Location of the API proxy bundle as a URI. + deploymentGroups: description: >- - Output only. Time the developer app was modified in milliseconds - since epoch. - scopes: - type: array + The list of deployment groups in which this proxy should be + deployed. Not currently populated for shared flows. items: type: string + type: array + uid: 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. - developerId: + Unique ID. The ID will only change if the deployment is deleted and + recreated. type: string - description: ID of the developer. - appId: - description: ID of the developer app. + serviceAccount: type: string - credentials: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Credential' - readOnly: true description: >- - Output only. Set of credentials for the developer app consisting of - the consumer key/secret pairs associated with the API products. - name: + The service account identity associated with this deployment. If + non-empty, will be in the following format: + `projects/-/serviceAccounts/{account_email}` + attributes: + type: object + additionalProperties: + type: string + description: Additional key-value metadata for the deployment. + proxyUid: + description: Unique ID of the API proxy revision. type: string - description: Name of the developer app. - createdAt: + basePath: + description: Base path where the application will be hosted. Defaults to "/". type: string - format: int64 - description: >- - Output only. Time the developer app was created in milliseconds - since epoch. - readOnly: true - keyExpiresIn: + name: 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 - format: int64 - appFamily: - type: string - description: Developer app family. - callbackUrl: - description: >- - Callback URL used by OAuth 2.0 authorization servers to communicate - authorization codes back to developer apps. - type: string - status: - description: >- - Status of the credential. Valid values include `approved` or - `revoked`. + 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 - apiProducts: + id: GoogleCloudApigeeV1DeploymentConfig + description: 'NEXT ID: 11' + GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest: + properties: + requests: type: array items: - type: string - description: List of API products associated with the developer app. - id: GoogleCloudApigeeV1DeveloperApp - type: object - GoogleCloudApigeeV1Access: - properties: - Remove: - $ref: '#/components/schemas/GoogleCloudApigeeV1AccessRemove' - Get: - $ref: '#/components/schemas/GoogleCloudApigeeV1AccessGet' - Set: - $ref: '#/components/schemas/GoogleCloudApigeeV1AccessSet' - id: GoogleCloudApigeeV1Access - type: object - GoogleCloudApigeeV1ApiDocDocumentation: + $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. type: object - properties: - graphqlDocumentation: - $ref: '#/components/schemas/GoogleCloudApigeeV1GraphqlDocumentation' - description: Optional. GraphQL documentation. - oasDocumentation: - $ref: '#/components/schemas/GoogleCloudApigeeV1OASDocumentation' - description: Optional. OpenAPI Specification documentation. - id: GoogleCloudApigeeV1ApiDocDocumentation - description: The documentation for a catalog item. - GoogleCloudApigeeV1ProfileConfigAuthorization: - id: GoogleCloudApigeeV1ProfileConfigAuthorization + description: Request for BatchUpdateSecurityIncident. + id: GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest + GoogleCloudApigeeV1SecurityProfileEnvironment: + id: GoogleCloudApigeeV1SecurityProfileEnvironment type: object description: >- - By default, following policies will be included: - JWS - JWT - OAuth - - BasicAuth - APIKey - properties: {} - GoogleCloudApigeeV1ListDeploymentsResponse: - type: object - id: GoogleCloudApigeeV1ListDeploymentsResponse - properties: - deployments: - type: array - description: List of deployments. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' - GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext: - id: GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext - description: Action context are all the relevant details for the action. - type: object - properties: - documentationLink: - type: string - description: Documentation link for the action. - GoogleCloudApigeeV1AccessGet: + Environment information of attached environments. Scoring an environment + is enabled only if it is attached to a security profile. properties: - value: + attachTime: + readOnly: true type: string - name: + format: google-datetime + description: >- + Output only. Time at which environment was attached to the security + profile. + environment: + readOnly: true + description: Output only. Name of the environment. type: string - type: object - id: GoogleCloudApigeeV1AccessGet - description: >- - Get action. For example, "Get" : { "name" : "target.name", "value" : - "default" } - GoogleCloudApigeeV1TlsInfo: + GoogleCloudApigeeV1RevisionStatus: properties: - protocols: - type: array - items: - type: string - description: The TLS versioins to be used. - trustStore: - description: The resource ID of the truststore. - type: string - commonName: - description: The TLS Common Name of the certificate. - $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfoCommonName' - clientAuthEnabled: - type: boolean - description: Optional. Enables two-way TLS. - keyStore: + revisionId: + description: The revision of the resource. type: string - description: >- - Required if `client_auth_enabled` is true. The resource ID of the - keystore. - 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. - ciphers: + replicas: + type: integer + description: The number of replicas that have successfully loaded this revision. + format: int32 + errors: 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. + $ref: '#/components/schemas/GoogleCloudApigeeV1UpdateError' + description: Errors reported when attempting to load this revision. type: array - enabled: - type: boolean - description: >- - Required. Enables TLS. If false, neither one-way nor two-way TLS - will be enabled. - keyAlias: + jsonSpec: type: string description: >- - Required if `client_auth_enabled` is true. The resource ID for the - alias containing the private key and cert. - enforce: - description: TLS is strictly enforced. - type: boolean - id: GoogleCloudApigeeV1TlsInfo - description: TLS configuration information for virtual hosts and TargetServers. + 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 - GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse: - description: Response for ListSecurityProfileRevisions. + id: GoogleCloudApigeeV1RevisionStatus + description: The status of a specific resource revision. + GoogleCloudApigeeV1Environment: properties: - nextPageToken: + type: + type: string + enum: + - ENVIRONMENT_TYPE_UNSPECIFIED + - BASE + - INTERMEDIATE + - COMPREHENSIVE + description: Optional. EnvironmentType selected for the environment. + 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. + displayName: + description: Optional. Display name for this environment. type: string + properties: 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 - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' + Optional. Key-value pairs that may be used for customizing the + environment. + $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' + deploymentType: description: >- - List of security profile revisions. The revisions may be attached or - unattached to any environment. - id: GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse - type: object - GoogleCloudApigeeV1Property: - description: A single property entry in the Properties message. - id: GoogleCloudApigeeV1Property - type: object - properties: + 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 + type: string + enum: + - DEPLOYMENT_TYPE_UNSPECIFIED + - PROXY + - ARCHIVE + 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. name: - description: The property key + description: >- + Required. Name of the environment. Values must match the regular + expression `^[.\\p{Alnum}-_]{1,255}$` type: string - value: + forwardProxyUri: type: string - description: The property value - GoogleRpcPreconditionFailure: - type: object - id: 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. - properties: - violations: - items: - $ref: '#/components/schemas/GoogleRpcPreconditionFailureViolation' - description: Describes all precondition violations. - type: array - GoogleCloudApigeeV1ListTraceConfigOverridesResponse: - id: GoogleCloudApigeeV1ListTraceConfigOverridesResponse - description: Response for ListTraceConfigOverrides. - type: object - properties: - nextPageToken: description: >- - Token value that can be passed as `page_token` to retrieve the next - page of content. + 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. + description: + type: string + description: Optional. Description of the environment. + apiProxyType: type: string - traceConfigOverrides: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' - description: List all trace configuration overrides in an environment. - GoogleCloudApigeeV1SecurityAssessmentResultScoringResult: - properties: - failedAssessmentPerWeight: - type: object - description: >- - The number of failed assessments grouped by its weight. Keys are one - of the following: "MAJOR", "MODERATE", "MINOR". - additionalProperties: - format: int32 - type: integer - score: - description: The security score of the assessment. - format: int32 - type: integer - assessmentRecommendations: - type: object - 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. - severity: + Optional. API Proxy type supported by the environment. The type can + be set when creating the Environment and cannot be changed. enumDescriptions: - - Severity is not defined. - - Severity is low. - - Severity is medium. - - Severity is high. - - Severity is minimal - description: The severity of the assessment. - type: string + - 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: - - SEVERITY_UNSPECIFIED - - LOW - - MEDIUM - - HIGH - - MINIMAL - dataUpdateTime: + - API_PROXY_TYPE_UNSPECIFIED + - PROGRAMMABLE + - CONFIGURABLE + nodeConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1NodeConfig' + description: Optional. NodeConfig of the environment. + state: type: string 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 result of the assessment. - type: object - id: GoogleCloudApigeeV1SecurityAssessmentResultScoringResult - GoogleCloudApigeeV1Datastore: - id: GoogleCloudApigeeV1Datastore - properties: - lastUpdateTime: - type: string + Output only. State of the environment. 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 readOnly: true - format: int64 - description: >- - Output only. Datastore last update time, in milliseconds since the - epoch of 1970-01-01T00:00:00Z - self: + createdAt: readOnly: true + format: int64 description: >- - Output only. Resource link of Datastore. Example: - `/organizations/{org}/analytics/datastores/{uuid}` - type: string - targetType: - description: Destination storage type. Supported types `gcs` or `bigquery`. + Output only. Creation time of this environment as milliseconds since + epoch. type: string - org: - description: Output only. Organization that the datastore belongs to + hasAttachedFlowHooks: + type: boolean + lastModifiedAt: type: string - readOnly: true - datastoreConfig: - description: Datastore Configurations. - $ref: '#/components/schemas/GoogleCloudApigeeV1DatastoreConfig' - createTime: - format: int64 description: >- - Output only. Datastore create time, in milliseconds since the epoch - of 1970-01-01T00:00:00Z - type: string + Output only. Last modification time of this environment as + milliseconds since epoch. + format: int64 readOnly: true - displayName: - description: Required. Display name in UI + id: GoogleCloudApigeeV1Environment + type: object + GoogleCloudApigeeV1SchemaSchemaElement: + type: object + description: Message type for the schema element + properties: + properties: + $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaProperty' + description: >- + Properties for the schema field. For example: { "createTime": + "2016-02-26T10:23:09.592Z", "custom": "false", "type": "string" } + name: + description: Name of the field. type: string - description: >- - The data store defines the connection to export data repository (Cloud - Storage, BigQuery), including the credentials used to access the data - repository. + id: GoogleCloudApigeeV1SchemaSchemaElement + 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. + id: GoogleCloudApigeeV1SetAddonEnablementRequest + type: object + GoogleCloudApigeeV1ListDebugSessionsResponse: type: object - GoogleCloudApigeeV1AppGroup: properties: - channelId: + nextPageToken: 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`. - type: string - attributes: - description: A list of attributes + Page token that you can include in a ListDebugSessionsRequest to + retrieve the next page. If omitted, no subsequent pages exist. + sessions: type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - appGroupId: - type: string - readOnly: true - description: Output only. Internal identifier that cannot be edited - organization: - type: string - description: Immutable. the org the app group is created - name: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1Session' description: >- - Immutable. Name of the AppGroup. Characters you can use in the name - are restricted to: A-Z0-9._\-$ %. - displayName: - description: app group name displayed in the UI + Session info that includes debug session ID and the first + transaction creation timestamp. + id: GoogleCloudApigeeV1ListDebugSessionsResponse + GoogleCloudApigeeV1SharedFlowRevision: + properties: + resourceFiles: + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFiles' + description: The resource files included in this shared flow revision. + contextInfo: type: string + description: A textual description of the shared flow revision. createdAt: - description: Output only. Created time as milliseconds since epoch. + description: >- + Time at which this shared flow revision was created, in milliseconds + since epoch. + type: string format: int64 + policies: + type: array + description: A list of policy names included in this shared flow revision. + items: + type: string + description: type: string - readOnly: true - channelUri: + description: Description of the shared flow revision. + revision: + description: The resource ID of this revision. type: string - description: A reference to the associated storefront/marketplace. lastModifiedAt: - type: string - description: Output only. Modified time as milliseconds since epoch. + description: >- + Time at which this shared flow revision was most recently modified, + in milliseconds since epoch. format: int64 - readOnly: true - type: object - 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. - id: GoogleCloudApigeeV1AppGroup - GoogleCloudApigeeV1QueryTimeSeriesStatsResponse: - type: object - properties: - nextPageToken: type: string - description: Next page token. - values: - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence - type: array - description: Results of the query returned as a JSON array. - columns: + name: + type: string + description: The resource ID of the parent shared flow. + resources: description: >- - Column names corresponding to the same order as the inner values in - the stats field. + A list of the resources included in this shared flow revision + formatted as "{type}://{name}". items: type: string type: array - description: >- - Represents security stats result as a collection of time series - sequences. - id: GoogleCloudApigeeV1QueryTimeSeriesStatsResponse - GoogleCloudApigeeV1ActivateNatAddressRequest: - type: object - id: GoogleCloudApigeeV1ActivateNatAddressRequest - properties: {} - description: Request for ActivateNatAddressRequest. Activate the nat address request. - GoogleCloudApigeeV1KeyValueEntry: - id: GoogleCloudApigeeV1KeyValueEntry - type: object - 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. - type: string - name: + type: + description: The string "Application" type: string + sharedFlows: + items: + type: string + type: array description: >- - Resource URI that can be used to identify the scope of the key value - map entries. - GoogleCloudApigeeV1ListEnvironmentGroupsResponse: + A list of the shared flow names included in this shared flow + revision. + configurationVersion: + $ref: '#/components/schemas/GoogleCloudApigeeV1ConfigVersion' + 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. + displayName: + description: The human readable name of this shared flow. + type: string + entityMetaDataAsProperties: + additionalProperties: + type: string + description: A Key-Value map of metadata about this shared flow revision. + type: object type: object - id: GoogleCloudApigeeV1ListEnvironmentGroupsResponse - description: Response for ListEnvironmentGroups. + description: The metadata describing a shared flow revision. + id: GoogleCloudApigeeV1SharedFlowRevision + GoogleCloudApigeeV1QueryTimeSeriesStatsRequest: + id: GoogleCloudApigeeV1QueryTimeSeriesStatsRequest properties: - nextPageToken: + 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. + type: array + items: + type: string + pageToken: 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: - description: EnvironmentGroups in the specified organization. + Page token stands for a specific collection of time series + sequences. + metrics: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1MetricAggregation' type: array - GoogleCloudApigeeV1GenerateDownloadUrlRequest: - id: GoogleCloudApigeeV1GenerateDownloadUrlRequest - properties: {} - type: object - description: Request for GenerateDownloadUrl method. - GoogleCloudApigeeV1DeveloperMonetizationConfig: - properties: - billingType: + description: Required. List of metrics and their aggregations. + pageSize: + description: >- + Page size represents the number of time series sequences, one per + unique set of dimensions and their values. + format: int32 + type: integer + timeRange: + $ref: '#/components/schemas/GoogleTypeInterval' + description: Required. Time range for the stats. + timestampOrder: + 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). enum: - - BILLING_TYPE_UNSPECIFIED - - PREPAID - - POSTPAID + - ORDER_UNSPECIFIED + - ASCENDING + - DESCENDING + type: string + 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 + windowSize: + description: Time buckets to group the stats by. 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. - description: Monetization configuration for the developer. - id: GoogleCloudApigeeV1DeveloperMonetizationConfig - type: object - GoogleCloudApigeeV1SecurityActionAllow: - id: GoogleCloudApigeeV1SecurityActionAllow - properties: {} - type: object + - 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 description: >- - Message that should be set in case of an Allow Action. This does not - have any fields. - GoogleCloudApigeeV1FlowHookConfig: + QueryTimeSeriesStatsRequest represents a query that returns a collection + of time series sequences grouped by their values. type: object - id: GoogleCloudApigeeV1FlowHookConfig + GoogleCloudApigeeV1ReportInstanceStatusRequest: 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 - sharedFlowName: + instanceUid: description: >- - Name of the shared flow to invoke in the following format: - `organizations/{org}/sharedflows/{sharedflow}` - type: string - name: + A unique ID for the instance which is guaranteed to be unique in + case the user installs multiple hybrid runtimes with the same + instance ID. type: string + reportTime: + format: google-datetime 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` - GoogleCloudApigeeV1CustomReportMetric: - properties: - function: - description: aggregate function - type: string - name: + 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. type: string - description: name of the metric - id: GoogleCloudApigeeV1CustomReportMetric + resources: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceStatus' + type: array + description: Status for config resources + description: Request for ReportInstanceStatus. + id: GoogleCloudApigeeV1ReportInstanceStatusRequest type: object - description: >- - This encapsulates a metric property of the form sum(message_count) where - name is message_count and function is sum - GoogleCloudApigeeV1SchemaSchemaElement: - description: Message type for the schema element + GoogleCloudApigeeV1ListNatAddressesResponse: type: object properties: - properties: + 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: + 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: Name of the field. - id: GoogleCloudApigeeV1SchemaSchemaElement - GoogleCloudApigeeV1SecurityProfileEnvironment: - id: GoogleCloudApigeeV1SecurityProfileEnvironment + natAddresses: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' + description: List of NAT Addresses for the instance. + type: array + id: GoogleCloudApigeeV1ListNatAddressesResponse + description: Response for ListNatAddresses. + GoogleCloudApigeeV1ApiDocDocumentationResponse: properties: - attachTime: - description: >- - Output only. Time at which environment was attached to the security - profile. + requestId: + type: string + description: Output only. Unique ID of the request. + readOnly: true + status: + description: Output only. Status of the operation. readOnly: true - format: google-datetime type: string - environment: - description: Output only. Name of the environment. + data: + description: Output only. The documentation resource. + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocDocumentation' readOnly: true + message: + description: Output only. Description of the operation. type: string - type: object + readOnly: true + errorCode: + type: string + readOnly: true + description: Output only. Unique error code for the request, if any. + id: GoogleCloudApigeeV1ApiDocDocumentationResponse description: >- - Environment information of attached environments. Scoring an environment - is enabled only if it is attached to a security profile. - GoogleCloudApigeeV1KeyValueMap: - properties: - encrypted: - type: boolean - 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. + The catalog item documentation wrapped with response status, error_code, + etc. + type: object + GoogleCloudApigeeV1ResourceFiles: + id: GoogleCloudApigeeV1ResourceFiles + properties: + resourceFile: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' + description: List of resource files. + type: array + type: object + description: List of resource files. + GoogleCloudApigeeV1ListOfDevelopersResponse: + type: object + id: GoogleCloudApigeeV1ListOfDevelopersResponse + properties: + developer: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + description: List of developers. + 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: + type: boolean + description: If the Analytics is enabled or not. + id: GoogleCloudApigeeV1RuntimeAnalyticsConfig + GoogleCloudApigeeV1ApiSecurityConfig: + id: GoogleCloudApigeeV1ApiSecurityConfig + type: object + properties: + expiresAt: + type: string + format: int64 + 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. + enabled: + type: boolean + description: Flag that specifies whether the API security add-on is enabled. + description: Configurations of the API Security add-on. + GoogleCloudApigeeV1CanaryEvaluation: + properties: + verdict: + readOnly: true + 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. + enum: + - VERDICT_UNSPECIFIED + - NONE + - FAIL + - PASS + createTime: + description: Output only. Create time of the canary evaluation. + type: string + readOnly: true + format: google-datetime + startTime: + type: string + format: google-datetime + description: Required. Start time for the canary evaluation's analysis. + treatment: + type: string + description: Required. The newer version that is serving requests. + state: + enum: + - STATE_UNSPECIFIED + - RUNNING + - SUCCEEDED + type: string + description: Output only. The current state of the canary evaluation. + enumDescriptions: + - No state has been specified. + - The canary evaluation is still in progress. + - The canary evaluation has finished. + readOnly: true + control: + type: string + description: Required. The stable version that is serving requests. + endTime: + type: string + format: google-datetime + description: Required. End time for the evaluation's analysis. name: - description: Required. ID of the key value map. type: string + description: Output only. Name of the canary evalution. + readOnly: true + metricLabels: + description: >- + Required. Labels used to filter the metrics used for a canary + evaluation. + $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluationMetricLabels' type: object - description: Collection of key/value string pairs. - id: GoogleCloudApigeeV1KeyValueMap - GoogleCloudApigeeV1Result: + description: >- + CanaryEvaluation represents the canary analysis between two versions of + the runtime that is serving requests. + id: GoogleCloudApigeeV1CanaryEvaluation + GoogleCloudApigeeV1EntityMetadata: + description: Metadata common to many entities in this API. type: object - id: GoogleCloudApigeeV1Result properties: - uRI: + createdAt: + format: int64 type: string description: >- - The relative path of the api proxy. for example, `"uRI" : - "/iloveapis"` - verb: + Time at which the API proxy was created, in milliseconds since + epoch. + subType: type: string - description: HTTP method verb - accessList: - type: array + description: The type of entity described + lastModifiedAt: description: >- - A list of variable access actions agaist the api proxy. Supported - values: Get, Set, Remove. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Access' - reasonPhrase: + Time at which the API proxy was most recently modified, in + milliseconds since epoch. + format: int64 type: string - description: HTTP response phrase - content: + id: GoogleCloudApigeeV1EntityMetadata + GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse: + description: Response for ListSecurityProfileRevisions. + type: object + properties: + nextPageToken: type: string description: >- - Error message content. for example, "content" : - "{\"fault\":{\"faultstring\":\"API timed - out\",\"detail\":{\"errorcode\":\"flow.APITimedOut\"}}}" - headers: + 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: >- - A list of HTTP headers. for example, '"headers" : [ { "name" : - "Content-Length", "value" : "83" }, { "name" : "Content-Type", - "value" : "application/json" } ]' + List of security profile revisions. The revisions may be attached or + unattached to any environment. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Property' - ActionResult: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' + id: GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse + GoogleCloudApigeeV1SecurityAssessmentResultResource: + properties: + type: + type: string + enumDescriptions: + - ResourceType not specified. + - Resource is an Apigee Proxy. + description: Required. Type of this resource. + enum: + - RESOURCE_TYPE_UNSPECIFIED + - API_PROXY + name: type: string + description: Required. Name of this resource. + resourceRevisionId: description: >- - Type of the action result. Can be one of the five: DebugInfo, - RequestMessage, ResponseMessage, ErrorMessage, VariableAccess - properties: - $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' - description: Name value pairs used for DebugInfo ActionResult. - statusCode: - description: HTTP response code + The revision id for the resource. In case of Apigee, this is proxy + revision id. type: string - timestamp: + description: Resource for which we are computing security assessment. + id: GoogleCloudApigeeV1SecurityAssessmentResultResource + type: object + GoogleCloudApigeeV1TlsInfoCommonName: + properties: + value: type: string + description: The TLS Common Name string of the certificate. + wildcardMatch: + type: boolean 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"` - 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 - GoogleCloudApigeeV1StatsHostStats: + Indicates whether the cert should be matched against as a wildcard + cert. + id: GoogleCloudApigeeV1TlsInfoCommonName + type: object + GoogleCloudApigeeV1DataCollectorConfig: + id: GoogleCloudApigeeV1DataCollectorConfig type: object - id: GoogleCloudApigeeV1StatsHostStats properties: - dimensions: - description: List of metrics grouped under dimensions. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DimensionMetric' - type: array + type: + description: Data type accepted by the data collector. + 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 name: type: string - description: Hostname used in query. - metrics: - 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. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' - description: >- - Encapsulates the hostname wrapper: ``` "hosts": [ { "metrics": [ { - "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], "name": - "example.com" } ]``` - GoogleIamV1TestIamPermissionsRequest: + Name of the data collector in the following format: + `organizations/{org}/datacollectors/{datacollector}` + description: Data collector and its configuration. + GoogleCloudApigeeV1DeveloperAppKey: properties: - permissions: + expiresAt: + type: string + description: Time the developer app expires in milliseconds since epoch. + format: int64 + scopes: + items: + type: string + 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). + 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 + 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. + issuedAt: + description: Time the developer app was created in milliseconds since epoch. + format: int64 + type: string + consumerKey: + type: string + description: Consumer key. + consumerSecret: + type: string + description: Secret key. + attributes: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + description: List of attributes associated with the credential. type: array + status: + type: string + description: >- + Status of the credential. Valid values include `approved` or + `revoked`. + apiProducts: items: - type: string - description: Request message for `TestIamPermissions` method. - type: object - id: GoogleIamV1TestIamPermissionsRequest - GoogleCloudApigeeV1ComputeEnvironmentScoresRequest: + type: any + type: array + 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. + id: GoogleCloudApigeeV1DeveloperAppKey type: object + GoogleCloudApigeeV1ListAppsResponse: + id: GoogleCloudApigeeV1ListAppsResponse properties: - pageSize: + totalSize: type: integer - 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. + description: Total count of Apps. format: int32 - 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. - 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 - filters: + app: items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter + $ref: '#/components/schemas/GoogleCloudApigeeV1App' type: array + nextPageToken: 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" - description: Request for ComputeEnvironmentScores. - id: GoogleCloudApigeeV1ComputeEnvironmentScoresRequest + 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 + type: object GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo: type: object - description: A Signed URL and the relevant metadata associated with it. + id: GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo properties: 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= @@ -7965,463 +7793,639 @@ components: 66924f722292d21e24d31dcfb38ce0c0f353ffa5a9756fc2a9f2b40bc2113206a81e324fc4fd6823 a29163fa845c8ae7eca1fcf6e5bb48b3200983c56c5ca81fffb151cca7402beddfc4a76b13344703 2ea7abedc098d2eb14a7` - sizeBytes: type: string - format: int64 - description: The size of the returned file in bytes md5: type: string description: The MD5 Hash of the JSON data - id: GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo - GoogleCloudApigeeV1ArchiveDeployment: - description: Archive Deployment information. + sizeBytes: + description: The size of the returned file in bytes + format: int64 + type: string + description: A Signed URL and the relevant metadata associated with it. + GoogleCloudApigeeV1ResourceFile: + description: Metadata about a resource file. properties: - operation: + name: + type: string + description: ID of the resource file. + type: + description: Resource file type. {{ resource_file_type }} + type: string + id: GoogleCloudApigeeV1ResourceFile + type: object + GoogleCloudApigeeV1ApiProxy: + type: object + description: Metadata describing the API proxy + id: GoogleCloudApigeeV1ApiProxy + properties: + metaData: + readOnly: true + description: Output only. Metadata describing the API proxy. + $ref: '#/components/schemas/GoogleCloudApigeeV1EntityMetadata' + revision: + readOnly: true + items: + type: string + type: array + description: Output only. List of revisions defined for the API proxy. + name: + type: string + description: Output only. Name of the API proxy. + readOnly: true + latestRevisionId: + readOnly: true + type: string description: >- - Output only. A reference to the LRO that created this Archive - Deployment in the following format: - `organizations/{org}/operations/{id}` + Output only. The id of the most recently created revision for this + api proxy. + 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: + 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. + description: Output only. The type of the API proxy. type: string + enum: + - API_PROXY_TYPE_UNSPECIFIED + - PROGRAMMABLE + - CONFIGURABLE + readOnly: true labels: type: object additionalProperties: 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. - updatedAt: - format: int64 - description: >- - Output only. The time at which the Archive Deployment was updated in - milliseconds since the epoch. - type: string - readOnly: true - name: - description: >- - Name of the Archive Deployment in the following format: - `organizations/{org}/environments/{env}/archiveDeployments/{id}`. - type: string - createdAt: - format: int64 + description: User labels applied to this API Proxy. + GoogleCloudApigeeV1DocumentationFile: + type: object + properties: + contents: type: string - readOnly: true + description: Required. The file contents. The max size is 4 MB. + format: byte + displayName: description: >- - Output only. The time at which the Archive Deployment was created in - milliseconds since the epoch. - gcsUri: + Required. A display name for the file, shown in the management UI. + Max length is 255 characters. type: string - description: >- - Input only. The Google Cloud Storage signed URL returned from - GenerateUploadUrl and used to upload the Archive zip file. - id: GoogleCloudApigeeV1ArchiveDeployment + description: Documentation file contents for a catalog item. + id: GoogleCloudApigeeV1DocumentationFile + GoogleCloudApigeeV1AppGroupApp: type: object - GoogleCloudApigeeV1SecurityReportMetadata: properties: - metrics: - description: >- - Metrics of the SecurityReport. Example: - ["name:bot_count,func:sum,alias:sum_bot_count"] + status: + description: Status of the App. Valid values include `approved` or `revoked`. + type: string + scopes: type: array items: type: string - endTimestamp: + 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. + keyExpiresIn: type: string - format: google-datetime - description: End timestamp of the query range. - dimensions: - items: - type: string + 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. + credentials: + readOnly: true type: array - description: Dimensions of the SecurityReport. - startTimestamp: + items: + $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. + apiProducts: + type: array + description: List of API products associated with the AppGroup app. + items: + type: string + createdAt: + readOnly: true type: string - description: Start timestamp of the query range. - format: google-datetime - mimeType: - description: MIME type / Output format. + description: >- + Output only. Time the AppGroup app was created in milliseconds since + epoch. + format: int64 + appGroup: + description: >- + Immutable. Name of the parent AppGroup whose resource name format is + of syntax (organizations/*/appgroups/*). type: string - timeUnit: + attributes: + description: List of attributes for the AppGroup app. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + type: array + lastModifiedAt: + readOnly: true type: string - description: 'Query GroupBy time unit. Example: "seconds", "minute", "hour"' - id: GoogleCloudApigeeV1SecurityReportMetadata - description: Metadata for the security report. - type: object - GoogleCloudApigeeV1ListSecurityActionsResponse: + description: >- + Output only. Time the AppGroup app was modified in milliseconds + since epoch. + format: int64 + name: + description: >- + Immutable. Name of the AppGroup app whose resource name format is of + syntax (organizations/*/appgroups/*/apps/*). + type: string + appId: + type: string + description: Immutable. ID of the AppGroup app. + callbackUrl: + type: string + description: >- + Callback URL used by OAuth 2.0 authorization servers to communicate + authorization codes back to AppGroup apps. + id: GoogleCloudApigeeV1AppGroupApp + description: >- + Response for [GetAppGroupApp].[AppGroupApps.GetAppGroupApp], + [CreateAppGroupAppRequest].[AppGroupApp.CreateAppGroupAppRequest] and + [DeleteAppGroupApp].[AppGroupApp.DeleteAppGroupApp] + GoogleCloudApigeeV1SecurityReportQueryMetric: type: object + description: Metric of the Query properties: - nextPageToken: + alias: + 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. + Alias for the metric. Alias will be used to replace metric name in + query results. + aggregationFunction: type: string - securityActions: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' - type: array - description: The SecurityActions for the specified environment. - id: GoogleCloudApigeeV1ListSecurityActionsResponse - description: >- - Contains a list of SecurityActions in response to a - ListSecurityActionRequest. - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse: - id: GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse - description: Response for BatchComputeSecurityAssessmentResults. + description: 'Aggregation function: avg, min, max, or sum.' + value: + description: Operand value should be provided when operator is set. + type: string + operator: + type: string + description: One of `+`, `-`, `/`, `%`, `*`. + name: + type: string + description: Required. Metric name. + id: GoogleCloudApigeeV1SecurityReportQueryMetric + GoogleCloudApigeeV1DeveloperMonetizationConfig: type: object + description: Monetization configuration for the developer. properties: - assessmentTime: - format: google-datetime - description: The time of the assessment api call. + billingType: + 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: string + description: Billing type. + id: GoogleCloudApigeeV1DeveloperMonetizationConfig + GoogleCloudApigeeV1ListAppGroupAppsResponse: + description: Response for ListAppGroupApps + id: GoogleCloudApigeeV1ListAppGroupAppsResponse + properties: nextPageToken: type: string 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. - securityAssessmentResults: - type: array + Token that can be sent as `next_page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + appGroupApps: + description: List of AppGroup apps and their credentials. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResult' - description: Default sort order is by resource name in alphabetic order. - GoogleCloudApigeeV1ListCustomReportsResponse: - description: This message encapsulates a list of custom report definitions + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + type: array + type: object + GoogleIamV1AuditLogConfig: + id: GoogleIamV1AuditLogConfig properties: - qualifier: + exemptedMembers: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' + 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 - type: object - id: GoogleCloudApigeeV1ListCustomReportsResponse - GoogleCloudApigeeV1RuntimeTraceConfig: - id: GoogleCloudApigeeV1RuntimeTraceConfig + 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. + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + type: string description: >- - NEXT ID: 8 RuntimeTraceConfig defines the configurations for distributed - trace in an environment. + 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 + GoogleCloudApigeeV1CommonNameConfig: properties: - endpoint: - description: Endpoint of the exporter. - type: string - samplingConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceSamplingConfig' - description: Trace configuration for all API proxies in an environment. + matchWildCards: + type: boolean name: type: string - description: >- - Name of the trace config in the following format: - `organizations/{org}/environment/{env}/traceConfig` - exporter: - enum: - - EXPORTER_UNSPECIFIED - - JAEGER - - CLOUD_TRACE - type: string - 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 - revisionCreateTime: - type: string - format: google-datetime - description: The timestamp that the revision was created or updated. - revisionId: - description: >- - Revision number which can be used by the runtime to detect if the - trace config has changed between two versions. - type: string - overrides: + type: object + id: GoogleCloudApigeeV1CommonNameConfig + GoogleCloudApigeeV1ListEnvironmentGroupsResponse: + type: object + properties: + environmentGroups: type: array - description: List of trace configuration overrides for spicific API proxies. + description: EnvironmentGroups in the specified organization. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceConfigOverride' - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink: + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' + nextPageToken: + type: string + description: >- + Page token that you can include in a ListEnvironmentGroups request + to retrieve the next page. If omitted, no subsequent pages exist. + description: Response for ListEnvironmentGroups. + id: GoogleCloudApigeeV1ListEnvironmentGroupsResponse + GoogleCloudApigeeV1Export: + description: Details of an export job. properties: - uri: - description: The link itself. + updated: type: string - text: + description: Output only. Time the export job was last updated. + readOnly: true + name: + description: Display name of the export job. type: string - description: 'The text of the url. (ie: "Learn more")' - description: The format for a link in the recommendation. - type: object - id: >- - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink - GoogleCloudApigeeV1DeveloperBalance: - type: object - properties: - wallets: - type: array + description: + type: string + description: Description of the export job. + executionTime: readOnly: true description: >- - Output only. List of all wallets. Each individual wallet stores the - account balance for a particular currency. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalanceWallet' - description: Account balance for the developer. - id: GoogleCloudApigeeV1DeveloperBalance - GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision: - id: GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision - type: object - properties: - percentage: - format: int32 - type: integer - description: Percentage of MP replicas reporting this revision. - revision: + 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 + datastoreName: type: string - description: API proxy revision reported as deployed. - description: Revisions deployed in the MPs. - 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: + Name of the datastore that is the destination of the export job + [datastore] + error: + readOnly: true 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"] }``` - GoogleCloudApigeeV1ProvisionOrganizationRequest: - type: object - id: GoogleCloudApigeeV1ProvisionOrganizationRequest - properties: - analyticsRegion: + description: Output only. Error is set when export fails + state: 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`. + Output only. Status of the export job. Valid values include + `enqueued`, `running`, `completed`, and `failed`. + readOnly: true type: string - runtimeLocation: + created: + description: Output only. Time the export job was created. type: string + readOnly: true + self: 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. - 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: + Output only. Self link of the export job. A URI that can be used to + retrieve the status of an export job. Example: + `/organizations/myorg/environments/myenv/analytics/exports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` + readOnly: true type: string - 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` - description: Request for ProvisionOrganization. - GoogleCloudApigeeV1ListSecurityProfilesResponse: type: object - id: GoogleCloudApigeeV1ListSecurityProfilesResponse - description: Response for ListSecurityProfiles. + id: GoogleCloudApigeeV1Export + GoogleCloudApigeeV1GenerateUploadUrlRequest: + id: GoogleCloudApigeeV1GenerateUploadUrlRequest + properties: {} + type: object + description: Request for GenerateUploadUrl method. + 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: - securityProfiles: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' + location: 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. - nextPageToken: + 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 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. + Textual representation of an expression in Common Expression + Language syntax. + title: type: string - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource: - description: Resource for which we are computing security assessment. - id: >- - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource + 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. + type: object + id: GoogleTypeExpr + GoogleCloudApigeeV1InstanceAttachment: properties: name: - description: Required. Name of this resource. + readOnly: true type: string - type: + description: Output only. ID of the attachment. + environment: + type: string + description: ID of the attached environment. + createdAt: + format: int64 + readOnly: true type: string - enumDescriptions: - - ResourceType not specified. - - Resource is an Apigee Proxy. - description: Required. Type of this resource. - enum: - - RESOURCE_TYPE_UNSPECIFIED - - API_PROXY - type: object - GoogleCloudApigeeV1DebugSessionTransaction: - id: GoogleCloudApigeeV1DebugSessionTransaction - properties: - point: description: >- - List of debug data collected by runtime plane at various defined - points in the flow. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Point' - type: array - completed: - type: boolean - description: Flag indicating whether a transaction is completed or not + Output only. Time the attachment was created in milliseconds since + epoch. + description: >- + InstanceAttachment represents the installation of an environment onto an + instance. type: object + id: GoogleCloudApigeeV1InstanceAttachment + GoogleCloudApigeeV1AccessGet: 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. - GoogleCloudApigeeV1CommonNameConfig: + Get action. For example, "Get" : { "name" : "target.name", "value" : + "default" } type: object + id: GoogleCloudApigeeV1AccessGet properties: name: type: string - matchWildCards: - type: boolean - id: GoogleCloudApigeeV1CommonNameConfig - GoogleCloudApigeeV1ListApiProductsResponse: - id: GoogleCloudApigeeV1ListApiProductsResponse - properties: - apiProduct: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' - type: array - description: Lists all API product names defined for an organization. - type: object - GoogleCloudApigeeV1Schema: + value: + type: string + GoogleCloudApigeeV1ListSecurityReportsResponse: type: object - description: Response for Schema call + id: GoogleCloudApigeeV1ListSecurityReportsResponse properties: - dimensions: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaElement' - description: List of schema fields grouped as dimensions. - type: array - meta: - description: >- - Additional metadata associated with schema. This is a legacy field - and usually consists of an empty array of strings. + securityReports: type: array items: - type: string - metrics: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaElement' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' + description: The security reports belong to requested resource name. + nextPageToken: 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: GoogleCloudApigeeV1Schema - GoogleCloudApigeeV1GenerateUploadUrlResponse: + 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. + type: string + description: The response for SecurityReports. + GoogleCloudApigeeV1ListEndpointAttachmentsResponse: + type: object properties: - uploadUri: + nextPageToken: type: string description: >- - The Google Cloud Storage signed URL that can be used to upload a new - Archive zip file. - type: object - description: Response for GenerateUploadUrl method. - id: GoogleCloudApigeeV1GenerateUploadUrlResponse - GoogleCloudApigeeV1DebugMask: - id: GoogleCloudApigeeV1DebugMask + 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' + id: GoogleCloudApigeeV1ListEndpointAttachmentsResponse + description: Response for ListEndpointAttachments method. + GoogleCloudApigeeV1NodeConfig: + description: >- + NodeConfig for setting the min/max number of nodes associated with the + environment. + type: object + id: GoogleCloudApigeeV1NodeConfig properties: - requestXPaths: + currentAggregateNodeCount: + readOnly: true + type: string + description: >- + Output only. The current total number of gateway nodes that each + environment currently has across all instances. + format: int64 + maxNodeCount: + format: int64 + type: string + 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. + minNodeCount: + format: int64 + type: string + 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. + GoogleCloudApigeeV1ListDatastoresResponse: + id: GoogleCloudApigeeV1ListDatastoresResponse + properties: + datastores: items: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + description: A list of datastores type: array + type: object + description: The response for ListDatastores + GoogleRpcPreconditionFailureViolation: + id: GoogleRpcPreconditionFailureViolation + type: object + description: A message type used to describe a single precondition failure. + properties: + type: description: >- - List of XPaths that specify the XML elements to be filtered from XML - request message payloads. - requestJSONPaths: - items: - type: string + 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 + subject: description: >- - List of JSON paths that specify the JSON elements to be filtered - from JSON request message payloads. - type: array - responseJSONPaths: - type: array + The subject, relative to the type, that failed. For example, + "google.com/cloud" relative to the "TOS" type would indicate which + terms of service is being referenced. + type: string + description: + type: string description: >- - List of JSON paths that specify the JSON elements to be filtered - from JSON response message payloads. - items: - type: string - responseXPaths: + 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". + GoogleCloudApigeeV1GrpcOperationConfig: + properties: + methods: items: type: string - description: >- - List of XPaths that specify the XML elements to be filtered from XML - response message payloads. type: array - faultJSONPaths: description: >- - List of JSON paths that specify the JSON elements to be filtered - from JSON payloads in error flows. + 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"]. + attributes: items: - type: string - type: array - faultXPaths: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' type: array + description: Custom attributes associated with the operation. + quota: description: >- - List of XPaths that specify the XML elements to be filtered from XML - payloads in error flows. + Quota parameters to be enforced for the methods and API source + combination. If none are specified, quota enforcement will not be + done. + $ref: '#/components/schemas/GoogleCloudApigeeV1Quota' + service: + type: string + description: >- + Required. gRPC Service name associated to be associated with the API + proxy, on which quota rules can be applied upon. + apiSource: + type: string + description: >- + Required. Name of the API proxy with which the gRPC operation and + quota are associated. + id: GoogleCloudApigeeV1GrpcOperationConfig + type: object + description: >- + Binds the resources in a proxy or remote service with the gRPC operation + and its associated quota enforcement. + GoogleCloudApigeeV1ApiDocResponse: + description: The catalog item resource wrapped with response status, error_code, etc. + id: GoogleCloudApigeeV1ApiDocResponse + type: object + properties: + status: + description: Status of the operation. + type: string + requestId: + description: Unique ID of the request. + type: string + errorCode: + description: Unique error code for the request, if any. + type: string + data: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' + description: The catalog item resource. + message: + type: string + description: Description of the operation. + 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: + name: + type: string + description: ID of the environment group. + hostnames: items: type: string - variables: type: array - items: - type: string - description: List of variables that should be masked from the debug output. - namespaces: - additionalProperties: - type: string - type: object - description: Map of namespaces to URIs. - name: - description: Name of the debug mask. + description: Required. Host names for this environment group. + lastModifiedAt: + description: >- + Output only. The time at which the environment group was last + updated as milliseconds since epoch. + readOnly: true + format: int64 type: string - type: object - GoogleCloudApigeeV1IntegrationConfig: + createdAt: + type: string + format: int64 + readOnly: true + description: >- + Output only. The time at which the environment group was created as + milliseconds since epoch. + state: + readOnly: true + description: >- + Output only. State of the environment group. Values other than + ACTIVE means the resource is not ready to use. + 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. + type: string + 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: - enabled: - type: boolean - description: Flag that specifies whether the Integration add-on is enabled. + name: + description: >- + Resource URI that can be used to identify the scope of the key value + map entries. + type: string + value: + description: >- + Required. Data or payload that is being retrieved and associated + with the unique key. + type: string type: object - id: GoogleCloudApigeeV1IntegrationConfig - description: Configuration for the Integration add-on. + id: GoogleCloudApigeeV1KeyValueEntry GoogleCloudApigeeV1ResourceConfig: + type: object + id: GoogleCloudApigeeV1ResourceConfig properties: location: type: string @@ -8432,1546 +8436,1353 @@ components: Resource name in the following format: `organizations/{org}/environments/{env}/resourcefiles/{type}/{file}/revisions/{rev}` Only environment-scoped resource files are supported. + GoogleCloudApigeeV1AdvancedApiOpsConfig: + description: Configuration for the Advanced API Ops add-on. type: object - id: GoogleCloudApigeeV1ResourceConfig - GoogleCloudApigeeV1ListAsyncQueriesResponse: - description: The response for ListAsyncQueries. properties: - queries: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' - description: The asynchronous queries belong to requested resource name. - type: object - id: GoogleCloudApigeeV1ListAsyncQueriesResponse - GoogleIamV1Binding: - description: Associates `members`, or principals, with a `role`. - id: GoogleIamV1Binding + enabled: + description: Flag that specifies whether the Advanced API Ops add-on is enabled. + type: boolean + id: GoogleCloudApigeeV1AdvancedApiOpsConfig + GoogleCloudApigeeV1ListDeploymentsResponse: properties: - members: - type: array + deployments: + description: List of deployments. 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' - 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/GoogleCloudApigeeV1Deployment' + type: array + id: GoogleCloudApigeeV1ListDeploymentsResponse + type: object + GoogleCloudApigeeV1ListEnvironmentResourcesResponse: + id: GoogleCloudApigeeV1ListEnvironmentResourcesResponse type: object - 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. properties: - samplingRate: - 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: - description: Sampler of distributed tracing. OFF is the default value. - enum: - - SAMPLER_UNSPECIFIED - - 'OFF' - - PROBABILITY - 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 + resourceFile: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' + type: array + description: List of resources files. + description: Response for ListEnvironmentResources + GoogleCloudApigeeV1SecuritySettings: + id: GoogleCloudApigeeV1SecuritySettings type: object - GoogleCloudApigeeV1SecurityActionConditionConfig: - id: GoogleCloudApigeeV1SecurityActionConditionConfig + description: >- + SecuritySettings reflects the current state of the SecuritySettings + feature. properties: - regionCodes: + 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. + Identifier. Full resource name is always + `organizations/{org}/securitySettings`. + mlRetrainingFeedbackEnabled: + type: boolean + description: >- + Optional. If true the user consents to the use of ML models for + Abuse detection. + GoogleCloudApigeeV1ListApiCategoriesResponse: + properties: + status: + type: string + description: Status of the operation. + data: type: array + description: The API category resources. items: - type: string - userAgents: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' + message: + description: Description of the operation. + type: string + errorCode: + description: Unique error code for the request, if any. + type: string + requestId: + type: string + description: Unique ID of the request. + type: object + id: GoogleCloudApigeeV1ListApiCategoriesResponse + description: 'The response for `ListApiCategoriesRequest`. Next ID: 6' + GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest: + type: object + properties: {} + id: GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest + description: Request for ExpireDeveloperSubscription. + GoogleCloudApigeeV1ListAppGroupsResponse: + description: >- + ListAppGroupsResponse contains the 0 or more AppGroups, along with the + optional page token and the total count of apps. + properties: + nextPageToken: description: >- - Optional. A list of user agents to deny. We look for exact matches. - Limit 50 per action. + 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 + appGroups: items: - type: string - type: array - developers: + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + description: List of AppGroups. type: array + totalSize: + description: Total count of AppGroups. + type: integer + format: int32 + id: GoogleCloudApigeeV1ListAppGroupsResponse + type: object + GoogleCloudApigeeV1SyncAuthorization: + properties: + identities: items: type: string - description: Optional. A list of developers. Limit 1000 per action. - developerApps: 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). + 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. + type: object + id: GoogleCloudApigeeV1SyncAuthorization + GoogleCloudApigeeV1QueryMetadata: + type: object + properties: + dimensions: items: type: string - description: Optional. A list of developer apps. Limit 1000 per action. - botReasons: + description: Dimensions of the AsyncQuery. type: array + timeUnit: + type: string + description: Query GroupBy time unit. + startTimestamp: + type: string + description: Start timestamp of the query range. + endTimestamp: + type: string + description: End timestamp of the query range. + outputFormat: + description: Output format. + type: string + metrics: 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. + Metrics of the AsyncQuery. Example: + ["name:message_count,func:sum,alias:sum_message_count"] + type: array items: type: string - asns: - 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 - type: array - ipAddressRanges: + id: GoogleCloudApigeeV1QueryMetadata + GoogleCloudApigeeV1AnalyticsConfig: + properties: + updateTime: + readOnly: true + format: google-datetime + type: string + description: Output only. The latest update time. + state: + enum: + - ADDON_STATE_UNSPECIFIED + - ENABLING + - ENABLED + - DISABLING + - DISABLED + type: string + 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. + readOnly: true + description: Output only. The state of the Analytics add-on. + expireTimeMillis: + format: int64 description: >- - Optional. A list of IP addresses. This could be either IPv4 or IPv6. - Limited to 100 per action. - items: - type: string - type: array - accessTokens: - type: array - items: - type: string - description: Optional. A list of access_tokens. Limit 1000 per action. - apiProducts: - description: Optional. A list of API Products. Limit 1000 per action. - items: - type: string + Output only. Time at which the Analytics add-on expires in + milliseconds since epoch. If unspecified, the add-on will never + expire. + readOnly: true + type: string + enabled: + description: Whether the Analytics add-on is enabled. + type: boolean + description: Configuration for the Analytics add-on. + type: object + id: GoogleCloudApigeeV1AnalyticsConfig + GoogleCloudApigeeV1ListDataCollectorsResponse: + type: object + description: Response for ListDataCollectors. + id: GoogleCloudApigeeV1ListDataCollectorsResponse + properties: + dataCollectors: type: array - apiKeys: items: - type: string - type: array - description: Optional. A list of API keys. Limit 1000 per action. - httpMethods: + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + description: Data collectors in the specified organization. + nextPageToken: + type: string 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 - items: - type: string - 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 - GoogleApiHttpBody: + Page token that you can include in a ListDataCollectors request to + retrieve the next page. If omitted, no subsequent pages exist. + GoogleCloudApigeeV1Query: + id: GoogleCloudApigeeV1Query type: object properties: - contentType: - description: >- - The HTTP Content-Type header value specifying the content type of - the body. + name: type: string - extensions: - items: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - type: array - description: >- - Application specific response metadata. Must be set in the first - response for streaming APIs. - data: - description: The HTTP request/response body as raw binary. - format: byte + description: Asynchronous Query Name. + reportDefinitionId: type: string - id: GoogleApiHttpBody - 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. - GoogleCloudApigeeV1Alias: - properties: - type: - enumDescriptions: - - Alias type is not specified. - - Certificate. - - Key/certificate pair. - enum: - - ALIAS_TYPE_UNSPECIFIED - - CERT - - KEY_CERT - description: Type of alias. + description: Asynchronous Report ID. + 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" } + outputFormat: + description: >- + Valid values include: `csv` or `json`. Defaults to `json`. Note: + Configure the delimiter for CSV output using the csvDelimiter + property. type: string - alias: + csvDelimiter: + description: >- + Delimiter used in the CSV file, if `outputFormat` is set to `csv`. + Defaults to the `,` (comma) character. Supported delimiter + characters include comma (`,`), pipe (`|`), and tab (`\t`). type: string + dimensions: + type: array 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. - description: Reference to a certificate or key/certificate pair. - id: GoogleCloudApigeeV1Alias - type: object - parameters: - 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 - 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 - _.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 - 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 - 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 - callback: - description: JSONP - in: query - name: callback - schema: - type: string - x-stackQL-resources: - issuers: - id: apigee.issuers - name: issuers - title: Issuers - methods: - hybrid_issuers_list: - operation: - $ref: '#/paths/~1v1~1hybrid~1issuers/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/issuers/methods/hybrid_issuers_list - insert: [] - update: [] - delete: [] - reports: - id: apigee.reports - name: reports - title: Reports - methods: - organizations_reports_update: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/put - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_reports_delete: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_reports_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_reports_list: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1reports/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' - 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: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/reports/methods/organizations_reports_delete - environments_deployed_config: - id: apigee.environments_deployed_config - name: environments_deployed_config - title: Environments_deployed_config - methods: - organizations_environments_get_deployed_config: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployedConfig/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/environments_deployed_config/methods/organizations_environments_get_deployed_config - insert: [] - update: [] - delete: [] - environments_api_security_runtime_config: - id: apigee.environments_api_security_runtime_config - name: environments_api_security_runtime_config - title: Environments_api_security_runtime_config - methods: - organizations_environments_get_api_security_runtime_config: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apiSecurityRuntimeConfig/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 - insert: [] - update: [] - delete: [] - environments_iam_policies: - id: apigee.environments_iam_policies - name: environments_iam_policies - title: Environments_iam_policies + A list of dimensions. + https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions + items: + type: string + metrics: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetric' + description: A list of Metrics. + type: array + groupByTimeUnit: + description: >- + Time unit used to group the result set. Valid values include: + second, minute, hour, day, week, or month. If a query includes + groupByTimeUnit, then the result is an aggregation based on the + specified time unit and the resultant timestamp does not include + milliseconds precision. If a query omits groupByTimeUnit, then the + resultant timestamp includes milliseconds precision. + type: string + limit: + description: Maximum number of rows that can be returned in the result. + format: int32 + type: integer + 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 + CreateHostAsyncQuery where analytics data will be grouped by + organization and hostname. + type: string + 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 + 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 + 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 + 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 + 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"). + in: query + name: uploadType + 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 + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + x-stackQL-resources: + apps: + id: google.apigee.apps + name: apps + title: Apps methods: - organizations_environments_test_iam_permissions: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_set_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - _organizations_environments_get_iam_policy: + _organizations_apps_list: operation: &ref_1 - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:getIamPolicy/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apps/get' response: &ref_2 mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - organizations_environments_get_iam_policy: + objectKey: $.app + organizations_apps_list: operation: *ref_1 response: *ref_2 - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/environments_iam_policies/methods/organizations_environments_get_iam_policy - insert: [] - update: [] - delete: [] - environments_trace_config: - id: apigee.environments_trace_config - name: environments_trace_config - title: Environments_trace_config - methods: - organizations_environments_get_trace_config: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_update_trace_config: + organizations_apps_get: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig/patch + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apps~1{appsId}/get' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/environments_trace_config/methods/organizations_environments_get_trace_config - insert: [] - update: [] - delete: [] - environments_security_actions_config: - id: apigee.environments_security_actions_config - name: environments_security_actions_config - title: Environments_security_actions_config - methods: - organizations_environments_get_security_actions_config: + organizations_developers_apps_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActionsConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_update_security_actions_config: + organizations_developers_apps_generate_key_pair_or_update_developer_app_status: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActionsConfig/patch + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/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: [] - update: [] - delete: [] - environments_environment: - id: apigee.environments_environment - name: environments_environment - title: Environments_environment - methods: - organizations_environments_update_environment: + organizations_developers_apps_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/put response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - environments: - id: apigee.environments - name: environments - title: Environments - methods: - organizations_environments_modify_environment: + organizations_developers_apps_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_update: + organizations_developers_apps_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_delete: + organizations_developers_apps_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_get: + organizations_developers_apps_attributes: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_unsubscribe: + organizations_appgroups_apps_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:unsubscribe/post + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_subscribe: + organizations_appgroups_apps_get: 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}~1appgroups~1{appgroupsId}~1apps~1{appsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_security_profiles_environments_compute_environment_scores: + organizations_appgroups_apps_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments~1{environmentsId}:computeEnvironmentScores/post + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_security_profiles_environments_create: + organizations_appgroups_apps_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments/post + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps/post response: mediaType: application/json openAPIDocKey: '200' - organizations_security_profiles_environments_delete: - operation: + _organizations_appgroups_apps_list: + operation: &ref_3 $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments~1{environmentsId}/delete - response: + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps/get + response: &ref_4 mediaType: application/json openAPIDocKey: '200' + objectKey: $.appGroupApps + organizations_appgroups_apps_list: + operation: *ref_3 + response: *ref_4 sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/environments/methods/organizations_environments_get + #/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_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_list insert: - $ref: >- - #/components/x-stackQL-resources/environments/methods/organizations_environments_create + #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_create - $ref: >- - #/components/x-stackQL-resources/environments/methods/organizations_security_profiles_environments_create - update: [] + #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_create + update: + - $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/environments/methods/organizations_environments_delete + #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_delete - $ref: >- - #/components/x-stackQL-resources/environments/methods/organizations_security_profiles_environments_delete - environments_debugmask: - id: apigee.environments_debugmask - name: environments_debugmask - title: Environments_debugmask + #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_delete + deployments: + id: google.apigee.deployments + name: deployments + title: Deployments methods: - organizations_environments_update_debugmask: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1debugmask/patch - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_get_debugmask: + organizations_deployments_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1debugmask/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1deployments/get' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/environments_debugmask/methods/organizations_environments_get_debugmask - insert: [] - update: [] - delete: [] - environments_addons_config: - id: apigee.environments_addons_config - name: environments_addons_config - title: Environments_addons_config - methods: - organizations_environments_get_addons_config: + organizations_apis_revisions_deployments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1addonsConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/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: [] - delete: [] - addons_config: - id: apigee.addons_config - name: addons_config - title: Addons_config - methods: - organizations_environments_addons_config_set_addon_enablement: + organizations_apis_deployments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1addonsConfig:setAddonEnablement/post + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - security_incidents: - id: apigee.security_incidents - name: security_incidents - title: Security_incidents - methods: - organizations_environments_security_incidents_patch: + organizations_environments_sharedflows_deployments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents~1{securityIncidentsId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_incidents_get: + organizations_environments_deployments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents~1{securityIncidentsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - _organizations_environments_security_incidents_list: - operation: &ref_3 - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents/get - response: &ref_4 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.securityIncidents - organizations_environments_security_incidents_list: - operation: *ref_3 - response: *ref_4 - organizations_environments_security_incidents_batch_update: + organizations_environments_apis_deployments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents:batchUpdate/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1deployments/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 - insert: [] - update: [] - delete: [] - references: - id: apigee.references - name: references - title: References - methods: - organizations_environments_references_delete: + organizations_environments_apis_revisions_deployments_generate_undeploy_change_report: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references~1{referencesId}/delete + #/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_references_update: + organizations_environments_apis_revisions_deployments_generate_deploy_change_report: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references~1{referencesId}/put + #/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_references_get: + organizations_sharedflows_revisions_deployments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references~1{referencesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_references_create: + organizations_sharedflows_deployments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references/post + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/references/methods/organizations_environments_references_get - insert: + #/components/x-stackQL-resources/deployments/methods/organizations_apis_revisions_deployments_list - $ref: >- - #/components/x-stackQL-resources/references/methods/organizations_environments_references_create - update: [] - delete: + #/components/x-stackQL-resources/deployments/methods/organizations_environments_sharedflows_deployments_list - $ref: >- - #/components/x-stackQL-resources/references/methods/organizations_environments_references_delete - stats: - id: 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: + #/components/x-stackQL-resources/deployments/methods/organizations_environments_apis_deployments_list - $ref: >- - #/components/x-stackQL-resources/stats/methods/organizations_environments_stats_get + #/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: [] delete: [] - aliases: - id: apigee.aliases - name: aliases - title: Aliases + attributes: + id: google.apigee.attributes + name: attributes + title: Attributes methods: - organizations_environments_keystores_aliases_delete: + organizations_developers_attributes_delete: 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}~1attributes~1{attributesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keystores_aliases_get: + organizations_developers_attributes_get: 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}~1attributes~1{attributesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keystores_aliases_update: + organizations_developers_attributes_list: 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}~1attributes/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keystores_aliases_csr: + organizations_developers_apps_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}~1developers~1{developersId}~1apps~1{appsId}~1attributes/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keystores_aliases_create: + organizations_developers_apps_attributes_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes~1{attributesId}/delete 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: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_delete - aliases_certificate: - id: apigee.aliases_certificate - name: aliases_certificate - title: Aliases_certificate - methods: - organizations_environments_keystores_aliases_get_certificate: + organizations_developers_apps_attributes_get: 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}~1apps~1{appsId}~1attributes~1{attributesId}/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: [] - delete: [] - keystores: - id: apigee.keystores - name: keystores - title: Keystores - methods: - organizations_environments_keystores_delete: + organizations_apiproducts_attributes_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keystores_get: + organizations_apiproducts_attributes_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keystores_create: + organizations_apiproducts_attributes_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores/post + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_get - insert: + #/components/x-stackQL-resources/attributes/methods/organizations_developers_apps_attributes_get - $ref: >- - #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_create + #/components/x-stackQL-resources/attributes/methods/organizations_developers_attributes_get + - $ref: >- + #/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: [] delete: - $ref: >- - #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_delete - targetservers: - id: apigee.targetservers - name: targetservers - title: Targetservers + #/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_attribute: + id: google.apigee.attributes_developer_attribute + name: attributes_developer_attribute + title: Attributes_developer_attribute + methods: + organizations_developers_attributes_update_developer_attribute: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes~1{attributesId}/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + developers: + id: google.apigee.developers + name: developers + title: Developers methods: - organizations_environments_targetservers_get: + organizations_developers_attributes: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_targetservers_update: + organizations_developers_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/put + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1developers/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_targetservers_delete: + organizations_developers_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/delete + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1developers/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_targetservers_create: + organizations_developers_set_developer_status: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/post 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: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_delete - flowhooks: - id: apigee.flowhooks - name: flowhooks - title: Flowhooks - methods: - organizations_environments_flowhooks_attach_shared_flow_to_flow_hook: + organizations_developers_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_flowhooks_detach_shared_flow_from_flow_hook: + organizations_developers_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_flowhooks_get: + organizations_developers_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/flowhooks/methods/organizations_environments_flowhooks_get - insert: [] - update: [] - delete: [] - security_actions: - id: apigee.security_actions - name: security_actions - title: Security_actions + #/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/developers/methods/organizations_developers_create + update: + - $ref: >- + #/components/x-stackQL-resources/developers/methods/organizations_developers_update + delete: + - $ref: >- + #/components/x-stackQL-resources/developers/methods/organizations_developers_delete + subscriptions: + id: google.apigee.subscriptions + name: subscriptions + title: Subscriptions methods: - _organizations_environments_security_actions_list: - operation: &ref_5 - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions/get - response: &ref_6 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.securityActions - organizations_environments_security_actions_list: - operation: *ref_5 - response: *ref_6 - organizations_environments_security_actions_create: + organizations_developers_subscriptions_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions~1{subscriptionsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_actions_get: + organizations_developers_subscriptions_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_actions_enable: + organizations_developers_subscriptions_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}:enable/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_actions_disable: + organizations_developers_subscriptions_expire: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}:disable/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions~1{subscriptionsId}:expire/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_list + #/components/x-stackQL-resources/subscriptions/methods/organizations_developers_subscriptions_get - $ref: >- - #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_get + #/components/x-stackQL-resources/subscriptions/methods/organizations_developers_subscriptions_list insert: - $ref: >- - #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_create + #/components/x-stackQL-resources/subscriptions/methods/organizations_developers_subscriptions_create update: [] delete: [] - deployments: - id: apigee.deployments - name: deployments - title: Deployments + balance: + id: google.apigee.balance + name: balance + title: Balance methods: - organizations_environments_deployments_list: + organizations_developers_balance_credit: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1balance:credit/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_apis_deployments_list: + organizations_developers_balance_adjust: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1deployments/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1balance:adjust/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_apis_revisions_deployments_generate_deploy_change_report: + sqlVerbs: + select: [] + insert: [] + update: [] + 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}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments:generateDeployChangeReport/post + #/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_deployments_generate_undeploy_change_report: + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + apiproducts: + id: google.apigee.apiproducts + name: apiproducts + title: Apiproducts + methods: + organizations_developers_apps_keys_apiproducts_delete: 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}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_sharedflows_deployments_list: + organizations_appgroups_apps_keys_apiproducts_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1deployments/get + #/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_sharedflows_revisions_deployments_list: + organizations_apiproducts_attributes: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/get + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes/post response: mediaType: application/json openAPIDocKey: '200' - organizations_sharedflows_deployments_list: + organizations_apiproducts_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1deployments/get + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_deployments_list: + organizations_apiproducts_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1deployments/get + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_revisions_deployments_list: + organizations_apiproducts_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/get + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_deployments_list: + organizations_apiproducts_create: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1deployments/get' + $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' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_environments_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_environments_apis_deployments_list + #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_get - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_environments_sharedflows_deployments_list + #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_list + insert: - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_sharedflows_revisions_deployments_list + #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_create + update: - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_sharedflows_deployments_list + #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_update + delete: - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_apis_deployments_list + #/components/x-stackQL-resources/apiproducts/methods/organizations_developers_apps_keys_apiproducts_delete - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_apis_revisions_deployments_list + #/components/x-stackQL-resources/apiproducts/methods/organizations_appgroups_apps_keys_apiproducts_delete - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_deployments_list - insert: [] - update: [] - delete: [] - admin_schemav2: - id: apigee.admin_schemav2 - name: admin_schemav2 - title: Admin_schemav2 + #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_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_environments_analytics_admin_get_schemav2: + organizations_developers_apps_keys_apiproducts_update_developer_app_key_api_product: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1admin~1schemav2/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/admin_schemav2/methods/organizations_environments_analytics_admin_get_schemav2 + select: [] insert: [] update: [] delete: [] - exports: - id: apigee.exports - name: exports - title: Exports + create: + id: google.apigee.create + name: create + title: Create 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: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1exports/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_analytics_exports_get: + organizations_developers_apps_keys_create_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1exports~1{exportsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1create/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/exports/methods/organizations_environments_analytics_exports_list - - $ref: >- - #/components/x-stackQL-resources/exports/methods/organizations_environments_analytics_exports_get + select: [] insert: - $ref: >- - #/components/x-stackQL-resources/exports/methods/organizations_environments_analytics_exports_create - update: [] - delete: [] - revisions: - id: apigee.revisions - name: revisions - title: Revisions - methods: - organizations_environments_apis_revisions_undeploy: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/delete - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_apis_revisions_deploy: + #/components/x-stackQL-resources/create/methods/organizations_developers_apps_keys_create_create + update: [] + delete: [] + keys: + id: google.apigee.keys + name: keys + title: Keys + methods: + organizations_developers_apps_keys_replace_developer_app_key: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/post + #/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_get: 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}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_sharedflows_revisions_undeploy: + organizations_developers_apps_keys_delete: 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}/delete 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' - organizations_sharedflows_revisions_get: + organizations_appgroups_apps_keys_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys/post response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_revisions_delete: + organizations_appgroups_apps_keys_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_revisions_get: + organizations_appgroups_apps_keys_get: 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}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/revisions/methods/organizations_sharedflows_revisions_get + #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_get - $ref: >- - #/components/x-stackQL-resources/revisions/methods/organizations_apis_revisions_get - insert: [] + #/components/x-stackQL-resources/keys/methods/organizations_appgroups_apps_keys_get + insert: + - $ref: >- + #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_create + - $ref: >- + #/components/x-stackQL-resources/keys/methods/organizations_appgroups_apps_keys_create update: [] delete: - $ref: >- - #/components/x-stackQL-resources/revisions/methods/organizations_sharedflows_revisions_delete + #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_delete - $ref: >- - #/components/x-stackQL-resources/revisions/methods/organizations_apis_revisions_delete - revisions_deployments: - id: apigee.revisions_deployments - name: revisions_deployments - title: Revisions_deployments + #/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_apis_revisions_get_deployments: + organizations_developers_apps_keys_update_developer_app_key: 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}/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_sharedflows_revisions_get_deployments: + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + developers_monetization_config: + id: google.apigee.developers_monetization_config + name: developers_monetization_config + title: Developers_monetization_config + methods: + organizations_developers_get_monetization_config: 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}~1monetizationConfig/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_developers_update_monetization_config: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1monetizationConfig/put 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 + #/components/x-stackQL-resources/developers_monetization_config/methods/organizations_developers_get_monetization_config insert: [] update: [] delete: [] - data: - id: apigee.data - name: data - title: Data + developers_balance: + id: google.apigee.developers_balance + name: developers_balance + title: Developers_balance methods: - organizations_environments_apis_revisions_debugsessions_data_get: + organizations_developers_get_balance: 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}~1developers~1{developersId}~1balance/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/data/methods/organizations_environments_apis_revisions_debugsessions_data_get + #/components/x-stackQL-resources/developers_balance/methods/organizations_developers_get_balance insert: [] update: [] delete: [] - debugsessions_data: - id: apigee.debugsessions_data - name: debugsessions_data - title: Debugsessions_data + appgroups: + id: google.apigee.appgroups + name: appgroups + title: Appgroups methods: - organizations_environments_apis_revisions_debugsessions_delete_data: + organizations_appgroups_update: 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}~1appgroups~1{appgroupsId}/put response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/debugsessions_data/methods/organizations_environments_apis_revisions_debugsessions_delete_data - debugsessions: - id: apigee.debugsessions - name: debugsessions - title: Debugsessions - methods: - _organizations_environments_apis_revisions_debugsessions_list: - operation: &ref_7 + organizations_appgroups_delete: + operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions/get - response: &ref_8 + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}/delete + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.sessions - organizations_environments_apis_revisions_debugsessions_list: - operation: *ref_7 - response: *ref_8 - organizations_environments_apis_revisions_debugsessions_create: + organizations_appgroups_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions/post + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_apis_revisions_debugsessions_get: + organizations_appgroups_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions~1{debugsessionsId}/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1appgroups/post' response: mediaType: application/json openAPIDocKey: '200' + _organizations_appgroups_list: + operation: &ref_5 + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1appgroups/get' + response: &ref_6 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.appGroups + organizations_appgroups_list: + operation: *ref_5 + response: *ref_6 sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/debugsessions/methods/organizations_environments_apis_revisions_debugsessions_list + #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_get - $ref: >- - #/components/x-stackQL-resources/debugsessions/methods/organizations_environments_apis_revisions_debugsessions_get + #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_list insert: - $ref: >- - #/components/x-stackQL-resources/debugsessions/methods/organizations_environments_apis_revisions_debugsessions_create + #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_create + update: + - $ref: >- + #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_update + delete: + - $ref: >- + #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_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_appgroups_apps_keys_update_app_group_app_key: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] update: [] delete: [] - security_reports_result: - id: apigee.security_reports_result - name: security_reports_result - title: Security_reports_result + 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_environments_security_reports_get_result: + organizations_appgroups_apps_keys_apiproducts_update_app_group_app_key_api_product: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports~1{securityReportsId}~1result/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: [] + insert: [] + update: [] + 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}~1hostQueries~1{hostQueriesId}~1result/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/security_reports_result/methods/organizations_environments_security_reports_get_result + #/components/x-stackQL-resources/host_queries_result/methods/organizations_host_queries_get_result insert: [] update: [] delete: [] - security_reports: - id: apigee.security_reports - name: security_reports - title: Security_reports + host_queries: + id: google.apigee.host_queries + name: host_queries + title: Host_queries methods: - organizations_environments_security_reports_create: + organizations_host_queries_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports/post + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1hostQueries/get' response: mediaType: application/json openAPIDocKey: '200' - _organizations_environments_security_reports_list: - operation: &ref_9 - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports/get - response: &ref_10 + organizations_host_queries_create: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1hostQueries/post' + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.securityReports - organizations_environments_security_reports_list: - operation: *ref_9 - response: *ref_10 - organizations_environments_security_reports_get: + organizations_host_queries_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports~1{securityReportsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1hostQueries~1{hostQueriesId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_list + #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_get - $ref: >- - #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_get + #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_list insert: - $ref: >- - #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_create + #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_create update: [] delete: [] - security_reports_result_view: - id: apigee.security_reports_result_view - name: security_reports_result_view - title: Security_reports_result_view + 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}~1hostQueries~1{hostQueriesId}~1resultView/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 + insert: [] + update: [] + delete: [] + host_stats: + id: google.apigee.host_stats + name: host_stats + title: Host_stats methods: - organizations_environments_security_reports_get_result_view: + organizations_host_stats_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports~1{securityReportsId}~1resultView/get + #/paths/~1v1~1organizations~1{organizationsId}~1hostStats~1{hostStatsId}/get 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 + #/components/x-stackQL-resources/host_stats/methods/organizations_host_stats_get insert: [] update: [] delete: [] entries: - id: apigee.entries + id: google.apigee.entries name: entries title: Entries methods: - organizations_environments_keyvaluemaps_entries_get: + organizations_keyvaluemaps_entries_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keyvaluemaps_entries_delete: + organizations_keyvaluemaps_entries_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keyvaluemaps_entries_update: + organizations_keyvaluemaps_entries_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/get response: mediaType: application/json openAPIDocKey: '200' - _organizations_environments_keyvaluemaps_entries_list: - operation: &ref_11 + _organizations_keyvaluemaps_entries_list: + operation: &ref_7 $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get - response: &ref_12 + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get + response: &ref_8 mediaType: application/json openAPIDocKey: '200' objectKey: $.keyValueEntries - organizations_environments_keyvaluemaps_entries_list: - operation: *ref_11 - response: *ref_12 - organizations_environments_keyvaluemaps_entries_create: + organizations_keyvaluemaps_entries_list: + operation: *ref_7 + response: *ref_8 + organizations_keyvaluemaps_entries_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_keyvaluemaps_entries_delete: + organizations_apis_keyvaluemaps_entries_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post response: mediaType: application/json openAPIDocKey: '200' + _organizations_apis_keyvaluemaps_entries_list: + operation: &ref_9 + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get + response: &ref_10 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.keyValueEntries + organizations_apis_keyvaluemaps_entries_list: + operation: *ref_9 + response: *ref_10 organizations_apis_keyvaluemaps_entries_update: operation: $ref: >- @@ -9986,261 +9797,159 @@ components: response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_keyvaluemaps_entries_create: + organizations_apis_keyvaluemaps_entries_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete response: mediaType: application/json openAPIDocKey: '200' - _organizations_apis_keyvaluemaps_entries_list: - operation: &ref_13 + organizations_environments_keyvaluemaps_entries_update: + operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get - response: &ref_14 + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/put + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.keyValueEntries - organizations_apis_keyvaluemaps_entries_list: - operation: *ref_13 - response: *ref_14 - organizations_keyvaluemaps_entries_get: + organizations_environments_keyvaluemaps_entries_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_keyvaluemaps_entries_update: + organizations_environments_keyvaluemaps_entries_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_keyvaluemaps_entries_delete: + organizations_environments_keyvaluemaps_entries_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post response: mediaType: application/json openAPIDocKey: '200' - _organizations_keyvaluemaps_entries_list: - operation: &ref_15 + _organizations_environments_keyvaluemaps_entries_list: + operation: &ref_11 $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get - response: &ref_16 + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get + response: &ref_12 mediaType: application/json openAPIDocKey: '200' objectKey: $.keyValueEntries - organizations_keyvaluemaps_entries_list: - operation: *ref_15 - response: *ref_16 - organizations_keyvaluemaps_entries_create: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post - response: - mediaType: application/json - openAPIDocKey: '200' + organizations_environments_keyvaluemaps_entries_list: + operation: *ref_11 + response: *ref_12 sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_get + #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_get - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_list + #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_get - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_get + #/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_keyvaluemaps_entries_get + #/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/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_environments_keyvaluemaps_entries_create - $ref: >- #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_create - update: [] - delete: + update: - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_delete + #/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: apigee.keyvaluemaps + id: google.apigee.keyvaluemaps name: keyvaluemaps title: Keyvaluemaps methods: - organizations_environments_keyvaluemaps_create: + organizations_keyvaluemaps_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps/post + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keyvaluemaps_delete: + organizations_keyvaluemaps_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_keyvaluemaps_delete: + organizations_apis_keyvaluemaps_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps/post response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_keyvaluemaps_create: + organizations_apis_keyvaluemaps_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps/post + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_keyvaluemaps_create: + organizations_environments_keyvaluemaps_delete: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_keyvaluemaps_delete: + organizations_environments_keyvaluemaps_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: [] insert: - - $ref: >- - #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_environments_keyvaluemaps_create - $ref: >- #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_apis_keyvaluemaps_create + - $ref: >- + #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_environments_keyvaluemaps_create - $ref: >- #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_keyvaluemaps_create update: [] delete: - - $ref: >- - #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_environments_keyvaluemaps_delete - $ref: >- #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_apis_keyvaluemaps_delete - $ref: >- - #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_keyvaluemaps_delete - optimized_stats: - id: 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/optimized_stats/methods/organizations_environments_optimized_stats_get - insert: [] - update: [] - delete: [] - archive_deployments: - id: apigee.archive_deployments - name: archive_deployments - title: Archive_deployments - methods: - 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_list: - operation: &ref_17 - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments/get - response: &ref_18 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.archiveDeployments - organizations_environments_archive_deployments_list: - operation: *ref_17 - response: *ref_18 - 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_delete: - operation: - $ref: >- - #/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_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}/get - 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' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_list - - $ref: >- - #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_get - insert: - - $ref: >- - #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_create - update: [] - delete: + #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_environments_keyvaluemaps_delete - $ref: >- - #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_delete - security_stats: - id: apigee.security_stats - name: security_stats - title: Security_stats - methods: - organizations_environments_security_stats_query_tabular_stats: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityStats:queryTabularStats/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_security_stats_query_time_series_stats: + #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_keyvaluemaps_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}~1securityStats:queryTimeSeriesStats/post + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/post response: mediaType: application/json openAPIDocKey: '200' @@ -10249,1137 +9958,1224 @@ components: insert: [] update: [] delete: [] - caches: - id: apigee.caches - name: caches - title: Caches + rateplans: + id: google.apigee.rateplans + name: rateplans + title: Rateplans methods: - organizations_environments_caches_delete: + organizations_apiproducts_rateplans_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1caches~1{cachesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/caches/methods/organizations_environments_caches_delete - queries_result: - id: apigee.queries_result - name: queries_result - title: Queries_result - methods: - organizations_environments_queries_get_result: + organizations_apiproducts_rateplans_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries~1{queriesId}~1result/get + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/queries_result/methods/organizations_environments_queries_get_result - insert: [] - update: [] - delete: [] - queries: - id: apigee.queries - name: queries - title: Queries - methods: - organizations_environments_queries_create: + organizations_apiproducts_rateplans_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries/post + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans~1{rateplansId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_queries_list: + organizations_apiproducts_rateplans_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries/get + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans~1{rateplansId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_queries_get: + organizations_apiproducts_rateplans_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries~1{queriesId}/get + #/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/queries/methods/organizations_environments_queries_list + #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_get - $ref: >- - #/components/x-stackQL-resources/queries/methods/organizations_environments_queries_get + #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_list insert: - $ref: >- - #/components/x-stackQL-resources/queries/methods/organizations_environments_queries_create - update: [] - delete: [] - queries_resulturl: - id: apigee.queries_resulturl - name: queries_resulturl - title: Queries_resulturl + #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_create + update: + - $ref: >- + #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_update + delete: + - $ref: >- + #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_delete + endpoint_attachments: + id: google.apigee.endpoint_attachments + name: endpoint_attachments + title: Endpoint_attachments methods: - organizations_environments_queries_get_resulturl: + organizations_endpoint_attachments_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries~1{queriesId}~1resulturl/get + #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments~1{endpointAttachmentsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_endpoint_attachments_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments~1{endpointAttachmentsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + _organizations_endpoint_attachments_list: + operation: &ref_13 + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments/get + response: &ref_14 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.endpointAttachments + organizations_endpoint_attachments_list: + operation: *ref_13 + response: *ref_14 + organizations_endpoint_attachments_create: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/queries_resulturl/methods/organizations_environments_queries_get_resulturl - insert: [] + #/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: [] - delete: [] - overrides: - id: apigee.overrides - name: overrides - title: Overrides + delete: + - $ref: >- + #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_delete + apis: + id: google.apigee.apis + name: apis + title: Apis methods: - organizations_environments_trace_config_overrides_create: + organizations_apis_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides/post + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis/get' response: mediaType: application/json openAPIDocKey: '200' - _organizations_environments_trace_config_overrides_list: - operation: &ref_19 - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides/get - response: &ref_20 + organizations_apis_create: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis/post' + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.traceConfigOverrides - organizations_environments_trace_config_overrides_list: - operation: *ref_19 - response: *ref_20 - organizations_environments_trace_config_overrides_get: + organizations_apis_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_trace_config_overrides_delete: + organizations_apis_get: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/delete + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_trace_config_overrides_patch: + organizations_apis_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_list + #/components/x-stackQL-resources/apis/methods/organizations_apis_get - $ref: >- - #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_get + #/components/x-stackQL-resources/apis/methods/organizations_apis_list insert: - $ref: >- - #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_create - update: [] + #/components/x-stackQL-resources/apis/methods/organizations_apis_create + update: + - $ref: >- + #/components/x-stackQL-resources/apis/methods/organizations_apis_patch delete: - $ref: >- - #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_delete - resourcefiles: - id: apigee.resourcefiles - name: resourcefiles - title: Resourcefiles + #/components/x-stackQL-resources/apis/methods/organizations_apis_delete + revisions: + id: google.apigee.revisions + name: revisions + title: Revisions methods: - organizations_environments_resourcefiles_delete: + organizations_apis_revisions_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}~1{name}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_resourcefiles_update: + organizations_apis_revisions_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}~1{name}/put + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_resourcefiles_get: + organizations_environments_sharedflows_revisions_undeploy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}~1{name}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_resourcefiles_list: + organizations_environments_sharedflows_revisions_deploy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_resourcefiles_create: + organizations_environments_apis_revisions_deploy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles/post + #/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}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_sharedflows_revisions_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_sharedflows_revisions_delete: + operation: + $ref: >- + #/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/resourcefiles/methods/organizations_environments_resourcefiles_get - - $ref: >- - #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_list - insert: + #/components/x-stackQL-resources/revisions/methods/organizations_apis_revisions_get - $ref: >- - #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_create + #/components/x-stackQL-resources/revisions/methods/organizations_sharedflows_revisions_get + insert: [] update: [] delete: - $ref: >- - #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_delete - resourcefiles_environment_resources: - id: apigee.resourcefiles_environment_resources - name: resourcefiles_environment_resources - title: Resourcefiles_environment_resources + #/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_environments_resourcefiles_list_environment_resources: + organizations_apis_revisions_update_api_proxy_revision: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}/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/resourcefiles_environment_resources/methods/organizations_environments_resourcefiles_list_environment_resources + select: [] insert: [] update: [] delete: [] - apicategories: - id: apigee.apicategories - name: apicategories - title: Apicategories + reports: + id: google.apigee.reports + name: reports + title: Reports methods: - organizations_sites_apicategories_delete: + organizations_reports_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apicategories_get: + organizations_reports_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apicategories_patch: + organizations_reports_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apicategories_list: + organizations_reports_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1reports/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apicategories_create: + organizations_reports_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories/post + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1reports/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_get + #/components/x-stackQL-resources/reports/methods/organizations_reports_get - $ref: >- - #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_list + #/components/x-stackQL-resources/reports/methods/organizations_reports_list insert: - $ref: >- - #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_create - update: [] + #/components/x-stackQL-resources/reports/methods/organizations_reports_create + update: + - $ref: >- + #/components/x-stackQL-resources/reports/methods/organizations_reports_update delete: - $ref: >- - #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_delete - apidocs: - id: apigee.apidocs - name: apidocs - title: Apidocs + #/components/x-stackQL-resources/reports/methods/organizations_reports_delete + security_profiles: + id: google.apigee.security_profiles + name: security_profiles + title: Security_profiles methods: - _organizations_sites_apidocs_list: - operation: &ref_21 + organizations_security_profiles_create: + operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs/get - response: &ref_22 + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.data - organizations_sites_apidocs_list: - operation: *ref_21 - response: *ref_22 - organizations_sites_apidocs_create: - operation: + _organizations_security_profiles_list: + operation: &ref_15 $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs/post - response: + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles/get + response: &ref_16 mediaType: application/json openAPIDocKey: '200' - organizations_sites_apidocs_get: + objectKey: $.securityProfiles + organizations_security_profiles_list: + operation: *ref_15 + response: *ref_16 + organizations_security_profiles_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apidocs_delete: + organizations_security_profiles_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apidocs_update: + organizations_security_profiles_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_list + #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_get - $ref: >- - #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_get + #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_list insert: - $ref: >- - #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_create - update: [] + #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_create + update: + - $ref: >- + #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_patch delete: - $ref: >- - #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_delete - apidocs_documentation: - id: apigee.apidocs_documentation - name: apidocs_documentation - title: Apidocs_documentation + #/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_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' - organizations_sites_apidocs_get_documentation: - operation: + _organizations_security_profiles_list_revisions: + operation: &ref_17 $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}~1documentation/get - response: + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}:listRevisions/get + response: &ref_18 mediaType: application/json openAPIDocKey: '200' + objectKey: $.securityProfiles + organizations_security_profiles_list_revisions: + operation: *ref_17 + response: *ref_18 sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/apidocs_documentation/methods/organizations_sites_apidocs_get_documentation + #/components/x-stackQL-resources/security_profiles_revisions/methods/organizations_security_profiles_list_revisions insert: [] update: [] delete: [] - host_stats: - id: apigee.host_stats - name: host_stats - title: Host_stats + environments: + id: google.apigee.environments + name: environments + title: Environments methods: - organizations_host_stats_get: + organizations_security_profiles_environments_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostStats~1{hostStatsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments~1{environmentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/host_stats/methods/organizations_host_stats_get - insert: [] - update: [] - delete: [] - revisions_shared_flow_revision: - id: apigee.revisions_shared_flow_revision - name: revisions_shared_flow_revision - title: Revisions_shared_flow_revision - methods: - organizations_sharedflows_revisions_update_shared_flow_revision: + organizations_security_profiles_environments_compute_environment_scores: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments~1{environmentsId}:computeEnvironmentScores/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - sharedflows: - id: apigee.sharedflows - name: sharedflows - title: Sharedflows - methods: - organizations_sharedflows_delete: + organizations_security_profiles_environments_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments/post response: mediaType: application/json openAPIDocKey: '200' - organizations_sharedflows_get: + organizations_environments_modify_environment: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_sharedflows_create: + organizations_environments_update: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1sharedflows/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_sharedflows_list: + organizations_environments_delete: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1sharedflows/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/delete 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 - update: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_delete - datacollectors: - id: apigee.datacollectors - name: datacollectors - title: Datacollectors - methods: - _organizations_datacollectors_list: - operation: &ref_23 - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1datacollectors/get' - response: &ref_24 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.dataCollectors - organizations_datacollectors_list: - operation: *ref_23 - response: *ref_24 - organizations_datacollectors_create: + organizations_environments_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_datacollectors_delete: + organizations_environments_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/delete + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1environments/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_datacollectors_patch: + organizations_environments_unsubscribe: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:unsubscribe/post response: mediaType: application/json openAPIDocKey: '200' - organizations_datacollectors_get: + organizations_environments_subscribe: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:subscribe/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_list - - $ref: >- - #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_get + #/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/environments/methods/organizations_environments_create + update: + - $ref: >- + #/components/x-stackQL-resources/environments/methods/organizations_environments_update delete: - $ref: >- - #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_delete - operations: - id: apigee.operations - name: operations - title: Operations + #/components/x-stackQL-resources/environments/methods/organizations_security_profiles_environments_delete + - $ref: >- + #/components/x-stackQL-resources/environments/methods/organizations_environments_delete + datastores: + id: google.apigee.datastores + name: datastores + title: Datastores methods: - organizations_operations_get: + organizations_analytics_datastores_test: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1operations~1{operationsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores:test/post response: mediaType: application/json openAPIDocKey: '200' - _organizations_operations_list: - operation: &ref_25 - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1operations/get' - response: &ref_26 + organizations_analytics_datastores_update: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores~1{datastoresId}/put + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations - organizations_operations_list: - operation: *ref_25 - response: *ref_26 - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/operations/methods/organizations_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/organizations_operations_list - insert: [] - update: [] - delete: [] - host_security_reports_result: - id: apigee.host_security_reports_result - name: host_security_reports_result - title: Host_security_reports_result - methods: - organizations_host_security_reports_get_result: + organizations_analytics_datastores_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}~1result/get + #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores~1{datastoresId}/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: [] - delete: [] - host_security_reports: - id: apigee.host_security_reports - name: host_security_reports - title: Host_security_reports - methods: - organizations_host_security_reports_create: + organizations_analytics_datastores_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports/post + #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores~1{datastoresId}/get response: mediaType: application/json openAPIDocKey: '200' - _organizations_host_security_reports_list: - operation: &ref_27 + organizations_analytics_datastores_list: + operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports/get - response: &ref_28 + #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.securityReports - organizations_host_security_reports_list: - operation: *ref_27 - response: *ref_28 - organizations_host_security_reports_get: + organizations_analytics_datastores_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_list + #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_get - $ref: >- - #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_get + #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_list insert: - $ref: >- - #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_create - update: [] - delete: [] - host_security_reports_result_view: - id: apigee.host_security_reports_result_view - name: host_security_reports_result_view - title: Host_security_reports_result_view + #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_create + update: + - $ref: >- + #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_update + delete: + - $ref: >- + #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_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_security_reports_get_result_view: + organizations_envgroups_get_deployed_ingress_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}~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_security_reports_result_view/methods/organizations_host_security_reports_get_result_view + #/components/x-stackQL-resources/envgroups_deployed_ingress_config/methods/organizations_envgroups_get_deployed_ingress_config insert: [] update: [] delete: [] - appgroups: - id: apigee.appgroups - name: appgroups - title: Appgroups + envgroups: + id: google.apigee.envgroups + name: envgroups + title: Envgroups methods: - organizations_appgroups_create: + organizations_envgroups_get: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1appgroups/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/get response: mediaType: application/json openAPIDocKey: '200' - _organizations_appgroups_list: - operation: &ref_29 - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1appgroups/get' - response: &ref_30 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.appGroups - organizations_appgroups_list: - operation: *ref_29 - response: *ref_30 - organizations_appgroups_update: + organizations_envgroups_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_delete: + organizations_envgroups_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_get: + _organizations_envgroups_list: + operation: &ref_19 + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1envgroups/get' + response: &ref_20 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.environmentGroups + organizations_envgroups_list: + operation: *ref_19 + response: *ref_20 + organizations_envgroups_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1envgroups/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_list + #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_get - $ref: >- - #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_get + #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_list insert: - $ref: >- - #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_create - update: [] + #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_create + update: + - $ref: >- + #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_patch delete: - $ref: >- - #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_delete - apiproducts: - id: apigee.apiproducts - name: apiproducts - title: Apiproducts + #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_delete + attachments: + id: google.apigee.attachments + name: attachments + title: Attachments methods: - organizations_appgroups_apps_keys_apiproducts_delete: + organizations_envgroups_attachments_get: 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}~1envgroups~1{envgroupsId}~1attachments~1{attachmentsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_get: + organizations_envgroups_attachments_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments~1{attachmentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_update: + organizations_envgroups_attachments_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments/post response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_delete: - operation: + _organizations_envgroups_attachments_list: + operation: &ref_21 $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/delete - response: + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments/get + response: &ref_22 mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_list: + objectKey: $.environmentGroupAttachments + organizations_envgroups_attachments_list: + operation: *ref_21 + response: *ref_22 + organizations_instances_attachments_get: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apiproducts/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments~1{attachmentsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_create: + organizations_instances_attachments_delete: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apiproducts/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments~1{attachmentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_attributes: - operation: + _organizations_instances_attachments_list: + operation: &ref_23 $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes/post - response: + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments/get + response: &ref_24 mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_keys_apiproducts_delete: + objectKey: $.attachments + organizations_instances_attachments_list: + operation: *ref_23 + response: *ref_24 + organizations_instances_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}~1instances~1{instancesId}~1attachments/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_get + #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_get - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_list + #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_get + - $ref: >- + #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_list + - $ref: >- + #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_list insert: - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_create + #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_create + - $ref: >- + #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_create update: [] delete: - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_appgroups_apps_keys_apiproducts_delete + #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_delete - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_delete + #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_delete + operations: + id: google.apigee.operations + name: operations + title: Operations + methods: + _organizations_operations_list: + operation: &ref_25 + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1operations/get' + response: &ref_26 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + organizations_operations_list: + operation: *ref_25 + response: *ref_26 + organizations_operations_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_developers_apps_keys_apiproducts_delete - apiproducts_app_group_app_key_api_product: - id: apigee.apiproducts_app_group_app_key_api_product - name: apiproducts_app_group_app_key_api_product - title: Apiproducts_app_group_app_key_api_product + #/components/x-stackQL-resources/operations/methods/organizations_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/organizations_operations_list + insert: [] + update: [] + delete: [] + revisions_deployments: + id: google.apigee.revisions_deployments + name: revisions_deployments + title: Revisions_deployments methods: - organizations_appgroups_apps_keys_apiproducts_update_app_group_app_key_api_product: + organizations_environments_sharedflows_revisions_get_deployments: 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}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/get + response: + mediaType: application/json + openAPIDocKey: '200' + 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' sqlVerbs: - select: [] + 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 insert: [] update: [] delete: [] - keys: - id: apigee.keys - name: keys - title: Keys + archive_deployments: + id: google.apigee.archive_deployments + name: archive_deployments + title: Archive_deployments methods: - organizations_appgroups_apps_keys_create: + organizations_environments_archive_deployments_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_archive_deployments_delete: + operation: + $ref: >- + #/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_create: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments/post response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_keys_delete: + _organizations_environments_archive_deployments_list: + operation: &ref_27 + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments/get + response: &ref_28 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.archiveDeployments + organizations_environments_archive_deployments_list: + operation: *ref_27 + response: *ref_28 + organizations_environments_archive_deployments_generate_upload_url: 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}~1archiveDeployments:generateUploadUrl/post response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_keys_get: + organizations_environments_archive_deployments_generate_download_url: 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}~1archiveDeployments~1{archiveDeploymentsId}:generateDownloadUrl/post response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_keys_replace_developer_app_key: + 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 + 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_references_get: 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}~1references~1{referencesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_keys_get: + organizations_environments_references_delete: 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}~1references~1{referencesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_keys_delete: + organizations_environments_references_update: 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}~1references~1{referencesId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_keys_create: + organizations_environments_references_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references/post 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 + #/components/x-stackQL-resources/references/methods/organizations_environments_references_get insert: - $ref: >- - #/components/x-stackQL-resources/keys/methods/organizations_appgroups_apps_keys_create + #/components/x-stackQL-resources/references/methods/organizations_environments_references_create + update: - $ref: >- - #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_create - update: [] + #/components/x-stackQL-resources/references/methods/organizations_environments_references_update 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: apigee.keys_app_group_app_key - name: keys_app_group_app_key - title: Keys_app_group_app_key + #/components/x-stackQL-resources/references/methods/organizations_environments_references_delete + admin_schemav2: + id: google.apigee.admin_schemav2 + name: admin_schemav2 + title: Admin_schemav2 methods: - organizations_appgroups_apps_keys_update_app_group_app_key: + organizations_environments_analytics_admin_get_schemav2: 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}~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: [] delete: [] - apps: - id: apigee.apps - name: apps - title: Apps + exports: + id: google.apigee.exports + name: exports + title: Exports methods: - organizations_appgroups_apps_delete: + organizations_environments_analytics_exports_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1exports~1{exportsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_get: + organizations_environments_analytics_exports_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1exports/get response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_update: + organizations_environments_analytics_exports_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1exports/post response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_create: + 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: [] + delete: [] + flowhooks: + id: google.apigee.flowhooks + name: flowhooks + title: Flowhooks + methods: + organizations_environments_flowhooks_attach_shared_flow_to_flow_hook: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps/post - response: - mediaType: application/json - openAPIDocKey: '200' - _organizations_appgroups_apps_list: - operation: &ref_31 - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps/get - response: &ref_32 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.appGroupApps - organizations_appgroups_apps_list: - operation: *ref_31 - response: *ref_32 - _organizations_apps_list: - operation: &ref_33 - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apps/get' - response: &ref_34 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.app - organizations_apps_list: - operation: *ref_33 - response: *ref_34 - organizations_apps_get: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apps~1{appsId}/get' + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_attributes: + organizations_environments_flowhooks_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_list: + organizations_environments_flowhooks_detach_shared_flow_from_flow_hook: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_create: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/flowhooks/methods/organizations_environments_flowhooks_get + insert: [] + update: [] + delete: [] + caches: + id: google.apigee.caches + name: caches + title: Caches + methods: + organizations_environments_caches_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1caches~1{cachesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_update: + sqlVerbs: + select: [] + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/caches/methods/organizations_environments_caches_delete + security_incidents: + id: google.apigee.security_incidents + name: security_incidents + title: Security_incidents + methods: + organizations_environments_security_incidents_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents~1{securityIncidentsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_get: + organizations_environments_security_incidents_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents~1{securityIncidentsId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_delete: + organizations_environments_security_incidents_batch_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents:batchUpdate/post response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_generate_key_pair_or_update_developer_app_status: - operation: + _organizations_environments_security_incidents_list: + operation: &ref_29 $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/post - response: + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents/get + response: &ref_30 mediaType: application/json openAPIDocKey: '200' + objectKey: $.securityIncidents + organizations_environments_security_incidents_list: + operation: *ref_29 + response: *ref_30 sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_get - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_list - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_apps_list - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_apps_get - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_list - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_get - insert: - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_create - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_create - update: [] - delete: + #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_get - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_delete + #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_list + insert: [] + update: - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_delete - security_profiles: - id: apigee.security_profiles - name: security_profiles - title: Security_profiles + #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_patch + delete: [] + optimized_stats: + id: google.apigee.optimized_stats + name: optimized_stats + title: Optimized_stats methods: - organizations_security_profiles_get: + organizations_environments_optimized_stats_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1optimizedStats~1{optimizedStatsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_security_profiles_patch: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/optimized_stats/methods/organizations_environments_optimized_stats_get + insert: [] + update: [] + delete: [] + queries: + id: google.apigee.queries + name: queries + title: Queries + methods: + organizations_environments_queries_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries/get response: mediaType: application/json openAPIDocKey: '200' - organizations_security_profiles_delete: + organizations_environments_queries_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries/post response: mediaType: application/json openAPIDocKey: '200' - _organizations_security_profiles_list: - operation: &ref_35 - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles/get - response: &ref_36 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.securityProfiles - organizations_security_profiles_list: - operation: *ref_35 - response: *ref_36 - organizations_security_profiles_create: + organizations_environments_queries_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries~1{queriesId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_get + #/components/x-stackQL-resources/queries/methods/organizations_environments_queries_get - $ref: >- - #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_list + #/components/x-stackQL-resources/queries/methods/organizations_environments_queries_list insert: - $ref: >- - #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_create + #/components/x-stackQL-resources/queries/methods/organizations_environments_queries_create update: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_delete - security_profiles_revisions: - id: apigee.security_profiles_revisions - name: security_profiles_revisions - title: Security_profiles_revisions + delete: [] + queries_resulturl: + id: google.apigee.queries_resulturl + name: queries_resulturl + title: Queries_resulturl methods: - _organizations_security_profiles_list_revisions: - operation: &ref_37 + organizations_environments_queries_get_resulturl: + operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}:listRevisions/get - response: &ref_38 + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries~1{queriesId}~1resulturl/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.securityProfiles - organizations_security_profiles_list_revisions: - operation: *ref_37 - response: *ref_38 sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/security_profiles_revisions/methods/organizations_security_profiles_list_revisions + #/components/x-stackQL-resources/queries_resulturl/methods/organizations_environments_queries_get_resulturl insert: [] update: [] delete: [] - apis: - id: apigee.apis - name: apis - title: Apis + queries_result: + id: google.apigee.queries_result + name: queries_result + title: Queries_result methods: - organizations_apis_delete: + organizations_environments_queries_get_result: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries~1{queriesId}~1result/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_patch: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/queries_result/methods/organizations_environments_queries_get_result + insert: [] + update: [] + delete: [] + security_reports: + id: google.apigee.security_reports + name: security_reports + title: Security_reports + methods: + organizations_environments_security_reports_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_apis_get: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/get' + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports~1{securityReportsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_create: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis/post' - response: + _organizations_environments_security_reports_list: + operation: &ref_31 + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports/get + response: &ref_32 mediaType: application/json openAPIDocKey: '200' - organizations_apis_list: + objectKey: $.securityReports + organizations_environments_security_reports_list: + operation: *ref_31 + response: *ref_32 + organizations_environments_security_reports_create: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/apis/methods/organizations_apis_get + #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_get - $ref: >- - #/components/x-stackQL-resources/apis/methods/organizations_apis_list + #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_list insert: - $ref: >- - #/components/x-stackQL-resources/apis/methods/organizations_apis_create + #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_create update: [] - delete: + 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: + operation: + $ref: >- + #/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/apis/methods/organizations_apis_delete - revisions_api_proxy_revision: - id: apigee.revisions_api_proxy_revision - name: revisions_api_proxy_revision - title: Revisions_api_proxy_revision + #/components/x-stackQL-resources/security_reports_result_view/methods/organizations_environments_security_reports_get_result_view + insert: [] + update: [] + delete: [] + security_reports_result: + id: google.apigee.security_reports_result + name: security_reports_result + title: Security_reports_result methods: - organizations_apis_revisions_update_api_proxy_revision: + organizations_environments_security_reports_get_result: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports~1{securityReportsId}~1result/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/security_reports_result/methods/organizations_environments_security_reports_get_result insert: [] update: [] delete: [] - security_assessment_results: - id: apigee.security_assessment_results - name: security_assessment_results - title: Security_assessment_results + addons_config: + id: google.apigee.addons_config + name: addons_config + title: Addons_config methods: - organizations_security_assessment_results_batch_compute: + organizations_environments_addons_config_set_addon_enablement: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityAssessmentResults:batchCompute/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1addonsConfig:setAddonEnablement/post response: mediaType: application/json openAPIDocKey: '200' @@ -11388,232 +11184,311 @@ components: insert: [] update: [] delete: [] - host_queries: - id: apigee.host_queries - name: host_queries - title: Host_queries + security_actions: + id: google.apigee.security_actions + name: security_actions + title: Security_actions methods: - organizations_host_queries_list: + _organizations_environments_security_actions_list: + operation: &ref_33 + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions/get + response: &ref_34 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.securityActions + organizations_environments_security_actions_list: + operation: *ref_33 + response: *ref_34 + organizations_environments_security_actions_create: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1hostQueries/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions/post response: mediaType: application/json openAPIDocKey: '200' - organizations_host_queries_create: + organizations_environments_security_actions_get: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1hostQueries/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_host_queries_get: + organizations_environments_security_actions_disable: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostQueries~1{hostQueriesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}:disable/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_security_actions_enable: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}:enable/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_list + #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_get - $ref: >- - #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_get + #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_list insert: - $ref: >- - #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_create + #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_create update: [] delete: [] - host_queries_result: - id: apigee.host_queries_result - name: host_queries_result - title: Host_queries_result + data: + id: google.apigee.data + name: data + title: Data methods: - organizations_host_queries_get_result: + organizations_environments_apis_revisions_debugsessions_data_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostQueries~1{hostQueriesId}~1result/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' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/host_queries_result/methods/organizations_host_queries_get_result + #/components/x-stackQL-resources/data/methods/organizations_environments_apis_revisions_debugsessions_data_get insert: [] update: [] delete: [] - host_queries_result_view: - id: apigee.host_queries_result_view - name: host_queries_result_view - title: Host_queries_result_view + debugsessions_data: + id: google.apigee.debugsessions_data + name: debugsessions_data + title: Debugsessions_data methods: - organizations_host_queries_get_result_view: + organizations_environments_apis_revisions_debugsessions_delete_data: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostQueries~1{hostQueriesId}~1resultView/get + #/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' + sqlVerbs: + select: [] + insert: [] + update: [] + 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_35 + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions/get + response: &ref_36 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.sessions + organizations_environments_apis_revisions_debugsessions_list: + operation: *ref_35 + response: *ref_36 + organizations_environments_apis_revisions_debugsessions_create: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_apis_revisions_debugsessions_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions~1{debugsessionsId}/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 - insert: [] + #/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: [] delete: [] - attributes: - id: apigee.attributes - name: attributes - title: Attributes + targetservers: + id: google.apigee.targetservers + name: targetservers + title: Targetservers methods: - organizations_apiproducts_attributes_list: + organizations_environments_targetservers_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers/post response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_attributes_delete: + organizations_environments_targetservers_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_attributes_get: + organizations_environments_targetservers_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_attributes_list: + organizations_environments_targetservers_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_attributes_get: + 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: + - $ref: >- + #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_update + delete: + - $ref: >- + #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_delete + aliases: + id: google.apigee.aliases + name: aliases + title: Aliases + methods: + organizations_environments_keystores_aliases_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes~1{attributesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_attributes_delete: + organizations_environments_keystores_aliases_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes~1{attributesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_attributes_list: + organizations_environments_keystores_aliases_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_attributes_get: + organizations_environments_keystores_aliases_csr: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes~1{attributesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}~1csr/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_attributes_delete: + organizations_environments_keystores_aliases_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes~1{attributesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_apiproducts_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_developers_apps_attributes_get + #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_get + insert: - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_developers_apps_attributes_list + #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_create + update: - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_developers_attributes_get - insert: [] - update: [] + #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_update delete: - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_apiproducts_attributes_delete - - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_developers_apps_attributes_delete - - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_developers_attributes_delete - rateplans: - id: apigee.rateplans - name: rateplans - title: Rateplans + #/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_apiproducts_rateplans_update: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans~1{rateplansId}/put - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_apiproducts_rateplans_delete: + organizations_environments_keystores_aliases_get_certificate: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans~1{rateplansId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}~1certificate/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_rateplans_get: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/aliases_certificate/methods/organizations_environments_keystores_aliases_get_certificate + insert: [] + update: [] + delete: [] + keystores: + id: google.apigee.keystores + name: keystores + title: Keystores + methods: + organizations_environments_keystores_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans~1{rateplansId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_rateplans_list: + organizations_environments_keystores_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_rateplans_create: + organizations_environments_keystores_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_get - - $ref: >- - #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_list + #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_get insert: - $ref: >- - #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_create + #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_create update: [] delete: - $ref: >- - #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_delete - attributes_api_product_attribute: - id: apigee.attributes_api_product_attribute - name: attributes_api_product_attribute - title: Attributes_api_product_attribute + #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_delete + security_stats: + id: google.apigee.security_stats + name: security_stats + title: Security_stats methods: - organizations_apiproducts_attributes_update_api_product_attribute: + organizations_environments_security_stats_query_time_series_stats: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityStats:queryTimeSeriesStats/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_security_stats_query_tabular_stats: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityStats:queryTabularStats/post response: mediaType: application/json openAPIDocKey: '200' @@ -11622,241 +11497,356 @@ components: insert: [] update: [] delete: [] - optimized_host_stats: - id: apigee.optimized_host_stats - name: optimized_host_stats - title: Optimized_host_stats + stats: + id: google.apigee.stats + name: stats + title: Stats methods: - organizations_optimized_host_stats_get: + organizations_environments_stats_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1optimizedHostStats~1{optimizedHostStatsId}/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/optimized_host_stats/methods/organizations_optimized_host_stats_get + #/components/x-stackQL-resources/stats/methods/organizations_environments_stats_get insert: [] update: [] delete: [] - developers: - id: apigee.developers - name: developers - title: Developers + overrides: + id: google.apigee.overrides + name: overrides + title: Overrides methods: - organizations_developers_delete: + organizations_environments_trace_config_overrides_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides/post response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_get: + _organizations_environments_trace_config_overrides_list: + operation: &ref_37 + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides/get + response: &ref_38 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.traceConfigOverrides + organizations_environments_trace_config_overrides_list: + operation: *ref_37 + response: *ref_38 + organizations_environments_trace_config_overrides_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_set_developer_status: + organizations_environments_trace_config_overrides_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_update: + organizations_environments_trace_config_overrides_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_attributes: + 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 + 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 + 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_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}~1{name}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_list: + organizations_environments_resourcefiles_get: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1developers/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}~1{name}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_create: + organizations_environments_resourcefiles_delete: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}~1{name}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_resourcefiles_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_resourcefiles_create: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_get + - $ref: >- + #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_list + insert: + - $ref: >- + #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_create + update: + - $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 + methods: + organizations_environments_resourcefiles_list_environment_resources: + operation: + $ref: >- + #/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/resourcefiles_environment_resources/methods/organizations_environments_resourcefiles_list_environment_resources + insert: [] + update: [] + 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}~1developers/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/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/developers/methods/organizations_developers_create + select: [] + insert: [] update: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/developers/methods/organizations_developers_delete - developers_monetization_config: - id: apigee.developers_monetization_config - name: developers_monetization_config - title: Developers_monetization_config + delete: [] + environments_iam_policies: + id: google.apigee.environments_iam_policies + name: environments_iam_policies + title: Environments_iam_policies methods: - organizations_developers_get_monetization_config: + organizations_environments_test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1monetizationConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_update_monetization_config: + _organizations_environments_get_iam_policy: + operation: &ref_39 + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:getIamPolicy/get + response: &ref_40 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + organizations_environments_get_iam_policy: + operation: *ref_39 + response: *ref_40 + organizations_environments_set_iam_policy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1monetizationConfig/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/developers_monetization_config/methods/organizations_developers_get_monetization_config + #/components/x-stackQL-resources/environments_iam_policies/methods/organizations_environments_get_iam_policy insert: [] update: [] delete: [] - developers_balance: - id: apigee.developers_balance - name: developers_balance - title: Developers_balance + environments_debugmask: + id: google.apigee.environments_debugmask + name: environments_debugmask + title: Environments_debugmask methods: - organizations_developers_get_balance: + organizations_environments_get_debugmask: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1balance/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1debugmask/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_update_debugmask: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1debugmask/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/developers_balance/methods/organizations_developers_get_balance + #/components/x-stackQL-resources/environments_debugmask/methods/organizations_environments_get_debugmask insert: [] update: [] delete: [] - subscriptions: - id: apigee.subscriptions - name: subscriptions - title: Subscriptions + environments_trace_config: + id: google.apigee.environments_trace_config + name: environments_trace_config + title: Environments_trace_config methods: - organizations_developers_subscriptions_get: + organizations_environments_update_trace_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions~1{subscriptionsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_subscriptions_expire: + organizations_environments_get_trace_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions~1{subscriptionsId}:expire/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_subscriptions_create: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/environments_trace_config/methods/organizations_environments_get_trace_config + insert: [] + update: [] + 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}~1developers~1{developersId}~1subscriptions/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActionsConfig/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_subscriptions_list: + organizations_environments_update_security_actions_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActionsConfig/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: - - $ref: >- - #/components/x-stackQL-resources/subscriptions/methods/organizations_developers_subscriptions_create + #/components/x-stackQL-resources/environments_security_actions_config/methods/organizations_environments_get_security_actions_config + insert: [] update: [] delete: [] - apiproducts_developer_app_key_api_product: - id: apigee.apiproducts_developer_app_key_api_product - name: apiproducts_developer_app_key_api_product - title: Apiproducts_developer_app_key_api_product + 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_developers_apps_keys_apiproducts_update_developer_app_key_api_product: + organizations_environments_get_api_security_runtime_config: 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}~1environments~1{environmentsId}~1apiSecurityRuntimeConfig/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/environments_api_security_runtime_config/methods/organizations_environments_get_api_security_runtime_config insert: [] update: [] delete: [] - create: - id: apigee.create - name: create - title: Create + environments_deployed_config: + id: google.apigee.environments_deployed_config + name: environments_deployed_config + title: Environments_deployed_config methods: - organizations_developers_apps_keys_create_create: + organizations_environments_get_deployed_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1create/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployedConfig/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: + select: - $ref: >- - #/components/x-stackQL-resources/create/methods/organizations_developers_apps_keys_create_create + #/components/x-stackQL-resources/environments_deployed_config/methods/organizations_environments_get_deployed_config + insert: [] update: [] delete: [] - keys_developer_app_key: - id: apigee.keys_developer_app_key - name: keys_developer_app_key - title: Keys_developer_app_key + environments_addons_config: + id: google.apigee.environments_addons_config + name: environments_addons_config + title: Environments_addons_config methods: - organizations_developers_apps_keys_update_developer_app_key: + organizations_environments_get_addons_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1addonsConfig/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/environments_addons_config/methods/organizations_environments_get_addons_config insert: [] update: [] delete: [] - attributes_developer_app_attribute: - id: apigee.attributes_developer_app_attribute - name: attributes_developer_app_attribute - title: Attributes_developer_app_attribute + security_assessment_results: + id: google.apigee.security_assessment_results + name: security_assessment_results + title: Security_assessment_results methods: - organizations_developers_apps_attributes_update_developer_app_attribute: + organizations_security_assessment_results_batch_compute: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes~1{attributesId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1securityAssessmentResults:batchCompute/post response: mediaType: application/json openAPIDocKey: '200' @@ -11865,325 +11855,346 @@ components: insert: [] update: [] delete: [] - attributes_developer_attribute: - id: apigee.attributes_developer_attribute - name: attributes_developer_attribute - title: Attributes_developer_attribute + apicategories: + id: google.apigee.apicategories + name: apicategories + title: Apicategories methods: - organizations_developers_attributes_update_developer_attribute: + organizations_sites_apicategories_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes~1{attributesId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - balance: - id: apigee.balance - name: balance - title: Balance - methods: - organizations_developers_balance_credit: + organizations_sites_apicategories_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1balance:credit/post + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_balance_adjust: + organizations_sites_apicategories_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1balance:adjust/post + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/patch response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - endpoint_attachments: - id: apigee.endpoint_attachments - name: endpoint_attachments - title: Endpoint_attachments - methods: - organizations_endpoint_attachments_delete: + organizations_sites_apicategories_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments~1{endpointAttachmentsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_endpoint_attachments_get: + organizations_sites_apicategories_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments~1{endpointAttachmentsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_endpoint_attachments_create: + 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 + delete: + - $ref: >- + #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_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}~1endpointAttachments/post + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}~1documentation/get response: mediaType: application/json openAPIDocKey: '200' - _organizations_endpoint_attachments_list: - operation: &ref_39 + organizations_sites_apidocs_update_documentation: + operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments/get - response: &ref_40 + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}~1documentation/patch + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.endpointAttachments - organizations_endpoint_attachments_list: - operation: *ref_39 - response: *ref_40 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 + #/components/x-stackQL-resources/apidocs_documentation/methods/organizations_sites_apidocs_get_documentation + insert: [] update: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_delete - attachments: - id: apigee.attachments - name: attachments - title: Attachments + delete: [] + apidocs: + id: google.apigee.apidocs + name: apidocs + title: Apidocs methods: - organizations_envgroups_attachments_delete: + organizations_sites_apidocs_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments~1{attachmentsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_envgroups_attachments_get: + organizations_sites_apidocs_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments~1{attachmentsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}/put response: mediaType: application/json openAPIDocKey: '200' - _organizations_envgroups_attachments_list: + 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_41 $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments/get + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs/get response: &ref_42 mediaType: application/json openAPIDocKey: '200' - objectKey: $.environmentGroupAttachments - organizations_envgroups_attachments_list: + objectKey: $.data + organizations_sites_apidocs_list: operation: *ref_41 response: *ref_42 - organizations_envgroups_attachments_create: + organizations_sites_apidocs_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments/post + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs/post response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_attachments_delete: + 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: + - $ref: >- + #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_update + delete: + - $ref: >- + #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_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: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments~1{attachmentsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}~1resultView/get response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_attachments_get: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/host_security_reports_result_view/methods/organizations_host_security_reports_get_result_view + insert: [] + update: [] + delete: [] + host_security_reports: + id: google.apigee.host_security_reports + name: host_security_reports + title: Host_security_reports + methods: + organizations_host_security_reports_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments~1{attachmentsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_attachments_create: + organizations_host_security_reports_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments/post + #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports/post response: mediaType: application/json openAPIDocKey: '200' - _organizations_instances_attachments_list: + _organizations_host_security_reports_list: operation: &ref_43 $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments/get + #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports/get response: &ref_44 mediaType: application/json openAPIDocKey: '200' - objectKey: $.attachments - organizations_instances_attachments_list: + objectKey: $.securityReports + organizations_host_security_reports_list: operation: *ref_43 response: *ref_44 sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_get - - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_list - - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_get + #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_get - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_list + #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_list insert: - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_create - - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_create + #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_create update: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_delete - - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_delete - envgroups: - id: apigee.envgroups - name: envgroups - title: Envgroups + delete: [] + host_security_reports_result: + id: google.apigee.host_security_reports_result + name: host_security_reports_result + title: Host_security_reports_result methods: - _organizations_envgroups_list: - operation: &ref_45 - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1envgroups/get' - response: &ref_46 + organizations_host_security_reports_get_result: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}~1result/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.environmentGroups - organizations_envgroups_list: - operation: *ref_45 - response: *ref_46 - organizations_envgroups_create: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/host_security_reports_result/methods/organizations_host_security_reports_get_result + insert: [] + update: [] + delete: [] + datacollectors: + id: google.apigee.datacollectors + name: datacollectors + title: Datacollectors + methods: + organizations_datacollectors_get: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1envgroups/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_envgroups_get: + organizations_datacollectors_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_envgroups_patch: + organizations_datacollectors_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_envgroups_delete: + _organizations_datacollectors_list: + operation: &ref_45 + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1datacollectors/get' + response: &ref_46 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.dataCollectors + organizations_datacollectors_list: + operation: *ref_45 + response: *ref_46 + organizations_datacollectors_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_list + #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_get - $ref: >- - #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_get + #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_list insert: - $ref: >- - #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_create - update: [] + #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_create + update: + - $ref: >- + #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_patch delete: - $ref: >- - #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_delete - envgroups_deployed_ingress_config: - id: apigee.envgroups_deployed_ingress_config - name: envgroups_deployed_ingress_config - title: Envgroups_deployed_ingress_config + #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_delete + revisions_shared_flow_revision: + id: google.apigee.revisions_shared_flow_revision + name: revisions_shared_flow_revision + title: Revisions_shared_flow_revision methods: - organizations_envgroups_get_deployed_ingress_config: + organizations_sharedflows_revisions_update_shared_flow_revision: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1deployedIngressConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/envgroups_deployed_ingress_config/methods/organizations_envgroups_get_deployed_ingress_config + select: [] insert: [] update: [] delete: [] - instances: - id: apigee.instances - name: instances - title: Instances + sharedflows: + id: google.apigee.sharedflows + name: sharedflows + title: Sharedflows methods: - organizations_instances_delete: + organizations_sharedflows_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/delete + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1sharedflows/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_get: + organizations_sharedflows_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1sharedflows/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_patch: + organizations_sharedflows_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - _organizations_instances_list: - operation: &ref_47 - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1instances/get' - response: &ref_48 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.instances - organizations_instances_list: - operation: *ref_47 - response: *ref_48 - organizations_instances_create: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1instances/post' + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_report_status: + 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' 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 + #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_create update: [] delete: - $ref: >- - #/components/x-stackQL-resources/instances/methods/organizations_instances_delete + #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_delete canaryevaluations: - id: apigee.canaryevaluations + id: google.apigee.canaryevaluations name: canaryevaluations title: Canaryevaluations methods: @@ -12211,28 +12222,24 @@ components: update: [] delete: [] nat_addresses: - id: apigee.nat_addresses + id: google.apigee.nat_addresses name: nat_addresses title: Nat_addresses methods: - organizations_instances_nat_addresses_create: + organizations_instances_nat_addresses_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses/post + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses~1{natAddressesId}/delete response: mediaType: application/json openAPIDocKey: '200' - _organizations_instances_nat_addresses_list: - operation: &ref_49 + organizations_instances_nat_addresses_get: + operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses/get - response: &ref_50 + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses~1{natAddressesId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.natAddresses - organizations_instances_nat_addresses_list: - operation: *ref_49 - response: *ref_50 organizations_instances_nat_addresses_activate: operation: $ref: >- @@ -12240,26 +12247,30 @@ components: response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_nat_addresses_get: - operation: + _organizations_instances_nat_addresses_list: + operation: &ref_47 $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses~1{natAddressesId}/get - response: + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses/get + response: &ref_48 mediaType: application/json openAPIDocKey: '200' - organizations_instances_nat_addresses_delete: + objectKey: $.natAddresses + organizations_instances_nat_addresses_list: + operation: *ref_47 + response: *ref_48 + organizations_instances_nat_addresses_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses~1{natAddressesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/nat_addresses/methods/organizations_instances_nat_addresses_list - $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 @@ -12267,154 +12278,152 @@ components: delete: - $ref: >- #/components/x-stackQL-resources/nat_addresses/methods/organizations_instances_nat_addresses_delete - datastores: - id: apigee.datastores - name: datastores - title: Datastores + instances: + id: google.apigee.instances + name: instances + title: Instances methods: - organizations_analytics_datastores_create: + organizations_instances_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores/post + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_analytics_datastores_list: + organizations_instances_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores/get + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_analytics_datastores_test: + organizations_instances_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores:test/post + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_analytics_datastores_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores~1{datastoresId}/get - response: + _organizations_instances_list: + operation: &ref_49 + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1instances/get' + response: &ref_50 mediaType: application/json openAPIDocKey: '200' - organizations_analytics_datastores_update: + objectKey: $.instances + organizations_instances_list: + operation: *ref_49 + response: *ref_50 + organizations_instances_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores~1{datastoresId}/put + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1instances/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_analytics_datastores_delete: + organizations_instances_report_status: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores~1{datastoresId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}:reportStatus/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_list + #/components/x-stackQL-resources/instances/methods/organizations_instances_get - $ref: >- - #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_get + #/components/x-stackQL-resources/instances/methods/organizations_instances_list insert: - $ref: >- - #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_create - update: [] + #/components/x-stackQL-resources/instances/methods/organizations_instances_create + update: + - $ref: >- + #/components/x-stackQL-resources/instances/methods/organizations_instances_patch delete: - $ref: >- - #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_delete - sync_authorization: - id: apigee.sync_authorization - name: sync_authorization - title: Sync_authorization + #/components/x-stackQL-resources/instances/methods/organizations_instances_delete + optimized_host_stats: + id: google.apigee.optimized_host_stats + name: optimized_host_stats + title: Optimized_host_stats methods: - organizations_get_sync_authorization: + organizations_optimized_host_stats_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}:getSyncAuthorization/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: [] delete: [] - security_settings: - id: apigee.security_settings - name: security_settings - title: Security_settings + runtime_config: + id: google.apigee.runtime_config + name: runtime_config + title: Runtime_config methods: - organizations_get_security_settings: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securitySettings/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_update_security_settings: + organizations_get_runtime_config: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securitySettings/patch + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1runtimeConfig/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/security_settings/methods/organizations_get_security_settings + #/components/x-stackQL-resources/runtime_config/methods/organizations_get_runtime_config insert: [] update: [] delete: [] organizations: - id: apigee.organizations + id: google.apigee.organizations name: organizations title: Organizations methods: - organizations_get: + organizations_list: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}/get' + $ref: '#/paths/~1v1~1organizations/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_update: + organizations_create: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}/put' + $ref: '#/paths/~1v1~1organizations/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_delete: + organizations_set_sync_authorization: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}/delete' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}:setSyncAuthorization/post response: mediaType: application/json openAPIDocKey: '200' - organizations_set_addons: + organizations_update: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}:setAddons/post' + $ref: '#/paths/~1v1~1organizations~1{organizationsId}/put' response: mediaType: application/json openAPIDocKey: '200' - organizations_create: + organizations_get: operation: - $ref: '#/paths/~1v1~1organizations/post' + $ref: '#/paths/~1v1~1organizations~1{organizationsId}/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_list: + organizations_delete: operation: - $ref: '#/paths/~1v1~1organizations/get' + $ref: '#/paths/~1v1~1organizations~1{organizationsId}/delete' response: mediaType: application/json openAPIDocKey: '200' - organizations_set_sync_authorization: + organizations_set_addons: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}:setSyncAuthorization/post + $ref: '#/paths/~1v1~1organizations~1{organizationsId}:setAddons/post' response: mediaType: application/json openAPIDocKey: '200' @@ -12427,49 +12436,76 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/organizations/methods/organizations_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/organizations/methods/organizations_update delete: - $ref: >- #/components/x-stackQL-resources/organizations/methods/organizations_delete - runtime_config: - id: apigee.runtime_config - name: runtime_config - title: Runtime_config + deployed_ingress_config: + id: google.apigee.deployed_ingress_config + name: deployed_ingress_config + title: Deployed_ingress_config methods: - organizations_get_runtime_config: + organizations_get_deployed_ingress_config: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1runtimeConfig/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1deployedIngressConfig/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/runtime_config/methods/organizations_get_runtime_config + #/components/x-stackQL-resources/deployed_ingress_config/methods/organizations_get_deployed_ingress_config insert: [] update: [] delete: [] - deployed_ingress_config: - id: apigee.deployed_ingress_config - name: deployed_ingress_config - title: Deployed_ingress_config + security_settings: + id: google.apigee.security_settings + name: security_settings + title: Security_settings methods: - organizations_get_deployed_ingress_config: + organizations_update_security_settings: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1deployedIngressConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1securitySettings/patch + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_get_security_settings: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1securitySettings/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/deployed_ingress_config/methods/organizations_get_deployed_ingress_config + #/components/x-stackQL-resources/security_settings/methods/organizations_get_security_settings + insert: [] + update: [] + delete: [] + sync_authorization: + id: google.apigee.sync_authorization + name: sync_authorization + title: Sync_authorization + methods: + organizations_get_sync_authorization: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}:getSyncAuthorization/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] insert: [] update: [] delete: [] project_mapping: - id: apigee.project_mapping + id: google.apigee.project_mapping name: project_mapping title: Project_mapping methods: @@ -12487,8 +12523,26 @@ components: insert: [] update: [] delete: [] + issuers: + id: google.apigee.issuers + name: issuers + title: Issuers + methods: + hybrid_issuers_list: + operation: + $ref: '#/paths/~1v1~1hybrid~1issuers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/issuers/methods/hybrid_issuers_list + insert: [] + update: [] + delete: [] projects: - id: apigee.projects + id: google.apigee.projects name: projects title: Projects methods: @@ -12504,76 +12558,25 @@ components: update: [] delete: [] paths: - /v1/hybrid/issuers: + /v1/organizations/{organizationsId}/apps: parameters: &ref_51 - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/callback' - 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_51 - 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 - delete: - description: Deletes an existing custom report definition - operationId: apigee.organizations.reports.delete + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/alt' + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12585,111 +12588,68 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeleteCustomReportResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1ListAppsResponse' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: reportsId - required: true + - in: query + name: status 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 + - in: query + name: pageToken schema: type: string - - in: path - name: reportsId - required: true + - in: query + name: startKey schema: type: string - /v1/organizations/{organizationsId}/reports: - parameters: *ref_51 - 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 + - in: query + name: includeCred + schema: + type: boolean + - in: query + name: ids + schema: + type: string + - in: query + name: rows schema: type: string + format: int64 - 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 + - in: query + name: filter schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/deployedConfig: + - in: query + name: apiProduct + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: apptype + schema: + type: string + - in: query + name: keyStatus + schema: + type: string + /v1/organizations/{organizationsId}/apps/{appsId}: parameters: *ref_51 get: - description: Gets the deployed configuration for an environment. - operationId: apigee.organizations.environments.getDeployedConfig + description: Gets the app profile for the specified app ID. + operationId: apigee.organizations.apps.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12701,7 +12661,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1App' parameters: - in: path name: organizationsId @@ -12709,18 +12669,15 @@ paths: schema: type: string - in: path - name: environmentsId + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apiSecurityRuntimeConfig: + /v1/organizations/{organizationsId}/deployments: parameters: *ref_51 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: Lists all deployments of API proxies or shared flows. + operationId: apigee.organizations.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12733,32 +12690,22 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ApiSecurityRuntimeConfig + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: sharedFlows schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}:testIamPermissions: + type: boolean + /v1/organizations/{organizationsId}/developers/{developersId}/attributes/{attributesId}: parameters: *ref_51 - 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/GoogleIamV1TestIamPermissionsRequest' + delete: + description: Deletes a developer attribute. + operationId: apigee.organizations.developers.attributes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12770,7 +12717,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -12778,50 +12725,29 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig: - parameters: *ref_51 - get: - description: Get distributed trace configuration in an environment. - operationId: apigee.organizations.environments.getTraceConfig - security: - - Oauth2: - - https://www.googleapis.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 + name: developersId required: true schema: type: string - in: path - name: environmentsId + name: attributesId required: true schema: type: string - 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 + 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/GoogleCloudApigeeV1TraceConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12833,64 +12759,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' 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 - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActionsConfig: - parameters: *ref_51 - get: - description: >- - GetSecurityActionConfig returns the current SecurityActions - configuration. - operationId: apigee.organizations.environments.getSecurityActionsConfig - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionsConfig' - parameters: + schema: + type: string - in: path - name: organizationsId + name: developersId required: true schema: type: string - in: path - name: environmentsId + name: attributesId required: true schema: type: string - 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' + 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 @@ -12902,7 +12790,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionsConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -12910,31 +12798,20 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: attributesId + required: true schema: type: string - format: google-fieldmask - /v1/organizations/{organizationsId}/environments/{environmentsId}: + /v1/organizations/{organizationsId}/developers/{developersId}/attributes: parameters: *ref_51 - 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' + get: + description: Returns a list of all developer attributes. + operationId: apigee.organizations.developers.attributes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12946,7 +12823,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' parameters: - in: path name: organizationsId @@ -12954,20 +12831,28 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - patch: + post: 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 + 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/GoogleCloudApigeeV1Environment' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12979,7 +12864,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' parameters: - in: path name: organizationsId @@ -12987,29 +12872,15 @@ 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 - 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/GoogleCloudApigeeV1Environment' + /v1/organizations/{organizationsId}/developers/{developersId}/subscriptions/{subscriptionsId}: + parameters: *ref_51 + get: + description: Gets details for an API product subscription. + operationId: apigee.organizations.developers.subscriptions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13021,7 +12892,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' parameters: - in: path name: organizationsId @@ -13029,17 +12900,20 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - 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 + - in: path + name: subscriptionsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}/subscriptions: + parameters: *ref_51 + get: + description: Lists all API product subscriptions for a developer. + operationId: apigee.organizations.developers.subscriptions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13051,7 +12925,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse parameters: - in: path name: organizationsId @@ -13059,13 +12934,27 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - get: - description: Gets environment details. - operationId: apigee.organizations.environments.get + - in: query + name: startKey + schema: + type: string + - in: query + name: count + schema: + type: integer + format: int32 + 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 @@ -13077,7 +12966,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' parameters: - in: path name: organizationsId @@ -13085,20 +12974,21 @@ 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/{developersId}/subscriptions/{subscriptionsId}:expire: parameters: *ref_51 post: - description: Deletes a subscription for the environment's Pub/Sub topic. - operationId: apigee.organizations.environments.unsubscribe + description: Expires an API product subscription immediately. + operationId: apigee.organizations.developers.subscriptions.expire requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Subscription' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13110,7 +13000,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' parameters: - in: path name: organizationsId @@ -13118,18 +13008,26 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}:subscribe: + - in: path + name: subscriptionsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}/balance:credit: parameters: *ref_51 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 + 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 @@ -13141,7 +13039,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Subscription' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalance' parameters: - in: path name: organizationsId @@ -13149,26 +13047,23 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}:setIamPolicy: + /v1/organizations/{organizationsId}/developers/{developersId}/balance:adjust: parameters: *ref_51 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 + 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/GoogleIamV1SetIamPolicyRequest' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1AdjustDeveloperBalanceRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13180,7 +13075,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalance' parameters: - in: path name: organizationsId @@ -13188,20 +13083,19 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/debugmask: + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}: parameters: *ref_51 - 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' + 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 @@ -13213,7 +13107,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' parameters: - in: path name: organizationsId @@ -13221,22 +13115,49 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: appsId + required: true schema: type: string - format: google-fieldmask - - in: query - name: replaceRepeatedFields - schema: - type: boolean - get: - description: Gets the debug mask singleton resource for an environment. - operationId: apigee.organizations.environments.getDebugmask + 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 @@ -13248,7 +13169,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' parameters: - in: path name: organizationsId @@ -13256,20 +13177,37 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments: - parameters: *ref_51 - post: - description: Creates an environment in an organization. - operationId: apigee.organizations.environments.create + - in: path + name: appsId + required: true + schema: + type: string + - in: query + name: action + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13281,22 +13219,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: name + - in: path + name: developersId + required: true + schema: + type: string + - in: path + name: appsId + required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/addonsConfig: - parameters: *ref_51 get: - description: Gets the add-ons config of an environment. - operationId: apigee.organizations.environments.getAddonsConfig + description: Returns the details for a developer app. + operationId: apigee.organizations.developers.apps.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13308,7 +13250,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' parameters: - in: path name: organizationsId @@ -13316,20 +13258,33 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}:getIamPolicy: + - in: path + name: appsId + required: true + schema: + type: string + - in: query + name: query + schema: + type: string + - in: query + name: entity + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}/apps: parameters: *ref_51 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 + 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 @@ -13341,7 +13296,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeveloperAppsResponse parameters: - in: path name: organizationsId @@ -13349,26 +13305,41 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: query - name: options.requestedPolicyVersion + name: shallowExpand schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/environments/{environmentsId}/addonsConfig:setAddonEnablement: - parameters: *ref_51 + type: boolean + - in: query + name: count + schema: + type: string + format: int64 + - in: query + name: startKey + schema: + type: string + - in: query + name: expand + schema: + type: boolean post: - description: Updates an add-on enablement status of an environment. - operationId: apigee.organizations.environments.addonsConfig.setAddonEnablement + 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/GoogleCloudApigeeV1SetAddonEnablementRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13380,7 +13351,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' parameters: - in: path name: organizationsId @@ -13388,20 +13359,22 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents/{securityIncidentsId}: + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes: parameters: *ref_51 - patch: - description: UpdateSecurityIncidents updates an existing security incident. - operationId: apigee.organizations.environments.securityIncidents.patch + 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/GoogleCloudApigeeV1SecurityIncident' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13413,7 +13386,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' parameters: - in: path name: organizationsId @@ -13421,26 +13394,18 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: path - name: securityIncidentsId + name: appsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask get: - 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 + 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 @@ -13452,7 +13417,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' parameters: - in: path name: organizationsId @@ -13460,22 +13425,20 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: path - name: securityIncidentsId + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents: + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes/{attributesId}: parameters: *ref_51 - get: - description: >- - ListSecurityIncidents lists all the security incident associated with - the environment. - operationId: apigee.organizations.environments.securityIncidents.list + delete: + description: Deletes a developer app attribute. + operationId: apigee.organizations.developers.apps.attributes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13487,8 +13450,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSecurityIncidentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -13496,36 +13458,23 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: appsId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: attributesId + required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents:batchUpdate: - parameters: *ref_51 - post: - description: >- - BatchUpdateSecurityIncident updates multiple existing security - incidents. - operationId: apigee.organizations.environments.securityIncidents.batchUpdate - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest + get: + description: Returns a developer app attribute. + operationId: apigee.organizations.developers.apps.attributes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13537,8 +13486,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -13546,17 +13494,36 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/references/{referencesId}: - parameters: *ref_51 - delete: + - in: path + name: appsId + required: true + schema: + type: string + - in: path + name: attributesId + required: true + schema: + type: string + post: description: >- - Deletes a Reference from an environment. Returns the deleted Reference - resource. - operationId: apigee.organizations.environments.references.delete + 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/GoogleCloudApigeeV1Attribute' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13568,7 +13535,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -13576,26 +13543,29 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: path - name: referencesId + name: appsId required: true schema: type: string - put: + - in: path + name: attributesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}/apiproducts/{apiproductsId}: + parameters: *ref_51 + delete: 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' + 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 @@ -13607,7 +13577,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -13615,18 +13585,35 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: path - name: referencesId + name: appsId required: true schema: type: string - get: - description: Gets a Reference resource. - operationId: apigee.organizations.environments.references.get + - in: path + name: keysId + required: true + schema: + type: string + - in: path + name: apiproductsId + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13638,7 +13625,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -13646,25 +13633,53 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: path - name: referencesId + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/references: + - 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}/developers/{developersId}/apps/{appsId}/keys/create: parameters: *ref_51 post: - description: Creates a Reference in the specified environment. - operationId: apigee.organizations.environments.references.create + 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/GoogleCloudApigeeV1Reference' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13676,7 +13691,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -13684,21 +13699,31 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/stats/{statsId}: + - in: path + name: appsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}: parameters: *ref_51 - get: + put: 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 + 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 @@ -13710,7 +13735,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Stats' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -13718,80 +13743,25 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: path - name: statsId + name: appsId required: true schema: type: string - - in: query - name: sort - schema: - type: string - - in: query - name: offset - schema: - type: string - - in: query - name: realtime - schema: - type: boolean - - in: query - name: sonar - schema: - type: boolean - - in: query - name: sortby - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: aggTable - schema: - type: string - - in: query - name: limit - schema: - type: string - - in: query - name: topk - schema: - type: string - - in: query - name: timeUnit - schema: - type: string - - in: query - name: tsAscending - schema: - type: boolean - - in: query - name: accuracy - schema: - type: string - - in: query - name: timeRange - schema: - type: string - - in: query - name: select - schema: - type: string - - in: query - name: tzo + - in: path + name: keysId + required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}: - parameters: *ref_51 - delete: - description: Deletes an alias. - operationId: apigee.organizations.environments.keystores.aliases.delete + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13803,7 +13773,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -13811,23 +13781,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 - get: - description: Gets an alias. - operationId: apigee.organizations.environments.keystores.aliases.get + 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 @@ -13839,7 +13816,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -13847,28 +13824,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 @@ -13880,7 +13864,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -13888,33 +13872,48 @@ 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}/certificate: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys: parameters: *ref_51 - get: - description: Gets the certificate from an alias in PEM-encoded form. - operationId: apigee.organizations.environments.keystores.aliases.getCertificate + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13926,7 +13925,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -13934,27 +13933,20 @@ 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}/keystores/{keystoresId}/aliases/{aliasesId}/csr: + /v1/organizations/{organizationsId}/developers/{developersId}/monetizationConfig: parameters: *ref_51 get: - description: >- - Generates a PKCS #10 Certificate Signing Request for the private key in - an alias. - operationId: apigee.organizations.environments.keystores.aliases.csr + description: Gets the monetization configuration for the developer. + operationId: apigee.organizations.developers.getMonetizationConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13966,7 +13958,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeveloperMonetizationConfig parameters: - in: path name: organizationsId @@ -13974,42 +13967,56 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string + 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 + 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: keystoresId + name: organizationsId required: true schema: type: string - in: path - name: aliasesId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases: + /v1/organizations/{organizationsId}/developers: parameters: *ref_51 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 + 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/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14021,48 +14028,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' 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 - schema: - type: string - - in: query - name: ignoreExpiryValidation - schema: - type: boolean - - in: query - name: _password - schema: - type: string - - in: query - name: ignoreNewlineValidation - schema: - type: boolean - - in: query - name: format - schema: - type: string - - in: query - name: alias - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}: - parameters: *ref_51 - delete: - description: Deletes a keystore or truststore. - operationId: apigee.organizations.environments.keystores.delete + 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 @@ -14074,26 +14055,53 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListOfDevelopersResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: count schema: type: string - - in: path - name: keystoresId - required: true + format: int64 + - in: query + name: expand + schema: + type: boolean + - in: query + name: startKey schema: type: string - get: - description: Gets a keystore or truststore. - operationId: apigee.organizations.environments.keystores.get + - in: query + name: ids + schema: + type: string + - in: query + name: includeCompany + schema: + type: boolean + - in: query + name: app + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}: + parameters: *ref_51 + 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 @@ -14105,7 +14113,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -14113,30 +14121,31 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - - in: path - name: keystoresId - required: true + - in: query + name: action schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores: - parameters: *ref_51 - post: + put: 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 + 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/GoogleCloudApigeeV1Keystore' + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14148,7 +14157,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' parameters: - in: path name: organizationsId @@ -14156,19 +14165,16 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - - in: query - name: name - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers/{targetserversId}: - parameters: *ref_51 get: - description: Gets a TargetServer resource. - operationId: apigee.organizations.environments.targetservers.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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14180,7 +14186,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' parameters: - in: path name: organizationsId @@ -14188,26 +14194,25 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - - in: path - name: targetserversId - required: true + - in: query + name: action schema: type: string - put: + delete: 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' + 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 @@ -14219,7 +14224,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' parameters: - in: path name: organizationsId @@ -14227,20 +14232,15 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: targetserversId + name: developersId required: true schema: type: string - delete: - description: >- - Deletes a TargetServer from an environment. Returns the deleted - TargetServer resource. - operationId: apigee.organizations.environments.targetservers.delete + /v1/organizations/{organizationsId}/developers/{developersId}/balance: + parameters: *ref_51 + get: + description: Gets the account balance for the developer. + operationId: apigee.organizations.developers.getBalance security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14252,7 +14252,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalance' parameters: - in: path name: organizationsId @@ -14260,25 +14260,25 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: targetserversId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers: + /v1/organizations/{organizationsId}/appgroups/{appgroupsId}: parameters: *ref_51 - post: - description: Creates a TargetServer in the specified environment. - operationId: apigee.organizations.environments.targetservers.create + 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/GoogleCloudApigeeV1TargetServer' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14290,7 +14290,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' parameters: - in: path name: organizationsId @@ -14298,24 +14298,23 @@ paths: schema: type: string - in: path - name: environmentsId + name: appgroupsId required: true schema: type: string - in: query - name: name + name: action schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/flowhooks/{flowhooksId}: - parameters: *ref_51 - 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 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 @@ -14327,7 +14326,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' parameters: - in: path name: organizationsId @@ -14335,18 +14334,15 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: flowhooksId + name: appgroupsId required: true schema: type: string - delete: - description: Detaches a shared flow from a flow hook. - operationId: apigee.organizations.environments.flowhooks.detachSharedFlowFromFlowHook + get: + 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 @@ -14358,7 +14354,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' parameters: - in: path name: organizationsId @@ -14366,21 +14362,47 @@ paths: schema: type: string - in: path - name: environmentsId + name: appgroupsId required: true schema: type: string + /v1/organizations/{organizationsId}/appgroups: + parameters: *ref_51 + 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: flowhooksId + name: organizationsId 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 + 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 @@ -14392,30 +14414,45 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' + $ref: '#/components/schemas/GoogleCloudApigeeV1ListAppGroupsResponse' 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: path - name: flowhooksId - required: true + - in: query + name: filter schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions: + /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}: parameters: *ref_51 - get: + put: description: >- - Returns a list of SecurityActions. This returns both enabled and - disabled actions. - operationId: apigee.organizations.environments.securityActions.list + 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' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14427,8 +14464,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSecurityActionsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' parameters: - in: path name: organizationsId @@ -14436,31 +14472,22 @@ paths: schema: type: string - in: path - name: environmentsId + name: appgroupsId required: true schema: type: string - - in: query - name: filter + - in: path + name: appsId + required: true schema: type: string - in: query - name: pageToken + name: action schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: CreateSecurityAction creates a SecurityAction. - operationId: apigee.organizations.environments.securityActions.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' + get: + description: Returns the details for an AppGroup app. + operationId: apigee.organizations.appgroups.apps.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14472,7 +14499,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' parameters: - in: path name: organizationsId @@ -14480,19 +14507,22 @@ paths: schema: type: string - in: path - name: environmentsId + name: appgroupsId required: true schema: type: string - - in: query - name: securityActionId + - in: path + name: appsId + required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}: - parameters: *ref_51 - get: - description: Get a SecurityAction by name. - operationId: apigee.organizations.environments.securityActions.get + 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 @@ -14504,7 +14534,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' parameters: - in: path name: organizationsId @@ -14512,30 +14542,30 @@ paths: schema: type: string - in: path - name: environmentsId + name: appgroupsId required: true schema: type: string - in: path - name: securityActionsId + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}:enable: + /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps: parameters: *ref_51 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 + 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/GoogleCloudApigeeV1EnableSecurityActionRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14547,7 +14577,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' parameters: - in: path name: organizationsId @@ -14555,30 +14585,18 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: securityActionsId + name: appgroupsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}:disable: - parameters: *ref_51 - post: + get: 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 - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DisableSecurityActionRequest + 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 @@ -14590,7 +14608,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListAppGroupAppsResponse parameters: - in: path name: organizationsId @@ -14598,20 +14617,41 @@ paths: schema: type: string - in: path - name: environmentsId + name: appgroupsId required: true schema: type: string - - in: path - name: securityActionsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments: + /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys: parameters: *ref_51 - get: - description: Lists all deployments of API proxies or shared flows in an environment. - operationId: apigee.organizations.environments.deployments.list + 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/GoogleCloudApigeeV1AppGroupAppKey' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14623,8 +14663,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' parameters: - in: path name: organizationsId @@ -14632,23 +14671,23 @@ paths: schema: type: string - in: path - name: environmentsId + name: appgroupsId required: true schema: type: string - - in: query - name: sharedFlows + - in: path + name: appsId + required: true schema: - type: boolean - /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/admin/schemav2: + type: string + /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys/{keysId}: parameters: *ref_51 - get: + delete: 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 + 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 @@ -14660,7 +14699,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Schema' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' parameters: - in: path name: organizationsId @@ -14668,25 +14707,25 @@ paths: schema: type: string - in: path - name: environmentsId + name: appgroupsId required: true schema: type: string - - in: query - name: type + - in: path + name: appsId + required: true schema: type: string - - in: query - name: disableCache + - in: path + name: keysId + required: true schema: - type: boolean - /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/exports: - parameters: *ref_51 + 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 + 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 @@ -14698,7 +14737,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListExportsResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' parameters: - in: path name: organizationsId @@ -14706,22 +14745,36 @@ paths: schema: type: string - in: path - name: environmentsId + 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 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 + 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/GoogleCloudApigeeV1ExportRequest' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14733,7 +14786,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Export' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' parameters: - in: path name: organizationsId @@ -14741,19 +14794,29 @@ paths: schema: type: string - in: path - name: environmentsId + name: appgroupsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/exports/{exportsId}: + - 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_51 - get: + delete: 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 + 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 @@ -14765,7 +14828,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Export' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' parameters: - in: path name: organizationsId @@ -14773,20 +14836,35 @@ paths: schema: type: string - in: path - name: environmentsId + name: appgroupsId required: true schema: type: string - in: path - name: exportsId + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/deployments: - parameters: *ref_51 - get: - description: Lists all deployments of an API proxy in an environment. - operationId: apigee.organizations.environments.apis.deployments.list + - in: path + name: keysId + required: true + schema: + type: string + - in: path + name: apiproductsId + 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.appgroups.apps.keys.apiproducts.updateAppGroupAppKeyApiProduct security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14798,8 +14876,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -14807,26 +14884,39 @@ paths: schema: type: string - in: path - name: environmentsId + name: appgroupsId required: true schema: type: string - in: path - name: apisId + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments: + - 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}/hostQueries/{hostQueriesId}/result: parameters: *ref_51 - delete: + 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 + 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 @@ -14838,7 +14928,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -14846,39 +14936,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 + name: hostQueriesId required: true schema: type: string - - in: query - name: sequencedRollout - schema: - type: boolean - 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 + /v1/organizations/{organizationsId}/hostQueries: + parameters: *ref_51 + 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 @@ -14890,45 +14956,54 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListAsyncQueriesResponse 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: apisId - required: true + - in: query + name: submittedBy schema: type: string - - in: path - name: revisionsId - required: true + - in: query + name: status schema: type: string - in: query - name: override + name: inclQueriesWithoutReport schema: - type: boolean + type: string - in: query - name: serviceAccount + name: dataset schema: type: string - in: query - name: sequencedRollout + name: envgroupHostname schema: - type: boolean - get: + type: string + - in: query + name: from + schema: + type: string + post: description: >- - Gets the deployment of an API proxy revision and actual state reported - by runtime pods. - operationId: apigee.organizations.environments.apis.revisions.getDeployments + 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 @@ -14940,47 +15015,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' + $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: apisId - required: true - schema: - type: string - - in: path - name: revisionsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments:generateDeployChangeReport: + /v1/organizations/{organizationsId}/hostQueries/{hostQueriesId}: parameters: *ref_51 - 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 + 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 @@ -14992,7 +15041,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentChangeReport' + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' parameters: - in: path name: organizationsId @@ -15000,42 +15049,49 @@ paths: schema: type: string - in: path - name: environmentsId + name: hostQueriesId required: true schema: type: string + /v1/organizations/{organizationsId}/hostQueries/{hostQueriesId}/resultView: + parameters: *ref_51 + get: + description: '' + operationId: apigee.organizations.hostQueries.getResultView + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQueryResultView' + parameters: - in: path - name: apisId + name: organizationsId required: true schema: type: string - in: path - name: revisionsId + name: hostQueriesId required: true schema: type: string - - in: query - name: override - schema: - type: boolean - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments:generateUndeployChangeReport: + /v1/organizations/{organizationsId}/hostStats/{hostStatsId}: parameters: *ref_51 - post: + get: 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 + 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 @@ -15047,7 +15103,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentChangeReport' + $ref: '#/components/schemas/GoogleCloudApigeeV1Stats' parameters: - in: path name: organizationsId @@ -15055,25 +15111,78 @@ paths: schema: type: string - in: path - name: environmentsId + name: hostStatsId required: true schema: type: string - - in: path - name: apisId - required: true + - in: query + name: topk schema: type: string - - in: path - name: revisionsId - required: true + - in: query + name: sort schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}/data/{dataId}: + - in: query + name: sortby + schema: + type: string + - in: query + name: select + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: offset + schema: + type: string + - in: query + name: tzo + schema: + type: string + - in: query + name: envgroupHostname + schema: + type: string + - in: query + name: tsAscending + schema: + type: boolean + - in: query + name: accuracy + schema: + type: string + - in: query + name: timeRange + schema: + type: string + - in: query + name: limit + schema: + type: string + - in: query + name: timeUnit + schema: + type: string + - in: query + name: realtime + schema: + type: boolean + /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: parameters: *ref_51 - get: - description: Gets the debug data from a transaction. - operationId: apigee.organizations.environments.apis.revisions.debugsessions.data.get + put: + 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' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15085,8 +15194,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DebugSessionTransaction + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -15094,39 +15202,57 @@ paths: schema: type: string - in: path - name: environmentsId + name: keyvaluemapsId required: true schema: type: string - in: path - name: apisId + 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.keyvaluemaps.entries.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/GoogleCloudApigeeV1KeyValueEntry' + parameters: - in: path - name: revisionsId + name: organizationsId required: true schema: type: string - in: path - name: debugsessionsId + name: keyvaluemapsId required: true schema: type: string - in: path - name: dataId + name: entriesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}/data: - parameters: *ref_51 - 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 + 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 @@ -15138,7 +15264,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -15146,32 +15272,23 @@ 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: keyvaluemapsId required: true schema: type: string - in: path - name: debugsessionsId + name: entriesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions: + /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}/entries: parameters: *ref_51 get: description: >- - Lists debug sessions that are currently active in the given API Proxy - revision. - operationId: apigee.organizations.environments.apis.revisions.debugsessions.list + 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 @@ -15184,7 +15301,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDebugSessionsResponse + #/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse parameters: - in: path name: organizationsId @@ -15192,17 +15309,7 @@ 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: keyvaluemapsId required: true schema: type: string @@ -15216,13 +15323,16 @@ paths: type: integer format: int32 post: - description: Creates a debug session for a deployed API Proxy revision. - operationId: apigee.organizations.environments.apis.revisions.debugsessions.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.keyvaluemaps.entries.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15234,7 +15344,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -15242,30 +15352,20 @@ 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: keyvaluemapsId 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}: + /v1/organizations/{organizationsId}/keyvaluemaps: parameters: *ref_51 - get: - description: Retrieves a debug session. - operationId: apigee.organizations.environments.apis.revisions.debugsessions.get + 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 @@ -15277,43 +15377,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' 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: path - name: debugsessionsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}/result: + /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}: parameters: *ref_51 - 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 + delete: + description: Deletes a key value map from an organization. + operationId: apigee.organizations.keyvaluemaps.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15325,7 +15400,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' parameters: - in: path name: organizationsId @@ -15333,29 +15408,15 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: securityReportsId + name: keyvaluemapsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports: + /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes/{attributesId}: parameters: *ref_51 - 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' + delete: + description: Deletes an API product attribute. + operationId: apigee.organizations.apiproducts.attributes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15367,7 +15428,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -15375,74 +15436,30 @@ paths: schema: type: string - in: path - name: environmentsId - 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: organizationsId + name: apiproductsId required: true schema: type: string - in: path - name: environmentsId + name: attributesId required: true schema: type: string - - in: query - name: dataset - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: status - 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 - - in: query - name: from - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}: - parameters: *ref_51 - get: + post: 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 + 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 @@ -15454,7 +15471,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -15462,22 +15479,18 @@ paths: schema: type: string - in: path - name: environmentsId + name: apiproductsId required: true schema: type: string - in: path - name: securityReportsId + name: attributesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}/resultView: - parameters: *ref_51 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 the value of an API product attribute. + operationId: apigee.organizations.apiproducts.attributes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15489,8 +15502,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityReportResultView + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -15498,23 +15510,20 @@ paths: schema: type: string - in: path - name: environmentsId + name: apiproductsId required: true schema: type: string - in: path - name: securityReportsId + name: attributesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: + /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes: parameters: *ref_51 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 + description: Lists all API product attributes. + operationId: apigee.organizations.apiproducts.attributes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15526,7 +15535,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' parameters: - in: path name: organizationsId @@ -15534,28 +15543,72 @@ paths: schema: type: string - in: path - name: environmentsId + name: apiproductsId required: true 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' + security: + - Oauth2: + - https://www.googleapis.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: keyvaluemapsId + name: organizationsId required: true schema: type: string - in: path - name: entriesId + name: apiproductsId required: true schema: type: string - delete: + /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/rateplans: + parameters: *ref_51 + 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.environments.keyvaluemaps.entries.delete + 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 @@ -15567,7 +15620,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' parameters: - in: path name: organizationsId @@ -15575,30 +15628,62 @@ paths: schema: type: string - in: path - name: environmentsId + name: apiproductsId required: true schema: type: string + 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 + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ListRatePlansResponse' + parameters: - in: path - name: keyvaluemapsId + name: organizationsId required: true schema: type: string - in: path - name: entriesId + name: apiproductsId required: true 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' + - in: query + name: expand + schema: + type: boolean + - in: query + name: startKey + schema: + type: string + - in: query + name: state + schema: + type: string + - in: query + name: count + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/rateplans/{rateplansId}: + parameters: *ref_51 + get: + description: Gets the details of a rate plan. + operationId: apigee.organizations.apiproducts.rateplans.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15610,7 +15695,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' parameters: - in: path name: organizationsId @@ -15618,28 +15703,23 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keyvaluemapsId + name: apiproductsId required: true schema: type: string - in: path - name: entriesId + name: rateplansId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}/entries: - parameters: *ref_51 - 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 + 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 @@ -15651,8 +15731,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' parameters: - in: path name: organizationsId @@ -15660,35 +15739,18 @@ paths: schema: type: string - in: path - name: environmentsId + name: apiproductsId required: true schema: type: string - in: path - name: keyvaluemapsId + name: rateplansId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + delete: + description: Deletes a rate plan. + operationId: apigee.organizations.apiproducts.rateplans.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15700,7 +15762,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' parameters: - in: path name: organizationsId @@ -15708,25 +15770,32 @@ paths: schema: type: string - in: path - name: environmentsId + name: apiproductsId required: true schema: type: string - in: path - name: keyvaluemapsId + name: rateplansId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps: + /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}: parameters: *ref_51 - post: - description: Creates a key value map in an environment. - operationId: apigee.organizations.environments.keyvaluemaps.create + 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/GoogleCloudApigeeV1KeyValueMap' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15738,7 +15807,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' parameters: - in: path name: organizationsId @@ -15746,15 +15815,18 @@ paths: schema: type: string - in: path - name: environmentsId + name: apiproductsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}: - parameters: *ref_51 - delete: - description: Deletes a key value map from an environment. - operationId: apigee.organizations.environments.keyvaluemaps.delete + 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 @@ -15766,7 +15838,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' parameters: - in: path name: organizationsId @@ -15774,20 +15846,21 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keyvaluemapsId + name: apiproductsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/optimizedStats/{optimizedStatsId}: - parameters: *ref_51 - get: - description: Similar to GetStats except that the response is less verbose. - operationId: apigee.organizations.environments.optimizedStats.get + 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 @@ -15799,7 +15872,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStats' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' parameters: - in: path name: organizationsId @@ -15807,97 +15880,38 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: optimizedStatsId + name: apiproductsId required: true schema: type: string - - in: query - name: sonar - schema: - type: boolean - - in: query - name: offset - schema: - type: string - - in: query - name: sort - schema: - type: string - - in: query - name: timeUnit - schema: - type: string - - in: query - name: timeRange - schema: - type: string - - in: query - name: topk - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: tsAscending - schema: - type: boolean - - in: query - name: limit - schema: - type: string - - in: query - name: sortby - schema: - type: string - - in: query - name: accuracy - schema: - type: string - - in: query - name: aggTable - schema: - type: string - - in: query - name: select - schema: - type: string - - in: query - name: realtime - schema: - type: boolean - - in: query - name: tzo - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments:generateUploadUrl: + /v1/organizations/{organizationsId}/apiproducts: parameters: *ref_51 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 + 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/GoogleCloudApigeeV1GenerateUploadUrlRequest' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15909,24 +15923,20 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1GenerateUploadUrlResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments: - parameters: *ref_51 get: - description: Lists the ArchiveDeployments in the specified Environment. - operationId: apigee.organizations.environments.archiveDeployments.list + 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 @@ -15939,39 +15949,39 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListArchiveDeploymentsResponse + #/components/schemas/GoogleCloudApigeeV1ListApiProductsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: expand + schema: + type: boolean + - in: query + name: attributevalue schema: type: string - in: query - name: filter + name: startKey schema: type: string - in: query - name: pageSize + name: count schema: - type: integer - format: int32 + type: string + format: int64 - in: query - name: pageToken + name: attributename schema: type: string - post: - description: Creates a new ArchiveDeployment. - operationId: apigee.organizations.environments.archiveDeployments.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' + /v1/organizations/{organizationsId}/endpointAttachments/{endpointAttachmentsId}: + parameters: *ref_51 + delete: + description: Deletes an endpoint attachment. + operationId: apigee.organizations.endpointAttachments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15991,15 +16001,13 @@ paths: schema: type: string - in: path - name: environmentsId + name: endpointAttachmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments/{archiveDeploymentsId}: - parameters: *ref_51 - delete: - description: Deletes an archive deployment. - operationId: apigee.organizations.environments.archiveDeployments.delete + get: + description: Gets the endpoint attachment. + operationId: apigee.organizations.endpointAttachments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16011,7 +16019,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' parameters: - in: path name: organizationsId @@ -16019,25 +16027,53 @@ paths: schema: type: string - in: path - name: environmentsId + name: endpointAttachmentsId required: true schema: type: string + /v1/organizations/{organizationsId}/endpointAttachments: + parameters: *ref_51 + 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: archiveDeploymentsId + name: organizationsId required: true schema: type: string - patch: + - in: query + name: pageToken + schema: + type: string + - 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 an endpoint attachment. **Note:** Not supported for Apigee + hybrid. + operationId: apigee.organizations.endpointAttachments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' + $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16049,31 +16085,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' + $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: archiveDeploymentsId + name: organizationsId required: true schema: type: string - in: query - name: updateMask + name: endpointAttachmentId schema: type: string - format: google-fieldmask + /v1/organizations/{organizationsId}/apis: + parameters: *ref_51 get: - description: Gets the specified ArchiveDeployment. - operationId: apigee.organizations.environments.archiveDeployments.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 @@ -16085,38 +16115,44 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' + $ref: '#/components/schemas/GoogleCloudApigeeV1ListApiProxiesResponse' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: includeRevisions schema: - type: string - - in: path - name: archiveDeploymentsId - required: true + type: boolean + - in: query + name: includeMetaData schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments/{archiveDeploymentsId}:generateDownloadUrl: - parameters: *ref_51 + type: boolean 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 + 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/GoogleCloudApigeeV1GenerateDownloadUrlRequest + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16128,29 +16164,33 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1GenerateDownloadUrlResponse + $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 - - in: path - name: archiveDeploymentsId - required: true + - in: query + name: name schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/sharedflows/{sharedflowsId}/deployments: + - in: query + name: validate + schema: + type: boolean + /v1/organizations/{organizationsId}/apis/{apisId}: parameters: *ref_51 - get: - description: Lists all deployments of a shared flow in an environment. - operationId: apigee.organizations.environments.sharedflows.deployments.list + 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 @@ -16162,8 +16202,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' parameters: - in: path name: organizationsId @@ -16171,22 +16210,13 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: sharedflowsId + name: apisId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}/deployments: - parameters: *ref_51 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: Gets an API proxy including a list of existing revisions. + operationId: apigee.organizations.apis.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16198,7 +16228,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' parameters: - in: path name: organizationsId @@ -16206,33 +16236,18 @@ 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: apisId 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 + patch: + description: Updates an existing API proxy. + operationId: apigee.organizations.apis.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16244,7 +16259,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' parameters: - in: path name: organizationsId @@ -16252,37 +16267,27 @@ 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: apisId required: true schema: type: string - in: query - name: serviceAccount + name: updateMask schema: type: string - - in: query - name: override - schema: - type: boolean - delete: + format: google-fieldmask + /v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}: + parameters: *ref_51 + get: 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 + 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 @@ -16294,7 +16299,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -16302,30 +16307,25 @@ paths: schema: type: string - in: path - name: environmentsId + name: apisId required: true schema: type: string - in: path - name: sharedflowsId + name: revisionsId required: true schema: type: string - - in: path - name: revisionsId - required: true + - in: query + name: format schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityStats:queryTabularStats: - parameters: *ref_51 - post: - description: Retrieve security statistics as tabular rows. - operationId: apigee.organizations.environments.securityStats.queryTabularStats - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1QueryTabularStatsRequest' + 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 @@ -16337,8 +16337,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1QueryTabularStatsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' parameters: - in: path name: organizationsId @@ -16346,21 +16345,29 @@ paths: schema: type: string - in: path - name: environmentsId + name: apisId + required: true + schema: + type: string + - in: path + name: revisionsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityStats:queryTimeSeriesStats: - parameters: *ref_51 post: - description: Retrieve security statistics as a collection of time series. - operationId: apigee.organizations.environments.securityStats.queryTimeSeriesStats + 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/GoogleCloudApigeeV1QueryTimeSeriesStatsRequest + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16372,8 +16379,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' parameters: - in: path name: organizationsId @@ -16381,15 +16387,24 @@ paths: schema: type: string - in: path - name: environmentsId + name: apisId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/caches/{cachesId}: + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: validate + schema: + type: boolean + /v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}/deployments: parameters: *ref_51 - delete: - description: Deletes a cache. - operationId: apigee.organizations.environments.caches.delete + 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 @@ -16401,7 +16416,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId @@ -16409,25 +16425,20 @@ paths: schema: type: string - in: path - name: environmentsId + name: apisId required: true schema: type: string - in: path - name: cachesId + name: revisionsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}/result: + /v1/organizations/{organizationsId}/apis/{apisId}/deployments: parameters: *ref_51 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: Lists all deployments of an API proxy. + operationId: apigee.organizations.apis.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16439,7 +16450,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId @@ -16447,29 +16459,23 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: queriesId + name: apisId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/queries: + /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}/entries: parameters: *ref_51 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 + 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/GoogleCloudApigeeV1Query' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16481,7 +16487,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -16489,13 +16495,21 @@ paths: schema: type: string - in: path - name: environmentsId + name: apisId + required: true + schema: + type: string + - in: path + name: keyvaluemapsId required: true schema: type: string get: - description: Return a list of Asynchronous Queries - operationId: apigee.organizations.environments.queries.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 @@ -16508,7 +16522,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListAsyncQueriesResponse + #/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse parameters: - in: path name: organizationsId @@ -16516,42 +16530,36 @@ paths: schema: type: string - in: path - name: environmentsId + name: apisId required: true schema: type: string - - in: query - name: inclQueriesWithoutReport - schema: - type: string - - in: query - name: dataset - schema: - type: string - - in: query - name: to - schema: - type: string - - in: query - name: submittedBy + - in: path + name: keyvaluemapsId + required: true schema: type: string - in: query - name: from + name: pageToken schema: type: string - in: query - name: status + name: pageSize schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}: + type: integer + format: int32 + /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: parameters: *ref_51 - get: + put: 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 + 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 @@ -16563,7 +16571,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -16571,23 +16579,26 @@ paths: schema: type: string - in: path - name: environmentsId + name: apisId required: true schema: type: string - in: path - name: queriesId + name: keyvaluemapsId + required: true + schema: + type: string + - in: path + name: entriesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}/resulturl: - parameters: *ref_51 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 + 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 @@ -16599,8 +16610,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -16608,29 +16618,28 @@ paths: schema: type: string - in: path - name: environmentsId + name: apisId required: true schema: type: string - in: path - name: queriesId + name: keyvaluemapsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig/overrides: - parameters: *ref_51 - post: + - in: path + name: entriesId + required: true + schema: + type: string + delete: 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + 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 @@ -16642,7 +16651,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -16650,53 +16659,30 @@ paths: schema: type: string - in: path - name: environmentsId + name: apisId 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 - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListTraceConfigOverridesResponse - parameters: - in: path - name: organizationsId + name: keyvaluemapsId required: true schema: type: string - in: path - name: environmentsId + name: entriesId 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}/traceConfig/overrides/{overridesId}: + /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps: parameters: *ref_51 - get: - description: Gets a trace configuration override. - operationId: apigee.organizations.environments.traceConfig.overrides.get + 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 @@ -16708,7 +16694,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' parameters: - in: path name: organizationsId @@ -16716,18 +16702,15 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: overridesId + name: apisId required: true schema: type: string + /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}: + parameters: *ref_51 delete: - description: Deletes a distributed trace configuration override. - operationId: apigee.organizations.environments.traceConfig.overrides.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 @@ -16739,7 +16722,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' parameters: - in: path name: organizationsId @@ -16747,27 +16730,25 @@ paths: schema: type: string - in: path - name: environmentsId + name: apisId required: true schema: type: string - in: path - name: overridesId + name: keyvaluemapsId required: true 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 + /v1/organizations/{organizationsId}/reports/{reportsId}: + parameters: *ref_51 + put: + description: Update an existing custom report definition + operationId: apigee.organizations.reports.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16779,7 +16760,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' parameters: - in: path name: organizationsId @@ -16787,28 +16768,13 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: overridesId + name: reportsId required: true schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}/{name}: - parameters: *ref_51 - 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 + type: string + get: + description: Retrieve a custom report definition. + operationId: apigee.organizations.reports.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16820,7 +16786,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' parameters: - in: path name: organizationsId @@ -16828,32 +16794,54 @@ paths: schema: type: string - in: path - name: environmentsId + name: reportsId 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: type + name: organizationsId required: true schema: type: string - in: path - name: name + name: reportsId required: true schema: type: string - put: + /v1/organizations/{organizationsId}/reports: + parameters: *ref_51 + 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 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/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16865,34 +16853,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' 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 - 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: Return a list of Custom Reports + operationId: apigee.organizations.reports.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16904,36 +16874,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $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: type - required: true - schema: - type: string - - in: path - name: name - required: true + - in: query + name: expand schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles: + type: boolean + /v1/organizations/{organizationsId}/securityProfiles: parameters: *ref_51 - 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 + 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 @@ -16945,35 +16907,22 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListEnvironmentResourcesResponse + $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 - post: + 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' + 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 @@ -16985,34 +16934,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListSecurityProfilesResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - in: query - name: name + name: pageSize schema: - type: string + type: integer + format: int32 - in: query - name: type + name: pageToken schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}: + /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}:listRevisions: parameters: *ref_51 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 + ListSecurityProfileRevisions lists all the revisions of the security + profile. + operationId: apigee.organizations.securityProfiles.listRevisions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17025,7 +16970,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListEnvironmentResourcesResponse + #/components/schemas/GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse parameters: - in: path name: organizationsId @@ -17033,20 +16978,24 @@ paths: schema: type: string - in: path - name: environmentsId + name: securityProfilesId required: true schema: type: string - - in: path - name: type - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/organizations/{organizationsId}/sites/{sitesId}/apicategories/{apicategoriesId}: + /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}: parameters: *ref_51 delete: - description: Deletes an API category. - operationId: apigee.organizations.sites.apicategories.delete + description: DeleteSecurityProfile delete a profile with all its revisions. + operationId: apigee.organizations.securityProfiles.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17058,7 +17007,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeleteResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -17066,18 +17015,18 @@ paths: schema: type: string - in: path - name: sitesId - required: true - schema: - type: string - - in: path - name: apicategoriesId + name: securityProfilesId required: true schema: type: string - get: - description: Gets an API category. - operationId: apigee.organizations.sites.apicategories.get + patch: + description: UpdateSecurityProfile update the metadata of security profile. + operationId: apigee.organizations.securityProfiles.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17089,7 +17038,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' parameters: - in: path name: organizationsId @@ -17097,23 +17046,21 @@ paths: schema: type: string - in: path - name: sitesId + name: securityProfilesId required: true schema: type: string - - in: path - name: apicategoriesId - required: true + - in: query + name: updateMask schema: type: string - patch: - description: Updates an API category. - operationId: apigee.organizations.sites.apicategories.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' + format: google-fieldmask + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17125,7 +17072,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' parameters: - in: path name: organizationsId @@ -17133,20 +17080,17 @@ paths: schema: type: string - in: path - name: sitesId - required: true - schema: - type: string - - in: path - name: apicategoriesId + name: securityProfilesId required: true schema: type: string - /v1/organizations/{organizationsId}/sites/{sitesId}/apicategories: + /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments/{environmentsId}: parameters: *ref_51 - get: - description: Returns the API categories associated with a portal. - operationId: apigee.organizations.sites.apicategories.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 @@ -17158,8 +17102,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListApiCategoriesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -17167,18 +17110,29 @@ paths: schema: type: string - in: path - name: sitesId + name: securityProfilesId + required: true + schema: + type: string + - in: path + name: environmentsId required: true schema: type: string + /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments/{environmentsId}:computeEnvironmentScores: + parameters: *ref_51 post: - description: Creates a new API category. - operationId: apigee.organizations.sites.apicategories.create + 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/GoogleCloudApigeeV1ApiCategory' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17190,7 +17144,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryResponse' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresResponse parameters: - in: path name: organizationsId @@ -17198,15 +17153,28 @@ paths: schema: type: string - in: path - name: sitesId + name: securityProfilesId required: true schema: type: string - /v1/organizations/{organizationsId}/sites/{sitesId}/apidocs: + - in: path + name: environmentsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments: parameters: *ref_51 - get: - description: Returns the catalog items associated with a portal. - operationId: apigee.organizations.sites.apidocs.list + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17218,7 +17186,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListApiDocsResponse' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation parameters: - in: path name: organizationsId @@ -17226,27 +17195,23 @@ paths: schema: type: string - in: path - name: sitesId + name: securityProfilesId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 + /v1/organizations/{organizationsId}/analytics/datastores:test: + parameters: *ref_51 post: - description: Creates a new catalog item. - operationId: apigee.organizations.sites.apidocs.create + 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/GoogleCloudApigeeV1ApiDoc' + $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17258,23 +17223,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1TestDatastoreResponse' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: sitesId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/sites/{sitesId}/apidocs/{apidocsId}: + /v1/organizations/{organizationsId}/analytics/datastores/{datastoresId}: parameters: *ref_51 - get: - description: Gets a catalog item. - operationId: apigee.organizations.sites.apidocs.get + 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 @@ -17286,7 +17251,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' parameters: - in: path name: organizationsId @@ -17294,18 +17259,13 @@ paths: schema: type: string - in: path - name: sitesId - required: true - schema: - type: string - - in: path - name: apidocsId + name: datastoresId required: true schema: type: string delete: - description: Deletes a catalog item. - operationId: apigee.organizations.sites.apidocs.delete + description: Delete a Datastore from an org. + operationId: apigee.organizations.analytics.datastores.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17317,7 +17277,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeleteResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -17325,23 +17285,13 @@ paths: schema: type: string - in: path - name: sitesId - required: true - schema: - type: string - - in: path - name: apidocsId + name: datastoresId 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' + get: + description: Get a Datastore + operationId: apigee.organizations.analytics.datastores.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17353,7 +17303,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' parameters: - in: path name: organizationsId @@ -17361,27 +17311,15 @@ paths: schema: type: string - in: path - name: sitesId - required: true - schema: - type: string - - in: path - name: apidocsId + name: datastoresId required: true schema: type: string - /v1/organizations/{organizationsId}/sites/{sitesId}/apidocs/{apidocsId}/documentation: + /v1/organizations/{organizationsId}/analytics/datastores: parameters: *ref_51 - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocDocumentation' + get: + description: List Datastores + operationId: apigee.organizations.analytics.datastores.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17393,27 +17331,25 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ApiDocDocumentationResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1ListDatastoresResponse' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: sitesId - required: true - schema: - type: string - - in: path - name: apidocsId - required: true + - in: query + name: targetType schema: type: string - get: - description: Gets the documentation for the specified catalog item. - operationId: apigee.organizations.sites.apidocs.getDocumentation + 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 @@ -17425,35 +17361,18 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ApiDocDocumentationResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: sitesId - required: true - schema: - type: string - - in: path - name: apidocsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/hostStats/{hostStatsId}: + /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/deployedIngressConfig: parameters: *ref_51 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 + description: Gets the deployed ingress configuration for an environment group. + operationId: apigee.organizations.envgroups.getDeployedIngressConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17465,7 +17384,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Stats' + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupConfig' parameters: - in: path name: organizationsId @@ -17473,71 +17392,19 @@ paths: schema: type: string - in: path - name: hostStatsId + name: envgroupsId required: true schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: limit - schema: - type: string - - in: query - name: topk - schema: - type: string - - in: query - name: select - schema: - type: string - - in: query - name: sort - schema: - type: string - - in: query - name: timeRange - schema: - type: string - - in: query - name: accuracy - schema: - type: string - - in: query - name: sortby - schema: - type: string - - in: query - name: timeUnit - 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: tzo - schema: - type: string - - in: query - name: envgroupHostname + name: view schema: type: string - /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}/deployments: + /v1/organizations/{organizationsId}/envgroups/{envgroupsId}: parameters: *ref_51 get: - description: Lists all deployments of a shared flow revision. - operationId: apigee.organizations.sharedflows.revisions.deployments.list + description: Gets an environment group. + operationId: apigee.organizations.envgroups.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17549,31 +17416,21 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' parameters: - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: sharedflowsId + name: organizationsId required: true schema: type: string - in: path - name: revisionsId + name: envgroupsId required: true schema: type: string - /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}: - parameters: *ref_51 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 + description: Deletes an environment group. + operationId: apigee.organizations.envgroups.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17585,7 +17442,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -17593,28 +17450,18 @@ paths: schema: type: string - in: path - name: sharedflowsId - required: true - schema: - type: string - - in: path - name: revisionsId + name: envgroupsId required: true schema: type: string - 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: Updates an environment group. + operationId: apigee.organizations.envgroups.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17626,7 +17473,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -17634,29 +17481,20 @@ paths: schema: type: string - in: path - name: sharedflowsId - required: true - schema: - type: string - - in: path - name: revisionsId + name: envgroupsId required: true schema: type: string - in: query - name: validate + name: updateMask schema: - type: boolean + type: string + format: google-fieldmask + /v1/organizations/{organizationsId}/envgroups: + parameters: *ref_51 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 + description: Lists all environment groups. + operationId: apigee.organizations.envgroups.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17668,32 +17506,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListEnvironmentGroupsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: sharedflowsId - required: true - schema: - type: string - - in: path - name: revisionsId - required: true + - in: query + name: pageSize schema: - type: string + type: integer + format: int32 - in: query - name: format + name: pageToken schema: type: string - /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/deployments: - parameters: *ref_51 - get: - description: Lists all deployments of a shared flow. - operationId: apigee.organizations.sharedflows.deployments.list + 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 @@ -17705,26 +17542,22 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: sharedflowsId - required: true + - in: query + name: name schema: type: string - /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}: + /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/attachments/{attachmentsId}: parameters: *ref_51 - delete: - 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 + get: + description: Gets an environment group attachment. + operationId: apigee.organizations.envgroups.attachments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17736,7 +17569,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment parameters: - in: path name: organizationsId @@ -17744,13 +17578,18 @@ paths: schema: type: string - in: path - name: sharedflowsId + name: envgroupsId required: true schema: type: string - get: - description: Gets a shared flow by name, including a list of its revisions. - operationId: apigee.organizations.sharedflows.get + - in: path + name: attachmentsId + required: true + schema: + type: string + delete: + description: Deletes an environment group attachment. + operationId: apigee.organizations.envgroups.attachments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17762,7 +17601,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -17770,25 +17609,26 @@ paths: schema: type: string - in: path - name: sharedflowsId + name: envgroupsId required: true schema: type: string - /v1/organizations/{organizationsId}/sharedflows: + - in: path + name: attachmentsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/attachments: parameters: *ref_51 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: 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/GoogleApiHttpBody' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17800,24 +17640,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: name - schema: - type: string - - in: query - name: action + - in: path + name: envgroupsId + required: true schema: type: string get: - description: Lists all shared flows in the organization. - operationId: apigee.organizations.sharedflows.list + description: Lists all attachments of an environment group. + operationId: apigee.organizations.envgroups.attachments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17830,26 +17667,34 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSharedFlowsResponse + #/components/schemas/GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: envgroupsId + required: true + schema: + type: string - in: query - name: includeRevisions + name: pageToken schema: - type: boolean + type: string - in: query - name: includeMetaData + name: pageSize schema: - type: boolean - /v1/organizations/{organizationsId}/datacollectors: + type: integer + format: int32 + /v1/organizations/{organizationsId}/operations: parameters: *ref_51 get: - description: Lists all data collectors. - operationId: apigee.organizations.datacollectors.list + 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 @@ -17861,8 +17706,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDataCollectorsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: organizationsId @@ -17874,18 +17718,22 @@ paths: schema: type: integer format: int32 + - in: query + name: filter + schema: + type: string - in: query name: pageToken schema: type: string - post: - description: Creates a new data collector. - operationId: apigee.organizations.datacollectors.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + /v1/organizations/{organizationsId}/operations/{operationsId}: + parameters: *ref_51 + 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 @@ -17897,22 +17745,63 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: dataCollectorId + - in: path + name: operationsId + required: true schema: type: string - /v1/organizations/{organizationsId}/datacollectors/{datacollectorsId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/sharedflows/{sharedflowsId}/deployments: parameters: *ref_51 - delete: - description: Deletes a data collector. - operationId: apigee.organizations.datacollectors.delete + 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 + 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: 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_51 + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17932,18 +17821,33 @@ paths: schema: type: string - in: path - name: datacollectorsId + name: environmentsId required: true schema: type: string - patch: - description: Updates a data collector. - operationId: apigee.organizations.datacollectors.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + - in: path + name: sharedflowsId + required: true + schema: + type: string + - in: path + name: revisionsId + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17955,7 +17859,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' parameters: - in: path name: organizationsId @@ -17963,18 +17867,33 @@ paths: schema: type: string - in: path - name: datacollectorsId + name: environmentsId + required: true + schema: + type: string + - in: path + name: sharedflowsId + required: true + schema: + type: string + - in: path + name: revisionsId required: true schema: type: string - in: query - name: updateMask + name: serviceAccount schema: type: string - format: google-fieldmask + - in: query + name: override + schema: + type: boolean get: - description: Gets a data collector. - operationId: apigee.organizations.datacollectors.get + description: >- + 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 @@ -17986,7 +17905,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' parameters: - in: path name: organizationsId @@ -17994,18 +17913,25 @@ paths: schema: type: string - in: path - name: datacollectorsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/operations/{operationsId}: + - in: path + name: sharedflowsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments/{archiveDeploymentsId}: parameters: *ref_51 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: Gets the specified ArchiveDeployment. + operationId: apigee.organizations.environments.archiveDeployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18017,7 +17943,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' parameters: - in: path name: organizationsId @@ -18025,17 +17951,18 @@ paths: schema: type: string - in: path - name: operationsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/operations: - parameters: *ref_51 - 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 + - in: path + name: archiveDeploymentsId + required: true + schema: + type: string + delete: + description: Deletes an archive deployment. + operationId: apigee.organizations.environments.archiveDeployments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18047,36 +17974,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $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 - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: archiveDeploymentsId + required: true schema: type: string - /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}/result: - parameters: *ref_51 - get: + patch: 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 + 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 @@ -18088,7 +18012,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' parameters: - in: path name: organizationsId @@ -18096,24 +18020,30 @@ paths: schema: type: string - in: path - name: hostSecurityReportsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/hostSecurityReports: + - in: path + name: archiveDeploymentsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments: parameters: *ref_51 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 + description: Creates a new ArchiveDeployment. + operationId: apigee.organizations.environments.archiveDeployments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQuery' + $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18125,16 +18055,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: environmentsId + required: true + schema: + type: string get: - description: Return a list of Security Reports at host level. - operationId: apigee.organizations.hostSecurityReports.list + description: Lists the ArchiveDeployments in the specified Environment. + operationId: apigee.organizations.environments.archiveDeployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18147,31 +18082,16 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSecurityReportsResponse + #/components/schemas/GoogleCloudApigeeV1ListArchiveDeploymentsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: dataset - schema: - type: string - - in: query - name: envgroupHostname - schema: - type: string - - in: query - name: from - schema: - type: string - - in: query - name: to - schema: - type: string - - in: query - name: submittedBy + - in: path + name: environmentsId + required: true schema: type: string - in: query @@ -18180,20 +18100,35 @@ paths: type: integer format: int32 - in: query - name: status + name: pageToken schema: type: string - in: query - name: pageToken + name: filter schema: type: string - /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}/resultView: + /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments:generateUploadUrl: parameters: *ref_51 - get: + post: description: >- - After the query is completed, use this API to view the query result when - result size is small. - operationId: apigee.organizations.hostSecurityReports.getResultView + 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 @@ -18206,7 +18141,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityReportResultView + #/components/schemas/GoogleCloudApigeeV1GenerateUploadUrlResponse parameters: - in: path name: organizationsId @@ -18214,18 +18149,25 @@ paths: schema: type: string - in: path - name: hostSecurityReportsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments/{archiveDeploymentsId}:generateDownloadUrl: parameters: *ref_51 - 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.hostSecurityReports.get + 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 @@ -18237,7 +18179,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1GenerateDownloadUrlResponse parameters: - in: path name: organizationsId @@ -18245,23 +18188,20 @@ paths: schema: type: string - in: path - name: hostSecurityReportsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/appgroups: + - in: path + name: archiveDeploymentsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/references/{referencesId}: parameters: *ref_51 - 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: Gets a Reference resource. + operationId: apigee.organizations.environments.references.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18273,19 +18213,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' parameters: - in: path name: organizationsId required: true schema: type: string - get: + - in: path + name: environmentsId + required: true + schema: + type: string + - in: path + name: referencesId + required: true + schema: + type: string + delete: 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 + 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 @@ -18297,41 +18246,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListAppGroupsResponse' + $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 - - in: query - name: filter + - in: path + name: referencesId + required: true schema: type: string - /v1/organizations/{organizationsId}/appgroups/{appgroupsId}: - parameters: *ref_51 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 + 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/GoogleCloudApigeeV1AppGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18343,7 +18285,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' parameters: - in: path name: organizationsId @@ -18351,23 +18293,25 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - - in: query - name: action + - in: path + name: referencesId + 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 + /v1/organizations/{organizationsId}/environments/{environmentsId}/references: + parameters: *ref_51 + 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 @@ -18379,7 +18323,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' parameters: - in: path name: organizationsId @@ -18387,15 +18331,19 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/admin/schemav2: + parameters: *ref_51 get: description: >- - Returns the AppGroup details for the provided AppGroup name in the - request URI. - operationId: apigee.organizations.appgroups.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 @@ -18407,7 +18355,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1Schema' parameters: - in: path name: organizationsId @@ -18415,19 +18363,27 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys/{keysId}/apiproducts/{apiproductsId}: + - in: query + name: type + schema: + type: string + - in: query + name: disableCache + schema: + type: boolean + /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/exports/{exportsId}: parameters: *ref_51 - 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.appgroups.apps.keys.apiproducts.delete + 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 @@ -18439,7 +18395,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1Export' parameters: - in: path name: organizationsId @@ -18447,35 +18403,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: exportsId required: true schema: type: string - post: + /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/exports: + parameters: *ref_51 + 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 + 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 @@ -18487,7 +18430,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1ListExportsResponse' parameters: - in: path name: organizationsId @@ -18495,51 +18438,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 - 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}/keys: - parameters: *ref_51 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 + 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/GoogleCloudApigeeV1AppGroupAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1ExportRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18551,7 +18465,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1Export' parameters: - in: path name: organizationsId @@ -18559,23 +18473,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 - /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys/{keysId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/flowhooks/{flowhooksId}: parameters: *ref_51 - 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 + 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 @@ -18587,7 +18498,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' parameters: - in: path name: organizationsId @@ -18595,25 +18506,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 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 + 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 @@ -18625,7 +18532,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' parameters: - in: path name: organizationsId @@ -18633,36 +18540,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: flowhooksId 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 + 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 @@ -18674,7 +18563,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' parameters: - in: path name: organizationsId @@ -18682,29 +18571,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: flowhooksId required: true schema: type: string - /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/caches/{cachesId}: parameters: *ref_51 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 + description: Deletes a cache. + operationId: apigee.organizations.environments.caches.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18716,7 +18596,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -18724,18 +18604,23 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - in: path - name: appsId + name: cachesId required: true schema: type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents/{securityIncidentsId}: + parameters: *ref_51 get: - description: Returns the details for an AppGroup app. - operationId: apigee.organizations.appgroups.apps.get + 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 @@ -18747,7 +18632,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' parameters: - in: path name: organizationsId @@ -18755,32 +18640,23 @@ 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 - put: - 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 + patch: + description: UpdateSecurityIncidents updates an existing security incident. + operationId: apigee.organizations.environments.securityIncidents.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18792,7 +18668,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' parameters: - in: path name: organizationsId @@ -18800,34 +18676,33 @@ 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 - in: query - name: action + name: updateMask schema: type: string - /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps: + format: google-fieldmask + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents:batchUpdate: parameters: *ref_51 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 @@ -18839,7 +18714,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse parameters: - in: path name: organizationsId @@ -18847,18 +18723,17 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents: + parameters: *ref_51 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 + 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 @@ -18871,7 +18746,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListAppGroupAppsResponse + #/components/schemas/GoogleCloudApigeeV1ListSecurityIncidentsResponse parameters: - in: path name: organizationsId @@ -18879,27 +18754,28 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 - in: query name: pageToken schema: type: string - in: query - name: pageSize + name: filter schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments: parameters: *ref_51 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 + 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 @@ -18911,7 +18787,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId @@ -18919,18 +18796,19 @@ 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: query + name: sharedFlows + schema: + type: boolean + /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}: + parameters: *ref_51 + 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 @@ -18942,7 +18820,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' parameters: - in: path name: organizationsId @@ -18950,18 +18828,25 @@ 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 - delete: - description: DeleteSecurityProfile delete a profile with all its revisions. - operationId: apigee.organizations.securityProfiles.delete + /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps: + parameters: *ref_51 + 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' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18973,7 +18858,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' parameters: - in: path name: organizationsId @@ -18981,53 +18866,22 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/securityProfiles: + /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: parameters: *ref_51 - get: + put: description: >- - 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 - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSecurityProfilesResponse - 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 - post: - description: CreateSecurityProfile create a new custom security profile. - operationId: apigee.organizations.securityProfiles.create + 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 @@ -19039,24 +18893,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: securityProfileId + - in: path + 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/{securityProfilesId}:listRevisions: - parameters: *ref_51 get: description: >- - ListSecurityProfileRevisions lists all the revisions of the security - profile. - operationId: apigee.organizations.securityProfiles.listRevisions + 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 @@ -19068,8 +18932,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -19077,33 +18940,28 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: environmentsId required: true schema: type: string - - in: query - name: pageSize + - in: path + name: keyvaluemapsId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: entriesId + required: true schema: type: string - /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments/{environmentsId}:computeEnvironmentScores: - parameters: *ref_51 - post: + delete: 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 + 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 @@ -19115,8 +18973,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -19124,28 +18981,33 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: environmentsId required: true schema: type: string - in: path - name: environmentsId + name: keyvaluemapsId required: true schema: type: string - /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments: + - in: path + name: entriesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}/entries: parameters: *ref_51 post: description: >- - CreateSecurityProfileEnvironmentAssociation creates profile environment - association i.e. attaches environment to security profile. - operationId: apigee.organizations.securityProfiles.environments.create + 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/GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19157,8 +19019,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -19166,17 +19027,21 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments/{environmentsId}: - parameters: *ref_51 - delete: + - in: path + name: keyvaluemapsId + required: true + schema: + type: string + get: description: >- - DeleteSecurityProfileEnvironmentAssociation removes profile environment - association i.e. detaches environment from security profile. - operationId: apigee.organizations.securityProfiles.environments.delete + 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 @@ -19188,7 +19053,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse parameters: - in: path name: organizationsId @@ -19196,23 +19062,29 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: environmentsId required: true schema: type: string - in: path - name: environmentsId + name: keyvaluemapsId required: true schema: type: string - /v1/organizations/{organizationsId}/apps: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/optimizedStats/{optimizedStatsId}: parameters: *ref_51 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: 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 @@ -19224,68 +19096,88 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListAppsResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStats' 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: apptype + name: offset schema: type: string - in: query - name: rows + name: sort schema: type: string - format: int64 - in: query - name: expand + name: sortby schema: - type: boolean + type: string - in: query - name: startKey + name: tzo schema: type: string - in: query - name: pageSize + name: tsAscending schema: - type: integer - format: int32 + type: boolean - in: query - name: status + name: limit schema: type: string - in: query - name: pageToken + name: accuracy schema: type: string - in: query - name: apiProduct + name: timeUnit schema: type: string - in: query - name: filter + name: topk schema: type: string - in: query - name: includeCred + name: sonar schema: type: boolean - in: query - name: ids + name: timeRange schema: type: string - in: query - name: keyStatus + name: filter schema: type: string - /v1/organizations/{organizationsId}/apps/{appsId}: + - in: query + name: select + schema: + type: string + - in: query + name: aggTable + schema: + type: string + - in: query + name: realtime + schema: + type: boolean + /v1/organizations/{organizationsId}/environments/{environmentsId}/queries: parameters: *ref_51 get: - description: Gets the app profile for the specified app ID. - operationId: apigee.organizations.apps.get + description: Return a list of Asynchronous Queries + operationId: apigee.organizations.environments.queries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19297,7 +19189,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1App' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListAsyncQueriesResponse parameters: - in: path name: organizationsId @@ -19305,49 +19198,46 @@ paths: schema: type: string - in: path - name: appsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/apis/{apisId}: - parameters: *ref_51 - 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 - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' - parameters: - - in: path - name: organizationsId - required: true + - in: query + name: from schema: type: string - - in: path - name: apisId - required: true + - in: query + name: to schema: type: string - patch: - description: Updates an existing API proxy. - operationId: apigee.organizations.apis.patch + - in: query + name: inclQueriesWithoutReport + schema: + type: string + - in: query + name: dataset + schema: + type: string + - in: query + name: status + schema: + type: string + - in: query + name: submittedBy + 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/GoogleCloudApigeeV1ApiProxy' + $ref: '#/components/schemas/GoogleCloudApigeeV1Query' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19359,7 +19249,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' parameters: - in: path name: organizationsId @@ -19367,18 +19257,18 @@ paths: schema: type: string - in: path - name: apisId + name: environmentsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask + /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}: + parameters: *ref_51 get: - description: Gets an API proxy including a list of existing revisions. - operationId: apigee.organizations.apis.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 @@ -19390,7 +19280,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' parameters: - in: path name: organizationsId @@ -19398,35 +19288,23 @@ paths: schema: type: string - in: path - name: apisId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/apis: + - in: path + name: queriesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}/resulturl: parameters: *ref_51 - post: + get: 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' + 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 @@ -19438,31 +19316,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse 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: validate - schema: - type: boolean - - in: query - name: name + - in: path + name: queriesId + required: true schema: type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}/result: + parameters: *ref_51 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 + 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 @@ -19474,26 +19355,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListApiProxiesResponse' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: includeRevisions + - in: path + name: environmentsId + required: true schema: - type: boolean - - in: query - name: includeMetaData + type: string + - in: path + name: queriesId + required: true schema: - type: boolean - /v1/organizations/{organizationsId}/apis/{apisId}/deployments: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}: parameters: *ref_51 get: - description: Lists all deployments of an API proxy. - operationId: apigee.organizations.apis.deployments.list + 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 @@ -19505,8 +19391,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' parameters: - in: path name: organizationsId @@ -19514,15 +19399,22 @@ paths: schema: type: string - in: path - name: apisId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}/deployments: + - in: path + name: securityReportsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}/resultView: parameters: *ref_51 get: - description: Lists all deployments of an API proxy revision. - operationId: apigee.organizations.apis.revisions.deployments.list + 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 @@ -19535,7 +19427,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + #/components/schemas/GoogleCloudApigeeV1SecurityReportResultView parameters: - in: path name: organizationsId @@ -19543,23 +19435,20 @@ paths: schema: type: string - in: path - name: apisId + name: environmentsId required: true schema: type: string - in: path - name: revisionsId + name: securityReportsId required: true schema: type: string - /v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports: parameters: *ref_51 - 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: Return a list of Security Reports + operationId: apigee.organizations.environments.securityReports.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19571,7 +19460,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListSecurityReportsResponse parameters: - in: path name: organizationsId @@ -19579,29 +19469,51 @@ paths: schema: type: string - in: path - name: apisId + name: environmentsId required: true schema: type: string - - in: path - name: revisionsId - required: true + - in: query + name: from + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: submittedBy + schema: + type: string + - in: query + name: dataset + schema: + type: string + - in: query + name: status + schema: + type: string + - in: query + name: to 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 + 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/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQuery' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19613,7 +19525,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' parameters: - in: path name: organizationsId @@ -19621,29 +19533,59 @@ paths: schema: type: string - in: path - name: apisId + name: environmentsId required: true schema: type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}/result: + parameters: *ref_51 + 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 + 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: revisionsId + name: organizationsId required: true schema: type: string - - in: query - name: validate + - in: path + name: environmentsId + required: true schema: - type: boolean - 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 + type: string + - in: path + name: securityReportsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/addonsConfig:setAddonEnablement: + parameters: *ref_51 + 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 @@ -19655,7 +19597,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -19663,24 +19605,17 @@ paths: schema: type: string - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId + name: environmentsId required: true schema: type: string - - in: query - name: format - schema: - type: string - /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions: parameters: *ref_51 - delete: - description: Deletes a key value map from an API proxy. - operationId: apigee.organizations.apis.keyvaluemaps.delete + get: + 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 @@ -19692,7 +19627,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListSecurityActionsResponse parameters: - in: path name: organizationsId @@ -19700,25 +19636,31 @@ paths: schema: type: string - in: path - name: apisId + name: environmentsId required: true schema: type: string - - in: path - name: keyvaluemapsId - 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 - /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps: - parameters: *ref_51 post: - description: Creates a key value map in an API proxy. - operationId: apigee.organizations.apis.keyvaluemaps.create + description: CreateSecurityAction creates a SecurityAction. + operationId: apigee.organizations.environments.securityActions.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19730,7 +19672,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' parameters: - in: path name: organizationsId @@ -19738,20 +19680,19 @@ paths: schema: type: string - in: path - name: apisId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: + - in: query + name: securityActionId + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}: parameters: *ref_51 - 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 + get: + description: Get a SecurityAction by name. + operationId: apigee.organizations.environments.securityActions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19763,7 +19704,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' parameters: - in: path name: organizationsId @@ -19771,30 +19712,30 @@ paths: schema: type: string - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: keyvaluemapsId + name: environmentsId required: true schema: type: string - in: path - name: entriesId + name: securityActionsId required: true schema: type: string - put: + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}:disable: + parameters: *ref_51 + 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 + 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/GoogleCloudApigeeV1KeyValueEntry' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DisableSecurityActionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19806,7 +19747,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' parameters: - in: path name: organizationsId @@ -19814,26 +19755,30 @@ paths: schema: type: string - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: keyvaluemapsId + name: environmentsId required: true schema: type: string - in: path - name: entriesId + name: securityActionsId required: true schema: type: string - get: + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}:enable: + parameters: *ref_51 + post: 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 + 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 @@ -19845,7 +19790,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' parameters: - in: path name: organizationsId @@ -19853,33 +19798,20 @@ paths: schema: type: string - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: keyvaluemapsId + name: environmentsId required: true schema: type: string - in: path - name: entriesId + name: securityActionsId required: true schema: type: string - /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}/entries: + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/deployments: parameters: *ref_51 - 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' + 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 @@ -19891,7 +19823,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId @@ -19899,21 +19832,20 @@ paths: schema: type: string - in: path - name: apisId + name: environmentsId required: true schema: type: string - in: path - name: keyvaluemapsId + name: apisId required: true schema: type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}/data/{dataId}: + parameters: *ref_51 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 + 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 @@ -19926,43 +19858,47 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse + #/components/schemas/GoogleCloudApigeeV1DebugSessionTransaction 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: keyvaluemapsId + name: revisionsId required: true schema: type: string - - in: query - name: pageSize + - in: path + name: debugsessionsId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: dataId + required: true schema: type: string - /v1/organizations/{organizationsId}/securityAssessmentResults:batchCompute: + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}/data: parameters: *ref_51 - 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 + 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 @@ -19974,19 +19910,40 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/hostQueries: + - 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 + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions: parameters: *ref_51 get: - description: Return a list of Asynchronous Queries at host level. - operationId: apigee.organizations.hostQueries.list + 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 @@ -19997,55 +19954,47 @@ paths: description: Successful response content: application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListAsyncQueriesResponse - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: query - name: dataset - schema: - type: string - - in: query - name: submittedBy + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDebugSessionsResponse + parameters: + - in: path + name: organizationsId + required: true schema: type: string - - in: query - name: inclQueriesWithoutReport + - in: path + name: environmentsId + required: true schema: type: string - - in: query - name: envgroupHostname + - in: path + name: apisId + required: true schema: type: string - - in: query - name: from + - in: path + name: revisionsId + required: true schema: type: string - in: query - name: status + name: pageSize schema: - type: string + type: integer + format: int32 - in: query - name: to + name: pageToken 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 + 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 @@ -20057,51 +20006,38 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/hostQueries/{hostQueriesId}/result: - parameters: *ref_51 - 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 - security: - - Oauth2: - - https://www.googleapis.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 + name: environmentsId required: true schema: type: string - in: path - name: hostQueriesId + name: apisId required: true schema: type: string - /v1/organizations/{organizationsId}/hostQueries/{hostQueriesId}/resultView: + - 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_51 get: - description: '' - operationId: apigee.organizations.hostQueries.getResultView + description: Retrieves a debug session. + operationId: apigee.organizations.environments.apis.revisions.debugsessions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20113,7 +20049,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQueryResultView' + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' parameters: - in: path name: organizationsId @@ -20121,18 +20057,43 @@ paths: schema: type: string - in: path - name: hostQueriesId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/hostQueries/{hostQueriesId}: + - 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}/deployments:generateUndeployChangeReport: parameters: *ref_51 - 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 + 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 @@ -20144,7 +20105,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentChangeReport' parameters: - in: path name: organizationsId @@ -20152,20 +20113,39 @@ paths: schema: type: string - in: path - name: hostQueriesId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}: + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments:generateDeployChangeReport: parameters: *ref_51 - get: + post: 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 + 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 @@ -20177,7 +20157,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentChangeReport' parameters: - in: path name: organizationsId @@ -20185,59 +20165,31 @@ 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' - security: - - Oauth2: - - https://www.googleapis.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 + name: apisId required: true schema: type: string - in: path - name: apiproductsId + name: revisionsId required: true schema: type: string - delete: + - in: query + name: override + schema: + type: boolean + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments: + parameters: *ref_51 + get: 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 + 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 @@ -20249,7 +20201,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' parameters: - in: path name: organizationsId @@ -20257,19 +20209,35 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/apiproducts: - parameters: *ref_51 - get: + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + post: 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 + 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 @@ -20281,61 +20249,49 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListApiProductsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: attributename + - in: path + name: environmentsId + required: true schema: type: string - - in: query - name: attributevalue + - in: path + name: apisId + required: true schema: type: string - - in: query - name: count + - in: path + name: revisionsId + required: true schema: type: string - format: int64 - in: query - name: expand + name: sequencedRollout schema: type: boolean - in: query - name: startKey + name: serviceAccount schema: type: string - post: + - in: query + name: override + schema: + type: boolean + delete: 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' + 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 @@ -20347,34 +20303,42 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes: + - 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 + /v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers: parameters: *ref_51 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: Creates a TargetServer in the specified environment. + operationId: apigee.organizations.environments.targetservers.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20386,7 +20350,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' parameters: - in: path name: organizationsId @@ -20394,13 +20358,19 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string + - in: query + name: name + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers/{targetserversId}: + parameters: *ref_51 get: - description: Lists all API product attributes. - operationId: apigee.organizations.apiproducts.attributes.list + description: Gets a TargetServer resource. + operationId: apigee.organizations.environments.targetservers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20412,7 +20382,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' parameters: - in: path name: organizationsId @@ -20420,20 +20390,26 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId + required: true + schema: + type: string + - in: path + name: targetserversId required: true schema: type: string - /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/rateplans/{rateplansId}: - parameters: *ref_51 put: - description: Updates an existing rate plan. - operationId: apigee.organizations.apiproducts.rateplans.update + 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/GoogleCloudApigeeV1RatePlan' + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20445,7 +20421,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' parameters: - in: path name: organizationsId @@ -20453,18 +20429,20 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - in: path - name: rateplansId + name: targetserversId required: true schema: type: string delete: - description: Deletes a rate plan. - operationId: apigee.organizations.apiproducts.rateplans.delete + description: >- + 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 @@ -20476,7 +20454,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' parameters: - in: path name: organizationsId @@ -20484,18 +20462,20 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - in: path - name: rateplansId + name: targetserversId required: true schema: type: string - get: - description: Gets the details of a rate plan. - operationId: apigee.organizations.apiproducts.rateplans.get + /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}: + parameters: *ref_51 + delete: + description: Deletes an alias. + operationId: apigee.organizations.environments.keystores.aliases.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20507,7 +20487,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' parameters: - in: path name: organizationsId @@ -20515,20 +20495,23 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - in: path - name: rateplansId + name: keystoresId + required: true + schema: + type: string + - in: path + name: aliasesId required: true schema: type: string - /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/rateplans: - parameters: *ref_51 get: - description: Lists all the rate plans for an API product. - operationId: apigee.organizations.apiproducts.rateplans.list + description: Gets an alias. + operationId: apigee.organizations.environments.keystores.aliases.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20540,7 +20523,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListRatePlansResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' parameters: - in: path name: organizationsId @@ -20548,49 +20531,74 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - - in: query - name: expand + - in: path + name: keystoresId + required: true schema: - type: boolean - - in: query - name: orderBy + type: string + - in: path + name: aliasesId + required: true schema: type: string - - in: query - name: state + 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 + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $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: path + name: keystoresId + required: true + schema: + type: string + - in: path + name: aliasesId + required: true schema: type: string - in: query - name: count + name: ignoreNewlineValidation schema: - type: integer - format: int32 - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + type: boolean + - in: query + name: ignoreExpiryValidation + schema: + type: boolean + /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}/certificate: + parameters: *ref_51 + 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 @@ -20602,7 +20610,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -20610,15 +20618,27 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes/{attributesId}: + - 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_51 - delete: - description: Deletes an API product attribute. - operationId: apigee.organizations.apiproducts.attributes.delete + get: + description: >- + 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 @@ -20630,7 +20650,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -20638,30 +20658,42 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - in: path - name: attributesId + 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_51 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 + 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/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20673,7 +20705,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' parameters: - in: path name: organizationsId @@ -20681,18 +20713,40 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - in: path - name: attributesId + name: keystoresId required: true schema: type: string + - in: query + name: ignoreNewlineValidation + schema: + type: boolean + - in: query + name: alias + schema: + type: string + - in: query + name: _password + schema: + type: string + - in: query + name: ignoreExpiryValidation + schema: + type: boolean + - in: query + name: format + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}: + parameters: *ref_51 get: - description: Gets the value of an API product attribute. - operationId: apigee.organizations.apiproducts.attributes.get + description: Gets a keystore or truststore. + operationId: apigee.organizations.environments.keystores.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20704,7 +20758,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' parameters: - in: path name: organizationsId @@ -20712,20 +20766,18 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - in: path - name: attributesId + name: keystoresId required: true schema: type: string - /v1/organizations/{organizationsId}/optimizedHostStats/{optimizedHostStatsId}: - parameters: *ref_51 - get: - description: Similar to GetHostStats except that the response is less verbose. - operationId: apigee.organizations.optimizedHostStats.get + delete: + description: Deletes a keystore or truststore. + operationId: apigee.organizations.environments.keystores.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20737,7 +20789,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStats' + $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' parameters: - in: path name: organizationsId @@ -20745,74 +20797,30 @@ paths: schema: type: string - in: path - name: optimizedHostStatsId + name: environmentsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: tsAscending - schema: - type: boolean - - in: query - name: realtime - schema: - type: boolean - - in: query - name: envgroupHostname - schema: - type: string - - in: query - name: limit - schema: - type: string - - in: query - name: select - schema: - type: string - - in: query - name: topk - schema: - type: string - - in: query - name: timeUnit - schema: - type: string - - in: query - name: accuracy - schema: - type: string - - in: query - name: sortby - schema: - type: string - - in: query - name: sort - schema: - type: string - - in: query - name: timeRange - schema: - type: string - - in: query - name: offset - schema: - type: string - - in: query - name: tzo + - in: path + name: keystoresId + required: true schema: type: string - /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores: parameters: *ref_51 - get: + post: 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 + 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 @@ -20824,7 +20832,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' parameters: - in: path name: organizationsId @@ -20832,25 +20840,25 @@ paths: schema: type: string - in: path - name: keyvaluemapsId + name: environmentsId required: true schema: type: string - - in: path - name: entriesId - required: true + - in: query + name: name schema: type: string - put: - description: >- - Update key value entry scoped to an organization, environment, or API - proxy for an existing key. - operationId: apigee.organizations.keyvaluemaps.entries.update + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityStats:queryTimeSeriesStats: + parameters: *ref_51 + 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/GoogleCloudApigeeV1KeyValueEntry' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20862,7 +20870,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsResponse parameters: - in: path name: organizationsId @@ -20870,23 +20879,20 @@ paths: schema: type: string - in: path - name: keyvaluemapsId - required: true - schema: - type: string - - in: path - name: entriesId + name: environmentsId 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.keyvaluemaps.entries.delete + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityStats:queryTabularStats: + parameters: *ref_51 + 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 @@ -20898,7 +20904,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1QueryTabularStatsResponse parameters: - in: path name: organizationsId @@ -20906,23 +20913,21 @@ paths: schema: type: string - in: path - name: keyvaluemapsId - required: true - schema: - type: string - - in: path - name: entriesId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}/entries: + /v1/organizations/{organizationsId}/environments/{environmentsId}/stats/{statsId}: parameters: *ref_51 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 + 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 @@ -20934,8 +20939,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1Stats' parameters: - in: path name: organizationsId @@ -20943,30 +20947,89 @@ paths: schema: type: string - in: path - name: keyvaluemapsId + name: environmentsId + required: true + schema: + type: string + - in: path + name: statsId required: true schema: type: string - in: query - name: pageToken + name: topk schema: type: string - in: query - name: pageSize + name: offset schema: - type: integer - format: int32 + type: string + - in: query + name: tsAscending + schema: + type: boolean + - in: query + name: timeUnit + schema: + type: string + - in: query + name: sort + schema: + type: string + - in: query + name: sortby + schema: + type: string + - in: query + name: realtime + schema: + type: boolean + - in: query + name: select + 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: limit + schema: + type: string + - in: query + name: aggTable + schema: + type: string + - in: query + name: timeRange + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig/overrides: + parameters: *ref_51 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 + 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/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20978,7 +21041,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' parameters: - in: path name: organizationsId @@ -20986,20 +21049,15 @@ paths: schema: type: string - in: path - name: keyvaluemapsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/keyvaluemaps: - parameters: *ref_51 - post: - description: Creates a key value map in an organization. - operationId: apigee.organizations.keyvaluemaps.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + 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 @@ -21011,18 +21069,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListTraceConfigOverridesResponse parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}: + - in: path + 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}/environments/{environmentsId}/traceConfig/overrides/{overridesId}: parameters: *ref_51 delete: - description: Deletes a key value map from an organization. - operationId: apigee.organizations.keyvaluemaps.delete + description: Deletes a distributed trace configuration override. + operationId: apigee.organizations.environments.traceConfig.overrides.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21034,7 +21107,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -21042,23 +21115,27 @@ paths: schema: type: string - in: path - name: keyvaluemapsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}: - parameters: *ref_51 - delete: + - in: path + name: overridesId + required: true + schema: + type: string + patch: 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 + 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 @@ -21070,7 +21147,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' parameters: - in: path name: organizationsId @@ -21078,16 +21155,23 @@ paths: schema: type: string - in: path - name: developersId + 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 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 trace configuration override. + operationId: apigee.organizations.environments.traceConfig.overrides.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21099,7 +21183,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' parameters: - in: path name: organizationsId @@ -21107,26 +21191,29 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - - in: query - name: action + - in: path + name: overridesId + required: true schema: type: string - post: + /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}/{name}: + parameters: *ref_51 + put: 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 + 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 @@ -21138,7 +21225,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' parameters: - in: path name: organizationsId @@ -21146,31 +21233,26 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - - in: query - name: action + - in: path + name: type + required: true schema: type: string - put: + - in: path + name: name + required: true + schema: + type: string + get: 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' + 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 @@ -21182,7 +21264,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -21190,30 +21272,26 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/attributes: - parameters: *ref_51 - post: + - in: path + name: type + required: true + schema: + type: string + - in: path + name: name + required: true + schema: + type: string + delete: 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' + 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 @@ -21225,7 +21303,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' parameters: - in: path name: organizationsId @@ -21233,13 +21311,28 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId + required: true + schema: + type: string + - in: path + name: type + required: true + schema: + type: string + - in: path + name: name required: true schema: type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}: + parameters: *ref_51 get: - description: Returns a list of all developer attributes. - operationId: apigee.organizations.developers.attributes.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.listEnvironmentResources security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21251,7 +21344,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListEnvironmentResourcesResponse parameters: - in: path name: organizationsId @@ -21259,15 +21353,23 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/monetizationConfig: + - in: path + name: type + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles: parameters: *ref_51 get: - description: Gets the monetization configuration for the developer. - operationId: apigee.organizations.developers.getMonetizationConfig + 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 @@ -21280,7 +21382,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeveloperMonetizationConfig + #/components/schemas/GoogleCloudApigeeV1ListEnvironmentResourcesResponse parameters: - in: path name: organizationsId @@ -21288,19 +21390,26 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - put: - description: Updates the monetization configuration for the developer. - operationId: apigee.organizations.developers.updateMonetizationConfig + - in: query + name: type + schema: + type: string + 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/GoogleCloudApigeeV1DeveloperMonetizationConfig + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21312,8 +21421,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeveloperMonetizationConfig + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' parameters: - in: path name: organizationsId @@ -21321,21 +21429,30 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers: + - in: query + name: type + schema: + type: string + - in: query + name: name + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}: parameters: *ref_51 - get: + patch: 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 + 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 @@ -21347,50 +21464,74 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListOfDevelopersResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: expand - schema: - type: boolean - - in: query - name: count + - in: path + name: environmentsId + required: true schema: type: string - format: int64 - in: query - name: ids + name: updateMask schema: type: string - - in: query - name: includeCompany - schema: - type: boolean - - in: query - name: startKey + format: google-fieldmask + 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/GoogleCloudApigeeV1Environment' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' + parameters: + - in: path + name: organizationsId + required: true schema: type: string - - in: query - name: app + - in: path + name: environmentsId + required: true schema: type: string 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 + 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/GoogleCloudApigeeV1Developer' + $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21402,18 +21543,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/balance: - parameters: *ref_51 - get: - description: Gets the account balance for the developer. - operationId: apigee.organizations.developers.getBalance + - in: path + name: environmentsId + required: true + schema: + type: string + 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 @@ -21425,7 +21573,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalance' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -21433,15 +21581,13 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/subscriptions/{subscriptionsId}: - parameters: *ref_51 get: - description: Gets details for an API product subscription. - operationId: apigee.organizations.developers.subscriptions.get + description: Gets environment details. + operationId: apigee.organizations.environments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21453,7 +21599,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' + $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' parameters: - in: path name: organizationsId @@ -21461,26 +21607,24 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: subscriptionsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/subscriptions/{subscriptionsId}:expire: + /v1/organizations/{organizationsId}/environments/{environmentsId}:testIamPermissions: parameters: *ref_51 post: - description: Expires an API product subscription immediately. - operationId: apigee.organizations.developers.subscriptions.expire + 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/GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21492,7 +21636,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: organizationsId @@ -21500,25 +21644,15 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: subscriptionsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/subscriptions: + /v1/organizations/{organizationsId}/environments/{environmentsId}/debugmask: parameters: *ref_51 - post: - description: 'Creates a subscription to an API product. ' - operationId: apigee.organizations.developers.subscriptions.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' + get: + description: Gets the debug mask singleton resource for an environment. + operationId: apigee.organizations.environments.getDebugmask security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21530,7 +21664,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' parameters: - in: path name: organizationsId @@ -21538,13 +21672,18 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - get: - description: Lists all API product subscriptions for a developer. - operationId: apigee.organizations.developers.subscriptions.list + 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 @@ -21556,8 +21695,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' parameters: - in: path name: organizationsId @@ -21565,31 +21703,33 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - in: query - name: count + name: replaceRepeatedFields schema: - type: integer - format: int32 + type: boolean - in: query - name: startKey + name: updateMask schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}/apiproducts/{apiproductsId}: + format: google-fieldmask + /v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig: parameters: *ref_51 - post: + patch: 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 + 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/GoogleCloudApigeeV1TraceConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21601,7 +21741,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfig' parameters: - in: path name: organizationsId @@ -21609,36 +21749,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 - required: true - schema: - type: string - - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - in: query - name: action + name: updateMask schema: 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 + format: google-fieldmask + get: + description: Get distributed trace configuration in an environment. + operationId: apigee.organizations.environments.getTraceConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21650,7 +21772,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfig' parameters: - in: path name: organizationsId @@ -21658,49 +21780,20 @@ 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: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/create: + /v1/organizations/{organizationsId}/environments/{environmentsId}:getIamPolicy: parameters: *ref_51 - post: + get: 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' + 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 @@ -21712,7 +21805,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: organizationsId @@ -21720,31 +21813,31 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - - in: path - name: appsId - required: true + - in: query + name: options.requestedPolicyVersion schema: - type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}: + type: integer + format: int32 + /v1/organizations/{organizationsId}/environments/{environmentsId}:setIamPolicy: parameters: *ref_51 - put: + 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 + 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/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21756,7 +21849,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: organizationsId @@ -21764,35 +21857,20 @@ 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: environmentsId required: true schema: type: string + /v1/organizations/{organizationsId}/environments: + parameters: *ref_51 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 an environment in an organization. + operationId: apigee.organizations.environments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21804,37 +21882,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleLongrunningOperation' 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 - - in: path - name: keysId - required: true - schema: - type: string - in: query - name: action + name: name schema: type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActionsConfig: + parameters: *ref_51 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 + GetSecurityActionConfig returns the current SecurityActions + configuration. + operationId: apigee.organizations.environments.getSecurityActionsConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21843,41 +21908,32 @@ paths: responses: '200': description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: developersId - required: true - schema: - type: string + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionsConfig' + parameters: - in: path - name: appsId + name: organizationsId required: true schema: type: string - in: path - name: keysId + name: environmentsId required: true schema: type: string - delete: + patch: 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 + 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 @@ -21889,7 +21945,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionsConfig' parameters: - in: path name: organizationsId @@ -21897,44 +21953,25 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId + name: environmentsId required: true schema: type: string - - in: path - name: keysId - required: true + - in: query + name: updateMask schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys: + format: google-fieldmask + /v1/organizations/{organizationsId}/environments/{environmentsId}:unsubscribe: parameters: *ref_51 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 + description: Deletes a subscription for the environment's Pub/Sub topic. + operationId: apigee.organizations.environments.unsubscribe requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1Subscription' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21946,7 +21983,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -21954,20 +21991,18 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes/{attributesId}: + /v1/organizations/{organizationsId}/environments/{environmentsId}/apiSecurityRuntimeConfig: parameters: *ref_51 get: - description: Returns a developer app attribute. - operationId: apigee.organizations.developers.apps.attributes.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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21979,7 +22014,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ApiSecurityRuntimeConfig parameters: - in: path name: organizationsId @@ -21987,23 +22023,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: environmentsId required: true schema: type: string - delete: - description: Deletes a developer app attribute. - operationId: apigee.organizations.developers.apps.attributes.delete + /v1/organizations/{organizationsId}/environments/{environmentsId}:subscribe: + parameters: *ref_51 + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22015,7 +22046,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleCloudApigeeV1Subscription' parameters: - in: path name: organizationsId @@ -22023,36 +22054,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: environmentsId 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + /v1/organizations/{organizationsId}/environments/{environmentsId}/deployedConfig: + parameters: *ref_51 + get: + description: Gets the deployed configuration for an environment. + operationId: apigee.organizations.environments.getDeployedConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22064,7 +22074,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentConfig' parameters: - in: path name: organizationsId @@ -22072,25 +22082,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: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes: + /v1/organizations/{organizationsId}/environments/{environmentsId}/addonsConfig: parameters: *ref_51 get: - description: Returns a list of all developer app attributes. - operationId: apigee.organizations.developers.apps.attributes.list + description: Gets the add-ons config of an environment. + operationId: apigee.organizations.environments.getAddonsConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22102,7 +22102,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' parameters: - in: path name: organizationsId @@ -22110,25 +22110,21 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId + name: environmentsId required: true schema: type: string + /v1/organizations/{organizationsId}/securityAssessmentResults:batchCompute: + parameters: *ref_51 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 + description: Compute RAV2 security scores for a set of resources. + operationId: apigee.organizations.securityAssessmentResults.batchCompute requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22140,33 +22136,50 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse parameters: - in: path name: organizationsId required: true schema: type: string + /v1/organizations/{organizationsId}/sites/{sitesId}/apicategories: + parameters: *ref_51 + 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 + 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: developersId + name: organizationsId required: true schema: type: string - in: path - name: appsId + name: sitesId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps: - parameters: *ref_51 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 @@ -22179,7 +22192,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeveloperAppsResponse + #/components/schemas/GoogleCloudApigeeV1ListApiCategoriesResponse parameters: - in: path name: organizationsId @@ -22187,41 +22200,20 @@ 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: shallowExpand - schema: - type: boolean - - in: query - name: startKey - schema: - type: string - - in: query - name: count - schema: - type: string - format: int64 - 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 + type: string + /v1/organizations/{organizationsId}/sites/{sitesId}/apicategories/{apicategoriesId}: + parameters: *ref_51 + patch: + description: Updates an API category. + operationId: apigee.organizations.sites.apicategories.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22233,7 +22225,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryResponse' parameters: - in: path name: organizationsId @@ -22241,30 +22233,18 @@ paths: schema: type: string - in: path - name: developersId + name: sitesId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}: - parameters: *ref_51 - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + - 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 @@ -22276,7 +22256,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeleteResponse' parameters: - in: path name: organizationsId @@ -22284,18 +22264,18 @@ 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 the details for a developer app. - operationId: apigee.organizations.developers.apps.get + description: Gets an API category. + operationId: apigee.organizations.sites.apicategories.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22307,7 +22287,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryResponse' parameters: - in: path name: organizationsId @@ -22315,30 +22295,20 @@ 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 - - in: query - name: entity - schema: - type: string - - in: query - name: query - 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_51 + 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 @@ -22350,7 +22320,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ApiDocDocumentationResponse parameters: - in: path name: organizationsId @@ -22358,49 +22329,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 @@ -22412,7 +22359,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ApiDocDocumentationResponse parameters: - in: path name: organizationsId @@ -22420,24 +22368,20 @@ 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 - schema: - type: string - /v1/organizations/{organizationsId}/developers/{developersId}/attributes/{attributesId}: + /v1/organizations/{organizationsId}/sites/{sitesId}/apidocs/{apidocsId}: parameters: *ref_51 - get: - description: Returns the value of the specified developer attribute. - operationId: apigee.organizations.developers.attributes.get + delete: + description: Deletes a catalog item. + operationId: apigee.organizations.sites.apidocs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22449,7 +22393,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeleteResponse' parameters: - in: path name: organizationsId @@ -22457,29 +22401,23 @@ paths: schema: type: string - in: path - name: developersId + name: sitesId required: true schema: type: string - in: path - name: attributesId + name: apidocsId 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 + put: + description: Updates a catalog item. + operationId: apigee.organizations.sites.apidocs.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22491,7 +22429,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' parameters: - in: path name: organizationsId @@ -22499,18 +22437,18 @@ paths: schema: type: string - in: path - name: developersId + name: sitesId required: true schema: type: string - in: path - name: attributesId + name: apidocsId required: true schema: type: string - delete: - description: Deletes a developer attribute. - operationId: apigee.organizations.developers.attributes.delete + get: + description: Gets a catalog item. + operationId: apigee.organizations.sites.apidocs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22522,7 +22460,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' parameters: - in: path name: organizationsId @@ -22530,26 +22468,20 @@ paths: schema: type: string - in: path - name: developersId + name: sitesId required: true schema: type: string - in: path - name: attributesId + name: apidocsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/balance:credit: + /v1/organizations/{organizationsId}/sites/{sitesId}/apidocs: parameters: *ref_51 - post: - description: Credits the account balance for the developer. - operationId: apigee.organizations.developers.balance.credit - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1CreditDeveloperBalanceRequest + 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 @@ -22561,7 +22493,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalance' + $ref: '#/components/schemas/GoogleCloudApigeeV1ListApiDocsResponse' parameters: - in: path name: organizationsId @@ -22569,23 +22501,27 @@ paths: schema: type: string - in: path - name: developersId + name: sitesId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/balance:adjust: - parameters: *ref_51 + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string 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 catalog item. + operationId: apigee.organizations.sites.apidocs.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1AdjustDeveloperBalanceRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22597,7 +22533,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalance' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' parameters: - in: path name: organizationsId @@ -22605,15 +22541,17 @@ paths: schema: type: string - in: path - name: developersId + name: sitesId required: true schema: type: string - /v1/organizations/{organizationsId}/deployments: + /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}/resultView: parameters: *ref_51 get: - description: Lists all deployments of API proxies or shared flows. - operationId: apigee.organizations.deployments.list + 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 @@ -22626,22 +22564,26 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + #/components/schemas/GoogleCloudApigeeV1SecurityReportResultView parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: sharedFlows + - in: path + name: hostSecurityReportsId + required: true schema: - type: boolean - /v1/organizations/{organizationsId}/endpointAttachments/{endpointAttachmentsId}: + type: string + /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}: parameters: *ref_51 - delete: - description: Deletes an endpoint attachment. - operationId: apigee.organizations.endpointAttachments.delete + 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 @@ -22653,7 +22595,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' parameters: - in: path name: organizationsId @@ -22661,13 +22603,20 @@ paths: schema: type: string - in: path - name: endpointAttachmentsId + name: hostSecurityReportsId required: true schema: type: string + /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}/result: + parameters: *ref_51 get: - description: Gets the endpoint attachment. - operationId: apigee.organizations.endpointAttachments.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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22679,7 +22628,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -22687,22 +22636,24 @@ paths: schema: type: string - in: path - name: endpointAttachmentsId + name: hostSecurityReportsId required: true schema: type: string - /v1/organizations/{organizationsId}/endpointAttachments: + /v1/organizations/{organizationsId}/hostSecurityReports: parameters: *ref_51 post: description: >- - Creates an endpoint attachment. **Note:** Not supported for Apigee - hybrid. - operationId: apigee.organizations.endpointAttachments.create + 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/GoogleCloudApigeeV1EndpointAttachment' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQuery' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22714,20 +22665,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: endpointAttachmentId - schema: - type: string get: - description: Lists the endpoint attachments in an organization. - operationId: apigee.organizations.endpointAttachments.list + description: Return a list of Security Reports at host level. + operationId: apigee.organizations.hostSecurityReports.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22740,7 +22687,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListEndpointAttachmentsResponse + #/components/schemas/GoogleCloudApigeeV1ListSecurityReportsResponse parameters: - in: path name: organizationsId @@ -22748,7 +22695,7 @@ paths: schema: type: string - in: query - name: pageToken + name: dataset schema: type: string - in: query @@ -22756,11 +22703,35 @@ paths: schema: type: integer format: int32 - /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/attachments/{attachmentsId}: + - in: query + name: status + schema: + type: string + - in: query + name: to + schema: + type: string + - in: query + name: envgroupHostname + schema: + type: string + - in: query + name: submittedBy + schema: + type: string + - in: query + name: from + schema: + type: string + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/datacollectors/{datacollectorsId}: parameters: *ref_51 - delete: - description: Deletes an environment group attachment. - operationId: apigee.organizations.envgroups.attachments.delete + get: + description: Gets a data collector. + operationId: apigee.organizations.datacollectors.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22772,7 +22743,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' parameters: - in: path name: organizationsId @@ -22780,18 +22751,18 @@ paths: schema: type: string - in: path - name: envgroupsId - required: true - schema: - type: string - - in: path - name: attachmentsId + name: datacollectorsId required: true schema: type: string - get: - description: Gets an environment group attachment. - operationId: apigee.organizations.envgroups.attachments.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 @@ -22803,8 +22774,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' parameters: - in: path name: organizationsId @@ -22812,20 +22782,46 @@ paths: schema: type: string - in: path - name: envgroupsId + name: datacollectorsId + 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 + security: + - Oauth2: + - https://www.googleapis.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: attachmentsId + name: datacollectorsId required: true schema: type: string - /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/attachments: + /v1/organizations/{organizationsId}/datacollectors: parameters: *ref_51 get: - description: Lists all attachments of an environment group. - operationId: apigee.organizations.envgroups.attachments.list + description: Lists all data collectors. + operationId: apigee.organizations.datacollectors.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22838,16 +22834,15 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse + #/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: query @@ -22855,19 +22850,14 @@ paths: schema: type: integer format: int32 - - in: query - name: pageToken - schema: - type: string post: - description: Creates a new attachment of an environment to an environment group. - operationId: apigee.organizations.envgroups.attachments.create + description: Creates a new data collector. + operationId: apigee.organizations.datacollectors.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22879,23 +22869,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: envgroupsId - required: true + - in: query + name: dataCollectorId schema: type: string - /v1/organizations/{organizationsId}/envgroups: + /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}/deployments: parameters: *ref_51 get: - description: Lists all environment groups. - operationId: apigee.organizations.envgroups.list + 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 @@ -22908,30 +22897,35 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListEnvironmentGroupsResponse + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: sharedflowsId + 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 environment group. - operationId: apigee.organizations.envgroups.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' + type: string + /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}: + parameters: *ref_51 + 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 @@ -22943,22 +22937,32 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: sharedflowsId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string - in: query - name: name + name: format schema: type: string - /v1/organizations/{organizationsId}/envgroups/{envgroupsId}: - parameters: *ref_51 - get: - description: Gets an environment group. - operationId: apigee.organizations.envgroups.get + 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 @@ -22970,7 +22974,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' parameters: - in: path name: organizationsId @@ -22978,18 +22982,28 @@ paths: schema: type: string - in: path - name: envgroupsId + name: sharedflowsId required: true schema: type: string - patch: - description: Updates an environment group. - operationId: apigee.organizations.envgroups.patch + - in: path + name: revisionsId + required: true + schema: + type: string + 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/GoogleCloudApigeeV1EnvironmentGroup' + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23001,7 +23015,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' parameters: - in: path name: organizationsId @@ -23009,18 +23023,24 @@ paths: schema: type: string - in: path - name: envgroupsId + name: sharedflowsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: revisionsId + required: true schema: type: string - format: google-fieldmask - delete: - description: Deletes an environment group. - operationId: apigee.organizations.envgroups.delete + - in: query + name: validate + schema: + type: boolean + /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/deployments: + parameters: *ref_51 + get: + description: Lists all deployments of a shared flow. + operationId: apigee.organizations.sharedflows.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23032,7 +23052,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId @@ -23040,15 +23061,15 @@ paths: schema: type: string - in: path - name: envgroupsId + name: sharedflowsId required: true schema: type: string - /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/deployedIngressConfig: + /v1/organizations/{organizationsId}/sharedflows: parameters: *ref_51 get: - description: Gets the deployed ingress configuration for an environment group. - operationId: apigee.organizations.envgroups.getDeployedIngressConfig + description: Lists all shared flows in the organization. + operationId: apigee.organizations.sharedflows.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23060,30 +23081,35 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupConfig' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListSharedFlowsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: envgroupsId - required: true + - in: query + name: includeMetaData schema: - type: string + type: boolean - in: query - name: view + name: includeRevisions schema: - type: string - /v1/organizations/{organizationsId}/instances/{instancesId}: - parameters: *ref_51 - delete: + type: boolean + 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 + 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 @@ -23095,23 +23121,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: instancesId - required: true + - in: query + name: action + schema: + type: string + - in: query + name: name schema: type: string + /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}: + parameters: *ref_51 get: - description: >- - Gets the details for an Apigee runtime instance. **Note:** Not supported - for Apigee hybrid. - operationId: apigee.organizations.instances.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 @@ -23123,7 +23152,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' parameters: - in: path name: organizationsId @@ -23131,21 +23160,15 @@ paths: schema: type: string - in: path - name: instancesId + name: sharedflowsId required: true schema: type: string - patch: + delete: 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' + 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 @@ -23157,7 +23180,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' parameters: - in: path name: organizationsId @@ -23165,22 +23188,15 @@ paths: schema: type: string - in: path - name: instancesId + name: sharedflowsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/organizations/{organizationsId}/instances: + /v1/organizations/{organizationsId}/instances/{instancesId}/canaryevaluations/{canaryevaluationsId}: parameters: *ref_51 get: - description: >- - Lists all Apigee runtime instances for the organization. **Note:** Not - supported for Apigee hybrid. - operationId: apigee.organizations.instances.list + description: Gets a CanaryEvaluation for an organization. + operationId: apigee.organizations.instances.canaryevaluations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23192,33 +23208,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListInstancesResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluation' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageSize + - in: path + name: instancesId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: canaryevaluationsId + required: true schema: type: string + /v1/organizations/{organizationsId}/instances/{instancesId}/canaryevaluations: + parameters: *ref_51 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 + description: Creates a new canary evaluation for an organization. + operationId: apigee.organizations.instances.canaryevaluations.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' + $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23237,17 +23253,16 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}:reportStatus: + - in: path + name: instancesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/instances/{instancesId}/attachments/{attachmentsId}: parameters: *ref_51 - post: - description: Reports the latest status for a runtime instance. - operationId: apigee.organizations.instances.reportStatus - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ReportInstanceStatusRequest + 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 @@ -23259,8 +23274,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ReportInstanceStatusResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceAttachment' parameters: - in: path name: organizationsId @@ -23272,8 +23286,11 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/attachments/{attachmentsId}: - parameters: *ref_51 + - in: path + name: attachmentsId + required: true + schema: + type: string delete: description: Deletes an attachment. **Note:** Not supported for Apigee hybrid. operationId: apigee.organizations.instances.attachments.delete @@ -23305,9 +23322,13 @@ paths: required: true schema: type: string + /v1/organizations/{organizationsId}/instances/{instancesId}/attachments: + parameters: *ref_51 get: - description: Gets an attachment. **Note:** Not supported for Apigee hybrid. - operationId: apigee.organizations.instances.attachments.get + 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 @@ -23319,7 +23340,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceAttachment' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListInstanceAttachmentsResponse parameters: - in: path name: organizationsId @@ -23331,13 +23353,15 @@ paths: required: true schema: type: string - - in: path - name: attachmentsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/attachments: - parameters: *ref_51 post: description: >- Creates a new attachment of an environment to an instance. **Note:** Not @@ -23371,11 +23395,14 @@ paths: required: true schema: type: string - get: + /v1/organizations/{organizationsId}/instances/{instancesId}/natAddresses/{natAddressesId}: + parameters: *ref_51 + delete: description: >- - Lists all attachments to an instance. **Note:** Not supported for Apigee + 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.attachments.list + operationId: apigee.organizations.instances.natAddresses.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23387,8 +23414,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListInstanceAttachmentsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -23400,20 +23426,16 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: natAddressesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/instances/{instancesId}/canaryevaluations/{canaryevaluationsId}: - parameters: *ref_51 get: - description: Gets a CanaryEvaluation for an organization. - operationId: apigee.organizations.instances.canaryevaluations.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 @@ -23425,7 +23447,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluation' + $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' parameters: - in: path name: organizationsId @@ -23438,59 +23460,23 @@ paths: schema: type: string - in: path - name: canaryevaluationsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/canaryevaluations: - parameters: *ref_51 - post: - 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 - 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: instancesId + name: natAddressesId required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/natAddresses: + /v1/organizations/{organizationsId}/instances/{instancesId}/natAddresses/{natAddressesId}:activate: parameters: *ref_51 - 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 + 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/GoogleCloudApigeeV1NatAddress' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ActivateNatAddressRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23514,6 +23500,13 @@ paths: required: true schema: type: string + - in: path + name: natAddressesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/instances/{instancesId}/natAddresses: + parameters: *ref_51 get: description: >- Lists the NAT addresses for an Apigee instance. **Note:** Not supported @@ -23543,28 +23536,29 @@ 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/organizations/{organizationsId}/instances/{instancesId}/natAddresses/{natAddressesId}:activate: - parameters: *ref_51 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 + 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/GoogleCloudApigeeV1ActivateNatAddressRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23588,18 +23582,14 @@ paths: required: true schema: type: string - - in: path - name: natAddressesId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/natAddresses/{natAddressesId}: + /v1/organizations/{organizationsId}/instances/{instancesId}: parameters: *ref_51 - get: + delete: description: >- - Gets the details of a NAT address. **Note:** Not supported for Apigee + 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.natAddresses.get + operationId: apigee.organizations.instances.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23611,7 +23601,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -23623,17 +23613,17 @@ paths: required: true schema: type: string - - in: path - name: natAddressesId - required: true - schema: - type: string - delete: + patch: 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 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 @@ -23657,21 +23647,16 @@ paths: required: true schema: type: string - - in: path - name: natAddressesId - required: true + - in: query + name: updateMask schema: type: string - /v1/organizations/{organizationsId}/analytics/datastores: - parameters: *ref_51 - post: - description: Create a Datastore for an org - operationId: apigee.organizations.analytics.datastores.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + format: google-fieldmask + get: + description: >- + 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 @@ -23683,16 +23668,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: instancesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/instances: + parameters: *ref_51 get: - description: List Datastores - operationId: apigee.organizations.analytics.datastores.list + 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 @@ -23704,7 +23698,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListDatastoresResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1ListInstancesResponse' parameters: - in: path name: organizationsId @@ -23712,22 +23706,25 @@ paths: schema: type: string - in: query - name: targetType + name: pageToken schema: type: string - /v1/organizations/{organizationsId}/analytics/datastores:test: - parameters: *ref_51 + - in: query + name: pageSize + schema: + type: integer + format: int32 post: 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 + 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/GoogleCloudApigeeV1Datastore' + $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23739,18 +23736,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TestDatastoreResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/analytics/datastores/{datastoresId}: + /v1/organizations/{organizationsId}/instances/{instancesId}:reportStatus: parameters: *ref_51 - get: - description: Get a Datastore - operationId: apigee.organizations.analytics.datastores.get + 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 @@ -23762,7 +23765,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ReportInstanceStatusResponse parameters: - in: path name: organizationsId @@ -23770,18 +23774,15 @@ paths: schema: type: string - in: path - name: datastoresId + name: instancesId required: true schema: type: string - put: - description: Update a Datastore - operationId: apigee.organizations.analytics.datastores.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + /v1/organizations/{organizationsId}/optimizedHostStats/{optimizedHostStatsId}: + parameters: *ref_51 + 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 @@ -23793,7 +23794,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStats' parameters: - in: path name: organizationsId @@ -23801,13 +23802,97 @@ paths: schema: type: string - in: path - name: datastoresId + name: optimizedHostStatsId required: true schema: type: string - delete: - description: Delete a Datastore from an org. - operationId: apigee.organizations.analytics.datastores.delete + - in: query + name: realtime + schema: + type: boolean + - in: query + name: tzo + schema: + type: string + - in: query + name: envgroupHostname + 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: accuracy + schema: + type: string + - in: query + name: sortby + schema: + type: string + - in: query + name: select + schema: + type: string + - in: query + name: topk + schema: + type: string + - in: query + name: timeRange + schema: + type: string + - in: query + name: limit + schema: + type: string + - in: query + name: sort + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/organizations/{organizationsId}/runtimeConfig: + parameters: *ref_51 + 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: + parameters: *ref_51 + 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 @@ -23819,38 +23904,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: datastoresId - required: true - schema: - type: string - /v1/organizations/{organizationsId}:getSyncAuthorization: - parameters: *ref_51 + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListOrganizationsResponse + parameters: [] 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 + 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/GoogleCloudApigeeV1GetSyncAuthorizationRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23862,18 +23928,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - - in: path - name: organizationsId - required: true + - in: query + name: parent schema: type: string - /v1/organizations/{organizationsId}/securitySettings: + /v1/organizations/{organizationsId}:setSyncAuthorization: parameters: *ref_51 - get: - description: GetSecuritySettings gets the security settings for API Security. - operationId: apigee.organizations.getSecuritySettings + 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 @@ -23885,23 +23966,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecuritySettings' + $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' 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' + /v1/organizations/{organizationsId}/deployedIngressConfig: + parameters: *ref_51 + get: + description: Gets the deployed ingress configuration for an organization. + operationId: apigee.organizations.getDeployedIngressConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23913,7 +23989,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecuritySettings' + $ref: '#/components/schemas/GoogleCloudApigeeV1IngressConfig' parameters: - in: path name: organizationsId @@ -23921,17 +23997,21 @@ paths: schema: type: string - in: query - name: updateMask + name: view schema: type: string - format: google-fieldmask /v1/organizations/{organizationsId}: parameters: *ref_51 - get: + put: 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 + 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 @@ -23950,16 +24030,11 @@ paths: required: true schema: type: string - put: + get: 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' + 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 @@ -24013,11 +24088,18 @@ paths: name: retention schema: type: string - /v1/organizations/{organizationsId}/runtimeConfig: + /v1/organizations/{organizationsId}/securitySettings: parameters: *ref_51 - get: - description: Get runtime config for an organization. - operationId: apigee.organizations.getRuntimeConfig + 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 @@ -24029,25 +24111,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecuritySettings' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}:setAddons: - parameters: *ref_51 - 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' + - 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 @@ -24059,25 +24137,25 @@ 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: + /v1/organizations/{organizationsId}:setAddons: parameters: *ref_51 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 + 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/GoogleCloudApigeeV1Organization' + $ref: '#/components/schemas/GoogleCloudApigeeV1SetAddonsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24090,79 +24168,32 @@ paths: application/json: schema: $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: query - name: parent - schema: - type: string - 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: [] - /v1/organizations/{organizationsId}/deployedIngressConfig: - parameters: *ref_51 - get: - description: Gets the deployed ingress configuration for an organization. - operationId: apigee.organizations.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/GoogleCloudApigeeV1IngressConfig' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: view - schema: - type: string - /v1/organizations/{organizationsId}:setSyncAuthorization: + /v1/organizations/{organizationsId}:getSyncAuthorization: parameters: *ref_51 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 + 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.setSyncAuthorization + operationId: apigee.organizations.getSyncAuthorization requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1GetSyncAuthorizationRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24205,6 +24236,29 @@ paths: required: true schema: type: string + /v1/hybrid/issuers: + parameters: *ref_51 + 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/projects/{projectsId}:provisionOrganization: parameters: *ref_51 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 48c1451a..cea62cd9 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-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub servers: @@ -1233,7 +1233,7 @@ components: - '2' x-stackQL-resources: locations: - id: apigeeregistry.locations + id: google.apigeeregistry.locations name: locations title: Locations methods: @@ -1255,15 +1255,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/locations/methods/projects_locations_list - $ref: >- #/components/x-stackQL-resources/locations/methods/projects_locations_get + - $ref: >- + #/components/x-stackQL-resources/locations/methods/projects_locations_list insert: [] update: [] delete: [] operations: - id: apigeeregistry.operations + id: google.apigeeregistry.operations name: operations title: Operations methods: @@ -1301,17 +1301,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list insert: [] update: [] delete: - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_delete instances: - id: apigeeregistry.instances + id: google.apigeeregistry.instances name: instances title: Instances methods: @@ -1348,7 +1348,7 @@ components: - $ref: >- #/components/x-stackQL-resources/instances/methods/projects_locations_instances_delete instances_iam_policies: - id: apigeeregistry.instances_iam_policies + id: google.apigeeregistry.instances_iam_policies name: instances_iam_policies title: Instances_iam_policies methods: @@ -1385,7 +1385,7 @@ components: update: [] delete: [] apis: - id: apigeeregistry.apis + id: google.apigeeregistry.apis name: apis title: Apis methods: @@ -1430,19 +1430,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/apis/methods/projects_locations_apis_list - $ref: >- #/components/x-stackQL-resources/apis/methods/projects_locations_apis_get + - $ref: >- + #/components/x-stackQL-resources/apis/methods/projects_locations_apis_list insert: - $ref: >- #/components/x-stackQL-resources/apis/methods/projects_locations_apis_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/apis/methods/projects_locations_apis_patch delete: - $ref: >- #/components/x-stackQL-resources/apis/methods/projects_locations_apis_delete apis_iam_policies: - id: apigeeregistry.apis_iam_policies + id: google.apigeeregistry.apis_iam_policies name: apis_iam_policies title: Apis_iam_policies methods: @@ -1479,7 +1481,7 @@ components: update: [] delete: [] versions: - id: apigeeregistry.versions + id: google.apigeeregistry.versions name: versions title: Versions methods: @@ -1524,19 +1526,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_apis_versions_list - $ref: >- #/components/x-stackQL-resources/versions/methods/projects_locations_apis_versions_get + - $ref: >- + #/components/x-stackQL-resources/versions/methods/projects_locations_apis_versions_list insert: - $ref: >- #/components/x-stackQL-resources/versions/methods/projects_locations_apis_versions_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/versions/methods/projects_locations_apis_versions_patch delete: - $ref: >- #/components/x-stackQL-resources/versions/methods/projects_locations_apis_versions_delete versions_iam_policies: - id: apigeeregistry.versions_iam_policies + id: google.apigeeregistry.versions_iam_policies name: versions_iam_policies title: Versions_iam_policies methods: @@ -1573,7 +1577,7 @@ components: update: [] delete: [] specs: - id: apigeeregistry.specs + id: google.apigeeregistry.specs name: specs title: Specs methods: @@ -1632,19 +1636,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/specs/methods/projects_locations_apis_versions_specs_list - $ref: >- #/components/x-stackQL-resources/specs/methods/projects_locations_apis_versions_specs_get + - $ref: >- + #/components/x-stackQL-resources/specs/methods/projects_locations_apis_versions_specs_list insert: - $ref: >- #/components/x-stackQL-resources/specs/methods/projects_locations_apis_versions_specs_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/specs/methods/projects_locations_apis_versions_specs_patch delete: - $ref: >- #/components/x-stackQL-resources/specs/methods/projects_locations_apis_versions_specs_delete specs_contents: - id: apigeeregistry.specs_contents + id: google.apigeeregistry.specs_contents name: specs_contents title: Specs_contents methods: @@ -1663,7 +1669,7 @@ components: update: [] delete: [] specs_revisions: - id: apigeeregistry.specs_revisions + id: google.apigeeregistry.specs_revisions name: specs_revisions title: Specs_revisions methods: @@ -1686,7 +1692,7 @@ components: update: [] delete: [] specs_revision: - id: apigeeregistry.specs_revision + id: google.apigeeregistry.specs_revision name: specs_revision title: Specs_revision methods: @@ -1705,7 +1711,7 @@ components: - $ref: >- #/components/x-stackQL-resources/specs_revision/methods/projects_locations_apis_versions_specs_delete_revision specs_iam_policies: - id: apigeeregistry.specs_iam_policies + id: google.apigeeregistry.specs_iam_policies name: specs_iam_policies title: Specs_iam_policies methods: @@ -1742,7 +1748,7 @@ components: update: [] delete: [] artifacts: - id: apigeeregistry.artifacts + id: google.apigeeregistry.artifacts name: artifacts title: Artifacts methods: @@ -1943,26 +1949,26 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/artifacts/methods/projects_locations_apis_versions_specs_artifacts_list - $ref: >- #/components/x-stackQL-resources/artifacts/methods/projects_locations_apis_versions_specs_artifacts_get - $ref: >- - #/components/x-stackQL-resources/artifacts/methods/projects_locations_apis_versions_artifacts_list + #/components/x-stackQL-resources/artifacts/methods/projects_locations_apis_versions_specs_artifacts_list - $ref: >- #/components/x-stackQL-resources/artifacts/methods/projects_locations_apis_versions_artifacts_get - - $ref: >- - #/components/x-stackQL-resources/artifacts/methods/projects_locations_apis_deployments_artifacts_list - $ref: >- #/components/x-stackQL-resources/artifacts/methods/projects_locations_apis_deployments_artifacts_get - $ref: >- - #/components/x-stackQL-resources/artifacts/methods/projects_locations_apis_artifacts_list + #/components/x-stackQL-resources/artifacts/methods/projects_locations_apis_versions_artifacts_list + - $ref: >- + #/components/x-stackQL-resources/artifacts/methods/projects_locations_apis_deployments_artifacts_list - $ref: >- #/components/x-stackQL-resources/artifacts/methods/projects_locations_apis_artifacts_get - $ref: >- - #/components/x-stackQL-resources/artifacts/methods/projects_locations_artifacts_list + #/components/x-stackQL-resources/artifacts/methods/projects_locations_apis_artifacts_list - $ref: >- #/components/x-stackQL-resources/artifacts/methods/projects_locations_artifacts_get + - $ref: >- + #/components/x-stackQL-resources/artifacts/methods/projects_locations_artifacts_list insert: - $ref: >- #/components/x-stackQL-resources/artifacts/methods/projects_locations_apis_versions_specs_artifacts_create @@ -1987,7 +1993,7 @@ components: - $ref: >- #/components/x-stackQL-resources/artifacts/methods/projects_locations_artifacts_delete artifacts_contents: - id: apigeeregistry.artifacts_contents + id: google.apigeeregistry.artifacts_contents name: artifacts_contents title: Artifacts_contents methods: @@ -2042,7 +2048,7 @@ components: update: [] delete: [] artifacts_iam_policies: - id: apigeeregistry.artifacts_iam_policies + id: google.apigeeregistry.artifacts_iam_policies name: artifacts_iam_policies title: Artifacts_iam_policies methods: @@ -2160,7 +2166,7 @@ components: update: [] delete: [] deployments: - id: apigeeregistry.deployments + id: google.apigeeregistry.deployments name: deployments title: Deployments methods: @@ -2219,19 +2225,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/projects_locations_apis_deployments_list - $ref: >- #/components/x-stackQL-resources/deployments/methods/projects_locations_apis_deployments_get + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/projects_locations_apis_deployments_list insert: - $ref: >- #/components/x-stackQL-resources/deployments/methods/projects_locations_apis_deployments_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/projects_locations_apis_deployments_patch delete: - $ref: >- #/components/x-stackQL-resources/deployments/methods/projects_locations_apis_deployments_delete deployments_revisions: - id: apigeeregistry.deployments_revisions + id: google.apigeeregistry.deployments_revisions name: deployments_revisions title: Deployments_revisions methods: @@ -2254,7 +2262,7 @@ components: update: [] delete: [] deployments_revision: - id: apigeeregistry.deployments_revision + id: google.apigeeregistry.deployments_revision name: deployments_revision title: Deployments_revision methods: @@ -2273,7 +2281,7 @@ components: - $ref: >- #/components/x-stackQL-resources/deployments_revision/methods/projects_locations_apis_deployments_delete_revision deployments_iam_policies: - id: apigeeregistry.deployments_iam_policies + id: google.apigeeregistry.deployments_iam_policies name: deployments_iam_policies title: Deployments_iam_policies methods: @@ -2310,7 +2318,7 @@ components: update: [] delete: [] runtime_iam_policies: - id: apigeeregistry.runtime_iam_policies + id: google.apigeeregistry.runtime_iam_policies name: runtime_iam_policies title: Runtime_iam_policies methods: @@ -2347,7 +2355,7 @@ components: update: [] delete: [] documents_iam_policies: - id: apigeeregistry.documents_iam_policies + id: google.apigeeregistry.documents_iam_policies name: documents_iam_policies title: Documents_iam_policies methods: 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 c2830ae1..68207730 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: '20240520' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/api-keys/docs servers: @@ -22,12 +22,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 @@ -37,29 +37,25 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - V2ServerKeyRestrictions: - description: The IP addresses of callers that are allowed to use the key. - id: V2ServerKeyRestrictions - type: object - properties: - allowedIps: - description: >- - A list of the caller IP addresses that are allowed to make API calls - with this key. - type: array - items: - type: string V2UndeleteKeyRequest: - id: V2UndeleteKeyRequest type: object - properties: {} description: Request message for `UndeleteKey` method. + id: V2UndeleteKeyRequest + properties: {} 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: + $ref: '#/components/schemas/Status' + description: >- + The error result of the operation in case of failure or + cancellation. 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 @@ -70,19 +66,13 @@ components: original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 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 - error: - $ref: '#/components/schemas/Status' - description: >- - The error result of the operation in case of failure or - cancellation. + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. 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 @@ -90,154 +80,123 @@ components: 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: + name: 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 - type: object - id: Operation + 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: >- This resource represents a long-running operation that is the result of a network API call. - V2BrowserKeyRestrictions: - description: The HTTP referrers (websites) that are allowed to use the key. - id: V2BrowserKeyRestrictions + type: object + id: Operation + V2ListKeysResponse: + id: V2ListKeysResponse properties: - allowedReferrers: - items: - type: string - description: >- - A list of regular expressions for the referrer URLs that are allowed - to make API calls with this key. + nextPageToken: + type: string + description: The pagination token for the next page of results. + keys: + description: A list of API keys. type: array + items: + $ref: '#/components/schemas/V2Key' + description: Response message for `ListKeys` method. type: object 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. + parent: + description: >- + The project that owns the key with the value specified in the + request. type: string - description: Response message for `LookupKey` method. - type: object id: V2LookupKeyResponse - V2Restrictions: - id: V2Restrictions type: object + V2GetKeyStringResponse: + description: Response message for `GetKeyString` method. properties: - 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. - apiTargets: - 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' - type: array - iosKeyRestrictions: - $ref: '#/components/schemas/V2IosKeyRestrictions' - description: The iOS apps that are allowed to use the key. - androidKeyRestrictions: - description: The Android apps that are allowed to use the key. - $ref: '#/components/schemas/V2AndroidKeyRestrictions' - description: Describes the restrictions on the key. + keyString: + description: An encrypted and signed value of the key. + type: string + id: V2GetKeyStringResponse + type: object V2ApiTarget: + description: >- + A restriction for a specific service and optionally one or multiple + specific methods. Both fields are case insensitive. + id: V2ApiTarget + type: object properties: + service: + description: >- + The service for this restriction. It should be the canonical service + name, for example: `translate.googleapis.com`. You can use [`gcloud + services list`](/sdk/gcloud/reference/services/list) to get a list + of services that are enabled in the project. + type: string methods: - 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`](/sdk/gcloud/reference/services/list) to get a list - of services that are enabled in the project. - type: object - description: >- - A restriction for a specific service and optionally one or multiple - specific methods. Both fields are case insensitive. - id: V2ApiTarget - V2ListKeysResponse: - description: Response message for `ListKeys` method. - id: V2ListKeysResponse + V2BrowserKeyRestrictions: type: object properties: - keys: - description: A list of API keys. + allowedReferrers: items: - $ref: '#/components/schemas/V2Key' + type: string + description: >- + A list of regular expressions for the referrer URLs that are allowed + to make API calls with this key. type: array - nextPageToken: - description: The pagination token for the next page of results. - type: string - V2GetKeyStringResponse: - id: V2GetKeyStringResponse + description: The HTTP referrers (websites) that are allowed to use the key. + id: V2BrowserKeyRestrictions + V2IosKeyRestrictions: + description: The iOS apps that are allowed to use the key. type: object - description: Response message for `GetKeyString` method. + id: V2IosKeyRestrictions properties: - keyString: - type: string - description: An encrypted and signed value of the key. + allowedBundleIds: + items: + type: string + type: array + description: >- + A list of bundle IDs that are allowed when making API calls with + this key. V2Key: - type: object - description: The representation of a key managed by the API Keys API. - id: V2Key properties: updateTime: - readOnly: true - format: google-datetime type: string + 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. - type: string - readOnly: true - keyString: - readOnly: true - description: >- - Output only. An encrypted and signed value held by this key. This - field can be accessed only through the `GetKeyString` method. - type: string - uid: - type: string - description: Output only. Unique id in UUID4 format. readOnly: true deleteTime: - readOnly: true - type: string - format: google-datetime description: >- Output only. A timestamp when this key was deleted. If the resource is not deleted, this must be empty. + format: google-datetime + readOnly: true + type: string + displayName: + type: string + description: >- + Human-readable display name of this key that you can modify. The + maximum length is 63 characters. name: description: >- Output only. The resource name of the key. The `name` has the form: @@ -247,21 +206,18 @@ components: location is `global`. type: string readOnly: true - displayName: + uid: + description: Output only. Unique id in UUID4 format. + readOnly: true type: string - description: >- - Human-readable display name of this key that you can modify. The - maximum length is 63 characters. - etag: + createTime: 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. + Output only. A timestamp identifying the time this key was + originally created. + readOnly: true + format: google-datetime annotations: - type: object additionalProperties: type: string description: >- @@ -269,33 +225,63 @@ components: 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 + etag: + readOnly: true + type: string + 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. restrictions: - $ref: '#/components/schemas/V2Restrictions' description: Key restrictions. + $ref: '#/components/schemas/V2Restrictions' + keyString: + description: >- + Output only. An encrypted and signed value held by this key. This + field can be accessed only through the `GetKeyString` method. + type: string + readOnly: true + description: The representation of a key managed by the API Keys API. + id: V2Key + type: object + V2ServerKeyRestrictions: + type: object + properties: + allowedIps: + type: array + description: >- + A list of the caller IP addresses that are allowed to make API calls + with this key. + items: + type: string + id: V2ServerKeyRestrictions + description: The IP addresses of callers that are allowed to use the key. Status: + type: object id: Status 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 items: - type: object additionalProperties: - type: any description: Properties of the object. Contains field @type with type URL. - code: - format: int32 - description: The status code, which should be an enum value of google.rpc.Code. - type: integer + 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. 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 + 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 @@ -304,17 +290,21 @@ 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). - V2IosKeyRestrictions: - id: V2IosKeyRestrictions - description: The iOS apps that are allowed to use the key. + V2AndroidApplication: properties: - allowedBundleIds: - items: - type: string + packageName: + type: string + description: The package name of the application. + sha1Fingerprint: description: >- - A list of bundle IDs that are allowed when making API calls with - this key. - type: array + 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: Identifier of an Android application for key use. + id: V2AndroidApplication type: object V2AndroidKeyRestrictions: properties: @@ -325,26 +315,42 @@ components: description: >- A list of Android applications that are allowed to make API calls with this key. - id: V2AndroidKeyRestrictions description: The Android apps that are allowed to use the key. type: object - V2AndroidApplication: - description: Identifier of an Android application for key use. - id: V2AndroidApplication + id: V2AndroidKeyRestrictions + V2Restrictions: properties: - packageName: - type: string - description: The package name of the application. - sha1Fingerprint: + browserKeyRestrictions: + $ref: '#/components/schemas/V2BrowserKeyRestrictions' + description: The HTTP referrers (websites) that are allowed to use the key. + serverKeyRestrictions: + description: The IP addresses of callers that are allowed to use the key. + $ref: '#/components/schemas/V2ServerKeyRestrictions' + androidKeyRestrictions: + $ref: '#/components/schemas/V2AndroidKeyRestrictions' + description: The Android apps that are allowed to use the key. + apiTargets: 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. - type: string + 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. + type: array + items: + $ref: '#/components/schemas/V2ApiTarget' + iosKeyRestrictions: + $ref: '#/components/schemas/V2IosKeyRestrictions' + description: The iOS apps that are allowed to use the key. + id: V2Restrictions type: object + description: Describes the restrictions on the key. parameters: + 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 @@ -354,6 +360,21 @@ 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. + in: query + name: key + schema: + type: string alt: description: Data format for response. in: query @@ -364,10 +385,10 @@ components: - json - media - proto - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + callback: + description: JSONP in: query - name: upload_protocol + name: callback schema: type: string prettyPrint: @@ -376,16 +397,22 @@ components: 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 - 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: @@ -397,42 +424,30 @@ 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 - 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 - callback: - description: JSONP - in: query - name: callback - schema: - type: string x-stackQL-resources: keys: - id: apikeys.keys + id: google.apikeys.keys name: keys title: Keys methods: - 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' + delete: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}/get response: mediaType: application/json openAPIDocKey: '200' @@ -461,122 +476,161 @@ components: response: mediaType: application/json openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - 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' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/keys/methods/list' - $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: [] + update: + - $ref: '#/components/x-stackQL-resources/keys/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/keys/methods/delete' - operations: - id: 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: [] delete: [] - keys_key_string: - id: 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 + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' insert: [] update: [] delete: [] paths: - /v2/keys:lookupKey: + /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}: parameters: &ref_3 + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/callback' - get: + - $ref: '#/components/parameters/quotaUser' + 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 + 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: keysId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + 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 + 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/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: etag schema: type: string - /v2/operations/{operationsId}: - parameters: *ref_3 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: apikeys.operations.get + 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 @@ -592,10 +646,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/V2Key' parameters: - in: path - name: operationsId + 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 @@ -671,6 +735,11 @@ paths: required: true schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 - in: query name: showDeleted schema: @@ -679,36 +748,29 @@ paths: name: pageToken schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}:undelete: + /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}/keyString: parameters: *ref_3 - 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 @@ -725,59 +787,19 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}: + /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}:undelete: parameters: *ref_3 - patch: + post: 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 + 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/V2Key' - security: - - Oauth2: - - https://www.googleapis.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: keysId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - 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 + $ref: '#/components/schemas/V2UndeleteKeyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -806,16 +828,14 @@ paths: required: true schema: type: string - - in: query - name: etag - schema: - type: string + /v2/operations/{operationsId}: + parameters: *ref_3 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 + Gets the latest 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 @@ -831,30 +851,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/V2Key' + $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 - /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}/keyString: + /v2/keys:lookupKey: parameters: *ref_3 get: 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 + 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 @@ -870,20 +882,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/V2GetKeyStringResponse' + $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 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 0077510c..81b9a544 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/appengine.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/appengine.yaml @@ -8,7 +8,7 @@ info: description: Provisions and manages developers' App Engine applications. version: v1 x-discovery-doc-revision: '20240527' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/appengine/docs/admin-api/ servers: @@ -3000,7 +3000,7 @@ components: - '2' x-stackQL-resources: apps: - id: appengine.apps + id: google.appengine.apps name: apps title: Apps methods: @@ -3033,10 +3033,11 @@ components: - $ref: '#/components/x-stackQL-resources/apps/methods/get' insert: - $ref: '#/components/x-stackQL-resources/apps/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/apps/methods/patch' delete: [] apps_runtimes: - id: appengine.apps_runtimes + id: google.appengine.apps_runtimes name: apps_runtimes title: Apps_runtimes methods: @@ -3058,7 +3059,7 @@ components: update: [] delete: [] operations: - id: appengine.operations + id: google.appengine.operations name: operations title: Operations methods: @@ -3080,13 +3081,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: [] services: - id: appengine.services + id: google.appengine.services name: services title: Services methods: @@ -3120,14 +3121,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/services/methods/list' - $ref: '#/components/x-stackQL-resources/services/methods/get' + - $ref: '#/components/x-stackQL-resources/services/methods/list' insert: [] - update: [] + update: + - $ref: '#/components/x-stackQL-resources/services/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/services/methods/delete' versions: - id: appengine.versions + id: google.appengine.versions name: versions title: Versions methods: @@ -3171,15 +3173,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/versions/methods/list' - $ref: '#/components/x-stackQL-resources/versions/methods/get' + - $ref: '#/components/x-stackQL-resources/versions/methods/list' insert: - $ref: '#/components/x-stackQL-resources/versions/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/versions/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/versions/methods/delete' instances: - id: appengine.instances + id: google.appengine.instances name: instances title: Instances methods: @@ -3217,14 +3220,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/instances/methods/list' - $ref: '#/components/x-stackQL-resources/instances/methods/get' + - $ref: '#/components/x-stackQL-resources/instances/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/instances/methods/delete' ingress_rules: - id: appengine.ingress_rules + id: google.appengine.ingress_rules name: ingress_rules title: Ingress_rules methods: @@ -3274,15 +3277,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/ingress_rules/methods/list' - $ref: '#/components/x-stackQL-resources/ingress_rules/methods/get' + - $ref: '#/components/x-stackQL-resources/ingress_rules/methods/list' insert: - $ref: '#/components/x-stackQL-resources/ingress_rules/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/ingress_rules/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/ingress_rules/methods/delete' authorized_domains: - id: appengine.authorized_domains + id: google.appengine.authorized_domains name: authorized_domains title: Authorized_domains methods: @@ -3305,7 +3309,7 @@ components: update: [] delete: [] authorized_certificates: - id: appengine.authorized_certificates + id: google.appengine.authorized_certificates name: authorized_certificates title: Authorized_certificates methods: @@ -3348,19 +3352,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/authorized_certificates/methods/list - $ref: >- #/components/x-stackQL-resources/authorized_certificates/methods/get + - $ref: >- + #/components/x-stackQL-resources/authorized_certificates/methods/list insert: - $ref: >- #/components/x-stackQL-resources/authorized_certificates/methods/create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/authorized_certificates/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/authorized_certificates/methods/delete domain_mappings: - id: appengine.domain_mappings + id: google.appengine.domain_mappings name: domain_mappings title: Domain_mappings methods: @@ -3403,15 +3409,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/domain_mappings/methods/list' - $ref: '#/components/x-stackQL-resources/domain_mappings/methods/get' + - $ref: '#/components/x-stackQL-resources/domain_mappings/methods/list' insert: - $ref: '#/components/x-stackQL-resources/domain_mappings/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/domain_mappings/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/domain_mappings/methods/delete' locations: - id: appengine.locations + id: google.appengine.locations name: locations title: Locations methods: @@ -3433,8 +3440,8 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] 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 63c5ffe6..48186775 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: '20240515' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/app-hub/docs/ servers: @@ -1303,7 +1303,7 @@ components: - '2' x-stackQL-resources: locations: - id: apphub.locations + id: google.apphub.locations name: locations title: Locations methods: @@ -1339,13 +1339,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: apphub.operations + id: google.apphub.operations name: operations title: Operations methods: @@ -1383,14 +1383,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' service_project_attachments: - id: apphub.service_project_attachments + id: google.apphub.service_project_attachments name: service_project_attachments title: Service_project_attachments methods: @@ -1428,10 +1428,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/service_project_attachments/methods/list - $ref: >- #/components/x-stackQL-resources/service_project_attachments/methods/get + - $ref: >- + #/components/x-stackQL-resources/service_project_attachments/methods/list insert: - $ref: >- #/components/x-stackQL-resources/service_project_attachments/methods/create @@ -1440,7 +1440,7 @@ components: - $ref: >- #/components/x-stackQL-resources/service_project_attachments/methods/delete discovered_services: - id: apphub.discovered_services + id: google.apphub.discovered_services name: discovered_services title: Discovered_services methods: @@ -1471,13 +1471,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/discovered_services/methods/list' - $ref: '#/components/x-stackQL-resources/discovered_services/methods/get' + - $ref: '#/components/x-stackQL-resources/discovered_services/methods/list' insert: [] update: [] delete: [] discovered_workloads: - id: apphub.discovered_workloads + id: google.apphub.discovered_workloads name: discovered_workloads title: Discovered_workloads methods: @@ -1508,13 +1508,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/discovered_workloads/methods/list' - $ref: '#/components/x-stackQL-resources/discovered_workloads/methods/get' + - $ref: '#/components/x-stackQL-resources/discovered_workloads/methods/list' insert: [] update: [] delete: [] applications: - id: apphub.applications + id: google.apphub.applications name: applications title: Applications methods: @@ -1559,15 +1559,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/applications/methods/list' - $ref: '#/components/x-stackQL-resources/applications/methods/get' + - $ref: '#/components/x-stackQL-resources/applications/methods/list' insert: - $ref: '#/components/x-stackQL-resources/applications/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/applications/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/applications/methods/delete' applications_iam_policies: - id: apphub.applications_iam_policies + id: google.apphub.applications_iam_policies name: applications_iam_policies title: Applications_iam_policies methods: @@ -1604,7 +1605,7 @@ components: update: [] delete: [] services: - id: apphub.services + id: google.apphub.services name: services title: Services methods: @@ -1649,15 +1650,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/services/methods/list' - $ref: '#/components/x-stackQL-resources/services/methods/get' + - $ref: '#/components/x-stackQL-resources/services/methods/list' insert: - $ref: '#/components/x-stackQL-resources/services/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/services/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/services/methods/delete' workloads: - id: apphub.workloads + id: google.apphub.workloads name: workloads title: Workloads methods: @@ -1702,11 +1704,12 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/workloads/methods/list' - $ref: '#/components/x-stackQL-resources/workloads/methods/get' + - $ref: '#/components/x-stackQL-resources/workloads/methods/list' insert: - $ref: '#/components/x-stackQL-resources/workloads/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/workloads/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/workloads/methods/delete' paths: 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 5290e4db..6e0dd37a 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/artifactregistry.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/artifactregistry.yaml @@ -10,7 +10,7 @@ info: on Google infrastructure. version: v1 x-discovery-doc-revision: '20240520' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/artifacts/docs/ servers: @@ -2170,7 +2170,7 @@ components: - '2' x-stackQL-resources: project_settings: - id: artifactregistry.project_settings + id: google.artifactregistry.project_settings name: project_settings title: Project_settings methods: @@ -2194,7 +2194,7 @@ components: update: [] delete: [] vpcsc_config: - id: artifactregistry.vpcsc_config + id: google.artifactregistry.vpcsc_config name: vpcsc_config title: Vpcsc_config methods: @@ -2220,7 +2220,7 @@ components: update: [] delete: [] locations: - id: artifactregistry.locations + id: google.artifactregistry.locations name: locations title: Locations methods: @@ -2242,13 +2242,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: artifactregistry.operations + id: google.artifactregistry.operations name: operations title: Operations methods: @@ -2266,7 +2266,7 @@ components: update: [] delete: [] repositories: - id: artifactregistry.repositories + id: google.artifactregistry.repositories name: repositories title: Repositories methods: @@ -2311,15 +2311,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/repositories/methods/list' - $ref: '#/components/x-stackQL-resources/repositories/methods/get' + - $ref: '#/components/x-stackQL-resources/repositories/methods/list' insert: - $ref: '#/components/x-stackQL-resources/repositories/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/repositories/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/repositories/methods/delete' repositories_iam_policies: - id: artifactregistry.repositories_iam_policies + id: google.artifactregistry.repositories_iam_policies name: repositories_iam_policies title: Repositories_iam_policies methods: @@ -2356,7 +2357,7 @@ components: update: [] delete: [] docker_images: - id: artifactregistry.docker_images + id: google.artifactregistry.docker_images name: docker_images title: Docker_images methods: @@ -2380,13 +2381,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/docker_images/methods/list' - $ref: '#/components/x-stackQL-resources/docker_images/methods/get' + - $ref: '#/components/x-stackQL-resources/docker_images/methods/list' insert: [] update: [] delete: [] maven_artifacts: - id: artifactregistry.maven_artifacts + id: google.artifactregistry.maven_artifacts name: maven_artifacts title: Maven_artifacts methods: @@ -2410,13 +2411,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/maven_artifacts/methods/list' - $ref: '#/components/x-stackQL-resources/maven_artifacts/methods/get' + - $ref: '#/components/x-stackQL-resources/maven_artifacts/methods/list' insert: [] update: [] delete: [] npm_packages: - id: artifactregistry.npm_packages + id: google.artifactregistry.npm_packages name: npm_packages title: Npm_packages methods: @@ -2440,13 +2441,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/npm_packages/methods/list' - $ref: '#/components/x-stackQL-resources/npm_packages/methods/get' + - $ref: '#/components/x-stackQL-resources/npm_packages/methods/list' insert: [] update: [] delete: [] python_packages: - id: artifactregistry.python_packages + id: google.artifactregistry.python_packages name: python_packages title: Python_packages methods: @@ -2470,13 +2471,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/python_packages/methods/list' - $ref: '#/components/x-stackQL-resources/python_packages/methods/get' + - $ref: '#/components/x-stackQL-resources/python_packages/methods/list' insert: [] update: [] delete: [] apt_artifacts: - id: artifactregistry.apt_artifacts + id: google.artifactregistry.apt_artifacts name: apt_artifacts title: Apt_artifacts methods: @@ -2500,7 +2501,7 @@ components: update: [] delete: [] yum_artifacts: - id: artifactregistry.yum_artifacts + id: google.artifactregistry.yum_artifacts name: yum_artifacts title: Yum_artifacts methods: @@ -2524,7 +2525,7 @@ components: update: [] delete: [] googet_artifacts: - id: artifactregistry.googet_artifacts + id: google.artifactregistry.googet_artifacts name: googet_artifacts title: Googet_artifacts methods: @@ -2548,7 +2549,7 @@ components: update: [] delete: [] generic_artifacts: - id: artifactregistry.generic_artifacts + id: google.artifactregistry.generic_artifacts name: generic_artifacts title: Generic_artifacts methods: @@ -2565,7 +2566,7 @@ components: update: [] delete: [] kfp_artifacts: - id: artifactregistry.kfp_artifacts + id: google.artifactregistry.kfp_artifacts name: kfp_artifacts title: Kfp_artifacts methods: @@ -2582,7 +2583,7 @@ components: update: [] delete: [] go_modules: - id: artifactregistry.go_modules + id: google.artifactregistry.go_modules name: go_modules title: Go_modules methods: @@ -2599,7 +2600,7 @@ components: update: [] delete: [] packages: - id: artifactregistry.packages + id: google.artifactregistry.packages name: packages title: Packages methods: @@ -2637,14 +2638,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/packages/methods/list' - $ref: '#/components/x-stackQL-resources/packages/methods/get' + - $ref: '#/components/x-stackQL-resources/packages/methods/list' insert: [] - update: [] + update: + - $ref: '#/components/x-stackQL-resources/packages/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/packages/methods/delete' versions: - id: artifactregistry.versions + id: google.artifactregistry.versions name: versions title: Versions methods: @@ -2682,14 +2684,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/versions/methods/list' - $ref: '#/components/x-stackQL-resources/versions/methods/get' + - $ref: '#/components/x-stackQL-resources/versions/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/versions/methods/delete' tags: - id: artifactregistry.tags + id: google.artifactregistry.tags name: tags title: Tags methods: @@ -2734,15 +2736,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/tags/methods/list' - $ref: '#/components/x-stackQL-resources/tags/methods/get' + - $ref: '#/components/x-stackQL-resources/tags/methods/list' insert: - $ref: '#/components/x-stackQL-resources/tags/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/tags/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/tags/methods/delete' files: - id: artifactregistry.files + id: google.artifactregistry.files name: files title: Files methods: @@ -2780,8 +2783,8 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/files/methods/list' - $ref: '#/components/x-stackQL-resources/files/methods/get' + - $ref: '#/components/x-stackQL-resources/files/methods/list' insert: [] update: [] delete: 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 cd7c6170..18d6ce3a 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: '20240523' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/learnmoreurl servers: @@ -34,292 +34,436 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: + 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' + description: The response message for Operations.ListOperations. + id: GoogleLongrunningListOperationsResponse + type: object GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud: description: Remediation instructions to resolve violation via gcloud cli - type: object id: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud + type: object properties: - steps: - type: array + additionalLinks: + description: Additional urls for more information about 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 - additionalLinks: - description: Additional urls for more information about steps + steps: + type: array items: type: string - type: array - GoogleLongrunningListOperationsResponse: - description: The response message for Operations.ListOperations. + description: Steps to resolve violation via gcloud cli + GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse: + description: Response for restricting the list of allowed resources. + type: object + id: GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse + properties: {} + GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse: properties: - operations: - description: >- - A list of operations that matches the specified filter in the - request. - type: array - items: - $ref: '#/components/schemas/GoogleLongrunningOperation' - nextPageToken: + ekmProvisioningErrorDomain: + enum: + - EKM_PROVISIONING_ERROR_DOMAIN_UNSPECIFIED + - UNSPECIFIED_ERROR + - GOOGLE_SERVER_ERROR + - EXTERNAL_USER_ERROR + - EXTERNAL_PARTNER_ERROR + - TIMEOUT_ERROR + 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 type: string - description: The standard List next-page token. - id: GoogleLongrunningListOperationsResponse + description: Indicates Ekm provisioning error if any. + ekmProvisioningState: + 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 + enum: + - EKM_PROVISIONING_STATE_UNSPECIFIED + - EKM_PROVISIONING_STATE_PENDING + - EKM_PROVISIONING_STATE_FAILED + - EKM_PROVISIONING_STATE_COMPLETED + type: string + ekmProvisioningErrorMapping: + type: string + enumDescriptions: + - Error is unspecified. + - Service account is used is invalid. + - Iam permission monitoring.MetricsScopeAdmin wasn't applied. + - Iam permission cloudkms.ekmConnectionsAdmin wasn't applied. + 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 + id: GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse + description: External key management systems(EKM) Provisioning response type: object - GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions: - properties: - consoleInstructions: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole - description: Remediation instructions to resolve violation via cloud console - gcloudInstructions: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud - description: Remediation instructions to resolve violation via gcloud cli - description: Instructions to remediate violation - id: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions + GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest: + description: >- + Request for restricting list of available resources in Workload + environment. type: object - GoogleCloudAssuredworkloadsV1Violation: + id: GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest + properties: + restrictionType: + type: string + description: >- + Required. The type of restriction for using gcp products in the + Workload environment. + 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. + enum: + - RESTRICTION_TYPE_UNSPECIFIED + - ALLOW_ALL_GCP_RESOURCES + - ALLOW_COMPLIANT_RESOURCES + - APPEND_COMPLIANT_RESOURCES + GoogleRpcStatus: type: object + id: GoogleRpcStatus properties: - orgPolicyConstraint: + 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 + format: int32 + description: The status code, which should be an enum value of google.rpc.Code. + message: type: string description: >- - Output only. Immutable. The org-policy-constraint that was - incorrectly changed, which resulted in this violation. - deprecated: true - readOnly: true - parentProjectNumber: - readOnly: true + 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). + GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse: + type: object + properties: {} + id: GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse + description: Response for EnableResourceMonitoring endpoint. + GoogleCloudAssuredworkloadsV1WorkloadResourceSettings: + type: object + properties: + resourceId: description: >- - Optional. Output only. Parent project number where resource is - present. Empty for org-policy violations. + 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 - state: - readOnly: true - enum: - - STATE_UNSPECIFIED - - RESOLVED - - UNRESOLVED - - EXCEPTION - description: Output only. State of the violation + 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) + enumDeprecated: + - false + - true + - false + - false + - false type: string enumDescriptions: - - Unspecified state. - - Violation is resolved. - - Violation is Unresolved - - Violation is Exception - acknowledged: - type: boolean - description: A boolean that indicates if the violation is acknowledged - name: + - 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 + displayName: + type: string description: >- - Output only. Immutable. Name of the Violation. Format: - organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id} + User-assigned resource display name. If not empty it will be used to + create a resource with the specified name. + description: Represent the custom settings for the resources to be created. + id: GoogleCloudAssuredworkloadsV1WorkloadResourceSettings + GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus: + description: Represents the Compliance Status of this workload + properties: + activeResourceViolationCount: + description: Number of current resource violations which are acknowledged. + type: integer + format: int32 + activeViolationCount: + format: int32 + description: Number of current orgPolicy violations which are not acknowledged. + type: integer + acknowledgedResourceViolationCount: + type: integer + description: Number of current resource violations which are not acknowledged. + format: int32 + acknowledgedViolationCount: + description: Number of current orgPolicy violations which are acknowledged. + format: int32 + type: integer + type: object + id: GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus + GoogleCloudAssuredworkloadsV1MoveImpact: + description: Represents the impact of moving the asset to the target. + type: object + id: GoogleCloudAssuredworkloadsV1MoveImpact + properties: + detail: + description: Explanation of the impact. type: string - readOnly: true - beginTime: - readOnly: true - format: google-datetime + GoogleCloudAssuredworkloadsV1AssetMoveAnalysis: + type: object + properties: + analysisGroups: + description: List of eligible analyses performed for the asset. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1MoveAnalysisGroup + assetType: type: string - description: Output only. Time of the event which triggered the Violation. - description: description: >- - Output only. Description for the Violation. e.g. OrgPolicy - gcp.resourceLocations has non compliant value. - readOnly: true - type: string - updateTime: - description: Output only. The last time when the Violation record was updated. - readOnly: true - format: google-datetime + 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). + asset: + description: >- + The full resource name of the asset being analyzed. Example: + //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1 type: string - violationType: + description: Represents move analysis results for an asset. + id: GoogleCloudAssuredworkloadsV1AssetMoveAnalysis + GoogleCloudAssuredworkloadsV1ListWorkloadsResponse: + properties: + nextPageToken: type: string - enum: - - VIOLATION_TYPE_UNSPECIFIED - - ORG_POLICY - - RESOURCE - readOnly: true - description: Output only. Type of the violation - enumDescriptions: - - Unspecified type. - - Org Policy Violation. - - Resource Violation. - acknowledgementTime: + description: The next page token. Return empty if reached the last page. + workloads: + type: array + description: List of Workloads under a given parent. + items: + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' + id: GoogleCloudAssuredworkloadsV1ListWorkloadsResponse + description: Response of ListWorkloads endpoint. + type: object + GoogleCloudAssuredworkloadsV1MoveAnalysisResult: + type: object + description: Represents the successful move analysis results for a group. + properties: + warnings: 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. + List of warnings. These are risks that may or may not result in + compliance violations. + items: + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1MoveImpact' + type: array + blockers: + items: + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1MoveImpact' + description: >- + List of blockers. If not resolved, these will result in compliance + violations in the target. + type: array + id: GoogleCloudAssuredworkloadsV1MoveAnalysisResult + GoogleCloudAssuredworkloadsV1WorkloadResourceInfo: + properties: + resourceId: + description: Resource identifier. For a project this represents project_number. type: string - format: google-datetime - resolveTime: + format: int64 + 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. + enum: + - RESOURCE_TYPE_UNSPECIFIED + - CONSUMER_PROJECT + - CONSUMER_FOLDER + - ENCRYPTION_KEYS_PROJECT + - KEYRING + enumDeprecated: + - false + - true + - false + - false + - false + description: Indicates the type of resource. 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 - category: + type: object + id: GoogleCloudAssuredworkloadsV1WorkloadResourceInfo + description: Represent the resources that are children of this Workload. + GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest: + description: Request for acknowledging the violation + properties: + comment: type: string - readOnly: true description: >- - Output only. Category under which this violation is mapped. e.g. - Location, Service Usage, Access, Encryption, etc. + Required. Business justification explaining the need for violation + acknowledgement + acknowledgeType: + type: string + enum: + - ACKNOWLEDGE_TYPE_UNSPECIFIED + - SINGLE_VIOLATION + - EXISTING_CHILD_RESOURCE_VIOLATIONS + 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. nonCompliantOrgPolicy: - readOnly: true + deprecated: true description: >- - Output only. Immutable. Name of the OrgPolicy which was modified - with non-compliant change and resulted this violation. Format: + 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 - resourceType: - type: string - readOnly: true - description: >- - Optional. Output only. Type of the resource like - compute.googleapis.com/Disk, etc. Empty for org-policy violations. - 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} - type: string - readOnly: true - remediation: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediation - description: Output only. Compliance violation remediation - readOnly: true - exceptionAuditLogLink: - readOnly: true - 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 - exceptionContexts: - readOnly: true - description: >- - Output only. List of all the exception detail added for the - violation. - items: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationExceptionContext - type: array - associatedOrgPolicyViolationId: - readOnly: true - description: >- - Optional. Output only. Violation Id of the org-policy violation due - to which the resource violation is caused. Empty for org-policy - violations. - type: string - resourceName: - type: string - readOnly: true - description: >- - Optional. Output only. Name of the resource like - //storage.googleapis.com/myprojectxyz-testbucket. Empty for - org-policy violations. - id: GoogleCloudAssuredworkloadsV1Violation - description: Workload monitoring Violation. - GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole: - description: Remediation instructions to resolve violation via cloud console + id: GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest type: object + GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole: properties: - additionalLinks: - description: Additional urls for more information about steps + steps: + type: array items: type: string + description: Steps to resolve violation via cloud console + additionalLinks: type: array - consoleUris: - description: Link to console page where violations can be resolved items: type: string + description: Additional urls for more information about steps + consoleUris: type: array - steps: items: type: string - type: array - description: Steps to resolve violation via cloud console + description: Link to console page where violations can be resolved + description: Remediation instructions to resolve violation via cloud console id: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole - GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions: - type: object - id: GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions - description: >- - Permissions granted to the AW Partner SA account for the customer - workload - properties: - assuredWorkloadsMonitoring: - description: Optional. Allow partner to view violation alerts. - type: boolean - dataLogsViewer: - type: boolean - description: >- - Allow the partner to view inspectability logs and monitoring - violations. - serviceAccessApprover: - type: boolean - description: Optional. Allow partner to view access approval logs. - 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: - 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: - 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. - 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 type: object 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); } - id: GoogleProtobufEmpty + GoogleCloudAssuredworkloadsV1ListViolationsResponse: + description: Response of ListViolations endpoint. + properties: + violations: + description: List of Violations under a Workload. + items: + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Violation' + type: array + nextPageToken: + description: The next page token. Returns empty if reached the last page. + type: string + type: object + id: GoogleCloudAssuredworkloadsV1ListViolationsResponse + GoogleCloudAssuredworkloadsV1MoveAnalysisGroup: + properties: + analysisResult: + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1MoveAnalysisResult' + description: Result of a successful analysis. + error: + description: Error details for a failed analysis. + $ref: '#/components/schemas/GoogleRpcStatus' + displayName: + description: Name of the analysis group. + type: string + 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. type: object GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse: id: GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse + type: object properties: + setupStatus: + type: string + 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 setupErrors: type: array + description: Indicates SAA enrollment setup error if any. 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. - >- @@ -332,208 +476,191 @@ components: - >- Returned when exception was encountered during evaluation of other criteria. - description: Indicates SAA enrollment setup error if any. - setupStatus: - description: Indicates SAA enrollment status of a given workload. - enum: - - SETUP_STATE_UNSPECIFIED - - STATUS_PENDING - - STATUS_COMPLETE - enumDescriptions: - - Unspecified. - - SAA enrollment pending. - - SAA enrollment comopleted. - type: string - type: object + enum: + - SETUP_ERROR_UNSPECIFIED + - ERROR_INVALID_BASE_SETUP + - ERROR_MISSING_EXTERNAL_SIGNING_KEY + - ERROR_NOT_ALL_SERVICES_ENROLLED + - ERROR_SETUP_CHECK_FAILED + type: string description: Signed Access Approvals (SAA) enrollment response. - GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest: + GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest: + id: GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest + description: Request for updating permission settings for a partner workload. type: object - description: Request for acknowledging the violation properties: + updateMask: + description: >- + Required. The list of fields to be updated. E.g. update_mask { + paths: "partner_permissions.data_logs_viewer"} + format: google-fieldmask + type: string + partnerPermissions: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions + description: Required. The partner permissions to be updated. + etag: + type: string + description: >- + Optional. The etag of the workload. If this is provided, it must + match the server's etag. + GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse: + description: Response for violation acknowledgement + type: object + properties: {} + id: GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse + GoogleCloudAssuredworkloadsV1Violation: + properties: + acknowledged: + type: boolean + description: A boolean that indicates if the violation is acknowledged + parentProjectNumber: + type: string + description: >- + Optional. Output only. Parent project number where resource is + present. Empty for org-policy violations. + readOnly: true nonCompliantOrgPolicy: - deprecated: true + readOnly: true 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: + 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 - acknowledgeType: - description: Optional. Acknowledge type of specified violation. + auditLogLink: + 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} + type: string + beginTime: + readOnly: true + type: string + format: google-datetime + description: Output only. Time of the event which triggered the Violation. + violationType: enum: - - ACKNOWLEDGE_TYPE_UNSPECIFIED - - SINGLE_VIOLATION - - EXISTING_CHILD_RESOURCE_VIOLATIONS + - VIOLATION_TYPE_UNSPECIFIED + - ORG_POLICY + - RESOURCE enumDescriptions: - - Acknowledge type unspecified. - - Acknowledge only the specific violation. - - >- - Acknowledge specified orgPolicy violation and also associated - resource violations. + - Unspecified type. + - Org Policy Violation. + - Resource Violation. + description: Output only. Type of the violation + readOnly: true type: string - comment: + category: + readOnly: true + description: >- + Output only. Category under which this violation is mapped. e.g. + Location, Service Usage, Access, Encryption, etc. type: string + orgPolicyConstraint: + readOnly: true + deprecated: true description: >- - Required. Business justification explaining the need for violation - acknowledgement - id: GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest - GoogleCloudAssuredworkloadsV1WorkloadResourceSettings: - type: object - id: GoogleCloudAssuredworkloadsV1WorkloadResourceSettings - properties: - resourceType: - enumDeprecated: - - false - - true - - false - - false - - false + Output only. Immutable. The org-policy-constraint that was + incorrectly changed, which resulted in this violation. + type: string + updateTime: + description: Output only. The last time when the Violation record was updated. type: string + readOnly: true + format: google-datetime + acknowledgementTime: 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) + 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 + state: 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. + - Unspecified state. + - Violation is resolved. + - Violation is Unresolved + - Violation is Exception enum: - - RESOURCE_TYPE_UNSPECIFIED - - CONSUMER_PROJECT - - CONSUMER_FOLDER - - ENCRYPTION_KEYS_PROJECT - - KEYRING - displayName: - description: >- - User-assigned resource display name. If not empty it will be used to - create a resource with the specified name. + - STATE_UNSPECIFIED + - RESOLVED + - UNRESOLVED + - EXCEPTION type: string - resourceId: + description: Output only. State of the violation + readOnly: true + description: + readOnly: true 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. + Output only. Description for the Violation. e.g. OrgPolicy + gcp.resourceLocations has non compliant value. type: string - description: Represent the custom settings for the resources to be created. - GoogleCloudAssuredworkloadsV1Workload: - id: GoogleCloudAssuredworkloadsV1Workload - type: object - properties: - resourceMonitoringEnabled: - 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. - readOnly: true - complianceStatus: + resourceType: readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus - description: Output only. Count of active Violations in the Workload. - displayName: type: string 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 - createTime: - description: Output only. Immutable. The Workload creation timestamp. - format: google-datetime - type: string + Optional. Output only. Type of the resource like + compute.googleapis.com/Disk, etc. Empty for org-policy violations. + remediation: readOnly: true - ekmProvisioningResponse: + description: Output only. Compliance violation remediation $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse - description: >- - Output only. Represents the Ekm Provisioning State of the given - workload. + #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediation + exceptionContexts: + type: array readOnly: true - kajEnrollmentState: description: >- - Output only. Represents the KAJ enrollment state of the given - workload. - enum: - - KAJ_ENROLLMENT_STATE_UNSPECIFIED - - KAJ_ENROLLMENT_STATE_PENDING - - KAJ_ENROLLMENT_STATE_COMPLETE - enumDescriptions: - - Default State for KAJ Enrollment. - - Pending State for KAJ Enrollment. - - Complete State for KAJ Enrollment. - type: string - readOnly: true - labels: - additionalProperties: - type: string - description: Optional. Labels applied to the workload. - type: object - saaEnrollmentResponse: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse + Output only. List of all the exception detail added for the + violation. + items: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationExceptionContext + name: 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. + Output only. Immutable. Name of the Violation. Format: + organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id} readOnly: true - compliantButDisallowedServices: - type: array + type: string + resourceName: + 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. + Optional. Output only. Name of the resource like + //storage.googleapis.com/myprojectxyz-testbucket. Empty for + org-policy violations. readOnly: true - items: - type: string - enableSovereignControls: - type: boolean + resolveTime: + format: google-datetime description: >- - Optional. Indicates the sovereignty status of the given workload. - Currently meant to be used by Europe/Canada customers. - partner: - enum: - - PARTNER_UNSPECIFIED - - LOCAL_CONTROLS_BY_S3NS - - SOVEREIGN_CONTROLS_BY_T_SYSTEMS - - SOVEREIGN_CONTROLS_BY_SIA_MINSAIT - - SOVEREIGN_CONTROLS_BY_PSN - description: Optional. Partner regime associated with this workload. - enumDescriptions: - - '' - - Enum representing S3NS (Thales) partner. - - Enum representing T_SYSTEM (TSI) partner. - - Enum representing SIA_MINSAIT (Indra) partner. - - Enum representing PSN (TIM) partner. + Output only. Time of the event which fixed the Violation. If the + violation is ACTIVE this will be empty. type: string - name: + readOnly: true + exceptionAuditLogLink: type: string + readOnly: true description: >- - Optional. The resource name of the workload. Format: - organizations/{organization}/locations/{location}/workloads/{workload} - Read-only. - kmsSettings: + 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} + associatedOrgPolicyViolationId: + type: string 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. - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadKMSSettings - deprecated: true + 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 + id: GoogleCloudAssuredworkloadsV1Violation + type: object + description: Workload monitoring Violation. + GoogleCloudAssuredworkloadsV1Workload: + id: GoogleCloudAssuredworkloadsV1Workload + description: >- + A Workload object for managing highly regulated workloads of cloud + customers. + properties: complianceRegime: enum: - COMPLIANCE_REGIME_UNSPECIFIED @@ -597,11 +724,82 @@ components: - KSA R5 Controls. - Assured Workloads for Regional Controls/Free Regions - Assured Workloads for Regional Controls/Free Regions - etag: + displayName: 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. + 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 + kmsSettings: + $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. + deprecated: true + compliantButDisallowedServices: + items: + type: string + 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. + readOnly: true + ekmProvisioningResponse: + description: >- + Output only. Represents the Ekm Provisioning State of the given + workload. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse + createTime: + format: google-datetime + readOnly: true + description: Output only. Immutable. The Workload creation timestamp. + type: string + provisionedResourcesParent: + 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} + type: string + 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. + description: Optional. Partner regime associated with this workload. + enum: + - PARTNER_UNSPECIFIED + - LOCAL_CONTROLS_BY_S3NS + - SOVEREIGN_CONTROLS_BY_T_SYSTEMS + - SOVEREIGN_CONTROLS_BY_SIA_MINSAIT + - SOVEREIGN_CONTROLS_BY_PSN + kajEnrollmentState: + readOnly: true + type: string + 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. + enumDescriptions: + - Default State for KAJ Enrollment. + - Pending State for KAJ Enrollment. + - Complete State for KAJ Enrollment. billingAccount: type: string description: >- @@ -612,6 +810,11 @@ components: change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`. + 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. violationNotificationsEnabled: type: boolean description: >- @@ -621,185 +824,107 @@ components: 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. - partnerPermissions: - description: >- - Optional. Permissions granted to the AW Partner SA account for the - customer workload - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions - resources: + resourceSettings: type: array - readOnly: true items: $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadResourceInfo - description: >- - Output only. The resources associated with this workload. These - resources will be created when creating the workload. If any of the - projects already exist, the workload creation will fail. Always read - only. - resourceSettings: + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadResourceSettings 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. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadResourceSettings - provisionedResourcesParent: - 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} - type: string - description: >- - A Workload object for managing highly regulated workloads of cloud - customers. - GoogleCloudAssuredworkloadsV1WorkloadKMSSettings: - deprecated: true - description: Settings specific to the Key Management Service. - type: object - id: GoogleCloudAssuredworkloadsV1WorkloadKMSSettings - properties: - rotationPeriod: - format: google-duration - type: string - 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. - nextRotationTime: - format: google-datetime + partnerPermissions: 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. - type: string - GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse: - type: object - description: Response for EnableResourceMonitoring endpoint. - properties: {} - id: GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse - GoogleCloudAssuredworkloadsV1WorkloadResourceInfo: - id: GoogleCloudAssuredworkloadsV1WorkloadResourceInfo - type: object - properties: - resourceType: - type: string - enumDeprecated: - - false - - true - - false - - false - - false - description: Indicates the type of resource. - enum: - - RESOURCE_TYPE_UNSPECIFIED - - CONSUMER_PROJECT - - CONSUMER_FOLDER - - ENCRYPTION_KEYS_PROJECT - - KEYRING - 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. - resourceId: - type: string - description: Resource identifier. For a project this represents project_number. - format: int64 - description: Represent the resources that are children of this Workload. - GoogleCloudAssuredworkloadsV1MoveImpact: - id: GoogleCloudAssuredworkloadsV1MoveImpact - description: Represents the impact of moving the asset to the target. - type: object - properties: - detail: - description: Explanation of the impact. - type: string - GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse: - properties: {} - id: GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse - description: Response for violation acknowledgement - type: object - GoogleCloudAssuredworkloadsV1AssetMoveAnalysis: - properties: - analysisGroups: - items: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1MoveAnalysisGroup - description: List of eligible analyses performed for the asset. - type: array - assetType: + Optional. Permissions granted to the AW Partner SA account for the + customer workload + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions + saaEnrollmentResponse: + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse 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 - asset: + 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. + resourceMonitoringEnabled: + type: boolean + readOnly: true description: >- - The full resource name of the asset being analyzed. Example: - //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1 - type: string - id: GoogleCloudAssuredworkloadsV1AssetMoveAnalysis - type: object - description: Represents move analysis results for an asset. - GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus: - type: object - description: Represents the Compliance Status of this workload - id: GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus - properties: - activeViolationCount: - type: integer - format: int32 - description: Number of current orgPolicy violations which are not acknowledged. - acknowledgedViolationCount: - description: Number of current orgPolicy violations which are acknowledged. - type: integer - format: int32 - activeResourceViolationCount: - format: int32 - description: Number of current resource violations which are acknowledged. - type: integer - acknowledgedResourceViolationCount: - type: integer - format: int32 - description: Number of current resource violations which are not acknowledged. - GoogleCloudAssuredworkloadsV1ListViolationsResponse: - type: object - description: Response of ListViolations endpoint. - properties: - nextPageToken: + 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. + enableSovereignControls: + description: >- + Optional. Indicates the sovereignty status of the given workload. + Currently meant to be used by Europe/Canada customers. + type: boolean + complianceStatus: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus + description: Output only. Count of active Violations in the Workload. + readOnly: true + name: + description: >- + Optional. The resource name of the workload. Format: + organizations/{organization}/locations/{location}/workloads/{workload} + Read-only. type: string - description: The next page token. Returns empty if reached the last page. - violations: - items: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Violation' - description: List of Violations under a Workload. + labels: + additionalProperties: + type: string + type: object + description: Optional. Labels applied to the workload. + resources: + readOnly: true type: array - id: GoogleCloudAssuredworkloadsV1ListViolationsResponse - GoogleCloudAssuredworkloadsV1ListWorkloadsResponse: + items: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadResourceInfo + description: >- + Output only. The resources associated with this workload. These + resources will be created when creating the workload. If any of the + projects already exist, the workload creation will fail. Always read + only. type: object - description: Response of ListWorkloads endpoint. + GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions: + id: GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions properties: - workloads: - items: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' - description: List of Workloads under a given parent. - type: array - nextPageToken: - description: The next page token. Return empty if reached the last page. - type: string - id: GoogleCloudAssuredworkloadsV1ListWorkloadsResponse + serviceAccessApprover: + description: Optional. Allow partner to view access approval logs. + type: boolean + dataLogsViewer: + type: boolean + description: >- + Allow the partner to view inspectability logs and monitoring + violations. + assuredWorkloadsMonitoring: + type: boolean + description: Optional. Allow partner to view violation alerts. + type: object + description: >- + Permissions granted to the AW Partner SA account for the customer + workload GoogleLongrunningOperation: + type: object + description: >- + This resource represents a long-running operation that is the result of + a network API call. 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 + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/GoogleRpcStatus' done: type: boolean description: >- @@ -818,15 +943,8 @@ components: 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}`. - type: string + description: Properties of the object. Contains field @type with type URL. metadata: description: >- Service-specific metadata associated with the operation. It @@ -834,26 +952,14 @@ components: 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 - type: object - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - The error result of the operation in case of failure or - cancellation. - type: object - description: >- - This resource represents a long-running operation that is the result of - a network API call. id: GoogleLongrunningOperation GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata: + id: GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata properties: - createTime: - type: string - format: google-datetime - description: Optional. Time when the operation was created. complianceRegime: enum: - COMPLIANCE_REGIME_UNSPECIFIED @@ -918,62 +1024,33 @@ components: Optional. Compliance controls that should be applied to the resources managed by the workload. displayName: - type: string description: Optional. The display name of the workload. - parent: type: string + parent: description: Optional. The parent of the workload. - id: GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata + type: string + createTime: + format: google-datetime + type: string + description: Optional. Time when the operation was created. description: Operation metadata to give request details of CreateWorkload. type: object - GoogleCloudAssuredworkloadsV1ViolationRemediation: + GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions: + id: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions properties: - remediationType: - readOnly: true - type: string - description: >- - Output only. Reemediation type based on the type of org policy - values violated - 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. - 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 - instructions: + gcloudInstructions: $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions - description: Required. Remediation instructions to resolve violations - compliantValues: - items: - type: string - 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 - type: array + #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud + description: Remediation instructions to resolve violation via gcloud cli + consoleInstructions: + description: Remediation instructions to resolve violation via cloud console + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole + description: Instructions to remediate violation type: object - description: >- - Represents remediation guidance to resolve compliance violation for - AssuredWorkload - id: GoogleCloudAssuredworkloadsV1ViolationRemediation GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse: + id: GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse type: object - description: >- - Response containing the analysis results for the hypothetical resource - move. properties: nextPageToken: type: string @@ -984,169 +1061,92 @@ components: items: $ref: >- #/components/schemas/GoogleCloudAssuredworkloadsV1AssetMoveAnalysis - id: GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse - GoogleCloudAssuredworkloadsV1MoveAnalysisResult: - properties: - blockers: - type: array - description: >- - List of blockers. If not resolved, these will result in compliance - violations in the target. - items: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1MoveImpact' - warnings: - type: array - description: >- - List of warnings. These are risks that may or may not result in - compliance violations. - items: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1MoveImpact' - description: Represents the successful move analysis results for a group. - id: GoogleCloudAssuredworkloadsV1MoveAnalysisResult - type: object - GoogleCloudAssuredworkloadsV1ViolationExceptionContext: - id: GoogleCloudAssuredworkloadsV1ViolationExceptionContext - description: Violation exception detail. - type: object + description: >- + Response containing the analysis results for the hypothetical resource + move. + GoogleCloudAssuredworkloadsV1WorkloadKMSSettings: + deprecated: true properties: - acknowledgementTime: - format: google-datetime - type: string - description: Timestamp when the violation was acknowledged. - comment: - description: >- - Business justification provided towards the acknowledgement of the - violation. - type: string - userName: + rotationPeriod: + format: google-duration description: >- - Name of the user (or service account) who acknowledged the - violation. + 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: string - GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse: - type: object - properties: {} - id: GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse - description: Response for restricting the list of allowed resources. - GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest: - description: >- - Request for restricting list of available resources in Workload - environment. - id: GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest - 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. + nextRotationTime: description: >- - Required. The type of restriction for using gcp products in the - Workload environment. + 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 type: string - enum: - - RESTRICTION_TYPE_UNSPECIFIED - - ALLOW_ALL_GCP_RESOURCES - - ALLOW_COMPLIANT_RESOURCES - - APPEND_COMPLIANT_RESOURCES + description: Settings specific to the Key Management Service. + id: GoogleCloudAssuredworkloadsV1WorkloadKMSSettings type: object - GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse: + GoogleCloudAssuredworkloadsV1ViolationRemediation: properties: - ekmProvisioningErrorMapping: - enum: - - EKM_PROVISIONING_ERROR_MAPPING_UNSPECIFIED - - INVALID_SERVICE_ACCOUNT - - MISSING_METRICS_SCOPE_ADMIN_PERMISSION - - MISSING_EKM_CONNECTION_ADMIN_PERMISSION - description: Detailed error message if Ekm provisioning fails - type: string - enumDescriptions: - - Error is unspecified. - - Service account is used is invalid. - - Iam permission monitoring.MetricsScopeAdmin wasn't applied. - - Iam permission cloudkms.ekmConnectionsAdmin wasn't applied. - ekmProvisioningState: + instructions: + description: Required. Remediation instructions to resolve violations + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions + 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 + remediationType: type: string - enumDescriptions: - - Default State for Ekm Provisioning - - Pending State for Ekm Provisioning - - Failed State for Ekm Provisioning - - Completed State for Ekm Provisioning enum: - - EKM_PROVISIONING_STATE_UNSPECIFIED - - EKM_PROVISIONING_STATE_PENDING - - EKM_PROVISIONING_STATE_FAILED - - EKM_PROVISIONING_STATE_COMPLETED - description: Indicates Ekm enrollment Provisioning of a given workload. - ekmProvisioningErrorDomain: + - 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 + readOnly: true enumDescriptions: - - No error domain - - Error but domain is unspecified. - - Internal logic breaks within provisioning code. + - Unspecified remediation type + - Remediation type for boolean org policy - >- - 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. - description: External key management systems(EKM) Provisioning response - id: GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse + 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. + description: >- + Output only. Reemediation type based on the type of org policy + values violated type: object - GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest: + id: GoogleCloudAssuredworkloadsV1ViolationRemediation + description: >- + Represents remediation guidance to resolve compliance violation for + AssuredWorkload + GoogleCloudAssuredworkloadsV1ViolationExceptionContext: + id: GoogleCloudAssuredworkloadsV1ViolationExceptionContext type: object properties: - partnerPermissions: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions - description: Required. The partner permissions to be updated. - etag: + userName: type: string description: >- - Optional. The etag of the workload. If this is provided, it must - match the server's etag. - updateMask: - format: google-fieldmask - type: string + Name of the user (or service account) who acknowledged the + violation. + comment: description: >- - Required. The list of fields to be updated. E.g. update_mask { - paths: "partner_permissions.data_logs_viewer"} - description: Request for updating permission settings for a partner workload. - id: GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest - 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. - id: GoogleCloudAssuredworkloadsV1MoveAnalysisGroup - properties: - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: Error details for a failed analysis. - analysisResult: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1MoveAnalysisResult' - description: Result of a successful analysis. - displayName: - description: Name of the analysis group. + Business justification provided towards the acknowledgement of the + violation. + type: string + acknowledgementTime: + description: Timestamp when the violation was acknowledged. type: string + format: google-datetime + description: Violation exception detail. parameters: _.xgafv: description: V1 error format. @@ -1157,32 +1157,25 @@ components: enum: - '1' - '2' - 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"). + 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. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: access_token + name: fields schema: type: string - callback: - description: JSONP + 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: callback + name: quotaUser schema: type: string oauth_token: @@ -1191,21 +1184,28 @@ components: 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. + callback: + description: JSONP in: query - name: quotaUser + name: callback 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: + 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 @@ -1215,10 +1215,10 @@ components: name: key 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 prettyPrint: @@ -1229,7 +1229,7 @@ components: type: boolean x-stackQL-resources: operations: - id: assuredworkloads.operations + id: google.assuredworkloads.operations name: operations title: Operations methods: @@ -1259,21 +1259,17 @@ components: update: [] delete: [] violations: - id: assuredworkloads.violations + id: google.assuredworkloads.violations name: violations title: Violations methods: - _list: - operation: &ref_3 + get: + operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}~1violations/get - response: &ref_4 + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}~1violations~1{violationsId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.violations - list: - operation: *ref_3 - response: *ref_4 acknowledge: operation: $ref: >- @@ -1281,25 +1277,36 @@ components: response: mediaType: application/json openAPIDocKey: '200' - get: - operation: + _list: + operation: &ref_3 $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}~1violations~1{violationsId}/get - response: + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}~1violations/get + response: &ref_4 mediaType: application/json openAPIDocKey: '200' + objectKey: $.violations + list: + operation: *ref_3 + response: *ref_4 sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/violations/methods/list' - $ref: '#/components/x-stackQL-resources/violations/methods/get' + - $ref: '#/components/x-stackQL-resources/violations/methods/list' insert: [] update: [] delete: [] workloads: - id: assuredworkloads.workloads + id: google.assuredworkloads.workloads 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' delete: operation: $ref: >- @@ -1321,13 +1328,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - enable_resource_monitoring: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}:enableResourceMonitoring/post - response: - mediaType: application/json - openAPIDocKey: '200' _list: operation: &ref_5 $ref: >- @@ -1346,24 +1346,24 @@ components: response: mediaType: application/json openAPIDocKey: '200' - 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' - analyze_workload_move: + enable_resource_monitoring: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}:analyzeWorkloadMove/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}:enableResourceMonitoring/post response: mediaType: application/json openAPIDocKey: '200' - mutate_partner_permissions: + analyze_workload_move: 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}:analyzeWorkloadMove/get response: mediaType: application/json openAPIDocKey: '200' @@ -1373,22 +1373,23 @@ components: - $ref: '#/components/x-stackQL-resources/workloads/methods/list' insert: - $ref: '#/components/x-stackQL-resources/workloads/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/workloads/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/workloads/methods/delete' paths: /v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}: parameters: &ref_7 - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/prettyPrint' get: description: >- @@ -1454,6 +1455,10 @@ paths: required: true schema: type: string + - in: query + name: pageToken + schema: + type: string - in: query name: pageSize schema: @@ -1463,20 +1468,11 @@ paths: name: filter schema: type: string - - in: query - name: pageToken - schema: - type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations: + /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}: parameters: *ref_7 get: - description: >- - Lists the Violations in the AssuredWorkload Environment. Callers may - also choose to read across multiple Workloads as per - [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash - character) as a wildcard character instead of workload-id in the parent. - Format `organizations/{org_id}/locations/{location}/workloads/-` - operationId: assuredworkloads.organizations.locations.workloads.violations.list + description: Retrieves Assured Workload Violation based on ID. + operationId: assuredworkloads.organizations.locations.workloads.violations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1488,8 +1484,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1ListViolationsResponse + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Violation' parameters: - in: path name: organizationsId @@ -1506,29 +1501,11 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: interval.endTime - schema: - type: string - format: google-datetime - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: interval.startTime + - in: path + name: violationsId + required: true schema: type: string - format: google-datetime /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}:acknowledge: parameters: *ref_7 post: @@ -1579,11 +1556,16 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}: + /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations: parameters: *ref_7 get: - description: Retrieves Assured Workload Violation based on ID. - operationId: assuredworkloads.organizations.locations.workloads.violations.get + description: >- + Lists the Violations in the AssuredWorkload Environment. Callers may + also choose to read across multiple Workloads as per + [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash + character) as a wildcard character instead of workload-id in the parent. + Format `organizations/{org_id}/locations/{location}/workloads/-` + operationId: assuredworkloads.organizations.locations.workloads.violations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1595,7 +1577,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Violation' + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1ListViolationsResponse parameters: - in: path name: organizationsId @@ -1612,8 +1595,73 @@ paths: required: true schema: type: string + - in: query + name: interval.endTime + schema: + type: string + format: google-datetime + - in: query + name: pageToken + schema: + type: string + - in: query + name: interval.startTime + schema: + type: string + format: google-datetime + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:restrictAllowedResources: + parameters: *ref_7 + 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: violationsId + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadsId required: true schema: type: string @@ -1735,41 +1783,6 @@ paths: schema: type: string format: google-fieldmask - /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:enableResourceMonitoring: - parameters: *ref_7 - post: - description: Enable resource violation monitoring for a workload. - operationId: >- - assuredworkloads.organizations.locations.workloads.enableResourceMonitoring - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse - 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: parameters: *ref_7 get: @@ -1800,7 +1813,7 @@ paths: schema: type: string - in: query - name: filter + name: pageToken schema: type: string - in: query @@ -1809,7 +1822,7 @@ paths: type: integer format: int32 - in: query - name: pageToken + name: filter schema: type: string post: @@ -1847,24 +1860,21 @@ paths: name: externalId schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:restrictAllowedResources: + /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:mutatePartnerPermissions: parameters: *ref_7 - 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 @@ -1876,8 +1886,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' parameters: - in: path name: organizationsId @@ -1894,14 +1903,12 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:analyzeWorkloadMove: + /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:enableResourceMonitoring: parameters: *ref_7 - get: - description: >- - Analyzes a hypothetical move of a source resource to a target workload - to surface compliance risks. The analysis is best effort and is not - guaranteed to be exhaustive. - operationId: assuredworkloads.organizations.locations.workloads.analyzeWorkloadMove + post: + description: Enable resource violation monitoring for a workload. + operationId: >- + assuredworkloads.organizations.locations.workloads.enableResourceMonitoring security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1914,7 +1921,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse + #/components/schemas/GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse parameters: - in: path name: organizationsId @@ -1931,38 +1938,14 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: project - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: assetTypes - schema: - type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:mutatePartnerPermissions: + /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:analyzeWorkloadMove: parameters: *ref_7 - patch: + get: 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. - operationId: >- - assuredworkloads.organizations.locations.workloads.mutatePartnerPermissions - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest + Analyzes a hypothetical move of a source resource to a target workload + to surface compliance risks. The analysis is best effort and is not + guaranteed to be exhaustive. + operationId: assuredworkloads.organizations.locations.workloads.analyzeWorkloadMove security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1974,7 +1957,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse parameters: - in: path name: organizationsId @@ -1991,3 +1975,20 @@ paths: required: true schema: type: string + - in: query + name: assetTypes + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: project + schema: + type: string + - in: query + name: pageToken + 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 4961ee3f..23253b96 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: '20240522' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/backup-disaster-recovery servers: @@ -875,7 +875,7 @@ components: - '2' x-stackQL-resources: locations: - id: backupdr.locations + id: google.backupdr.locations name: locations title: Locations methods: @@ -897,13 +897,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] management_servers_iam_policies: - id: backupdr.management_servers_iam_policies + id: google.backupdr.management_servers_iam_policies name: management_servers_iam_policies title: Management_servers_iam_policies methods: @@ -940,7 +940,7 @@ components: update: [] delete: [] management_servers: - id: backupdr.management_servers + id: google.backupdr.management_servers name: management_servers title: Management_servers methods: @@ -978,15 +978,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/management_servers/methods/list' - $ref: '#/components/x-stackQL-resources/management_servers/methods/get' + - $ref: '#/components/x-stackQL-resources/management_servers/methods/list' insert: - $ref: '#/components/x-stackQL-resources/management_servers/methods/create' update: [] delete: - $ref: '#/components/x-stackQL-resources/management_servers/methods/delete' operations: - id: backupdr.operations + id: google.backupdr.operations name: operations title: Operations methods: @@ -1024,8 +1024,8 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: 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 a307d43b..ac8246fd 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/baremetalsolution.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/baremetalsolution.yaml @@ -10,7 +10,7 @@ info: extension located near a Google Cloud data center. version: v2 x-discovery-doc-revision: '20240513' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/bare-metal servers: @@ -2123,7 +2123,7 @@ components: - '2' x-stackQL-resources: locations: - id: baremetalsolution.locations + id: google.baremetalsolution.locations name: locations title: Locations methods: @@ -2145,13 +2145,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] instances: - id: baremetalsolution.instances + id: google.baremetalsolution.instances name: instances title: Instances methods: @@ -2259,13 +2259,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/instances/methods/list' - $ref: '#/components/x-stackQL-resources/instances/methods/get' + - $ref: '#/components/x-stackQL-resources/instances/methods/list' insert: [] - update: [] + update: + - $ref: '#/components/x-stackQL-resources/instances/methods/patch' delete: [] ssh_keys: - id: baremetalsolution.ssh_keys + id: google.baremetalsolution.ssh_keys name: ssh_keys title: Ssh_keys methods: @@ -2303,7 +2304,7 @@ components: delete: - $ref: '#/components/x-stackQL-resources/ssh_keys/methods/delete' volumes: - id: baremetalsolution.volumes + id: google.baremetalsolution.volumes name: volumes title: Volumes methods: @@ -2355,13 +2356,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/volumes/methods/list' - $ref: '#/components/x-stackQL-resources/volumes/methods/get' + - $ref: '#/components/x-stackQL-resources/volumes/methods/list' insert: [] - update: [] + update: + - $ref: '#/components/x-stackQL-resources/volumes/methods/patch' delete: [] snapshots: - id: baremetalsolution.snapshots + id: google.baremetalsolution.snapshots name: snapshots title: Snapshots methods: @@ -2406,15 +2408,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/snapshots/methods/list' - $ref: '#/components/x-stackQL-resources/snapshots/methods/get' + - $ref: '#/components/x-stackQL-resources/snapshots/methods/list' insert: - $ref: '#/components/x-stackQL-resources/snapshots/methods/create' update: [] delete: - $ref: '#/components/x-stackQL-resources/snapshots/methods/delete' luns: - id: baremetalsolution.luns + id: google.baremetalsolution.luns name: luns title: Luns methods: @@ -2451,7 +2453,7 @@ components: update: [] delete: [] networks: - id: baremetalsolution.networks + id: google.baremetalsolution.networks name: networks title: Networks methods: @@ -2489,13 +2491,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/networks/methods/list' - $ref: '#/components/x-stackQL-resources/networks/methods/get' + - $ref: '#/components/x-stackQL-resources/networks/methods/list' insert: [] - update: [] + update: + - $ref: '#/components/x-stackQL-resources/networks/methods/patch' delete: [] networks_network_usage: - id: baremetalsolution.networks_network_usage + id: google.baremetalsolution.networks_network_usage name: networks_network_usage title: Networks_network_usage methods: @@ -2514,7 +2517,7 @@ components: update: [] delete: [] nfs_shares: - id: baremetalsolution.nfs_shares + id: google.baremetalsolution.nfs_shares name: nfs_shares title: Nfs_shares methods: @@ -2570,11 +2573,12 @@ components: - $ref: '#/components/x-stackQL-resources/nfs_shares/methods/list' insert: - $ref: '#/components/x-stackQL-resources/nfs_shares/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/nfs_shares/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/nfs_shares/methods/delete' provisioning_quotas: - id: baremetalsolution.provisioning_quotas + id: google.baremetalsolution.provisioning_quotas name: provisioning_quotas title: Provisioning_quotas methods: @@ -2596,7 +2600,7 @@ components: update: [] delete: [] provisioning_configs: - id: baremetalsolution.provisioning_configs + id: google.baremetalsolution.provisioning_configs name: provisioning_configs title: Provisioning_configs methods: @@ -2634,10 +2638,12 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/provisioning_configs/methods/create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/provisioning_configs/methods/patch delete: [] operations: - id: baremetalsolution.operations + id: google.baremetalsolution.operations name: operations title: Operations methods: @@ -2655,7 +2661,7 @@ components: update: [] delete: [] os_images: - id: baremetalsolution.os_images + id: google.baremetalsolution.os_images name: os_images title: Os_images methods: @@ -2679,8 +2685,8 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/os_images/methods/list' - $ref: '#/components/x-stackQL-resources/os_images/methods/get' + - $ref: '#/components/x-stackQL-resources/os_images/methods/list' insert: [] update: [] delete: [] 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 19a4ff87..7d655563 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: '20240517' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/batch/ servers: @@ -2045,7 +2045,7 @@ components: - '2' x-stackQL-resources: locations: - id: batch.locations + id: google.batch.locations name: locations title: Locations methods: @@ -2067,13 +2067,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: batch.operations + id: google.batch.operations name: operations title: Operations methods: @@ -2111,14 +2111,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' jobs: - id: batch.jobs + id: google.batch.jobs name: jobs title: Jobs methods: @@ -2156,15 +2156,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/jobs/methods/list' - $ref: '#/components/x-stackQL-resources/jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/jobs/methods/list' insert: - $ref: '#/components/x-stackQL-resources/jobs/methods/create' update: [] delete: - $ref: '#/components/x-stackQL-resources/jobs/methods/delete' tasks: - id: batch.tasks + id: google.batch.tasks name: tasks title: Tasks methods: @@ -2194,7 +2194,7 @@ components: update: [] delete: [] state: - id: batch.state + id: google.batch.state name: state title: State methods: 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 0afa1d3f..62df341f 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: '20240508' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/ servers: @@ -1884,7 +1884,7 @@ components: - '2' x-stackQL-resources: locations: - id: beyondcorp.locations + id: google.beyondcorp.locations name: locations title: Locations methods: @@ -1906,15 +1906,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/locations/methods/projects_locations_list - $ref: >- #/components/x-stackQL-resources/locations/methods/projects_locations_get + - $ref: >- + #/components/x-stackQL-resources/locations/methods/projects_locations_list insert: [] update: [] delete: [] operations: - id: beyondcorp.operations + id: google.beyondcorp.operations name: operations title: Operations methods: @@ -1984,14 +1984,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/organizations_locations_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/organizations_locations_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list + - $ref: >- + #/components/x-stackQL-resources/operations/methods/organizations_locations_operations_list insert: [] update: [] delete: @@ -2000,7 +2000,7 @@ components: - $ref: >- #/components/x-stackQL-resources/operations/methods/organizations_locations_operations_delete app_connections: - id: beyondcorp.app_connections + id: google.beyondcorp.app_connections name: app_connections title: App_connections methods: @@ -2052,19 +2052,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/app_connections/methods/projects_locations_app_connections_list - $ref: >- #/components/x-stackQL-resources/app_connections/methods/projects_locations_app_connections_get + - $ref: >- + #/components/x-stackQL-resources/app_connections/methods/projects_locations_app_connections_list insert: - $ref: >- #/components/x-stackQL-resources/app_connections/methods/projects_locations_app_connections_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/app_connections/methods/projects_locations_app_connections_patch delete: - $ref: >- #/components/x-stackQL-resources/app_connections/methods/projects_locations_app_connections_delete app_connections_iam_policies: - id: beyondcorp.app_connections_iam_policies + id: google.beyondcorp.app_connections_iam_policies name: app_connections_iam_policies title: App_connections_iam_policies methods: @@ -2101,7 +2103,7 @@ components: update: [] delete: [] app_connectors: - id: beyondcorp.app_connectors + id: google.beyondcorp.app_connectors name: app_connectors title: App_connectors methods: @@ -2160,19 +2162,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/app_connectors/methods/projects_locations_app_connectors_list - $ref: >- #/components/x-stackQL-resources/app_connectors/methods/projects_locations_app_connectors_get + - $ref: >- + #/components/x-stackQL-resources/app_connectors/methods/projects_locations_app_connectors_list insert: - $ref: >- #/components/x-stackQL-resources/app_connectors/methods/projects_locations_app_connectors_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/app_connectors/methods/projects_locations_app_connectors_patch delete: - $ref: >- #/components/x-stackQL-resources/app_connectors/methods/projects_locations_app_connectors_delete app_connectors_iam_policies: - id: beyondcorp.app_connectors_iam_policies + id: google.beyondcorp.app_connectors_iam_policies name: app_connectors_iam_policies title: App_connectors_iam_policies methods: @@ -2209,7 +2213,7 @@ components: update: [] delete: [] app_gateways: - id: beyondcorp.app_gateways + id: google.beyondcorp.app_gateways name: app_gateways title: App_gateways methods: @@ -2247,10 +2251,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/app_gateways/methods/projects_locations_app_gateways_list - $ref: >- #/components/x-stackQL-resources/app_gateways/methods/projects_locations_app_gateways_get + - $ref: >- + #/components/x-stackQL-resources/app_gateways/methods/projects_locations_app_gateways_list insert: - $ref: >- #/components/x-stackQL-resources/app_gateways/methods/projects_locations_app_gateways_create @@ -2259,7 +2263,7 @@ components: - $ref: >- #/components/x-stackQL-resources/app_gateways/methods/projects_locations_app_gateways_delete app_gateways_iam_policies: - id: beyondcorp.app_gateways_iam_policies + id: google.beyondcorp.app_gateways_iam_policies name: app_gateways_iam_policies title: App_gateways_iam_policies methods: @@ -2296,7 +2300,7 @@ components: update: [] delete: [] client_connector_services_iam_policies: - id: beyondcorp.client_connector_services_iam_policies + id: google.beyondcorp.client_connector_services_iam_policies name: client_connector_services_iam_policies title: Client_connector_services_iam_policies methods: @@ -2333,7 +2337,7 @@ components: update: [] delete: [] client_gateways_iam_policies: - id: beyondcorp.client_gateways_iam_policies + id: google.beyondcorp.client_gateways_iam_policies name: client_gateways_iam_policies title: Client_gateways_iam_policies methods: @@ -2370,7 +2374,7 @@ components: update: [] delete: [] partner_tenants_iam_policies: - id: beyondcorp.partner_tenants_iam_policies + id: google.beyondcorp.partner_tenants_iam_policies name: partner_tenants_iam_policies title: Partner_tenants_iam_policies methods: @@ -2407,7 +2411,7 @@ components: update: [] delete: [] proxy_configs_iam_policies: - id: beyondcorp.proxy_configs_iam_policies + id: google.beyondcorp.proxy_configs_iam_policies name: proxy_configs_iam_policies title: Proxy_configs_iam_policies methods: @@ -2444,7 +2448,7 @@ components: update: [] delete: [] browser_dlp_rules_iam_policies: - id: beyondcorp.browser_dlp_rules_iam_policies + id: google.beyondcorp.browser_dlp_rules_iam_policies name: browser_dlp_rules_iam_policies title: Browser_dlp_rules_iam_policies methods: 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 b4051447..a61b9a39 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: '20240522' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/bigquery/ servers: @@ -374,7 +374,7 @@ components: - '2' x-stackQL-resources: catalogs: - id: biglake.catalogs + id: google.biglake.catalogs name: catalogs title: Catalogs methods: @@ -412,15 +412,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/catalogs/methods/list' - $ref: '#/components/x-stackQL-resources/catalogs/methods/get' + - $ref: '#/components/x-stackQL-resources/catalogs/methods/list' insert: - $ref: '#/components/x-stackQL-resources/catalogs/methods/create' update: [] delete: - $ref: '#/components/x-stackQL-resources/catalogs/methods/delete' databases: - id: biglake.databases + id: google.biglake.databases name: databases title: Databases methods: @@ -465,15 +465,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/databases/methods/list' - $ref: '#/components/x-stackQL-resources/databases/methods/get' + - $ref: '#/components/x-stackQL-resources/databases/methods/list' insert: - $ref: '#/components/x-stackQL-resources/databases/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/databases/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/databases/methods/delete' tables: - id: biglake.tables + id: google.biglake.tables name: tables title: Tables methods: @@ -525,11 +526,12 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/tables/methods/list' - $ref: '#/components/x-stackQL-resources/tables/methods/get' + - $ref: '#/components/x-stackQL-resources/tables/methods/list' insert: - $ref: '#/components/x-stackQL-resources/tables/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/tables/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/tables/methods/delete' paths: 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 f7507cf7..61e54973 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/bigquery.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/bigquery.yaml @@ -8,7 +8,7 @@ info: description: A data platform for customers to create, manage, share and query data. version: v2 x-discovery-doc-revision: '20240418' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/bigquery/ servers: @@ -9449,7 +9449,7 @@ components: type: string x-stackQL-resources: datasets: - id: bigquery.datasets + id: google.bigquery.datasets name: datasets title: Datasets methods: @@ -9505,11 +9505,13 @@ components: - $ref: '#/components/x-stackQL-resources/datasets/methods/list' insert: - $ref: '#/components/x-stackQL-resources/datasets/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/datasets/methods/patch' + - $ref: '#/components/x-stackQL-resources/datasets/methods/update' delete: - $ref: '#/components/x-stackQL-resources/datasets/methods/delete' jobs: - id: bigquery.jobs + id: google.bigquery.jobs name: jobs title: Jobs methods: @@ -9563,7 +9565,7 @@ components: delete: - $ref: '#/components/x-stackQL-resources/jobs/methods/delete' jobs_query_results: - id: bigquery.jobs_query_results + id: google.bigquery.jobs_query_results name: jobs_query_results title: Jobs_query_results methods: @@ -9581,7 +9583,7 @@ components: update: [] delete: [] models: - id: bigquery.models + id: google.bigquery.models name: models title: Models methods: @@ -9622,11 +9624,12 @@ components: - $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' delete: - $ref: '#/components/x-stackQL-resources/models/methods/delete' service_account: - id: bigquery.service_account + id: google.bigquery.service_account name: service_account title: Service_account methods: @@ -9644,7 +9647,7 @@ components: update: [] delete: [] projects: - id: bigquery.projects + id: google.bigquery.projects name: projects title: Projects methods: @@ -9665,7 +9668,7 @@ components: update: [] delete: [] routines: - id: bigquery.routines + id: google.bigquery.routines name: routines title: Routines methods: @@ -9714,11 +9717,12 @@ components: - $ref: '#/components/x-stackQL-resources/routines/methods/list' insert: - $ref: '#/components/x-stackQL-resources/routines/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/routines/methods/update' delete: - $ref: '#/components/x-stackQL-resources/routines/methods/delete' tables_iam_policies: - id: bigquery.tables_iam_policies + id: google.bigquery.tables_iam_policies name: tables_iam_policies title: Tables_iam_policies methods: @@ -9734,7 +9738,7 @@ components: update: [] delete: [] row_access_policies: - id: bigquery.row_access_policies + id: google.bigquery.row_access_policies name: row_access_policies title: Row_access_policies methods: @@ -9756,7 +9760,7 @@ components: update: [] delete: [] tabledata: - id: bigquery.tabledata + id: google.bigquery.tabledata name: tabledata title: Tabledata methods: @@ -9782,7 +9786,7 @@ components: update: [] delete: [] tables: - id: bigquery.tables + id: google.bigquery.tables name: tables title: Tables methods: @@ -9838,7 +9842,9 @@ components: - $ref: '#/components/x-stackQL-resources/tables/methods/list' insert: - $ref: '#/components/x-stackQL-resources/tables/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/tables/methods/patch' + - $ref: '#/components/x-stackQL-resources/tables/methods/update' delete: - $ref: '#/components/x-stackQL-resources/tables/methods/delete' paths: 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 2de9bed8..5bb22853 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/bigqueryconnection.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/bigqueryconnection.yaml @@ -8,7 +8,7 @@ info: description: Allows users to manage BigQuery connections to external data sources. version: v1 x-discovery-doc-revision: '20240418' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/bigquery/docs/connections-api-intro servers: @@ -920,7 +920,7 @@ components: - '2' x-stackQL-resources: connections: - id: bigqueryconnection.connections + id: google.bigqueryconnection.connections name: connections title: Connections methods: @@ -965,15 +965,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/connections/methods/list' - $ref: '#/components/x-stackQL-resources/connections/methods/get' + - $ref: '#/components/x-stackQL-resources/connections/methods/list' insert: - $ref: '#/components/x-stackQL-resources/connections/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/connections/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/connections/methods/delete' connections_iam_policies: - id: bigqueryconnection.connections_iam_policies + id: google.bigqueryconnection.connections_iam_policies name: connections_iam_policies title: Connections_iam_policies methods: 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 f0e9c4f0..e390526f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/bigquerydatapolicy.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/bigquerydatapolicy.yaml @@ -8,7 +8,7 @@ info: description: Allows users to manage BigQuery data policies. version: v1 x-discovery-doc-revision: '20240520' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/bigquery/docs/column-data-masking servers: @@ -612,7 +612,7 @@ components: - '2' x-stackQL-resources: data_policies: - id: bigquerydatapolicy.data_policies + id: google.bigquerydatapolicy.data_policies name: data_policies title: Data_policies methods: @@ -664,15 +664,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/data_policies/methods/list' - $ref: '#/components/x-stackQL-resources/data_policies/methods/get' + - $ref: '#/components/x-stackQL-resources/data_policies/methods/list' insert: - $ref: '#/components/x-stackQL-resources/data_policies/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/data_policies/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/data_policies/methods/delete' data_policies_iam_policies: - id: bigquerydatapolicy.data_policies_iam_policies + id: google.bigquerydatapolicy.data_policies_iam_policies name: data_policies_iam_policies title: Data_policies_iam_policies methods: 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 c4a0db55..966fea79 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: '20240527' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/bigquery-transfer/ servers: @@ -955,7 +955,7 @@ components: - '2' x-stackQL-resources: projects: - id: bigquerydatatransfer.projects + id: google.bigquerydatatransfer.projects name: projects title: Projects methods: @@ -971,7 +971,7 @@ components: update: [] delete: [] data_sources: - id: bigquerydatatransfer.data_sources + id: google.bigquerydatatransfer.data_sources name: data_sources title: Data_sources methods: @@ -1026,19 +1026,19 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/data_sources/methods/projects_data_sources_get - - $ref: >- - #/components/x-stackQL-resources/data_sources/methods/projects_data_sources_list - $ref: >- #/components/x-stackQL-resources/data_sources/methods/projects_locations_data_sources_get + - $ref: >- + #/components/x-stackQL-resources/data_sources/methods/projects_data_sources_get - $ref: >- #/components/x-stackQL-resources/data_sources/methods/projects_locations_data_sources_list + - $ref: >- + #/components/x-stackQL-resources/data_sources/methods/projects_data_sources_list insert: [] update: [] delete: [] transfer_configs: - id: bigquerydatatransfer.transfer_configs + id: google.bigquerydatatransfer.transfer_configs name: transfer_configs title: Transfer_configs methods: @@ -1149,26 +1149,30 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/transfer_configs/methods/projects_transfer_configs_list + #/components/x-stackQL-resources/transfer_configs/methods/projects_locations_transfer_configs_get - $ref: >- #/components/x-stackQL-resources/transfer_configs/methods/projects_transfer_configs_get - $ref: >- #/components/x-stackQL-resources/transfer_configs/methods/projects_locations_transfer_configs_list - $ref: >- - #/components/x-stackQL-resources/transfer_configs/methods/projects_locations_transfer_configs_get + #/components/x-stackQL-resources/transfer_configs/methods/projects_transfer_configs_list insert: + - $ref: >- + #/components/x-stackQL-resources/transfer_configs/methods/projects_locations_transfer_configs_create - $ref: >- #/components/x-stackQL-resources/transfer_configs/methods/projects_transfer_configs_create + update: - $ref: >- - #/components/x-stackQL-resources/transfer_configs/methods/projects_locations_transfer_configs_create - update: [] - delete: + #/components/x-stackQL-resources/transfer_configs/methods/projects_locations_transfer_configs_patch - $ref: >- - #/components/x-stackQL-resources/transfer_configs/methods/projects_transfer_configs_delete + #/components/x-stackQL-resources/transfer_configs/methods/projects_transfer_configs_patch + delete: - $ref: >- #/components/x-stackQL-resources/transfer_configs/methods/projects_locations_transfer_configs_delete + - $ref: >- + #/components/x-stackQL-resources/transfer_configs/methods/projects_transfer_configs_delete runs: - id: bigquerydatatransfer.runs + id: google.bigquerydatatransfer.runs name: runs title: Runs methods: @@ -1224,23 +1228,23 @@ components: response: *ref_12 sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/runs/methods/projects_transfer_configs_runs_get - - $ref: >- - #/components/x-stackQL-resources/runs/methods/projects_transfer_configs_runs_list - $ref: >- #/components/x-stackQL-resources/runs/methods/projects_locations_transfer_configs_runs_get + - $ref: >- + #/components/x-stackQL-resources/runs/methods/projects_transfer_configs_runs_get - $ref: >- #/components/x-stackQL-resources/runs/methods/projects_locations_transfer_configs_runs_list + - $ref: >- + #/components/x-stackQL-resources/runs/methods/projects_transfer_configs_runs_list insert: [] update: [] delete: - - $ref: >- - #/components/x-stackQL-resources/runs/methods/projects_transfer_configs_runs_delete - $ref: >- #/components/x-stackQL-resources/runs/methods/projects_locations_transfer_configs_runs_delete + - $ref: >- + #/components/x-stackQL-resources/runs/methods/projects_transfer_configs_runs_delete transfer_logs: - id: bigquerydatatransfer.transfer_logs + id: google.bigquerydatatransfer.transfer_logs name: transfer_logs title: Transfer_logs methods: @@ -1268,15 +1272,15 @@ components: response: *ref_16 sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/transfer_logs/methods/projects_transfer_configs_runs_transfer_logs_list - $ref: >- #/components/x-stackQL-resources/transfer_logs/methods/projects_locations_transfer_configs_runs_transfer_logs_list + - $ref: >- + #/components/x-stackQL-resources/transfer_logs/methods/projects_transfer_configs_runs_transfer_logs_list insert: [] update: [] delete: [] locations: - id: bigquerydatatransfer.locations + id: google.bigquerydatatransfer.locations name: locations title: Locations methods: @@ -1312,10 +1316,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/locations/methods/projects_locations_list - $ref: >- #/components/x-stackQL-resources/locations/methods/projects_locations_get + - $ref: >- + #/components/x-stackQL-resources/locations/methods/projects_locations_list insert: [] update: [] delete: [] 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 db09a717..0fa11387 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/bigqueryreservation.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/bigqueryreservation.yaml @@ -8,7 +8,7 @@ info: description: A service to modify your BigQuery flat-rate reservations. version: v1 x-discovery-doc-revision: '20240518' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/bigquery/ servers: @@ -757,7 +757,7 @@ components: - '2' x-stackQL-resources: locations: - id: bigqueryreservation.locations + id: google.bigqueryreservation.locations name: locations title: Locations methods: @@ -781,7 +781,7 @@ components: update: [] delete: [] bi_reservation: - id: bigqueryreservation.bi_reservation + id: google.bigqueryreservation.bi_reservation name: bi_reservation title: Bi_reservation methods: @@ -807,7 +807,7 @@ components: update: [] delete: [] reservations: - id: bigqueryreservation.reservations + id: google.bigqueryreservation.reservations name: reservations title: Reservations methods: @@ -859,15 +859,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/reservations/methods/list' - $ref: '#/components/x-stackQL-resources/reservations/methods/get' + - $ref: '#/components/x-stackQL-resources/reservations/methods/list' insert: - $ref: '#/components/x-stackQL-resources/reservations/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/reservations/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/reservations/methods/delete' assignments: - id: bigqueryreservation.assignments + id: google.bigqueryreservation.assignments name: assignments title: Assignments methods: @@ -915,11 +916,12 @@ components: - $ref: '#/components/x-stackQL-resources/assignments/methods/list' insert: - $ref: '#/components/x-stackQL-resources/assignments/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/assignments/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/assignments/methods/delete' capacity_commitments: - id: bigqueryreservation.capacity_commitments + id: google.bigqueryreservation.capacity_commitments name: capacity_commitments title: Capacity_commitments methods: @@ -978,12 +980,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/capacity_commitments/methods/list' - $ref: '#/components/x-stackQL-resources/capacity_commitments/methods/get' + - $ref: '#/components/x-stackQL-resources/capacity_commitments/methods/list' insert: - $ref: >- #/components/x-stackQL-resources/capacity_commitments/methods/create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/capacity_commitments/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/capacity_commitments/methods/delete 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 e66fa1d5..cc94578e 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/bigtableadmin.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/bigtableadmin.yaml @@ -8,7 +8,7 @@ info: description: Administer your Cloud Bigtable tables and instances. version: v2 x-discovery-doc-revision: '20240520' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/bigtable/ servers: @@ -2587,7 +2587,7 @@ components: - '2' x-stackQL-resources: operations: - id: bigtableadmin.operations + id: google.bigtableadmin.operations name: operations title: Operations methods: @@ -2615,7 +2615,7 @@ components: update: [] delete: [] instances: - id: bigtableadmin.instances + id: google.bigtableadmin.instances name: instances title: Instances methods: @@ -2663,15 +2663,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/instances/methods/list' - $ref: '#/components/x-stackQL-resources/instances/methods/get' + - $ref: '#/components/x-stackQL-resources/instances/methods/list' insert: - $ref: '#/components/x-stackQL-resources/instances/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/instances/methods/update' delete: - $ref: '#/components/x-stackQL-resources/instances/methods/delete' instances_iam_policies: - id: bigtableadmin.instances_iam_policies + id: google.bigtableadmin.instances_iam_policies name: instances_iam_policies title: Instances_iam_policies methods: @@ -2708,7 +2709,7 @@ components: update: [] delete: [] clusters: - id: bigtableadmin.clusters + id: google.bigtableadmin.clusters name: clusters title: Clusters methods: @@ -2760,15 +2761,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/clusters/methods/list' - $ref: '#/components/x-stackQL-resources/clusters/methods/get' + - $ref: '#/components/x-stackQL-resources/clusters/methods/list' insert: - $ref: '#/components/x-stackQL-resources/clusters/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/clusters/methods/update' delete: - $ref: '#/components/x-stackQL-resources/clusters/methods/delete' hot_tablets: - id: bigtableadmin.hot_tablets + id: google.bigtableadmin.hot_tablets name: hot_tablets title: Hot_tablets methods: @@ -2790,7 +2792,7 @@ components: update: [] delete: [] backups: - id: bigtableadmin.backups + id: google.bigtableadmin.backups name: backups title: Backups methods: @@ -2842,15 +2844,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/backups/methods/list' - $ref: '#/components/x-stackQL-resources/backups/methods/get' + - $ref: '#/components/x-stackQL-resources/backups/methods/list' insert: - $ref: '#/components/x-stackQL-resources/backups/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/backups/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/backups/methods/delete' backups_iam_policies: - id: bigtableadmin.backups_iam_policies + id: google.bigtableadmin.backups_iam_policies name: backups_iam_policies title: Backups_iam_policies methods: @@ -2887,7 +2890,7 @@ components: update: [] delete: [] app_profiles: - id: bigtableadmin.app_profiles + id: google.bigtableadmin.app_profiles name: app_profiles title: App_profiles methods: @@ -2932,15 +2935,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/app_profiles/methods/list' - $ref: '#/components/x-stackQL-resources/app_profiles/methods/get' + - $ref: '#/components/x-stackQL-resources/app_profiles/methods/list' insert: - $ref: '#/components/x-stackQL-resources/app_profiles/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/app_profiles/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/app_profiles/methods/delete' tables: - id: bigtableadmin.tables + id: google.bigtableadmin.tables name: tables title: Tables methods: @@ -3027,15 +3031,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/tables/methods/list' - $ref: '#/components/x-stackQL-resources/tables/methods/get' + - $ref: '#/components/x-stackQL-resources/tables/methods/list' insert: - $ref: '#/components/x-stackQL-resources/tables/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/tables/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/tables/methods/delete' tables_iam_policies: - id: bigtableadmin.tables_iam_policies + id: google.bigtableadmin.tables_iam_policies name: tables_iam_policies title: Tables_iam_policies methods: @@ -3072,7 +3077,7 @@ components: update: [] delete: [] authorized_views: - id: bigtableadmin.authorized_views + id: google.bigtableadmin.authorized_views name: authorized_views title: Authorized_views methods: @@ -3117,15 +3122,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/authorized_views/methods/list' - $ref: '#/components/x-stackQL-resources/authorized_views/methods/get' + - $ref: '#/components/x-stackQL-resources/authorized_views/methods/list' insert: - $ref: '#/components/x-stackQL-resources/authorized_views/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/authorized_views/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/authorized_views/methods/delete' authorized_views_iam_policies: - id: bigtableadmin.authorized_views_iam_policies + id: google.bigtableadmin.authorized_views_iam_policies name: authorized_views_iam_policies title: Authorized_views_iam_policies methods: @@ -3162,7 +3168,7 @@ components: update: [] delete: [] locations: - id: bigtableadmin.locations + id: google.bigtableadmin.locations name: locations title: Locations methods: 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 20f8d732..8ee30d34 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/billingbudgets.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/billingbudgets.yaml @@ -10,7 +10,7 @@ info: budget plan and the rules to execute as spend is tracked against that plan. version: v1 x-discovery-doc-revision: '20240526' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' 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,136 +37,53 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudBillingBudgetsV1Filter: - description: A filter for a budget, limiting the scope of the cost to calculate. - id: GoogleCloudBillingBudgetsV1Filter + GoogleCloudBillingBudgetsV1ThresholdRule: + id: GoogleCloudBillingBudgetsV1ThresholdRule type: object + 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). properties: - projects: - type: array + spendBasis: 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. - items: - type: string - creditTypesTreatment: + Optional. The type of basis used to determine if spend has passed + the threshold. Behavior defaults to CURRENT_SPEND if not set. type: string enumDescriptions: - - '' - - >- - All types of credit are subtracted from the gross cost to - determine the spend for threshold calculations. + - Unspecified threshold basis. - >- - All types of credit are added to the net cost to determine the - spend for threshold calculations. + Use current spend as the basis for comparison against the + threshold. - >- - [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. - 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`. - calendarPeriod: - type: string - 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. + 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. enum: - - CALENDAR_PERIOD_UNSPECIFIED - - MONTH - - QUARTER - - YEAR - 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. - labels: - additionalProperties: - items: - type: any - type: array - 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._ - type: object - 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. - 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. - type: array - items: - type: string - subaccounts: - type: array - items: - type: string - 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. - creditTypes: - 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. - items: - type: string - type: array - services: - type: array + - BASIS_UNSPECIFIED + - CURRENT_SPEND + - FORECASTED_SPEND + thresholdPercent: + format: double + type: number 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 + Required. Send an alert when this threshold is exceeded. This is a + 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number. GoogleCloudBillingBudgetsV1BudgetAmount: - type: object description: The budgeted amount for each usage period. id: GoogleCloudBillingBudgetsV1BudgetAmount + type: object properties: specifiedAmount: description: >- @@ -177,36 +94,20 @@ components: `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. - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1LastPeriodAmount' GoogleCloudBillingBudgetsV1NotificationsRule: + type: object + id: GoogleCloudBillingBudgetsV1NotificationsRule description: >- NotificationsRule defines notifications that are sent based on budget spend and thresholds. - id: 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. - schemaVersion: - 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. - type: string pubsubTopic: - type: string description: >- Optional. The name of the Pub/Sub topic where budget-related messages are published, in the form @@ -229,7 +130,17 @@ 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 + 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: + type: array description: >- Optional. Email targets to send notifications to when a threshold is exceeded. This is in addition to the `DefaultIamRecipients` who @@ -252,7 +163,14 @@ components: 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 + 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: description: >- Optional. When set to true, disables default notifications sent when @@ -260,9 +178,74 @@ components: with Billing Account Administrator and Billing Account User IAM roles for the target account. type: boolean + 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: + 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 + 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. + notificationsRule: + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1NotificationsRule' + description: >- + Optional. Rules to apply to notifications sent based on budget spend + and thresholds. + thresholdRules: + items: + $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 + 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' + ownershipScope: + 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. + type: string + displayName: + description: >- + User data for display name in UI. The name must be less than or + equal to 60 characters. + type: string type: object + id: GoogleCloudBillingBudgetsV1Budget GoogleCloudBillingBudgetsV1LastPeriodAmount: - id: GoogleCloudBillingBudgetsV1LastPeriodAmount type: object description: >- Describes a budget amount targeted to the last Filter.calendar_period @@ -270,54 +253,159 @@ 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. + id: GoogleCloudBillingBudgetsV1LastPeriodAmount properties: {} - GoogleCloudBillingBudgetsV1ListBudgetsResponse: - type: object - description: Response for ListBudgets - 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' - type: array - description: List of the budgets owned by the requested billing account. - id: GoogleCloudBillingBudgetsV1ListBudgetsResponse 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 - GoogleTypeDate: - id: GoogleTypeDate + GoogleCloudBillingBudgetsV1Filter: + description: A filter for a budget, limiting the scope of the cost to calculate. properties: - day: - format: int32 + projects: + items: + type: string + type: array 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: - type: integer + 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: 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 + 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 + calendarPeriod: + enum: + - CALENDAR_PERIOD_UNSPECIFIED + - MONTH + - QUARTER + - YEAR + 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. description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - type: integer + 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. + creditTypes: + items: + type: string + 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. + customPeriod: + 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. + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1CustomPeriod' + 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 + 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 + 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 + resourceAncestors: + 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. + type: object + id: GoogleCloudBillingBudgetsV1Filter + GoogleCloudBillingBudgetsV1CustomPeriod: + properties: + startDate: + description: Required. The start date must be after January 1, 2017. + $ref: '#/components/schemas/GoogleTypeDate' + endDate: + $ref: '#/components/schemas/GoogleTypeDate' + 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. + type: object + description: All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). + id: GoogleCloudBillingBudgetsV1CustomPeriod + 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 @@ -329,12 +417,34 @@ components: expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp type: object + 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 + 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: + 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. GoogleTypeMoney: + description: Represents an amount of money with its currency type. + type: object id: GoogleTypeMoney properties: nanos: - format: int32 type: integer + 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 @@ -342,148 +452,56 @@ 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. - 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 currencyCode: description: The three-letter currency code defined in ISO 4217. type: string - type: object - description: Represents an amount of money with its currency type. - GoogleCloudBillingBudgetsV1ThresholdRule: - properties: - spendBasis: - 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. + units: type: string + format: int64 description: >- - Optional. The type of basis used to determine if spend has passed - the threshold. Behavior defaults to CURRENT_SPEND if not set. - enum: - - BASIS_UNSPECIFIED - - CURRENT_SPEND - - FORECASTED_SPEND - 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. - format: double - type: object - 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 - 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. - type: object - id: GoogleCloudBillingBudgetsV1Budget + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. + GoogleCloudBillingBudgetsV1ListBudgetsResponse: + description: Response for ListBudgets properties: - amount: - description: Required. Budgeted amount. - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1BudgetAmount' - ownershipScope: - enum: - - OWNERSHIP_SCOPE_UNSPECIFIED - - ALL_USERS - - BILLING_ACCOUNT - 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. - - >- - 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. - notificationsRule: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1NotificationsRule' + nextPageToken: description: >- - Optional. Rules to apply to notifications sent based on budget spend - and thresholds. - name: + 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 - 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}`. - 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. - thresholdRules: + budgets: + description: List of the budgets owned by the requested billing account. type: array - 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. items: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1ThresholdRule' - 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. - displayName: - description: >- - User data for display name in UI. The name must be less than or - equal to 60 characters. - type: string - GoogleCloudBillingBudgetsV1CustomPeriod: + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Budget' type: object - id: GoogleCloudBillingBudgetsV1CustomPeriod - description: All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). - properties: - startDate: - $ref: '#/components/schemas/GoogleTypeDate' - description: Required. The start date must be after January 1, 2017. - endDate: - 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' + id: GoogleCloudBillingBudgetsV1ListBudgetsResponse 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 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 key: description: >- API key. Your API key identifies your project and provides you with API @@ -493,16 +511,19 @@ components: name: key schema: type: string - access_token: - description: OAuth access token. + _.xgafv: + description: V1 error format. in: query - name: access_token + name: $.xgafv schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + enum: + - '1' + - '2' + callback: + description: JSONP in: query - name: uploadType + name: callback schema: type: string alt: @@ -515,15 +536,6 @@ components: - json - media - proto - _.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 @@ -533,10 +545,10 @@ components: name: quotaUser schema: type: string - 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 prettyPrint: @@ -545,21 +557,9 @@ 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 - callback: - description: JSONP - in: query - name: callback - schema: - type: string x-stackQL-resources: budgets: - id: billingbudgets.budgets + id: google.billingbudgets.budgets name: budgets title: Budgets methods: @@ -570,17 +570,17 @@ components: 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: + get: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1budgets~1{budgetsId}/delete + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1budgets~1{budgetsId}/get response: mediaType: application/json openAPIDocKey: '200' @@ -606,23 +606,24 @@ components: - $ref: '#/components/x-stackQL-resources/budgets/methods/list' insert: - $ref: '#/components/x-stackQL-resources/budgets/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/budgets/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/budgets/methods/delete' paths: /v1/billingAccounts/{billingAccountsId}/budgets/{budgetsId}: parameters: &ref_3 + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/callback' patch: description: >- Updates a budget and returns the updated budget. WARNING: There are some @@ -667,13 +668,9 @@ paths: 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 @@ -689,7 +686,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Budget' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: billingAccountsId @@ -701,9 +698,13 @@ paths: required: true schema: type: string - delete: - description: Deletes a budget. Returns successfully if already deleted. - operationId: billingbudgets.billingAccounts.budgets.delete + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-billing @@ -719,7 +720,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Budget' parameters: - in: path name: billingAccountsId @@ -800,12 +801,12 @@ paths: name: pageToken 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 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 6bf44db3..0001f802 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: '20240524' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/binary-authorization/ servers: @@ -1656,7 +1656,7 @@ components: - '2' x-stackQL-resources: policy: - id: binaryauthorization.policy + id: google.binaryauthorization.policy name: policy title: Policy methods: @@ -1679,7 +1679,7 @@ components: update: [] delete: [] policies: - id: binaryauthorization.policies + id: google.binaryauthorization.policies name: policies title: Policies methods: @@ -1731,15 +1731,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/policies/methods/list' - $ref: '#/components/x-stackQL-resources/policies/methods/get' + - $ref: '#/components/x-stackQL-resources/policies/methods/list' insert: - $ref: '#/components/x-stackQL-resources/policies/methods/create' update: [] delete: - $ref: '#/components/x-stackQL-resources/policies/methods/delete' attestors: - id: binaryauthorization.attestors + id: google.binaryauthorization.attestors name: attestors title: Attestors methods: @@ -1787,15 +1787,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/attestors/methods/list' - $ref: '#/components/x-stackQL-resources/attestors/methods/get' + - $ref: '#/components/x-stackQL-resources/attestors/methods/list' insert: - $ref: '#/components/x-stackQL-resources/attestors/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/attestors/methods/update' delete: - $ref: '#/components/x-stackQL-resources/attestors/methods/delete' attestors_iam_policies: - id: binaryauthorization.attestors_iam_policies + id: google.binaryauthorization.attestors_iam_policies name: attestors_iam_policies title: Attestors_iam_policies methods: @@ -1832,7 +1833,7 @@ components: update: [] delete: [] policy_iam_policies: - id: binaryauthorization.policy_iam_policies + id: google.binaryauthorization.policy_iam_policies name: policy_iam_policies title: Policy_iam_policies methods: @@ -1867,7 +1868,7 @@ components: update: [] delete: [] systempolicy_policy: - id: binaryauthorization.systempolicy_policy + id: google.binaryauthorization.systempolicy_policy name: systempolicy_policy title: Systempolicy_policy methods: 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 5261411a..e7c22729 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/blockchainnodeengine.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/blockchainnodeengine.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1 x-discovery-doc-revision: '20240529' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/blockchain-node-engine servers: @@ -647,7 +647,7 @@ components: - '2' x-stackQL-resources: locations: - id: blockchainnodeengine.locations + id: google.blockchainnodeengine.locations name: locations title: Locations methods: @@ -669,13 +669,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: blockchainnodeengine.operations + id: google.blockchainnodeengine.operations name: operations title: Operations methods: @@ -713,14 +713,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' blockchain_nodes: - id: blockchainnodeengine.blockchain_nodes + id: google.blockchainnodeengine.blockchain_nodes name: blockchain_nodes title: Blockchain_nodes methods: @@ -765,11 +765,12 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/blockchain_nodes/methods/list' - $ref: '#/components/x-stackQL-resources/blockchain_nodes/methods/get' + - $ref: '#/components/x-stackQL-resources/blockchain_nodes/methods/list' insert: - $ref: '#/components/x-stackQL-resources/blockchain_nodes/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/blockchain_nodes/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/blockchain_nodes/methods/delete' paths: 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 e0851d81..9706b9d7 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/certificatemanager.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/certificatemanager.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1 x-discovery-doc-revision: '20240508' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/certificate-manager servers: @@ -1111,7 +1111,7 @@ components: - '2' x-stackQL-resources: locations: - id: certificatemanager.locations + id: google.certificatemanager.locations name: locations title: Locations methods: @@ -1133,13 +1133,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: certificatemanager.operations + id: google.certificatemanager.operations name: operations title: Operations methods: @@ -1177,14 +1177,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' certificates: - id: certificatemanager.certificates + id: google.certificatemanager.certificates name: certificates title: Certificates methods: @@ -1229,15 +1229,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/certificates/methods/list' - $ref: '#/components/x-stackQL-resources/certificates/methods/get' + - $ref: '#/components/x-stackQL-resources/certificates/methods/list' insert: - $ref: '#/components/x-stackQL-resources/certificates/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/certificates/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/certificates/methods/delete' certificate_maps: - id: certificatemanager.certificate_maps + id: google.certificatemanager.certificate_maps name: certificate_maps title: Certificate_maps methods: @@ -1282,15 +1283,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/certificate_maps/methods/list' - $ref: '#/components/x-stackQL-resources/certificate_maps/methods/get' + - $ref: '#/components/x-stackQL-resources/certificate_maps/methods/list' insert: - $ref: '#/components/x-stackQL-resources/certificate_maps/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/certificate_maps/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/certificate_maps/methods/delete' certificate_map_entries: - id: certificatemanager.certificate_map_entries + id: google.certificatemanager.certificate_map_entries name: certificate_map_entries title: Certificate_map_entries methods: @@ -1335,19 +1337,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/certificate_map_entries/methods/list - $ref: >- #/components/x-stackQL-resources/certificate_map_entries/methods/get + - $ref: >- + #/components/x-stackQL-resources/certificate_map_entries/methods/list insert: - $ref: >- #/components/x-stackQL-resources/certificate_map_entries/methods/create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/certificate_map_entries/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/certificate_map_entries/methods/delete dns_authorizations: - id: certificatemanager.dns_authorizations + id: google.certificatemanager.dns_authorizations name: dns_authorizations title: Dns_authorizations methods: @@ -1392,15 +1396,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/dns_authorizations/methods/list' - $ref: '#/components/x-stackQL-resources/dns_authorizations/methods/get' + - $ref: '#/components/x-stackQL-resources/dns_authorizations/methods/list' insert: - $ref: '#/components/x-stackQL-resources/dns_authorizations/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/dns_authorizations/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/dns_authorizations/methods/delete' certificate_issuance_configs: - id: certificatemanager.certificate_issuance_configs + id: google.certificatemanager.certificate_issuance_configs name: certificate_issuance_configs title: Certificate_issuance_configs methods: @@ -1438,10 +1443,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/certificate_issuance_configs/methods/list - $ref: >- #/components/x-stackQL-resources/certificate_issuance_configs/methods/get + - $ref: >- + #/components/x-stackQL-resources/certificate_issuance_configs/methods/list insert: - $ref: >- #/components/x-stackQL-resources/certificate_issuance_configs/methods/create @@ -1450,7 +1455,7 @@ components: - $ref: >- #/components/x-stackQL-resources/certificate_issuance_configs/methods/delete trust_configs: - id: certificatemanager.trust_configs + id: google.certificatemanager.trust_configs name: trust_configs title: Trust_configs methods: @@ -1495,11 +1500,12 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/trust_configs/methods/list' - $ref: '#/components/x-stackQL-resources/trust_configs/methods/get' + - $ref: '#/components/x-stackQL-resources/trust_configs/methods/list' insert: - $ref: '#/components/x-stackQL-resources/trust_configs/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/trust_configs/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/trust_configs/methods/delete' paths: 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 ee8ec00e..44005775 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudasset.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudasset.yaml @@ -10,7 +10,7 @@ info: resources. version: v1 x-discovery-doc-revision: '20240530' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/asset-inventory/docs/quickstart servers: @@ -5014,7 +5014,7 @@ components: - '2' x-stackQL-resources: saved_queries: - id: cloudasset.saved_queries + id: google.cloudasset.saved_queries name: saved_queries title: Saved_queries methods: @@ -5054,15 +5054,16 @@ components: response: *ref_2 sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/saved_queries/methods/get' - $ref: '#/components/x-stackQL-resources/saved_queries/methods/list' + - $ref: '#/components/x-stackQL-resources/saved_queries/methods/get' insert: - $ref: '#/components/x-stackQL-resources/saved_queries/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/saved_queries/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/saved_queries/methods/delete' cloudasset: - id: cloudasset.cloudasset + id: google.cloudasset.cloudasset name: cloudasset title: Cloudasset methods: @@ -5090,7 +5091,7 @@ components: update: [] delete: [] cloudasset_assets_history: - id: cloudasset.cloudasset_assets_history + id: google.cloudasset.cloudasset_assets_history name: cloudasset_assets_history title: Cloudasset_assets_history methods: @@ -5106,7 +5107,7 @@ components: update: [] delete: [] cloudasset_iam_policies: - id: cloudasset.cloudasset_iam_policies + id: google.cloudasset.cloudasset_iam_policies name: cloudasset_iam_policies title: Cloudasset_iam_policies methods: @@ -5122,7 +5123,7 @@ components: update: [] delete: [] assets: - id: cloudasset.assets + id: google.cloudasset.assets name: assets title: Assets methods: @@ -5143,7 +5144,7 @@ components: update: [] delete: [] feeds: - id: cloudasset.feeds + id: google.cloudasset.feeds name: feeds title: Feeds methods: @@ -5167,7 +5168,7 @@ components: update: [] delete: [] effective_iam_policies: - id: cloudasset.effective_iam_policies + id: google.cloudasset.effective_iam_policies name: effective_iam_policies title: Effective_iam_policies methods: 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 d98f0c98..d0ca82a1 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudbilling.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudbilling.yaml @@ -10,7 +10,7 @@ info: programmatically. version: v1 x-discovery-doc-revision: '20240517' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/billing/docs/apis servers: @@ -902,7 +902,7 @@ components: - '2' x-stackQL-resources: billing_accounts: - id: cloudbilling.billing_accounts + id: google.cloudbilling.billing_accounts name: billing_accounts title: Billing_accounts methods: @@ -951,10 +951,11 @@ components: insert: - $ref: '#/components/x-stackQL-resources/billing_accounts/methods/create' - $ref: '#/components/x-stackQL-resources/billing_accounts/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/billing_accounts/methods/patch' delete: [] billing_accounts_iam_policies: - id: cloudbilling.billing_accounts_iam_policies + id: google.cloudbilling.billing_accounts_iam_policies name: billing_accounts_iam_policies title: Billing_accounts_iam_policies methods: @@ -991,7 +992,7 @@ components: update: [] delete: [] sub_accounts: - id: cloudbilling.sub_accounts + id: google.cloudbilling.sub_accounts name: sub_accounts title: Sub_accounts methods: @@ -1021,7 +1022,7 @@ components: update: [] delete: [] projects: - id: cloudbilling.projects + id: google.cloudbilling.projects name: projects title: Projects methods: @@ -1042,7 +1043,7 @@ components: update: [] delete: [] billing_info: - id: cloudbilling.billing_info + id: google.cloudbilling.billing_info name: billing_info title: Billing_info methods: @@ -1066,7 +1067,7 @@ components: update: [] delete: [] services: - id: cloudbilling.services + id: google.cloudbilling.services name: services title: Services methods: @@ -1087,7 +1088,7 @@ components: update: [] delete: [] skus: - id: cloudbilling.skus + id: google.cloudbilling.skus name: skus title: Skus methods: 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 4fc4b59a..0290b5c4 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudbuild.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudbuild.yaml @@ -8,7 +8,7 @@ info: description: Creates and manages builds on Google Cloud Platform. version: v2 x-discovery-doc-revision: '20240528' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/cloud-build/docs/ servers: @@ -34,2135 +34,2134 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - ListRepositoriesResponse: - description: Message for response to listing Repositories. - id: ListRepositoriesResponse + SecretVolumeSource: properties: - nextPageToken: + secretName: + description: Name of the secret referenced by the WorkspaceBinding. type: string - description: A token identifying a page of results the server should return. - repositories: - type: array - items: - $ref: '#/components/schemas/Repository' - description: The list of Repositories. - type: object - PipelineRef: - properties: - resolver: - enum: - - RESOLVER_NAME_UNSPECIFIED - - BUNDLES - - GCB_REPO - - GIT - - DEVELOPER_CONNECT - 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. - description: >- - Resolver is the name of the resolver that should perform resolution - of the referenced Tekton resource. + secretVersion: type: string - params: - type: array - items: - $ref: '#/components/schemas/Param' + readOnly: true 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: - type: string - description: Name of the Pipeline. - deprecated: true - type: object - description: PipelineRef can be used to refer to a specific instance of a Pipeline. - id: PipelineRef - Repository: + Output only. Resource name of the SecretVersion. In format: + projects/*/secrets/*/versions/* + description: Secret Volume Source. + id: SecretVolumeSource type: object + EmbeddedTask: + id: EmbeddedTask + description: EmbeddedTask defines a Task that is embedded in a Pipeline. properties: - 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 - createTime: - format: google-datetime - type: string - description: >- - Output only. Server assigned timestamp for when the connection was - created. - readOnly: true - remoteUri: - type: string - description: Required. Git Clone HTTPS URI. - updateTime: - format: google-datetime - description: >- - Output only. Server assigned timestamp for when the connection was - updated. - type: string - readOnly: true annotations: + description: User annotations. See https://google.aip.dev/128#annotations additionalProperties: type: string type: object - description: Optional. Allows clients to store small amounts of arbitrary data. - webhookId: - type: string + taskSpec: + description: Spec to instantiate this TaskRun. + $ref: '#/components/schemas/TaskSpec' + type: object + PipelineRunResult: + description: PipelineRunResult used to describe the results of a pipeline + id: PipelineRunResult + properties: + value: + $ref: '#/components/schemas/ResultValue' + description: Output only. Value of the result. readOnly: true - description: Output only. External ID of the webhook created for the repository. name: type: string + readOnly: true + description: Output only. Name of the TaskRun + type: object + 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. + id: Probe + properties: + periodSeconds: description: >- - Immutable. Resource name of the repository, in the format - `projects/*/locations/*/connections/*/repositories/*`. - id: Repository - description: A repository associated to a parent connection. - PipelineRun: + Optional. How often (in seconds) to perform the probe. Default to 10 + seconds. Minimum value is 1. +optional + format: int32 + type: integer + exec: + description: Optional. Exec specifies the action to take. +optional + $ref: '#/components/schemas/ExecAction' + Status: properties: - conditions: + message: description: >- - Output only. Kubernetes Conditions convention for PipelineRun status - and 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 + code: + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 + type: integer + details: items: - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV2Condition' + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. type: array - readOnly: true - provenance: - $ref: '#/components/schemas/Provenance' - description: Optional. Provenance configuration. - worker: - $ref: '#/components/schemas/Worker' - description: Optional. Worker configuration. - serviceAccount: - deprecated: true - description: >- - Service account used in the Pipeline. Deprecated; please use - security.service_account instead. - type: string - pipelineRef: - $ref: '#/components/schemas/PipelineRef' - description: PipelineRef refer to a specific instance of a Pipeline. - results: description: >- - Optional. Output only. List of results written out by the pipeline's - containers - type: array - readOnly: true + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + 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). + FetchReadWriteTokenRequest: + properties: {} + description: Message for fetching SCM read/write token. + id: FetchReadWriteTokenRequest + type: object + FetchLinkableRepositoriesResponse: + properties: + repositories: items: - $ref: '#/components/schemas/PipelineRunResult' - finallyStartTime: + $ref: '#/components/schemas/Repository' + description: repositories ready to be created. + type: array + nextPageToken: type: string - readOnly: true - description: >- - Output only. FinallyStartTime is when all non-finally tasks have - been completed and only finally tasks are being executed. +optional - format: google-datetime - record: + description: A token identifying a page of results the server should return. + type: object + id: FetchLinkableRepositoriesResponse + description: Response message for FetchLinkableRepositories. + CreateRepositoryRequest: + properties: + repository: + $ref: '#/components/schemas/Repository' + description: Required. The repository to create. + parent: description: >- - Output only. The `Record` of this `PipelineRun`. Format: - `projects/{project}/locations/{location}/results/{result_id}/records/{record_id}` - readOnly: true + 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 - workspaces: + repositoryId: description: >- - Workspaces is a list of WorkspaceBindings from volumes to - workspaces. + 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 + type: object + id: CreateRepositoryRequest + description: Message for creating a Repository. + Sidecar: + description: Sidecars run alongside the Task's step containers. + id: Sidecar + type: object + properties: + image: + type: string + description: Docker image name. + script: + description: The contents of an executable file to execute. + type: string + command: type: array + description: Entrypoint array. items: - $ref: '#/components/schemas/WorkspaceBinding' - 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 - annotations: - description: User annotations. See https://google.aip.dev/128#annotations - additionalProperties: type: string - type: object - params: + name: + description: Name of the Sidecar. + type: string + env: type: array - description: Params is a list of parameter names and values. + description: List of environment variables to set in the container. items: - $ref: '#/components/schemas/Param' - skippedTasks: - type: array - description: >- - Output only. List of tasks that were skipped due to when expressions - evaluating to false. + $ref: '#/components/schemas/EnvVar' + volumeMounts: + type: array items: - $ref: '#/components/schemas/SkippedTask' - readOnly: true - startTime: - type: string - format: google-datetime - description: Output only. Time the pipeline is actually started. - readOnly: true - updateTime: - readOnly: true + $ref: '#/components/schemas/VolumeMount' + description: Pod volumes to mount into the container's filesystem. + readinessProbe: description: >- - Output only. Time at which the request to update the `PipelineRun` - was received. - format: google-datetime + 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 + $ref: '#/components/schemas/Probe' + workingDir: + description: Container's working directory. type: string - pipelineRunStatus: + securityContext: + description: Optional. Security options the container should be run with. + $ref: '#/components/schemas/SecurityContext' + args: + description: Arguments to the entrypoint. + type: array + items: + type: string + Provenance: + description: Provenance configuration. + id: Provenance + properties: + enabled: + description: Optional. Provenance push mode. enumDescriptions: - - Default enum type; should not be used. - - Cancelled status. - description: Pipelinerun status the user can provide. Used for cancellation. - enum: - - PIPELINE_RUN_STATUS_UNSPECIFIED - - PIPELINE_RUN_CANCELLED + - 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. type: string - etag: + enum: + - ENABLED_UNSPECIFIED + - REQUIRED + - OPTIMISTIC + - DISABLED + storage: + enum: + - STORAGE_UNSPECIFIED + - PREFER_ARTIFACT_PROJECT + - ARTIFACT_PROJECT_ONLY + - BUILD_PROJECT_ONLY + 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. type: string - description: Needed for declarative-friendly resources. - gcbParams: - readOnly: true - additionalProperties: - type: string - type: object - description: Output only. GCB default params. - security: - $ref: '#/components/schemas/Security' - description: Optional. Security configuration. - workerPool: - description: Output only. The WorkerPool used to run this PipelineRun. - readOnly: true + region: type: string - pipelineSpec: - $ref: '#/components/schemas/PipelineSpec' - description: PipelineSpec defines the desired state of Pipeline. - resolvedPipelineSpec: - $ref: '#/components/schemas/PipelineSpec' - description: Output only. The exact PipelineSpec used to instantiate the run. - readOnly: true - pipelineSpecYaml: - readOnly: true - description: >- - Output only. Inline pipelineSpec yaml string, used by workflow run - requests. + 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 + description: Optional. Provenance region. + type: object + ListRepositoriesResponse: + type: object + properties: + nextPageToken: type: string - childReferences: - readOnly: true - items: - $ref: '#/components/schemas/ChildStatusReference' - description: >- - Output only. List of TaskRun and Run names and PipelineTask names - for children of this PipelineRun. + description: A token identifying a page of results the server should return. + repositories: + description: The list of Repositories. type: array - uid: - readOnly: true - description: Output only. A unique identifier for the `PipelineRun`. + items: + $ref: '#/components/schemas/Repository' + description: Message for response to listing Repositories. + id: ListRepositoriesResponse + FetchReadTokenResponse: + description: Message for responding to get read token. + type: object + id: FetchReadTokenResponse + properties: + token: + description: The token content. type: string - completionTime: - format: google-datetime + expirationTime: type: string - readOnly: true - description: Output only. Time the pipeline completed. - createTime: format: google-datetime - type: string - readOnly: true + description: Expiration timestamp. Can be empty if unknown or non-expiring. + SkippedTask: + type: object + description: >- + SkippedTask is used to describe the Tasks that were skipped due to their + When Expressions evaluating to False. + id: SkippedTask + properties: + whenExpressions: + type: array + items: + $ref: '#/components/schemas/WhenExpression' description: >- - Output only. Time at which the request to create the `PipelineRun` - was received. + WhenExpressions is the list of checks guarding the execution of the + PipelineTask name: type: string + description: Name is the Pipeline Task name + reason: readOnly: true - description: >- - Output only. The `PipelineRun` name with format - `projects/{project}/locations/{location}/pipelineRuns/{pipeline_run}` - workflow: - description: Output only. The Workflow used to create this PipelineRun. + description: Output only. Reason is the cause of the PipelineTask being skipped. type: string - readOnly: true - type: object - description: Message describing PipelineRun object - id: PipelineRun - Connection: + WhenExpression: + description: Conditions that need to be true for the task to run. + id: WhenExpression properties: - updateTime: - type: string - format: google-datetime + input: description: >- - Output only. Server assigned timestamp for when the connection was - updated. - readOnly: true - githubEnterpriseConfig: - $ref: >- - #/components/schemas/GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig - description: Configuration for connections to an instance of GitHub Enterprise. - installationState: - $ref: '#/components/schemas/InstallationState' - description: Output only. Installation state of the Connection. - readOnly: true - bitbucketCloudConfig: - description: Configuration for connections to Bitbucket Cloud. - $ref: '#/components/schemas/BitbucketCloudConfig' - createTime: + Input is the string for guard checking which can be a static input + or an output from a parent Task. type: string - readOnly: true - format: google-datetime - description: >- - Output only. Server assigned timestamp for when the connection was - created. - name: + 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. type: string + description: Operator that represents an Input's relationship to the values + values: description: >- - Immutable. The resource name of the connection, in the format - `projects/{project}/locations/{location}/connections/{connection_id}`. + Values is an array of strings, which is compared against the input, + for guard checking. + items: + type: string + type: array + type: object + Policy: + type: object + properties: + auditConfigs: + items: + $ref: '#/components/schemas/AuditConfig' + description: Specifies cloud audit logging configuration for this policy. + type: array etag: + format: byte 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. - disabled: + `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/Binding' + type: array 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 - bitbucketDataCenterConfig: - $ref: '#/components/schemas/BitbucketDataCenterConfig' - description: Configuration for connections to Bitbucket Data Center. - annotations: - description: Optional. Allows clients to store small amounts of arbitrary data. - type: object - additionalProperties: - type: string - githubConfig: - $ref: '#/components/schemas/GitHubConfig' - description: Configuration for connections to github.com. - reconciling: - type: boolean - description: >- - Output only. Set to true when the connection is being set up or - updated in the background. - readOnly: true - gitlabConfig: + 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: >- - Configuration for connections to gitlab.com or an instance of GitLab - Enterprise. - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV2GitLabConfig' - type: object - id: Connection + 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 + id: Policy description: >- - A connection to a SCM like GitHub, GitHub Enterprise, Bitbucket Data - Center, Bitbucket Cloud or GitLab. - PropertySpec: - id: PropertySpec + 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/). + PipelineRef: + description: PipelineRef can be used to refer to a specific instance of a Pipeline. type: object properties: - type: + 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. + resolver: + description: >- + Resolver is the name of the resolver that should perform resolution + of the referenced Tekton resource. type: string - description: A type for the object. + enum: + - RESOLVER_NAME_UNSPECIFIED + - BUNDLES + - GCB_REPO + - GIT + - DEVELOPER_CONNECT enumDescriptions: - Default enum type; should not be used. - - Default - enum: - - TYPE_UNSPECIFIED - - STRING - description: PropertySpec holds information about a property in an object. - ListLocationsResponse: - description: The response message for Locations.ListLocations. - id: ListLocationsResponse - type: object - properties: - locations: - items: - $ref: '#/components/schemas/Location' - description: >- - A list of locations that matches the specified filter in the - request. - type: array - nextPageToken: + - >- + 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. + name: + description: Name of the Pipeline. type: string - description: The standard List next-page token. - EmptyDirVolumeSource: - type: object - id: EmptyDirVolumeSource - properties: {} - description: Represents an empty Volume source. - PipelineRunResult: - id: PipelineRunResult - description: PipelineRunResult used to describe the results of a pipeline - type: object + deprecated: true + id: PipelineRef + ParamSpec: properties: - value: - description: Output only. Value of the result. - $ref: '#/components/schemas/ResultValue' - readOnly: true name: type: string - description: Output only. Name of the TaskRun - readOnly: true - Status: - id: Status - properties: - code: - format: int32 - description: The status code, which should be an enum value of google.rpc.Code. - 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 - 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. + description: Name of the ParamSpec + description: + type: string + description: Description of the ParamSpec + type: + enum: + - TYPE_UNSPECIFIED + - STRING + - ARRAY + description: Type of ParamSpec + enumDescriptions: + - Default enum type; should not be used. + - Default + - Arrary type. type: string + default: + $ref: '#/components/schemas/ParamValue' + description: The default value a parameter takes if no input value is supplied + id: ParamSpec 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). + 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 - FetchGitRefsResponse: - description: Response for fetching git refs + TaskSpec: + id: TaskSpec properties: - nextPageToken: - description: A token identifying a page of results the server should return. + description: type: string - refNames: - items: - type: string - type: array - description: Name of the refs fetched. - id: FetchGitRefsResponse - type: object - PipelineSpec: - type: object - id: PipelineSpec - properties: + description: Description of the task. workspaces: - description: >- - Workspaces declares a set of named workspaces that are expected to - be provided by a PipelineRun. + description: The volumes that this Task requires. type: array items: - $ref: '#/components/schemas/PipelineWorkspaceDeclaration' - generatedYaml: - 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. - type: string - finallyTasks: - type: array - 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. + $ref: '#/components/schemas/WorkspaceDeclaration' + results: + description: Values that this Task can output. items: - $ref: '#/components/schemas/PipelineTask' - params: + $ref: '#/components/schemas/TaskResult' type: array + managedSidecars: items: - $ref: '#/components/schemas/ParamSpec' - description: List of parameters. - tasks: - items: - $ref: '#/components/schemas/PipelineTask' - description: List of Tasks that execute when this Pipeline is run. + enumDescriptions: + - Default enum type; should not be used. + - Sidecar for a privileged docker daemon. + enum: + - MANAGED_SIDECAR_UNSPECIFIED + - PRIVILEGED_DOCKER_DAEMON + type: string type: array - results: + description: >- + Sidecars that run alongside the Task’s step containers that should + be added to this Task. + steps: + description: Steps of the task. type: array items: - $ref: '#/components/schemas/PipelineResult' - readOnly: true + $ref: '#/components/schemas/Step' + params: + type: array + description: List of parameters. + items: + $ref: '#/components/schemas/ParamSpec' + stepTemplate: description: >- - Optional. Output only. List of results written out by the pipeline's - containers - description: PipelineSpec defines the desired state of Pipeline. - WorkspaceBinding: + 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' + volumes: + description: A collection of volumes that are available to mount into steps. + type: array + items: + $ref: '#/components/schemas/VolumeSource' + sidecars: + items: + $ref: '#/components/schemas/Sidecar' + type: array + description: Sidecars that run alongside the Task's step containers. + type: object + description: TaskSpec contains the Spec to instantiate a TaskRun. + TaskResult: + description: TaskResult is used to describe the results of a task. + id: TaskResult + type: object properties: - subPath: - 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: + description: 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 + value: + $ref: '#/components/schemas/ParamValue' + description: >- + Optional. Optionally used to initialize a Task's result with a + Step's result. + 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 name: - description: Name of the workspace. type: string - secret: - $ref: '#/components/schemas/SecretVolumeSource' - description: Secret Volume Source. - 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 - GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig: - description: >- - ServiceDirectoryConfig represents Service Directory configuration for a - connection. - id: GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig - type: object + description: Name of the result. + description: + description: Description of the result. + type: string + ListLocationsResponse: + id: ListLocationsResponse properties: - service: - description: >- - Required. The Service Directory service name. Format: - projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. + nextPageToken: + description: The standard List next-page token. type: string - FetchReadWriteTokenRequest: - properties: {} - description: Message for fetching SCM read/write token. + locations: + description: >- + A list of locations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Location' + description: The response message for Locations.ListLocations. type: object - id: FetchReadWriteTokenRequest - GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig: + VolumeMount: + description: Pod volumes to mount into the container's filesystem. + id: VolumeMount properties: - apiKey: - type: string - description: Required. API Key used for authentication of webhook events. - serverVersion: - type: string - description: Output only. GitHub Enterprise version installed at the host_uri. - readOnly: true - privateKeySecretVersion: + readOnly: + type: boolean + description: >- + Mounted read-only if true, read-write otherwise (false or + unspecified). + subPath: type: string description: >- - Optional. SecretManager resource containing the private key of the - GitHub App, formatted as `projects/*/secrets/*/versions/*`. - appId: + Path within the volume from which the container's volume should be + mounted. Defaults to "" (volume's root). + subPathExpr: type: string - format: int64 - description: Optional. Id of the GitHub App created from the manifest. - serviceDirectoryConfig: 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. - $ref: >- - #/components/schemas/GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig - sslCa: + 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). + mountPath: type: string - description: Optional. SSL certificate to use for requests to GitHub Enterprise. - hostUri: + description: >- + Path within the container at which the volume should be mounted. + Must not contain ':'. + name: type: string + description: Name of the volume. + type: object + BitbucketCloudConfig: + description: Configuration for connections to Bitbucket Cloud. + type: object + properties: + authorizerCredential: + $ref: '#/components/schemas/UserCredential' description: >- - Required. The URI of the GitHub Enterprise host this connection is - for. + 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. webhookSecretSecretVersion: type: string description: >- - Optional. SecretManager resource containing the webhook secret of - the GitHub App, formatted as `projects/*/secrets/*/versions/*`. - appInstallationId: - description: Optional. ID of the installation of the GitHub App. - format: int64 + 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 - appSlug: + description: >- + Required. The Bitbucket Cloud Workspace ID to be connected to Google + Cloud Platform. + id: BitbucketCloudConfig + BatchCreateRepositoriesResponse: + type: object + description: Message for response of creating repositories in batch. + properties: + repositories: + description: Repository resources created. + items: + $ref: '#/components/schemas/Repository' + type: array + id: BatchCreateRepositoriesResponse + FetchReadWriteTokenResponse: + id: FetchReadWriteTokenResponse + type: object + properties: + token: + description: The token content. type: string - description: Optional. The URL-friendly name of the GitHub App. - id: GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig - description: Configuration for connections to an instance of GitHub Enterprise. + expirationTime: + format: google-datetime + description: Expiration timestamp. Can be empty if unknown or non-expiring. + type: string + description: Message for responding to get read/write token. + Empty: type: object - Binding: + 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 + properties: {} + Security: + id: Security type: object properties: - 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' - 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). + serviceAccount: type: string - 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 - id: Binding - description: Associates `members`, or principals, with a `role`. - WhenExpression: - id: WhenExpression - properties: - expressionOperator: + description: IAM service account whose credentials will be used at runtime. + privilegeMode: enumDescriptions: - - Default enum type; should not be used. - - Input is in values. - - Input is not in values. + - Default to PRIVILEGED. + - Privileged mode. + - Unprivileged mode. enum: - - EXPRESSION_OPERATOR_UNSPECIFIED - - IN - - NOT_IN - type: string - description: Operator that represents an Input's relationship to the values - input: + - PRIVILEGE_MODE_UNSPECIFIED + - PRIVILEGED + - UNPRIVILEGED + description: Optional. Privilege mode. type: string - description: >- - Input is the string for guard checking which can be a static input - or an output from a parent Task. - values: - description: >- - Values is an array of strings, which is compared against the input, - for guard checking. - type: array - items: - type: string - type: object - description: Conditions that need to be true for the task to run. - FetchReadWriteTokenResponse: - id: FetchReadWriteTokenResponse - description: Message for responding to get read/write token. + description: Security configuration. + OAuthCredential: + description: >- + Represents an OAuth token of the account that authorized the Connection, + and associated metadata. + id: OAuthCredential properties: - expirationTime: - description: Expiration timestamp. Can be empty if unknown or non-expiring. + oauthTokenSecretVersion: type: string - format: google-datetime - token: - description: The token content. + description: >- + Optional. A SecretManager resource containing the OAuth token that + authorizes the Cloud Build connection. Format: + `projects/*/secrets/*/versions/*`. + username: + readOnly: true type: string + description: Output only. The username associated to this token. type: object - BatchCreateRepositoriesResponse: - id: BatchCreateRepositoriesResponse - properties: - repositories: - items: - $ref: '#/components/schemas/Repository' - description: Repository resources created. - type: array - description: Message for response of creating repositories in batch. + SecurityContext: type: object - RunWorkflowCustomOperationMetadata: - description: >- - Represents the custom metadata of the RunWorkflow long-running - operation. - id: RunWorkflowCustomOperationMetadata properties: - endTime: - type: string - readOnly: true - description: Output only. The time the operation finished running. - format: google-datetime - createTime: - readOnly: true - format: google-datetime - description: Output only. The time the operation was created. - type: string - verb: - readOnly: true - type: string - description: Output only. Name of the verb executed by the operation. - apiVersion: - readOnly: true - description: Output only. API version used to start the operation. + 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: type: string - target: - 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: + format: int64 type: string description: >- - Output only. Server-defined resource path for the target of the - operation. - requestedCancellation: + 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: >- - 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 - pipelineRunId: - description: Output only. ID of the pipeline run created by RunWorkflow. - readOnly: true + 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: + description: >- + Optional. Adds and removes POSIX capabilities from running + containers. + $ref: '#/components/schemas/Capabilities' + id: SecurityContext + description: Security options the container should be run with. + 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. + 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: + items: + $ref: '#/components/schemas/AuditLogConfig' + description: The configuration for logging of each type of permission. + type: array + id: AuditConfig type: object - VolumeMount: + WorkspacePipelineTaskBinding: + id: WorkspacePipelineTaskBinding properties: subPath: - type: string description: >- - Path within the volume from which the container's volume should be - mounted. Defaults to "" (volume's root). - mountPath: + 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: string - description: >- - Path within the container at which the volume should be mounted. - Must not contain ':'. - subPathExpr: + workspace: type: string - 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). + description: Name of the workspace declared by the pipeline. name: - description: Name of the volume. + description: Name of the workspace as declared by the task. type: string - readOnly: - type: boolean - description: >- - Mounted read-only if true, read-write otherwise (false or - unspecified). - id: VolumeMount - description: Pod volumes to mount into the container's filesystem. - type: object - Probe: type: object - id: Probe - properties: - exec: - $ref: '#/components/schemas/ExecAction' - description: Optional. Exec specifies the action to take. +optional - periodSeconds: - format: int32 - type: integer - description: >- - Optional. How often (in seconds) to perform the probe. Default to 10 - seconds. Minimum value is 1. +optional description: >- - Probe describes a health check to be performed against a container to - determine whether it is alive or ready to receive traffic. - Capabilities: + WorkspacePipelineTaskBinding maps workspaces from the PipelineSpec to + the workspaces declared in the Task. + StepTemplate: description: >- - Capabilities adds and removes POSIX capabilities from running - containers. - id: Capabilities - properties: - drop: - items: - type: string - description: Optional. Removed capabilities +optional - type: array - add: - type: array - description: Optional. Added capabilities +optional - items: - type: string - type: object - CreateRepositoryRequest: - properties: - parent: - 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. - type: string - repository: - description: Required. The repository to create. - $ref: '#/components/schemas/Repository' - repositoryId: - 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 - -._~%!$&'()*+,;=@. - description: Message for creating a Repository. - id: CreateRepositoryRequest - type: object - Step: + StepTemplate can be used as the basis for all step containers within the + Task, so that the steps inherit settings on the base container. + id: StepTemplate properties: - workingDir: - description: Container's working directory. - type: string volumeMounts: type: array + description: Optional. Pod volumes to mount into the container's filesystem. items: $ref: '#/components/schemas/VolumeMount' - description: Pod volumes to mount into the container's filesystem. - command: - type: array - description: Entrypoint array. - items: - type: string - securityContext: - $ref: '#/components/schemas/SecurityContext' + env: 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 - args: + Optional. List of environment variables to set in the Step. Cannot + be updated. items: - type: string - description: Arguments to the entrypoint. - type: array - params: + $ref: '#/components/schemas/EnvVar' type: array - items: - $ref: '#/components/schemas/Param' - description: Optional. Optional parameters passed to the StepAction. - name: - description: Name of the container specified as a DNS_LABEL. - type: string - timeout: - description: Time after which the Step times out. Defaults to never. - type: string - format: google-duration - script: + type: object + ListConnectionsResponse: + type: object + id: ListConnectionsResponse + properties: + nextPageToken: type: string - description: The contents of an executable file to execute. - env: + description: A token identifying a page of results the server should return. + connections: + description: The list of Connections. items: - $ref: '#/components/schemas/EnvVar' - description: List of environment variables to set in the container. + $ref: '#/components/schemas/Connection' type: array - image: - description: Docker image name. - type: string - ref: - $ref: '#/components/schemas/StepRef' - description: Optional. Optional reference to a remote StepAction. - id: Step - type: object - description: >- - Step embeds the Container type, which allows it to include fields not - provided by Container. - GoogleDevtoolsCloudbuildV2OperationMetadata: + description: Message for response to listing Connections. + OperationMetadata: description: Represents the metadata of the long-running operation. - type: object properties: - statusMessage: + statusDetail: type: string description: Output only. Human-readable status of the operation, if any. readOnly: true - createTime: - readOnly: true - type: string - description: Output only. The time the operation was created. - format: google-datetime - 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: + type: string description: >- Output only. Server-defined resource path for the target of the operation. readOnly: true - type: string endTime: - type: string readOnly: true - description: Output only. The time the operation finished running. + type: string format: google-datetime + description: Output only. The time the operation finished running. verb: readOnly: true - type: string description: Output only. Name of the verb executed by the operation. + type: string apiVersion: - description: Output only. API version used to start the operation. readOnly: true + description: Output only. API version used to start the operation. type: string - id: GoogleDevtoolsCloudbuildV2OperationMetadata - ChildStatusReference: + createTime: + type: string + readOnly: true + format: google-datetime + description: Output only. The time the operation was created. + cancelRequested: + type: boolean + readOnly: true + 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`. + id: OperationMetadata type: object - id: ChildStatusReference + Repository: + description: A repository associated to a parent connection. properties: - whenExpressions: - description: >- - WhenExpressions is the list of checks guarding the execution of the - PipelineTask - items: - $ref: '#/components/schemas/WhenExpression' - type: array - pipelineTaskName: + updateTime: + format: google-datetime type: string + readOnly: true description: >- - PipelineTaskName is the name of the PipelineTask this is - referencing. + Output only. Server assigned timestamp for when the connection was + updated. + annotations: + description: Optional. Allows clients to store small amounts of arbitrary data. + type: object + additionalProperties: + type: string name: type: string - description: Name is the name of the TaskRun or Run this is referencing. - type: - enum: - - TYPE_UNSPECIFIED - - TASK_RUN - enumDescriptions: - - Default enum type; should not be used. - - TaskRun. - description: Output only. Type of the child reference. + description: >- + Immutable. Resource name of the repository, in the format + `projects/*/locations/*/connections/*/repositories/*`. + webhookId: type: string readOnly: true - description: >- - ChildStatusReference is used to point to the statuses of individual - TaskRuns and Runs within this PipelineRun. - ExecAction: - description: ExecAction describes a "run in container" action. - properties: - command: - type: array + description: Output only. External ID of the webhook created for the repository. + etag: 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 - items: - type: string - type: object - id: ExecAction - GitHubConfig: - description: Configuration for connections to github.com. - properties: - appInstallationId: + 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 + createTime: + format: google-datetime + readOnly: true type: string - format: int64 - description: Optional. GitHub App installation id. - authorizerCredential: - $ref: '#/components/schemas/OAuthCredential' 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. - id: GitHubConfig + Output only. Server assigned timestamp for when the connection was + created. + remoteUri: + type: string + description: Required. Git Clone HTTPS URI. + id: Repository type: object - WorkspacePipelineTaskBinding: + Param: + id: Param description: >- - WorkspacePipelineTaskBinding maps workspaces from the PipelineSpec to - the workspaces declared in the Task. + Param defined with name and value. PipelineRef can be used to refer to a + specific instance of a Pipeline. properties: name: - description: Name of the workspace as declared by the task. - type: string - 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 - id: WorkspacePipelineTaskBinding + description: Name of the parameter. + value: + description: Value of the parameter. + $ref: '#/components/schemas/ParamValue' type: object - FetchLinkableRepositoriesResponse: + ParamValue: + type: object + id: ParamValue + description: Parameter value. properties: - nextPageToken: + stringVal: + description: Value of the parameter if type is string. type: string - description: A token identifying a page of results the server should return. - repositories: + arrayVal: + description: Value of the parameter if type is array. items: - $ref: '#/components/schemas/Repository' + type: string type: array - description: repositories ready to be created. + type: + description: Type of parameter. + enumDescriptions: + - Default enum type; should not be used. + - Default + - Array type + enum: + - TYPE_UNSPECIFIED + - STRING + - ARRAY + type: string + FetchReadTokenRequest: + properties: {} + id: FetchReadTokenRequest type: object - id: FetchLinkableRepositoriesResponse - description: Response message for FetchLinkableRepositories. - PipelineTask: + description: Message for fetching SCM read token. + Capabilities: properties: - retries: - format: int32 - type: integer - description: >- - Retries represents how many times this task should be retried in - case of task failure. - timeout: - description: >- - Time after which the TaskRun times out. Defaults to 1 hour. - Specified TaskRun timeout should be less than 24h. - type: string - format: google-duration - runAfter: - 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.) + drop: + description: Optional. Removed capabilities +optional type: array items: type: string - taskRef: - $ref: '#/components/schemas/TaskRef' - description: Reference to a specific instance of a task. - name: - type: string - description: Name of the task. - params: - items: - $ref: '#/components/schemas/Param' - type: array - description: Params is a list of parameter names and values. - workspaces: - description: >- - Workspaces maps workspaces from the pipeline spec to the workspaces - declared in the Task. - type: array - items: - $ref: '#/components/schemas/WorkspacePipelineTaskBinding' - taskSpec: - $ref: '#/components/schemas/EmbeddedTask' - description: Spec to instantiate this TaskRun. - whenExpressions: + add: type: array - description: Conditions that need to be true for the task to run. items: - $ref: '#/components/schemas/WhenExpression' - id: PipelineTask - description: PipelineTask defines a task in a Pipeline. - type: object - ParamSpec: + type: string + description: Optional. Added capabilities +optional + id: Capabilities type: object + description: >- + Capabilities adds and removes POSIX capabilities from running + containers. + PropertySpec: properties: - description: - type: string - description: Description of the ParamSpec - default: - $ref: '#/components/schemas/ParamValue' - description: The default value a parameter takes if no input value is supplied type: - type: string - enumDescriptions: - - Default enum type; should not be used. - - Default - - Arrary type. - description: Type of ParamSpec enum: - TYPE_UNSPECIFIED - STRING - - ARRAY - name: + enumDescriptions: + - Default enum type; should not be used. + - Default + description: A type for the object. type: string - description: Name of the ParamSpec - id: ParamSpec - description: >- - ParamSpec defines parameters needed beyond typed inputs (such as - resources). Parameter values are provided by users as inputs on a - TaskRun or PipelineRun. - HttpBody: + id: PropertySpec + description: PropertySpec holds information about a property in an object. type: object - id: 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. + Worker: + type: object + id: Worker + description: Configuration for the worker. properties: - data: - format: byte - type: string - description: The HTTP request/response body as raw binary. - extensions: - type: array - description: >- - 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 HTTP Content-Type header value specifying the content type of - the body. + machineType: type: string - Location: - id: Location + description: Optional. Machine type of a worker, default is "e2-standard-2". + Expr: properties: - labels: - type: object - description: >- - Cross-service attributes for the location. For example - {"cloud.googleapis.com/region": "us-east1"} - additionalProperties: - type: string - metadata: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object + title: description: >- - Service-specific metadata. For example the available capacity at the - given location. - displayName: + 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: type: string description: >- - The friendly name for this location, typically a nearby city name. - For example, "Tokyo". - name: + Textual representation of an expression in Common Expression + Language syntax. + location: type: string description: >- - Resource name for the location, which may vary between - implementations. For example: - `"projects/example-project/locations/us-east1"` - locationId: + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. + description: type: string - description: 'The canonical id for this location. For example: `"us-east1"`.' - description: A resource that represents a Google Cloud location. - type: object - BatchCreateRepositoriesRequest: - description: Message for creating repositoritories in batch. - properties: - requests: description: >- - Required. The request messages specifying the repositories to - create. - items: - $ref: '#/components/schemas/CreateRepositoryRequest' - type: array - type: object - id: BatchCreateRepositoriesRequest - Sidecar: + Optional. Description of the expression. This is a longer text which + describes the expression, e.g. when hovered over it in a UI. + id: Expr type: object - properties: - script: - description: The contents of an executable file to execute. - type: string - workingDir: - description: Container's working directory. - type: string - volumeMounts: - type: array - items: - $ref: '#/components/schemas/VolumeMount' - description: Pod volumes to mount into the container's filesystem. - securityContext: - $ref: '#/components/schemas/SecurityContext' - description: Optional. Security options the container should be run with. - command: - items: - type: string - description: Entrypoint array. - type: array - name: - type: string - description: Name of the Sidecar. - args: - type: array - description: Arguments to the entrypoint. - items: - type: string - image: - description: Docker image name. - type: string - readinessProbe: - 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 - $ref: '#/components/schemas/Probe' - env: - description: List of environment variables to set in the container. - type: array - items: - $ref: '#/components/schemas/EnvVar' - id: Sidecar - description: Sidecars run alongside the Task's step containers. - 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/). - 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: - 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' - 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 - auditConfigs: - items: - $ref: '#/components/schemas/AuditConfig' - type: array - description: Specifies cloud audit logging configuration for this policy. - type: object - TestIamPermissionsRequest: - description: Request message for `TestIamPermissions` method. - type: object - id: 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). - GoogleDevtoolsCloudbuildV2Condition: + 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. + GoogleDevtoolsCloudbuildV2OperationMetadata: + description: Represents the metadata of the long-running operation. type: object - id: GoogleDevtoolsCloudbuildV2Condition - description: Conditions defines a readiness condition for a Knative resource. - properties: - 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 - type: - type: string - description: Type of condition. - status: - enum: - - UNKNOWN - - 'TRUE' - - 'FALSE' - enumDescriptions: - - Default enum type indicating execution is still ongoing. - - Success - - Failure - description: Status of the condition. - type: string - severity: - enum: - - SEVERITY_UNSPECIFIED - - WARNING - - INFO - 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. - type: string - reason: - type: string - description: The reason for the condition's last transition. - TaskResult: + id: GoogleDevtoolsCloudbuildV2OperationMetadata properties: - type: - type: string - enumDescriptions: - - Default enum type; should not be used. - - Default - - Array type - - Object type - enum: - - TYPE_UNSPECIFIED - - STRING - - ARRAY - - OBJECT - description: The type of data that the result holds. - name: - type: string - description: Name of the result. - 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 - properties: - additionalProperties: - $ref: '#/components/schemas/PropertySpec' + requestedCancellation: 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: object - description: TaskResult is used to describe the results of a task. - type: object - id: TaskResult - OperationMetadata: - type: object - properties: - apiVersion: - description: Output only. API version used to start the operation. - type: string + 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 readOnly: true endTime: format: google-datetime type: string readOnly: true description: Output only. The time the operation finished running. - statusDetail: + statusMessage: type: string - readOnly: true description: Output only. Human-readable status of the operation, if any. - createTime: - type: string - format: google-datetime readOnly: true - description: Output only. The time the operation was created. target: - readOnly: true description: >- Output only. Server-defined resource path for the target of the operation. + readOnly: true type: string verb: type: string readOnly: true description: Output only. Name of the verb executed by the operation. - cancelRequested: - type: boolean - readOnly: true - 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`. - id: OperationMetadata - description: Represents the metadata of the long-running operation. - OAuthCredential: - description: >- - Represents an OAuth token of the account that authorized the Connection, - and associated metadata. - properties: - oauthTokenSecretVersion: - type: string - description: >- - Optional. A SecretManager resource containing the OAuth token that - authorizes the Cloud Build connection. Format: - `projects/*/secrets/*/versions/*`. - username: - type: string - description: Output only. The username associated to this token. + apiVersion: readOnly: true - type: object - id: OAuthCredential - FetchReadTokenResponse: - id: FetchReadTokenResponse - properties: - expirationTime: type: string - description: Expiration timestamp. Can be empty if unknown or non-expiring. + description: Output only. API version used to start the operation. + createTime: format: google-datetime - token: - description: The token content. + readOnly: true type: string - type: object - description: Message for responding to get read token. - ResultValue: - id: ResultValue - description: ResultValue holds different types of data for a single result. + description: Output only. The time the operation was created. + PipelineSpec: + id: PipelineSpec properties: - type: - enum: - - TYPE_UNSPECIFIED - - STRING - - ARRAY - - OBJECT - enumDescriptions: - - Default enum type; should not be used. - - Default - - Array type - - Object type - type: string + tasks: + type: array + description: List of Tasks that execute when this Pipeline is run. + items: + $ref: '#/components/schemas/PipelineTask' + params: + description: List of parameters. + type: array + items: + $ref: '#/components/schemas/ParamSpec' + results: + description: >- + Optional. Output only. List of results written out by the pipeline's + containers + type: array + items: + $ref: '#/components/schemas/PipelineResult' readOnly: true - description: Output only. The type of data that the result holds. - arrayVal: - description: Value of the result if type is array. + finallyTasks: + 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. items: - type: string + $ref: '#/components/schemas/PipelineTask' type: array - stringVal: + generatedYaml: + 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 type: string - description: Value of the result if type is string. - objectVal: - additionalProperties: - type: string - description: Value of the result if type is object. - type: object + workspaces: + description: >- + Workspaces declares a set of named workspaces that are expected to + be provided by a PipelineRun. + type: array + items: + $ref: '#/components/schemas/PipelineWorkspaceDeclaration' type: object - ParamValue: + description: PipelineSpec defines the desired state of Pipeline. + TaskRef: + type: object + id: TaskRef properties: - stringVal: - type: string - description: Value of the parameter if type is string. - arrayVal: - description: Value of the parameter if type is array. + params: 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. items: - type: string - type: - description: Type of parameter. + $ref: '#/components/schemas/Param' + resolver: enum: - - TYPE_UNSPECIFIED - - STRING - - ARRAY + - RESOLVER_NAME_UNSPECIFIED + - BUNDLES + - GCB_REPO + - GIT + - DEVELOPER_CONNECT enumDescriptions: - Default enum type; should not be used. - - Default - - Array type + - >- + 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. type: string - description: Parameter value. - type: object - id: ParamValue - FetchReadTokenRequest: - id: FetchReadTokenRequest - description: Message for fetching SCM read token. - properties: {} + description: >- + Resolver is the name of the resolver that should perform resolution + of the referenced Tekton resource. + name: + description: Name of the task. + type: string + deprecated: true + 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. + GitHubConfig: + properties: + appInstallationId: + format: int64 + type: string + description: Optional. GitHub App installation id. + authorizerCredential: + $ref: '#/components/schemas/OAuthCredential' + 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. + description: Configuration for connections to github.com. type: object - VolumeSource: - id: VolumeSource + id: GitHubConfig + BatchCreateRepositoriesRequest: type: object - description: Volumes available to mount. properties: - name: - type: string + requests: + type: array 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 - emptyDir: - $ref: '#/components/schemas/EmptyDirVolumeSource' - description: A temporary directory that shares a pod's lifetime. - Provenance: - description: Provenance configuration. + Required. The request messages specifying the repositories to + create. + items: + $ref: '#/components/schemas/CreateRepositoryRequest' + description: Message for creating repositoritories in batch. + id: BatchCreateRepositoriesRequest + GoogleDevtoolsCloudbuildV2GitLabConfig: type: object - id: Provenance + description: >- + Configuration for connections to gitlab.com or an instance of GitLab + Enterprise. + id: GoogleDevtoolsCloudbuildV2GitLabConfig properties: - 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. + sslCa: type: string - storage: - 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. + description: Optional. SSL certificate to use for requests to GitLab Enterprise. + 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 + hostUri: type: string - region: - description: Optional. Provenance region. - enum: - - REGION_UNSPECIFIED - - GLOBAL + description: >- + Optional. The URI of the GitLab Enterprise host this connection is + for. If not specified, the default value is https://gitlab.com. + readAuthorizerCredential: + $ref: '#/components/schemas/UserCredential' + description: >- + Required. A GitLab personal access token with the minimum `read_api` + scope access. + webhookSecretSecretVersion: + description: >- + Required. Immutable. SecretManager resource containing the webhook + secret of a GitLab Enterprise project, formatted as + `projects/*/secrets/*/versions/*`. + type: string + authorizerCredential: + description: >- + Required. A GitLab personal access token with the `api` scope + access. + $ref: '#/components/schemas/UserCredential' + serverVersion: + readOnly: true + description: >- + Output only. Version of the GitLab Enterprise server running on the + `host_uri`. + type: string + Operation: + properties: + 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. + 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: >- + 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: + 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. + type: object + id: Operation + description: >- + This resource represents a long-running operation that is the result of + a network API call. + GoogleDevtoolsCloudbuildV2Condition: + type: object + description: Conditions defines a readiness condition for a Knative resource. + id: GoogleDevtoolsCloudbuildV2Condition + properties: + type: + description: Type of condition. + type: string + message: + type: string + description: A human readable message indicating details about the transition. + status: + enumDescriptions: + - Default enum type indicating execution is still ongoing. + - Success + - Failure + type: string + enum: + - UNKNOWN + - 'TRUE' + - 'FALSE' + description: Status of the condition. + lastTransitionTime: + description: >- + LastTransitionTime is the last time the condition transitioned from + one status to another. + type: string + format: google-datetime + severity: + type: string + description: Severity with which to treat failures of this type of condition. + enum: + - SEVERITY_UNSPECIFIED + - WARNING + - INFO + enumDescriptions: + - Default enum type; should not be used. + - Severity is warning. + - Severity is informational only. + reason: + description: The reason for the condition's last transition. + type: string + TestIamPermissionsRequest: + type: object + 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). + items: + type: string + description: Request message for `TestIamPermissions` method. + id: TestIamPermissionsRequest + StepRef: + properties: + name: + description: Optional. Name of the step. + type: string + params: + description: Optional. Parameters used to control the resolution. + type: array + items: + $ref: '#/components/schemas/Param' + resolver: + description: Optional. Type of the resolver. + enum: + - RESOLVER_NAME_UNSPECIFIED + - BUNDLES + - GCB_REPO + - GIT + - DEVELOPER_CONNECT + 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. + id: StepRef + description: A reference to a remote Step, i.e. a StepAction. + type: object + WorkspaceDeclaration: + type: object + properties: + mountPath: + type: string + description: >- + MountPath overrides the directory that the volume will be made + available at. + optional: + description: >- + Optional. Optional marks a Workspace as not being required in + TaskRuns. By default this field is false and so declared workspaces + are required. + type: boolean + name: + description: Name is the name by which you can bind the volume at runtime. + type: string + readOnly: + type: boolean + description: ReadOnly dictates whether a mounted volume is writable. + description: + description: Description is a human readable description of this volume. + type: string + id: WorkspaceDeclaration + description: WorkspaceDeclaration is a declaration of a volume that a Task requires. + Binding: + id: Binding + 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: + 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: + $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). + type: object + description: Associates `members`, or principals, with a `role`. + GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig: + type: object + id: GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig + description: >- + ServiceDirectoryConfig represents Service Directory configuration for a + connection. + properties: + service: + description: >- + Required. The Service Directory service name. Format: + projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. + type: string + PipelineWorkspaceDeclaration: + type: object + description: >- + Workspaces declares a set of named workspaces that are expected to be + provided by a PipelineRun. + 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 + id: PipelineWorkspaceDeclaration + InstallationState: + id: InstallationState + properties: + stage: type: string + readOnly: true enumDescriptions: + - No stage specified. - >- - 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. - Empty: - id: Empty + 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. + description: Output only. Current step of the installation process. + enum: + - STAGE_UNSPECIFIED + - PENDING_CREATE_APP + - PENDING_USER_OAUTH + - PENDING_INSTALL_APP + - COMPLETE + message: + 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 + readOnly: true + actionUri: + description: >- + Output only. Link to follow for next action. Empty string if the + installation is already complete. + type: string + readOnly: true 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: {} + Describes stage and necessary actions to be taken by the user to + complete the installation. Used for GitHub and GitHub Enterprise based + connections. + type: object + SetIamPolicyRequest: + description: Request message for `SetIamPolicy` method. type: object - TaskSpec: properties: - stepTemplate: - $ref: '#/components/schemas/StepTemplate' + policy: 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. - managedSidecars: + 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 + format: google-fieldmask description: >- - Sidecars that run alongside the Task’s step containers that should - be added to this Task. - type: array - items: - type: string - enum: - - MANAGED_SIDECAR_UNSPECIFIED - - PRIVILEGED_DOCKER_DAEMON - enumDescriptions: - - Default enum type; should not be used. - - Sidecar for a privileged docker daemon. + 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"` + id: SetIamPolicyRequest + PipelineTask: + id: PipelineTask + properties: + name: + description: Name of the task. + type: string + taskSpec: + description: Spec to instantiate this TaskRun. + $ref: '#/components/schemas/EmbeddedTask' workspaces: - description: The volumes that this Task requires. - items: - $ref: '#/components/schemas/WorkspaceDeclaration' - type: array - results: - description: Values that this Task can output. items: - $ref: '#/components/schemas/TaskResult' - type: array - description: - type: string - description: Description of the task. - sidecars: + $ref: '#/components/schemas/WorkspacePipelineTaskBinding' type: array - description: Sidecars that run alongside the Task's step containers. - items: - $ref: '#/components/schemas/Sidecar' + description: >- + Workspaces maps workspaces from the pipeline spec to the workspaces + declared in the Task. + retries: + format: int32 + description: >- + Retries represents how many times this task should be retried in + case of task failure. + type: integer params: - items: - $ref: '#/components/schemas/ParamSpec' - description: List of parameters. - type: array - steps: type: array items: - $ref: '#/components/schemas/Step' - description: Steps of the task. - volumes: + $ref: '#/components/schemas/Param' + description: Params is a list of parameter names and values. + 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: - $ref: '#/components/schemas/VolumeSource' + type: string + taskRef: + $ref: '#/components/schemas/TaskRef' + description: Reference to a specific instance of a task. + whenExpressions: + description: Conditions that need to be true for the task to run. type: array - description: A collection of volumes that are available to mount into steps. + items: + $ref: '#/components/schemas/WhenExpression' + timeout: + type: string + format: google-duration + description: >- + Time after which the TaskRun times out. Defaults to 1 hour. + Specified TaskRun timeout should be less than 24h. + description: PipelineTask defines a task in a Pipeline. type: object - id: TaskSpec - description: TaskSpec contains the Spec to instantiate a TaskRun. - PipelineResult: - description: A value produced by a Pipeline. + AuditLogConfig: type: object + id: AuditLogConfig properties: - description: - description: Output only. Description of the result. + logType: + description: The log type that this config enables. + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + enumDescriptions: + - Default case. Should never be this. + - 'Admin reads. Example: CloudIAM getIamPolicy' + - 'Data writes. Example: CloudSQL Users create' + - 'Data reads. Example: CloudSQL Users list' + type: string + 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 + 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. + PipelineRun: + properties: + etag: + type: string + description: Needed for declarative-friendly resources. + pipelineSpecYaml: type: string readOnly: true - type: + description: >- + Output only. Inline pipelineSpec yaml string, used by workflow run + requests. + skippedTasks: readOnly: true - enum: - - TYPE_UNSPECIFIED - - STRING - - ARRAY - - OBJECT - description: Output only. The type of data that the result holds. + type: array + description: >- + Output only. List of tasks that were skipped due to when expressions + evaluating to false. + items: + $ref: '#/components/schemas/SkippedTask' + worker: + description: Optional. Worker configuration. + $ref: '#/components/schemas/Worker' + workerPool: type: string + description: Output only. The WorkerPool used to run this PipelineRun. + readOnly: true + completionTime: + description: Output only. Time the pipeline completed. + type: string + format: google-datetime + readOnly: true + pipelineRunStatus: + description: Pipelinerun status the user can provide. Used for cancellation. + enum: + - PIPELINE_RUN_STATUS_UNSPECIFIED + - PIPELINE_RUN_CANCELLED enumDescriptions: - Default enum type; should not be used. - - Default - - Array type - - Object type + - Cancelled status. + type: string + 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: + readOnly: true + description: Output only. The exact PipelineSpec used to instantiate the run. + $ref: '#/components/schemas/PipelineSpec' + workspaces: + items: + $ref: '#/components/schemas/WorkspaceBinding' + type: array + description: >- + Workspaces is a list of WorkspaceBindings from volumes to + workspaces. + security: + $ref: '#/components/schemas/Security' + description: Optional. Security configuration. + workflow: + description: Output only. The Workflow used to create this PipelineRun. + type: string + readOnly: true + childReferences: + type: array + description: >- + Output only. List of TaskRun and Run names and PipelineTask names + for children of this PipelineRun. + readOnly: true + items: + $ref: '#/components/schemas/ChildStatusReference' name: - description: Output only. Name of the result. + type: string + description: >- + Output only. The `PipelineRun` name with format + `projects/{project}/locations/{location}/pipelineRuns/{pipeline_run}` readOnly: true + finallyStartTime: + description: >- + Output only. FinallyStartTime is when all non-finally tasks have + been completed and only finally tasks are being executed. +optional type: string - value: - description: Output only. Value of the result. - $ref: '#/components/schemas/ResultValue' + format: google-datetime + readOnly: true + pipelineRef: + description: PipelineRef refer to a specific instance of a Pipeline. + $ref: '#/components/schemas/PipelineRef' + pipelineSpec: + $ref: '#/components/schemas/PipelineSpec' + description: PipelineSpec defines the desired state of Pipeline. + conditions: readOnly: true - id: PipelineResult - StepTemplate: - 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. - properties: - volumeMounts: - description: Optional. Pod volumes to mount into the container's filesystem. - type: array - items: - $ref: '#/components/schemas/VolumeMount' - env: type: array description: >- - Optional. List of environment variables to set in the Step. Cannot - be updated. + Output only. Kubernetes Conditions convention for PipelineRun status + and error. items: - $ref: '#/components/schemas/EnvVar' - id: StepTemplate - Security: - type: object - properties: - serviceAccount: - type: string - description: IAM service account whose credentials will be used at runtime. - privilegeMode: - description: Optional. Privilege mode. - enumDescriptions: - - Default to PRIVILEGED. - - Privileged mode. - - Unprivileged mode. - enum: - - PRIVILEGE_MODE_UNSPECIFIED - - PRIVILEGED - - UNPRIVILEGED + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV2Condition' + gcbParams: + type: object + readOnly: true + additionalProperties: + type: string + description: Output only. GCB default params. + provenance: + $ref: '#/components/schemas/Provenance' + description: Optional. Provenance configuration. + startTime: type: string - id: Security - description: Security configuration. - Param: - description: >- - Param defined with name and value. PipelineRef can be used to refer to a - specific instance of a Pipeline. - type: object - properties: - name: + readOnly: true + format: google-datetime + description: Output only. Time the pipeline is actually started. + createTime: + readOnly: true + format: google-datetime type: string - description: Name of the parameter. - value: - description: Value of the parameter. - $ref: '#/components/schemas/ParamValue' - id: Param - WorkspaceDeclaration: - id: WorkspaceDeclaration - properties: - optional: description: >- - Optional. Optional marks a Workspace as not being required in - TaskRuns. By default this field is false and so declared workspaces - are required. - type: boolean - description: - description: Description is a human readable description of this volume. - type: string - mountPath: - type: string + Output only. Time at which the request to create the `PipelineRun` + was received. + updateTime: description: >- - MountPath overrides the directory that the volume will be made - available at. - readOnly: - description: ReadOnly dictates whether a mounted volume is writable. - type: boolean - name: - description: Name is the name by which you can bind the volume at runtime. + Output only. Time at which the request to update the `PipelineRun` + was received. type: string - type: object - description: WorkspaceDeclaration is a declaration of a volume that a Task requires. - ListConnectionsResponse: - properties: - nextPageToken: + format: google-datetime + readOnly: true + serviceAccount: type: string - description: A token identifying a page of results the server should return. - connections: + description: >- + Service account used in the Pipeline. Deprecated; please use + security.service_account instead. + deprecated: true + results: + readOnly: true + description: >- + Optional. Output only. List of results written out by the pipeline's + containers type: array items: - $ref: '#/components/schemas/Connection' - description: The list of Connections. - id: ListConnectionsResponse + $ref: '#/components/schemas/PipelineRunResult' + params: + description: Params is a list of parameter names and values. + items: + $ref: '#/components/schemas/Param' + type: array + annotations: + additionalProperties: + type: string + description: User annotations. See https://google.aip.dev/128#annotations + type: object + uid: + readOnly: true + type: string + description: Output only. A unique identifier for the `PipelineRun`. + record: + readOnly: true + type: string + description: >- + Output only. The `Record` of this `PipelineRun`. Format: + `projects/{project}/locations/{location}/results/{result_id}/records/{record_id}` + description: Message describing PipelineRun object type: object - description: Message for response to listing Connections. - PipelineWorkspaceDeclaration: - description: >- - Workspaces declares a set of named workspaces that are expected to be - provided by a PipelineRun. + id: PipelineRun + Connection: + id: Connection type: object properties: - description: + disabled: + type: boolean description: >- - Description is a human readable string describing how the workspace - will be used in the Pipeline. - type: string + 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. + bitbucketCloudConfig: + $ref: '#/components/schemas/BitbucketCloudConfig' + description: Configuration for connections to Bitbucket Cloud. + reconciling: + readOnly: true + description: >- + Output only. Set to true when the connection is being set up or + updated in the background. + type: boolean + githubConfig: + description: Configuration for connections to github.com. + $ref: '#/components/schemas/GitHubConfig' name: - description: Name is the name of a workspace to be provided by a PipelineRun. + description: >- + Immutable. The resource name of the connection, in the format + `projects/{project}/locations/{location}/connections/{connection_id}`. type: string - optional: - type: boolean + gitlabConfig: + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV2GitLabConfig' description: >- - Optional marks a Workspace as not being required in PipelineRuns. By - default this field is false and so declared workspaces are required. - id: PipelineWorkspaceDeclaration - TestIamPermissionsResponse: - id: TestIamPermissionsResponse - type: object - properties: - permissions: - items: + Configuration for connections to gitlab.com or an instance of GitLab + Enterprise. + githubEnterpriseConfig: + description: Configuration for connections to an instance of GitHub Enterprise. + $ref: >- + #/components/schemas/GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig + installationState: + description: Output only. Installation state of the Connection. + $ref: '#/components/schemas/InstallationState' + readOnly: true + bitbucketDataCenterConfig: + description: Configuration for connections to Bitbucket Data Center. + $ref: '#/components/schemas/BitbucketDataCenterConfig' + annotations: + description: Optional. Allows clients to store small amounts of arbitrary data. + additionalProperties: type: string + type: object + updateTime: + format: google-datetime + readOnly: true description: >- - A subset of `TestPermissionsRequest.permissions` that the caller is - allowed. - type: array - description: Response message for `TestIamPermissions` method. - SetIamPolicyRequest: - type: object - description: Request message for `SetIamPolicy` method. - properties: - 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 + Output only. Server assigned timestamp for when the connection was + updated. type: string - policy: + createTime: + readOnly: true 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' - id: SetIamPolicyRequest - EnvVar: - description: Environment variable. - properties: - name: - description: Name of the environment variable. + Output only. Server assigned timestamp for when the connection was + created. + format: google-datetime type: string - value: + 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 - description: Value of the environment variable. - type: object - id: EnvVar - CancelOperationRequest: - id: CancelOperationRequest - type: object - description: The request message for Operations.CancelOperation. - properties: {} - TaskRef: - type: object 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. + A connection to a SCM like GitHub, GitHub Enterprise, Bitbucket Data + Center, Bitbucket Cloud or GitLab. + FetchGitRefsResponse: + description: Response for fetching git refs + type: object + id: FetchGitRefsResponse properties: - resolver: - 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 - 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. - params: - 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. + refNames: items: - $ref: '#/components/schemas/Param' + type: string type: array - name: + description: Name of the refs fetched. + nextPageToken: type: string - description: Name of the task. - deprecated: true - id: TaskRef - StepRef: - id: StepRef - description: A reference to a remote Step, i.e. a StepAction. + description: A token identifying a page of results the server should return. + TimeoutFields: + id: TimeoutFields + type: object + properties: + tasks: + type: string + description: Tasks sets the maximum allowed duration of this pipeline's tasks + format: google-duration + finally: + format: google-duration + description: Finally sets the maximum allowed duration of this pipeline's finally + type: string + pipeline: + 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 + description: >- + TimeoutFields allows granular specification of pipeline, task, and + finally timeouts + PipelineResult: type: object + description: A value produced by a Pipeline. properties: name: - description: Optional. Name of the step. + description: Output only. Name of the result. + readOnly: true type: string - params: - type: array - description: Optional. Parameters used to control the resolution. - items: - $ref: '#/components/schemas/Param' - resolver: + value: + readOnly: true + $ref: '#/components/schemas/ResultValue' + description: Output only. Value of the result. + type: + readOnly: true enum: - - RESOLVER_NAME_UNSPECIFIED - - BUNDLES - - GCB_REPO - - GIT - - DEVELOPER_CONNECT - description: Optional. Type of the resolver. + - TYPE_UNSPECIFIED + - STRING + - ARRAY + - OBJECT 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 + - Array type + - Object type type: string - Operation: + description: Output only. The type of data that the result holds. + description: + description: Output only. Description of the result. + readOnly: true + type: string + id: PipelineResult + UserCredential: description: >- - This resource represents a long-running operation that is the result of - a network API call. + Represents a personal access token that authorized the Connection, and + associated metadata. + id: UserCredential + type: object 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`. - done: - type: boolean + username: + readOnly: true + description: Output only. The username associated to this token. + type: string + userTokenSecretVersion: 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: + Required. A SecretManager resource containing the user token that + authorizes the Cloud Build connection. Format: + `projects/*/secrets/*/versions/*`. + type: string + ChildStatusReference: + id: ChildStatusReference + description: >- + ChildStatusReference is used to point to the statuses of individual + TaskRuns and Runs within this PipelineRun. + properties: + pipelineTaskName: + 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. - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any + PipelineTaskName is the name of the PipelineTask this is + referencing. name: type: string + description: Name is the name of the TaskRun or Run this is referencing. + whenExpressions: 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/Status' - description: >- - The error result of the operation in case of failure or - cancellation. - id: Operation + WhenExpressions is the list of checks guarding the execution of the + PipelineTask + type: array + items: + $ref: '#/components/schemas/WhenExpression' + type: + readOnly: true + enum: + - TYPE_UNSPECIFIED + - TASK_RUN + type: string + description: Output only. Type of the child reference. + enumDescriptions: + - Default enum type; should not be used. + - TaskRun. type: object - AuditConfig: + EnvVar: type: object + id: EnvVar properties: - auditLogConfigs: - type: array - items: - $ref: '#/components/schemas/AuditLogConfig' - 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. + value: 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. - id: AuditConfig - GoogleDevtoolsCloudbuildV2GitLabConfig: - id: GoogleDevtoolsCloudbuildV2GitLabConfig + description: Value of the environment variable. + name: + type: string + description: Name of the environment variable. + description: Environment variable. + RunWorkflowCustomOperationMetadata: + id: RunWorkflowCustomOperationMetadata properties: - serverVersion: + verb: readOnly: true type: string - description: >- - Output only. Version of the GitLab Enterprise server running on the - `host_uri`. - 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 - sslCa: - description: Optional. SSL certificate to use for requests to GitLab Enterprise. + description: Output only. Name of the verb executed by the operation. + apiVersion: type: string - readAuthorizerCredential: - $ref: '#/components/schemas/UserCredential' - description: >- - Required. A GitLab personal access token with the minimum `read_api` - scope access. - webhookSecretSecretVersion: + readOnly: true + description: Output only. API version used to start the operation. + target: + readOnly: true type: string description: >- - Required. Immutable. SecretManager resource containing the webhook - secret of a GitLab Enterprise project, formatted as - `projects/*/secrets/*/versions/*`. - hostUri: + Output only. Server-defined resource path for the target of the + operation. + createTime: + readOnly: true + description: Output only. The time the operation was created. type: string + format: google-datetime + pipelineRunId: + readOnly: true + type: string + description: Output only. ID of the pipeline run created by RunWorkflow. + requestedCancellation: description: >- - Optional. The URI of the GitLab Enterprise host this connection is - for. If not specified, the default value is https://gitlab.com. - authorizerCredential: - $ref: '#/components/schemas/UserCredential' - description: >- - Required. A GitLab personal access token with the `api` scope - access. - type: object + 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 + endTime: + readOnly: true + type: string + format: google-datetime + description: Output only. The time the operation finished running. description: >- - Configuration for connections to gitlab.com or an instance of GitLab - Enterprise. - EmbeddedTask: - properties: - taskSpec: - description: Spec to instantiate this TaskRun. - $ref: '#/components/schemas/TaskSpec' - annotations: - type: object - description: User annotations. See https://google.aip.dev/128#annotations - additionalProperties: - type: string + Represents the custom metadata of the RunWorkflow long-running + operation. type: object - description: EmbeddedTask defines a Task that is embedded in a Pipeline. - id: EmbeddedTask - Worker: - description: Configuration for the worker. + HttpBody: + id: 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: Worker properties: - machineType: - description: Optional. Machine type of a worker, default is "e2-standard-2". + contentType: type: string - BitbucketCloudConfig: + description: >- + The HTTP Content-Type header value specifying the content type of + the body. + extensions: + 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 + type: array + data: + description: The HTTP request/response body as raw binary. + format: byte + type: string + VolumeSource: type: object + id: VolumeSource + description: Volumes available to mount. properties: - workspace: - type: string - description: >- - Required. The Bitbucket Cloud Workspace ID to be connected to Google - Cloud Platform. - webhookSecretSecretVersion: + name: 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. - 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' - description: Configuration for connections to Bitbucket Cloud. - id: BitbucketCloudConfig + 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 + emptyDir: + $ref: '#/components/schemas/EmptyDirVolumeSource' + description: A temporary directory that shares a pod's lifetime. BitbucketDataCenterConfig: properties: - webhookSecretSecretVersion: - description: >- - Required. Immutable. SecretManager resource containing the webhook - secret used to verify webhook events, formatted as - `projects/*/secrets/*/versions/*`. - type: string - readAuthorizerCredential: - $ref: '#/components/schemas/UserCredential' - description: Required. A http access token with the `REPO_READ` access. sslCa: - type: string description: >- Optional. SSL certificate to use for requests to the Bitbucket Data Center. - authorizerCredential: - $ref: '#/components/schemas/UserCredential' - description: Required. A http access token with the `REPO_ADMIN` scope access. + type: string + hostUri: + type: string + description: >- + Required. The URI of the Bitbucket Data Center instance or cluster + this connection is for. serviceDirectoryConfig: description: >- Optional. Configuration for using Service Directory to privately @@ -2172,293 +2171,300 @@ components: Data Center will be made over the public internet. $ref: >- #/components/schemas/GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig - serverVersion: + readAuthorizerCredential: + description: Required. A http access token with the `REPO_READ` access. + $ref: '#/components/schemas/UserCredential' + webhookSecretSecretVersion: + type: string description: >- - Output only. Version of the Bitbucket Data Center running on the - `host_uri`. + Required. Immutable. SecretManager resource containing the webhook + secret used to verify webhook events, formatted as + `projects/*/secrets/*/versions/*`. + serverVersion: readOnly: true type: string - hostUri: - type: string description: >- - Required. The URI of the Bitbucket Data Center instance or cluster - this connection is for. - type: object + Output only. Version of the Bitbucket Data Center running on the + `host_uri`. + authorizerCredential: + description: Required. A http access token with the `REPO_ADMIN` scope access. + $ref: '#/components/schemas/UserCredential' description: Configuration for connections to Bitbucket Data Center. - id: BitbucketDataCenterConfig - TimeoutFields: - id: TimeoutFields type: object - description: >- - TimeoutFields allows granular specification of pipeline, task, and - finally timeouts + id: BitbucketDataCenterConfig + ResultValue: properties: - finally: - type: string - 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 + objectVal: + description: Value of the result if type is object. + additionalProperties: + type: string + type: object + stringVal: + description: Value of the result if type is string. type: string - pipeline: - format: google-duration + type: + description: Output only. The type of data that the result holds. + enumDescriptions: + - Default enum type; should not be used. + - Default + - Array type + - Object type + readOnly: true + enum: + - TYPE_UNSPECIFIED + - STRING + - ARRAY + - OBJECT 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. - Expr: + arrayVal: + type: array + description: Value of the result if type is array. + items: + type: string + description: ResultValue holds different types of data for a single result. + id: ResultValue + type: object + GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig: type: object 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. + appSlug: + type: string + description: Optional. The URL-friendly name of the GitHub App. + hostUri: 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: + Required. The URI of the GitHub Enterprise host this connection is + for. + serviceDirectoryConfig: + $ref: >- + #/components/schemas/GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. + 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. + serverVersion: type: string - expression: - description: >- - Textual representation of an expression in Common Expression - Language syntax. + readOnly: true + description: Output only. GitHub Enterprise version installed at the host_uri. + apiKey: + description: Required. API Key used for authentication of webhook events. 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. - id: Expr - SecretVolumeSource: - type: object - properties: - secretName: - description: Name of the secret referenced by the WorkspaceBinding. + appInstallationId: + format: int64 type: string - secretVersion: + description: Optional. ID of the installation of the GitHub App. + privateKeySecretVersion: type: string - readOnly: true description: >- - Output only. Resource name of the SecretVersion. In format: - projects/*/secrets/*/versions/* - description: Secret Volume Source. - id: SecretVolumeSource - SkippedTask: - type: object - id: SkippedTask - properties: - reason: - description: Output only. Reason is the cause of the PipelineTask being skipped. - readOnly: true + Optional. SecretManager resource containing the private key of the + GitHub App, formatted as `projects/*/secrets/*/versions/*`. + appId: + format: int64 + description: Optional. Id of the GitHub App created from the manifest. + type: string + sslCa: + type: string + description: Optional. SSL certificate to use for requests to GitHub Enterprise. + webhookSecretSecretVersion: type: string - whenExpressions: - items: - $ref: '#/components/schemas/WhenExpression' description: >- - WhenExpressions is the list of checks guarding the execution of the - PipelineTask + Optional. SecretManager resource containing the webhook secret of + the GitHub App, formatted as `projects/*/secrets/*/versions/*`. + id: GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig + description: Configuration for connections to an instance of GitHub Enterprise. + TestIamPermissionsResponse: + id: TestIamPermissionsResponse + description: Response message for `TestIamPermissions` method. + properties: + permissions: type: array - name: - type: string - description: Name is the Pipeline Task name + description: >- + A subset of `TestPermissionsRequest.permissions` that the caller is + allowed. + items: + type: string + type: object + EmptyDirVolumeSource: + id: EmptyDirVolumeSource + description: Represents an empty Volume source. + properties: {} + type: object + WorkspaceBinding: + id: WorkspaceBinding description: >- - SkippedTask is used to describe the Tasks that were skipped due to their - When Expressions evaluating to False. - InstallationState: + WorkspaceBinding maps a workspace to a Volume. PipelineRef can be used + to refer to a specific instance of a Pipeline. + type: object properties: - stage: + name: + description: Name of the workspace. type: string - readOnly: true - enum: - - STAGE_UNSPECIFIED - - PENDING_CREATE_APP - - PENDING_USER_OAUTH - - PENDING_INSTALL_APP - - COMPLETE - 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. - description: Output only. Current step of the installation process. - actionUri: - description: >- - Output only. Link to follow for next action. Empty string if the - installation is already complete. - readOnly: true + secret: + $ref: '#/components/schemas/SecretVolumeSource' + description: Secret Volume Source. + subPath: type: string - message: 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 - type: string - 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. + 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 + CancelOperationRequest: + description: The request message for Operations.CancelOperation. + properties: {} + id: CancelOperationRequest + type: object + Location: type: object - SecurityContext: properties: - 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 - privileged: - type: boolean - description: Run container in privileged mode. - 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 - runAsUser: + labels: 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 + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + type: object + additionalProperties: + type: string + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' type: string - format: int64 - runAsGroup: - format: int64 + metadata: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + description: >- + Service-specific metadata. For example the available capacity at the + given location. + type: object + displayName: type: string 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 - capabilities: - $ref: '#/components/schemas/Capabilities' + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + name: description: >- - Optional. Adds and removes POSIX capabilities from running - containers. - id: SecurityContext - description: Security options the container should be run with. - type: object - UserCredential: - id: UserCredential + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + type: string + description: A resource that represents a Google Cloud location. + id: Location + ExecAction: properties: - userTokenSecretVersion: + command: + type: array description: >- - Required. A SecretManager resource containing the user token that - authorizes the Cloud Build connection. Format: - `projects/*/secrets/*/versions/*`. - type: string - username: - readOnly: true - description: Output only. The username associated to this token. - type: string + 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 + items: + type: string + id: ExecAction + description: ExecAction describes a "run in container" action. + type: object + Step: + id: Step type: object description: >- - Represents a personal access token that authorized the Connection, and - associated metadata. - AuditLogConfig: + Step embeds the Container type, which allows it to include fields not + provided by Container. 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. - enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ + workingDir: type: string - exemptedMembers: + description: Container's working directory. + env: + type: array + items: + $ref: '#/components/schemas/EnvVar' + description: List of environment variables to set in the container. + command: type: array + description: Entrypoint array. items: type: string + securityContext: + $ref: '#/components/schemas/SecurityContext' description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. - 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 + 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: + $ref: '#/components/schemas/StepRef' + description: Optional. Optional reference to a remote StepAction. + image: + description: Docker image name. + type: string + params: + items: + $ref: '#/components/schemas/Param' + type: array + description: Optional. Optional parameters passed to the StepAction. + script: + type: string + description: The contents of an executable file to execute. + name: + type: string + description: Name of the container specified as a DNS_LABEL. + args: + type: array + items: + type: string + description: Arguments to the entrypoint. + volumeMounts: + type: array + description: Pod volumes to mount into the container's filesystem. + items: + $ref: '#/components/schemas/VolumeMount' + timeout: + type: string + description: Time after which the Step times out. Defaults to never. + format: google-duration parameters: - 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 - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean + 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"). + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: upload_protocol + name: oauth_token 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 + callback: + description: JSONP + in: query + name: callback + schema: + type: string alt: description: Data format for response. in: query @@ -2469,15 +2475,6 @@ components: - json - media - proto - _.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 @@ -2487,16 +2484,19 @@ components: name: quotaUser 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 - 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 uploadType: @@ -2506,59 +2506,125 @@ components: schema: type: string x-stackQL-resources: - locations: - id: cloudbuild.locations - name: locations - title: Locations + operations: + id: google.cloudbuild.operations + name: operations + title: Operations methods: - _projects_locations_list: - operation: &ref_1 - $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations/get' - response: &ref_2 + projects_locations_operations_cancel: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.locations - projects_locations_list: - operation: *ref_1 - response: *ref_2 - projects_locations_get: + projects_locations_operations_get: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}/get' + $ref: >- + #/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/locations/methods/projects_locations_list - - $ref: >- - #/components/x-stackQL-resources/locations/methods/projects_locations_get + #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get insert: [] update: [] delete: [] - connections: - id: cloudbuild.connections - name: connections - title: Connections + repositories_git_refs: + id: google.cloudbuild.repositories_git_refs + name: repositories_git_refs + title: Repositories_git_refs methods: - _projects_locations_connections_list: - operation: &ref_3 + projects_locations_connections_repositories_fetch_git_refs: + operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get - response: &ref_4 + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}:fetchGitRefs/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.connections - projects_locations_connections_list: - operation: *ref_3 - response: *ref_4 - projects_locations_connections_create: + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + repositories: + id: google.cloudbuild.repositories + name: repositories + title: Repositories + methods: + projects_locations_connections_repositories_access_read_write_token: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/post + #/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_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' + _projects_locations_connections_repositories_list: + operation: &ref_1 + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories/get + response: &ref_2 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.repositories + projects_locations_connections_repositories_list: + operation: *ref_1 + response: *ref_2 + projects_locations_connections_repositories_create: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_connections_repositories_batch_create: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories:batchCreate/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_connections_repositories_delete: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}/delete response: mediaType: application/json openAPIDocKey: '200' + projects_locations_connections_repositories_get: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + 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 + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/repositories/methods/projects_locations_connections_repositories_delete + connections: + id: google.cloudbuild.connections + name: connections + title: Connections + methods: projects_locations_connections_patch: operation: $ref: >- @@ -2587,41 +2653,51 @@ components: response: mediaType: application/json openAPIDocKey: '200' + projects_locations_connections_create: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/post + response: + mediaType: application/json + openAPIDocKey: '200' + _projects_locations_connections_list: + operation: &ref_3 + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get + response: &ref_4 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.connections + projects_locations_connections_list: + operation: *ref_3 + response: *ref_4 sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_list - $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: [] + update: + - $ref: >- + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_patch delete: - $ref: >- #/components/x-stackQL-resources/connections/methods/projects_locations_connections_delete - connections_linkable_repositories: - id: cloudbuild.connections_linkable_repositories - name: connections_linkable_repositories - title: Connections_linkable_repositories + connections_iam_policies: + id: google.cloudbuild.connections_iam_policies + name: connections_iam_policies + title: Connections_iam_policies methods: - projects_locations_connections_fetch_linkable_repositories: + projects_locations_connections_set_iam_policy: 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}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - connections_iam_policies: - id: cloudbuild.connections_iam_policies - name: connections_iam_policies - title: Connections_iam_policies - methods: projects_locations_connections_test_iam_permissions: operation: $ref: >- @@ -2640,13 +2716,6 @@ components: projects_locations_connections_get_iam_policy: operation: *ref_5 response: *ref_6 - projects_locations_connections_set_iam_policy: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}:setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' sqlVerbs: select: - $ref: >- @@ -2654,86 +2723,15 @@ components: insert: [] update: [] delete: [] - repositories: - id: cloudbuild.repositories - name: repositories - title: Repositories - methods: - _projects_locations_connections_repositories_list: - operation: &ref_7 - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories/get - response: &ref_8 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.repositories - projects_locations_connections_repositories_list: - operation: *ref_7 - response: *ref_8 - projects_locations_connections_repositories_create: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_connections_repositories_delete: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_connections_repositories_get: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_connections_repositories_batch_create: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories:batchCreate/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_connections_repositories_access_read_write_token: - operation: - $ref: >- - #/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_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/repositories/methods/projects_locations_connections_repositories_list - - $ref: >- - #/components/x-stackQL-resources/repositories/methods/projects_locations_connections_repositories_get - insert: - - $ref: >- - #/components/x-stackQL-resources/repositories/methods/projects_locations_connections_repositories_create - update: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/repositories/methods/projects_locations_connections_repositories_delete - repositories_git_refs: - id: cloudbuild.repositories_git_refs - name: repositories_git_refs - title: Repositories_git_refs + 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' @@ -2742,113 +2740,67 @@ components: insert: [] update: [] delete: [] - operations: - id: cloudbuild.operations - name: operations - title: Operations + locations: + id: google.cloudbuild.locations + name: locations + title: Locations methods: - projects_locations_operations_get: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get - response: + _projects_locations_list: + operation: &ref_7 + $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations/get' + response: &ref_8 mediaType: application/json openAPIDocKey: '200' - projects_locations_operations_cancel: + objectKey: $.locations + projects_locations_list: + operation: *ref_7 + response: *ref_8 + projects_locations_get: operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get + #/components/x-stackQL-resources/locations/methods/projects_locations_get + - $ref: >- + #/components/x-stackQL-resources/locations/methods/projects_locations_list insert: [] update: [] delete: [] paths: - /v2/projects/{projectsId}/locations: + /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: parameters: &ref_9 - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' - 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 - 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: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v2/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_9 - 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 - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections: - parameters: *ref_9 - get: - description: Lists Connections in a given project and location. - operationId: cloudbuild.projects.locations.connections.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: cloudbuild.projects.locations.operations.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelOperationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2860,7 +2812,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListConnectionsResponse' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -2872,23 +2824,19 @@ paths: 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 - post: - description: Creates a Connection. - operationId: cloudbuild.projects.locations.connections.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Connection' + /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_9 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: cloudbuild.projects.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2912,20 +2860,16 @@ paths: required: true schema: type: string - - in: query - name: connectionId + - in: path + name: operationsId + required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}: + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}:fetchGitRefs: parameters: *ref_9 - patch: - description: Updates a single connection. - operationId: cloudbuild.projects.locations.connections.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Connection' + 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 @@ -2937,7 +2881,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/FetchGitRefsResponse' parameters: - in: path name: projectsId @@ -2954,22 +2898,35 @@ paths: required: true schema: type: string - - in: query - name: etag + - in: path + name: repositoriesId + required: true schema: type: string - in: query - name: allowMissing + name: pageToken schema: - type: boolean + type: string - in: query - name: updateMask + name: refType schema: type: string - format: google-fieldmask - delete: - description: Deletes a single connection. - operationId: cloudbuild.projects.locations.connections.delete + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}:accessReadWriteToken: + parameters: *ref_9 + 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 @@ -2981,7 +2938,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/FetchReadWriteTokenResponse' parameters: - in: path name: projectsId @@ -2998,17 +2955,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 - get: - description: Gets details of a single connection. - operationId: cloudbuild.projects.locations.connections.get + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}:accessReadToken: + parameters: *ref_9 + 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' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3020,7 +2981,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Connection' + $ref: '#/components/schemas/FetchReadTokenResponse' parameters: - in: path name: projectsId @@ -3037,24 +2998,28 @@ 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}/connections/{connectionsId}/repositories: parameters: *ref_9 - 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: [] + get: + description: Lists Repositories in a given connection. + operationId: cloudbuild.projects.locations.connections.repositories.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/Empty' + $ref: '#/components/schemas/ListRepositoriesResponse' parameters: - in: path name: projectsId @@ -3066,17 +3031,32 @@ paths: required: true schema: type: string + - in: path + name: connectionsId + required: true + schema: + type: string - in: query - name: webhookKey + name: pageToken schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:fetchLinkableRepositories: - parameters: *ref_9 - get: - description: >- - FetchLinkableRepositories get repositories from SCM that are accessible - and could be added to the connection. - operationId: cloudbuild.projects.locations.connections.fetchLinkableRepositories + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + 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 @@ -3088,7 +3068,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FetchLinkableRepositoriesResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -3106,29 +3086,19 @@ paths: schema: type: string - in: query - name: pageToken + name: repositoryId schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:testIamPermissions: + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories:batchCreate: parameters: *ref_9 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: Creates multiple repositories inside a connection. + operationId: cloudbuild.projects.locations.connections.repositories.batchCreate requestBody: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' + $ref: '#/components/schemas/BatchCreateRepositoriesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3140,7 +3110,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -3157,13 +3127,11 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:getIamPolicy: + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}: parameters: *ref_9 - 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 + delete: + description: Deletes a single repository. + operationId: cloudbuild.projects.locations.connections.repositories.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3175,7 +3143,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -3192,24 +3160,22 @@ paths: required: true schema: type: string + - in: path + name: repositoriesId + required: true + schema: + type: string - in: query - name: options.requestedPolicyVersion + name: etag schema: - type: integer - format: int32 - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:setIamPolicy: - parameters: *ref_9 - 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' + type: string + - in: query + name: validateOnly + schema: + type: boolean + get: + description: Gets details of a single repository. + operationId: cloudbuild.projects.locations.connections.repositories.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3221,7 +3187,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Repository' parameters: - in: path name: projectsId @@ -3238,11 +3204,21 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories: + - in: path + name: repositoriesId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}: parameters: *ref_9 - get: - description: Lists Repositories in a given connection. - operationId: cloudbuild.projects.locations.connections.repositories.list + 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 @@ -3254,7 +3230,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListRepositoriesResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -3272,26 +3248,21 @@ paths: schema: type: string - in: query - name: filter + name: updateMask schema: type: string + format: google-fieldmask - in: query - name: pageToken + name: allowMissing schema: - type: string + type: boolean - in: query - name: pageSize + name: etag schema: - type: integer - format: int32 - post: - description: Creates a Repository. - operationId: cloudbuild.projects.locations.connections.repositories.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Repository' + type: string + delete: + description: Deletes a single connection. + operationId: cloudbuild.projects.locations.connections.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3321,14 +3292,16 @@ 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}/repositories/{repositoriesId}: - parameters: *ref_9 - delete: - description: Deletes a single repository. - operationId: cloudbuild.projects.locations.connections.repositories.delete + get: + description: Gets details of a single connection. + operationId: cloudbuild.projects.locations.connections.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3340,7 +3313,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Connection' parameters: - in: path name: projectsId @@ -3357,22 +3330,52 @@ paths: required: true schema: type: string + /v2/projects/{projectsId}/locations/{locationsId}/connections:processWebhook: + parameters: *ref_9 + 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: repositoriesId + name: projectsId required: true schema: type: string - - in: query - name: validateOnly + - in: path + name: locationsId + required: true schema: - type: boolean + type: string - in: query - name: etag + name: webhookKey schema: type: string - get: - description: Gets details of a single repository. - operationId: cloudbuild.projects.locations.connections.repositories.get + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:setIamPolicy: + parameters: *ref_9 + 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' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3384,7 +3387,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Repository' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -3401,16 +3404,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}:fetchLinkableRepositories: parameters: *ref_9 get: - description: Fetch the list of branches or tags for a given repository. - operationId: cloudbuild.projects.locations.connections.repositories.fetchGitRefs + 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 @@ -3422,7 +3422,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FetchGitRefsResponse' + $ref: '#/components/schemas/FetchLinkableRepositoriesResponse' parameters: - in: path name: projectsId @@ -3439,9 +3439,8 @@ paths: required: true schema: type: string - - in: path - name: repositoriesId - required: true + - in: query + name: pageToken schema: type: string - in: query @@ -3449,24 +3448,21 @@ paths: schema: type: integer format: int32 - - in: query - name: refType - schema: - type: string - - in: query - name: pageToken - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories:batchCreate: + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:testIamPermissions: parameters: *ref_9 post: - description: Creates multiple repositories inside a connection. - operationId: cloudbuild.projects.locations.connections.repositories.batchCreate + 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/BatchCreateRepositoriesRequest' + $ref: '#/components/schemas/TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3478,7 +3474,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -3495,17 +3491,16 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}:accessReadWriteToken: + /v2/projects/{projectsId}/locations/{locationsId}/connections: parameters: *ref_9 post: - description: Fetches read/write token of a given repository. - operationId: >- - cloudbuild.projects.locations.connections.repositories.accessReadWriteToken + description: Creates a Connection. + operationId: cloudbuild.projects.locations.connections.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/FetchReadWriteTokenRequest' + $ref: '#/components/schemas/Connection' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3517,7 +3512,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FetchReadWriteTokenResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -3529,26 +3524,52 @@ paths: required: true schema: type: string + - in: query + name: connectionId + schema: + type: string + 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 + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListConnectionsResponse' + parameters: - in: path - name: connectionsId + name: projectsId required: true schema: type: string - in: path - name: repositoriesId + name: locationsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}:accessReadToken: + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:getIamPolicy: parameters: *ref_9 - 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: >- + 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 @@ -3560,7 +3581,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FetchReadTokenResponse' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -3577,19 +3598,16 @@ paths: required: true schema: type: string - - in: path - name: repositoriesId - required: true + - in: query + name: options.requestedPolicyVersion schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + type: integer + format: int32 + /v2/projects/{projectsId}/locations: parameters: *ref_9 get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: cloudbuild.projects.locations.operations.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 @@ -3601,42 +3619,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/ListLocationsResponse' 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: operationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + /v2/projects/{projectsId}/locations/{locationsId}: parameters: *ref_9 - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CancelOperationRequest' + get: + description: Gets information about a location. + operationId: cloudbuild.projects.locations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3648,7 +3655,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Location' parameters: - in: path name: projectsId @@ -3660,8 +3667,3 @@ paths: 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/cloudcommerceprocurement.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudcommerceprocurement.yaml index e9165c25..5ee66dee 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudcommerceprocurement.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudcommerceprocurement.yaml @@ -8,7 +8,7 @@ info: description: Partner API for the Cloud Commerce Procurement Service. version: v1 x-discovery-doc-revision: '20240526' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/marketplace/docs/partners/ servers: @@ -35,84 +35,77 @@ components: scopes: *ref_0 schemas: RejectAccountRequest: + 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. + type: string 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: string - id: RejectAccountRequest description: Request message for PartnerProcurementService.RejectAccount. - type: object - RejectEntitlementRequest: - description: Request message for PartnerProcurementService.RejectEntitlement. - id: RejectEntitlementRequest + id: RejectAccountRequest + ApproveAccountRequest: + id: ApproveAccountRequest type: object properties: - reason: + approvalName: + type: string description: >- - Free form text string explaining the rejection reason. Max allowed - length: 256 bytes. Longer strings will be truncated. + 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. + reason: type: string - Consumer: - description: A resource using (consuming) this entitlement. - id: Consumer - type: object + description: >- + Free form text string explaining the approval reason. Optional. Max + allowed length: 256 bytes. Longer strings will be truncated. + properties: + description: >- + Set of properties that should be associated with the account. + Optional. + additionalProperties: + type: string + type: object + description: Request message for PartnerProcurementService.ApproveAccount. + ApproveEntitlementPlanChangeRequest: + description: >- + Request message for + [PartnerProcurementService.ApproveEntitlementPlanChange[]. + id: ApproveEntitlementPlanChangeRequest properties: - project: - description: A project name with format `projects/`. + pendingPlanName: + description: Required. Name of the pending plan that is being approved. type: string - ResetAccountRequest: type: object - properties: {} + ResetAccountRequest: description: Request message for PartnerProcurementService.ResetAccount. + properties: {} id: ResetAccountRequest - Entitlement: + type: object + SuspendEntitlementRequest: + description: >- + Request message for ParterProcurementService.SuspendEntitlement. This is + not yet supported. + type: object properties: - 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 - 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 - plan: - type: string - description: >- - Output only. The identifier of the plan that was procured. Required - if the product has plans. - offer: - 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: - '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. - account: + reason: description: >- - Output only. The resource name of the account that this entitlement - is based on, if any. + A free-form reason string, explaining the reason for suspension + request. type: string + id: SuspendEntitlementRequest + Entitlement: + properties: state: + type: string enumDescriptions: - >- Default state of the entitlement. It's only set to this value when @@ -175,6 +168,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. + description: Output only. The state of the entitlement. enum: - ENTITLEMENT_STATE_UNSPECIFIED - ENTITLEMENT_ACTIVATION_REQUESTED @@ -184,22 +178,65 @@ components: - ENTITLEMENT_PENDING_PLAN_CHANGE - ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL - ENTITLEMENT_SUSPENDED + 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 - description: Output only. The state of the entitlement. - newPendingOfferDuration: + cancellationReason: + readOnly: true + description: >- + Output only. The reason the entitlement was cancelled. If this + entitlement was not cancelled, this field will be 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). + type: string + productExternalName: + description: Output only. The identifier of the product that was procured. type: string readOnly: true + usageReportingId: + type: string description: >- - Output only. The offer duration of the new offer in ISO 8601 - duration format. This field is not populated for entitlements which - are not 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. - consumers: - type: array - description: Output only. The resources using this entitlement, if applicable. + 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. + entitlementBenefitIds: + readOnly: true items: - $ref: '#/components/schemas/Consumer' + type: string + description: >- + Output only. The entitlement benefit IDs associated with the + purchase. + type: array + createTime: + description: Output only. The creation timestamp. + type: string + format: google-datetime + account: + type: string + description: >- + Output only. The resource name of the account that this entitlement + is based on, if any. + orderId: + description: >- + Output only. The order ID of this entitlement, without any `orders/` + resource name prefix. + readOnly: true + type: string + plan: + type: string + description: >- + Output only. The identifier of the plan that was procured. Required + if the product has plans. + updateTime: + format: google-datetime + description: Output only. The last update timestamp. + type: string provider: type: string description: >- @@ -207,15 +244,15 @@ components: entitlement was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform. - 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 will be populated even if the entitlement is not active - yet. If there is no upcoming offer, the field will be empty. + newPendingOfferDuration: readOnly: true + description: >- + Output only. The offer duration of the new offer in ISO 8601 + duration format. This field is not populated for entitlements which + are not 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. + type: string offerDuration: readOnly: true type: string @@ -224,12 +261,6 @@ components: 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. - 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 name: description: >- Output only. The resource name of the entitlement. Entitlement names @@ -238,62 +269,55 @@ components: type: string 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. - updateTime: - description: Output only. The last update timestamp. type: string - format: google-datetime - entitlementBenefitIds: - readOnly: true + consumers: + items: + $ref: '#/components/schemas/Consumer' type: array + description: Output only. The resources using this entitlement, if applicable. + newOfferEndTime: description: >- - Output only. The entitlement benefit IDs associated with the - purchase. - items: - type: string - subscriptionEndTime: + 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 will be populated even if the entitlement is not active + yet. If there is no upcoming offer, the field will be empty. + format: google-datetime + readOnly: true type: string + offerEndTime: + readOnly: true 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. + type: string + subscriptionEndTime: description: >- Output only. End time for the subscription corresponding to this entitlement. - readOnly: true - cancellationReason: - description: >- - Output only. The reason the entitlement was cancelled. If this - entitlement was not cancelled, this field will be 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). - readOnly: true - type: string - createTime: format: google-datetime - description: Output only. The creation timestamp. + readOnly: true type: string inputProperties: - deprecated: true type: object + deprecated: true + additionalProperties: + type: any + description: Properties of the object. description: >- Output only. The custom properties that were collected from the user to create this entitlement. - additionalProperties: - description: Properties of the object. - type: any - newPendingOffer: + offer: 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 is not populated for entitlements - which are not active yet. Format: + 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} @@ -301,25 +325,9 @@ 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. - orderId: - description: >- - Output only. The order ID of this entitlement, without any `orders/` - resource name prefix. - readOnly: true type: string - productExternalName: - type: string - description: Output only. The identifier of the product that was procured. - readOnly: true - newOfferStartTime: - format: google-datetime + messageToUser: type: string - description: >- - Output only. The timestamp when the new offer will become effective. - This field will be populated even if the entitlement is not active - yet. If there is no upcoming offer, the field will be empty. - readOnly: true - messageToUser: description: >- Provider-supplied message that is displayed to the end user. Currently this is used to communicate progress and ETA for @@ -328,31 +336,110 @@ components: EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field is cleared automatically when the entitlement state changes. - type: string - offerEndTime: + newOfferStartTime: format: google-datetime type: string + readOnly: true 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. + Output only. The timestamp when the new offer will become effective. + This field will be populated even if the entitlement is not active + yet. If there is no upcoming offer, the field will be empty. + quoteExternalName: readOnly: true + type: string + description: >- + Output only. The identifier of the quote that was used to procure. + Empty if the order is not purchased using a quote. + newPendingOffer: + readOnly: true + 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 is not populated for entitlements + which are not 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. + type: string description: Represents a procured product of a customer. + type: object id: Entitlement + Approval: type: object + id: Approval + properties: + name: + type: string + description: Output only. The name of the approval. + reason: + type: string + description: Output only. An explanation for the state of the approval. + updateTime: + description: Optional. The last update timestamp of the approval. + format: google-datetime + type: string + state: + type: string + enum: + - STATE_UNSPECIFIED + - PENDING + - APPROVED + - REJECTED + description: Output only. The state of the approval. + 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: An approval for some action on an account. Account: - type: object - id: Account description: >- Represents an account that was established by the customer on the service provider's system. + type: object + id: Account properties: - state: + createTime: + description: Output only. The creation timestamp. type: string - enum: - - ACCOUNT_STATE_UNSPECIFIED - - ACCOUNT_ACTIVATION_REQUESTED - - ACCOUNT_ACTIVE + format: google-datetime + inputProperties: + additionalProperties: + description: Properties of the object. + type: any + description: >- + Output only. The custom properties that were collected from the user + to create this account. + type: object + 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. + type: array + items: + $ref: '#/components/schemas/Approval' + 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: enumDescriptions: - >- Default state of the account. It's only set to this value when the @@ -366,233 +453,130 @@ components: The account is active and ready for use. The next possible states are: - Account getting deleted: After the user invokes delete from another API. + 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. - 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 - 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. + enum: + - ACCOUNT_STATE_UNSPECIFIED + - ACCOUNT_ACTIVATION_REQUESTED + - ACCOUNT_ACTIVE name: + type: string description: >- Output only. The resource name of the account. Account names have the form `accounts/{account_id}`. - type: string - inputProperties: - deprecated: true - description: >- - Output only. The custom properties that were collected from the user - to create this account. - additionalProperties: - description: Properties of the object. - type: any - type: object updateTime: description: Output only. The last update timestamp. - type: string - format: google-datetime - createTime: format: google-datetime - description: Output only. The creation timestamp. type: string - ApproveAccountRequest: + RejectEntitlementPlanChangeRequest: properties: - properties: - type: object - description: >- - Set of properties that should be associated with the account. - Optional. - additionalProperties: - type: string - approvalName: + reason: 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. + Free form text string explaining the rejection reason. Max allowed + length: 256 bytes. Longer strings will be truncated. type: string - reason: + pendingPlanName: type: string - description: >- - Free form text string explaining the approval reason. Optional. Max - allowed length: 256 bytes. Longer strings will be truncated. - id: ApproveAccountRequest + description: Required. Name of the pending plan that is being rejected. type: object - description: Request message for PartnerProcurementService.ApproveAccount. + description: >- + Request message for + PartnerProcurementService.RejectEntitlementPlanChange. + id: RejectEntitlementPlanChangeRequest + ListEntitlementsResponse: + type: object + description: Response message for PartnerProcurementService.ListEntitlements. + properties: + nextPageToken: + description: The token for fetching the next page. + type: string + entitlements: + type: array + items: + $ref: '#/components/schemas/Entitlement' + description: The list of entitlements in this response. + id: ListEntitlementsResponse + RejectEntitlementRequest: + type: object + description: Request message for PartnerProcurementService.RejectEntitlement. + id: RejectEntitlementRequest + properties: + reason: + description: >- + Free form text string explaining the rejection reason. Max allowed + length: 256 bytes. Longer strings will be truncated. + type: string Empty: - properties: {} - id: Empty type: object + id: 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); } - SuspendEntitlementRequest: + Consumer: + description: A resource using (consuming) this entitlement. + type: object + id: Consumer properties: - reason: - description: >- - A free-form reason string, explaining the reason for suspension - request. + project: + description: A project name with format `projects/`. type: string - description: >- - Request message for ParterProcurementService.SuspendEntitlement. This is - not yet supported. - id: SuspendEntitlementRequest - type: object - RejectEntitlementPlanChangeRequest: - id: RejectEntitlementPlanChangeRequest + ListAccountsResponse: + id: ListAccountsResponse + description: Response message for [PartnerProcurementService.ListAccounts[]. type: object - description: >- - Request message for - PartnerProcurementService.RejectEntitlementPlanChange. properties: - reason: - description: >- - Free form text string explaining the rejection reason. Max allowed - length: 256 bytes. Longer strings will be truncated. - type: string - pendingPlanName: + accounts: + type: array + items: + $ref: '#/components/schemas/Account' + description: The list of accounts in this response. + nextPageToken: type: string - description: Required. Name of the pending plan that is being rejected. + description: The token for fetching the next page. ApproveEntitlementRequest: - id: ApproveEntitlementRequest type: object + id: ApproveEntitlementRequest 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. - type: string properties: - type: object deprecated: true + additionalProperties: + type: string + type: object description: >- Set of properties that should be associated with the entitlement. Optional. - additionalProperties: - type: string description: Request message for [PartnerProcurementService.ApproveEntitlement[]. - Approval: - properties: - name: - description: Output only. The name of the approval. - type: string - state: - type: string - 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. - reason: - description: Output only. An explanation for the state of the approval. - type: string - updateTime: - format: google-datetime - type: string - description: Optional. The last update timestamp of the approval. - type: object - id: Approval - description: An approval for some action on an account. - ApproveEntitlementPlanChangeRequest: - description: >- - Request message for - [PartnerProcurementService.ApproveEntitlementPlanChange[]. - properties: - pendingPlanName: - description: Required. Name of the pending plan that is being approved. - type: string - id: ApproveEntitlementPlanChangeRequest - type: object - ListEntitlementsResponse: - id: ListEntitlementsResponse - description: Response message for PartnerProcurementService.ListEntitlements. - properties: - nextPageToken: - type: string - description: The token for fetching the next page. - entitlements: - type: array - description: The list of entitlements in this response. - items: - $ref: '#/components/schemas/Entitlement' - type: object - ListAccountsResponse: - description: Response message for [PartnerProcurementService.ListAccounts[]. - id: ListAccountsResponse - type: object - properties: - nextPageToken: - description: The token for fetching the next page. - type: string - accounts: - description: The list of accounts in this response. - items: - $ref: '#/components/schemas/Account' - type: array parameters: - 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. + _.xgafv: + description: V1 error format. in: query - name: quotaUser + name: $.xgafv schema: type: string - alt: - description: Data format for response. + enum: + - '1' + - '2' + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: alt + name: uploadType schema: type: string - enum: - - json - - media - - proto key: description: >- API key. Your API key identifies your project and provides you with API @@ -608,58 +592,61 @@ components: name: callback schema: type: string - 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 + 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' - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string + - 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 + 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 x-stackQL-resources: accounts: - id: cloudcommerceprocurement.accounts + id: google.cloudcommerceprocurement.accounts name: accounts title: Accounts methods: - reset: - 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' - response: - mediaType: application/json - openAPIDocKey: '200' _list: operation: &ref_1 $ref: '#/paths/~1v1~1providers~1{providersId}~1accounts/get' @@ -677,6 +664,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + reset: + operation: + $ref: >- + #/paths/~1v1~1providers~1{providersId}~1accounts~1{accountsId}:reset/post + response: + mediaType: application/json + openAPIDocKey: '200' reject: operation: $ref: >- @@ -684,6 +678,12 @@ components: response: mediaType: application/json openAPIDocKey: '200' + get: + operation: + $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' @@ -692,10 +692,17 @@ components: update: [] delete: [] entitlements: - id: cloudcommerceprocurement.entitlements + id: google.cloudcommerceprocurement.entitlements name: entitlements title: Entitlements methods: + approve_plan_change: + operation: + $ref: >- + #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:approvePlanChange/post + response: + mediaType: application/json + openAPIDocKey: '200' reject_plan_change: operation: $ref: >- @@ -703,6 +710,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + suspend: + operation: + $ref: >- + #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:suspend/post + response: + mediaType: application/json + openAPIDocKey: '200' patch: operation: $ref: >- @@ -717,6 +731,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + reject: + operation: + $ref: >- + #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:reject/post + response: + mediaType: application/json + openAPIDocKey: '200' _list: operation: &ref_3 $ref: '#/paths/~1v1~1providers~1{providersId}~1entitlements/get' @@ -727,31 +748,10 @@ components: list: operation: *ref_3 response: *ref_4 - approve_plan_change: - operation: - $ref: >- - #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:approvePlanChange/post - response: - mediaType: application/json - openAPIDocKey: '200' - suspend: - operation: - $ref: >- - #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:suspend/post - response: - mediaType: application/json - openAPIDocKey: '200' approve: operation: $ref: >- - #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:approve/post - response: - mediaType: application/json - openAPIDocKey: '200' - reject: - 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' @@ -760,32 +760,26 @@ components: - $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' delete: [] paths: - /v1/providers/{providersId}/accounts/{accountsId}:reset: + /v1/providers/{providersId}/accounts: parameters: &ref_5 - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/_.xgafv' + - $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/_.xgafv' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/upload_protocol' - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ResetAccountRequest' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/fields' + get: + description: Lists Accounts that the provider has access to. + operationId: cloudcommerceprocurement.providers.accounts.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -797,23 +791,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: accountsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/providers/{providersId}/accounts/{accountsId}: + /v1/providers/{providersId}/accounts/{accountsId}:approve: parameters: *ref_5 - get: - description: Gets a requested Account resource. - operationId: cloudcommerceprocurement.providers.accounts.get + post: + description: Grants an approval on an Account. + operationId: cloudcommerceprocurement.providers.accounts.approve + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ApproveAccountRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -825,7 +828,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Account' + $ref: '#/components/schemas/Empty' parameters: - in: path name: providersId @@ -837,11 +840,18 @@ paths: required: true schema: type: string - /v1/providers/{providersId}/accounts: + /v1/providers/{providersId}/accounts/{accountsId}:reset: parameters: *ref_5 - get: - description: Lists Accounts that the provider has access to. - operationId: cloudcommerceprocurement.providers.accounts.list + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ResetAccountRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -853,32 +863,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListAccountsResponse' + $ref: '#/components/schemas/Empty' parameters: - in: path name: providersId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: accountsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/providers/{providersId}/accounts/{accountsId}:approve: + /v1/providers/{providersId}/accounts/{accountsId}:reject: parameters: *ref_5 post: - description: Grants an approval on an Account. - operationId: cloudcommerceprocurement.providers.accounts.approve + description: Rejects an approval on an Account. + operationId: cloudcommerceprocurement.providers.accounts.reject requestBody: content: application/json: schema: - $ref: '#/components/schemas/ApproveAccountRequest' + $ref: '#/components/schemas/RejectAccountRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -902,16 +908,11 @@ paths: required: true schema: type: string - /v1/providers/{providersId}/accounts/{accountsId}:reject: + /v1/providers/{providersId}/accounts/{accountsId}: parameters: *ref_5 - 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 @@ -923,7 +924,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Account' parameters: - in: path name: providersId @@ -935,20 +936,20 @@ paths: required: true schema: type: string - /v1/providers/{providersId}/entitlements/{entitlementsId}:rejectPlanChange: + /v1/providers/{providersId}/entitlements/{entitlementsId}:approvePlanChange: parameters: *ref_5 post: description: >- - Rejects an entitlement plan change that is in the + Approves 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 + method is invoked by the provider to approve the plan change on the entitlement resource. - operationId: cloudcommerceprocurement.providers.entitlements.rejectPlanChange + operationId: cloudcommerceprocurement.providers.entitlements.approvePlanChange requestBody: content: application/json: schema: - $ref: '#/components/schemas/RejectEntitlementPlanChangeRequest' + $ref: '#/components/schemas/ApproveEntitlementPlanChangeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -972,16 +973,20 @@ paths: required: true schema: type: string - /v1/providers/{providersId}/entitlements/{entitlementsId}: + /v1/providers/{providersId}/entitlements/{entitlementsId}:rejectPlanChange: parameters: *ref_5 - patch: - description: Updates an existing Entitlement. - operationId: cloudcommerceprocurement.providers.entitlements.patch + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/Entitlement' + $ref: '#/components/schemas/RejectEntitlementPlanChangeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -993,7 +998,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Entitlement' + $ref: '#/components/schemas/Empty' parameters: - in: path name: providersId @@ -1005,14 +1010,16 @@ paths: required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: Gets a requested Entitlement resource. - operationId: cloudcommerceprocurement.providers.entitlements.get + /v1/providers/{providersId}/entitlements/{entitlementsId}:suspend: + parameters: *ref_5 + 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/SuspendEntitlementRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1024,7 +1031,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Entitlement' + $ref: '#/components/schemas/Empty' parameters: - in: path name: providersId @@ -1036,11 +1043,16 @@ paths: required: true schema: type: string - /v1/providers/{providersId}/entitlements: + /v1/providers/{providersId}/entitlements/{entitlementsId}: parameters: *ref_5 - get: - description: Lists Entitlements for which the provider has read access. - operationId: cloudcommerceprocurement.providers.entitlements.list + patch: + description: Updates an existing Entitlement. + operationId: cloudcommerceprocurement.providers.entitlements.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Entitlement' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1052,40 +1064,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: pageToken + - in: path + name: entitlementsId + required: true schema: type: string - in: query - name: filter + name: updateMask schema: type: string - /v1/providers/{providersId}/entitlements/{entitlementsId}:approvePlanChange: - parameters: *ref_5 - 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' + format: google-fieldmask + get: + description: Gets a requested Entitlement resource. + operationId: cloudcommerceprocurement.providers.entitlements.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1097,7 +1095,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Entitlement' parameters: - in: path name: providersId @@ -1109,16 +1107,20 @@ paths: required: true schema: type: string - /v1/providers/{providersId}/entitlements/{entitlementsId}:suspend: + /v1/providers/{providersId}/entitlements/{entitlementsId}:reject: parameters: *ref_5 post: - description: Requests suspension of an active Entitlement. This is not yet supported. - operationId: cloudcommerceprocurement.providers.entitlements.suspend + 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/SuspendEntitlementRequest' + $ref: '#/components/schemas/RejectEntitlementRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1142,20 +1144,11 @@ paths: required: true schema: type: string - /v1/providers/{providersId}/entitlements/{entitlementsId}:approve: + /v1/providers/{providersId}/entitlements: parameters: *ref_5 - 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 Entitlements for which the provider has read access. + operationId: cloudcommerceprocurement.providers.entitlements.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1167,32 +1160,40 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/ListEntitlementsResponse' parameters: - in: path name: providersId required: true schema: type: string - - in: path - name: entitlementsId - required: true + - in: query + name: filter schema: type: string - /v1/providers/{providersId}/entitlements/{entitlementsId}:reject: + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/providers/{providersId}/entitlements/{entitlementsId}:approve: parameters: *ref_5 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 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 5a5bb274..5e1e44bf 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudcontrolspartner.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudcontrolspartner.yaml @@ -10,7 +10,7 @@ info: your Sovereign Controls by Partners offering. version: v1 x-discovery-doc-revision: '20240515' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: >- https://cloud.google.com/sovereign-controls-by-partners/docs/sovereign-partners/reference/rest @@ -830,7 +830,7 @@ components: - '2' x-stackQL-resources: partner: - id: cloudcontrolspartner.partner + id: google.cloudcontrolspartner.partner name: partner title: Partner methods: @@ -848,7 +848,7 @@ components: update: [] delete: [] customers: - id: cloudcontrolspartner.customers + id: google.cloudcontrolspartner.customers name: customers title: Customers methods: @@ -878,7 +878,7 @@ components: update: [] delete: [] workloads: - id: cloudcontrolspartner.workloads + id: google.cloudcontrolspartner.workloads name: workloads title: Workloads methods: @@ -908,7 +908,7 @@ components: update: [] delete: [] workloads_ekm_connections: - id: cloudcontrolspartner.workloads_ekm_connections + id: google.cloudcontrolspartner.workloads_ekm_connections name: workloads_ekm_connections title: Workloads_ekm_connections methods: @@ -927,7 +927,7 @@ components: update: [] delete: [] workloads_partner_permissions: - id: cloudcontrolspartner.workloads_partner_permissions + id: google.cloudcontrolspartner.workloads_partner_permissions name: workloads_partner_permissions title: Workloads_partner_permissions methods: @@ -946,7 +946,7 @@ components: update: [] delete: [] access_approval_requests: - id: cloudcontrolspartner.access_approval_requests + id: google.cloudcontrolspartner.access_approval_requests name: access_approval_requests title: Access_approval_requests methods: @@ -969,7 +969,7 @@ components: update: [] delete: [] violations: - id: cloudcontrolspartner.violations + id: google.cloudcontrolspartner.violations name: violations title: Violations methods: @@ -993,8 +993,8 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/violations/methods/list' - $ref: '#/components/x-stackQL-resources/violations/methods/get' + - $ref: '#/components/x-stackQL-resources/violations/methods/list' insert: [] update: [] delete: [] 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 d775007f..09740c64 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/clouddeploy.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/clouddeploy.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1 x-discovery-doc-revision: '20240515' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/deploy/ servers: @@ -4447,7 +4447,7 @@ components: - '2' x-stackQL-resources: config: - id: clouddeploy.config + id: google.clouddeploy.config name: config title: Config methods: @@ -4465,7 +4465,7 @@ components: update: [] delete: [] locations: - id: clouddeploy.locations + id: google.clouddeploy.locations name: locations title: Locations methods: @@ -4487,13 +4487,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: clouddeploy.operations + id: google.clouddeploy.operations name: operations title: Operations methods: @@ -4531,14 +4531,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' delivery_pipelines: - id: clouddeploy.delivery_pipelines + id: google.clouddeploy.delivery_pipelines name: delivery_pipelines title: Delivery_pipelines methods: @@ -4590,15 +4590,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/delivery_pipelines/methods/list' - $ref: '#/components/x-stackQL-resources/delivery_pipelines/methods/get' + - $ref: '#/components/x-stackQL-resources/delivery_pipelines/methods/list' insert: - $ref: '#/components/x-stackQL-resources/delivery_pipelines/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/delivery_pipelines/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/delivery_pipelines/methods/delete' delivery_pipelines_iam_policies: - id: clouddeploy.delivery_pipelines_iam_policies + id: google.clouddeploy.delivery_pipelines_iam_policies name: delivery_pipelines_iam_policies title: Delivery_pipelines_iam_policies methods: @@ -4635,7 +4636,7 @@ components: update: [] delete: [] releases: - id: clouddeploy.releases + id: google.clouddeploy.releases name: releases title: Releases methods: @@ -4673,14 +4674,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/releases/methods/list' - $ref: '#/components/x-stackQL-resources/releases/methods/get' + - $ref: '#/components/x-stackQL-resources/releases/methods/list' insert: - $ref: '#/components/x-stackQL-resources/releases/methods/create' update: [] delete: [] rollouts: - id: clouddeploy.rollouts + id: google.clouddeploy.rollouts name: rollouts title: Rollouts methods: @@ -4746,14 +4747,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/rollouts/methods/list' - $ref: '#/components/x-stackQL-resources/rollouts/methods/get' + - $ref: '#/components/x-stackQL-resources/rollouts/methods/list' insert: - $ref: '#/components/x-stackQL-resources/rollouts/methods/create' update: [] delete: [] job_runs: - id: clouddeploy.job_runs + id: google.clouddeploy.job_runs name: job_runs title: Job_runs methods: @@ -4784,13 +4785,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/job_runs/methods/list' - $ref: '#/components/x-stackQL-resources/job_runs/methods/get' + - $ref: '#/components/x-stackQL-resources/job_runs/methods/list' insert: [] update: [] delete: [] automations: - id: clouddeploy.automations + id: google.clouddeploy.automations name: automations title: Automations methods: @@ -4835,15 +4836,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/automations/methods/list' - $ref: '#/components/x-stackQL-resources/automations/methods/get' + - $ref: '#/components/x-stackQL-resources/automations/methods/list' insert: - $ref: '#/components/x-stackQL-resources/automations/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/automations/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/automations/methods/delete' automation_runs: - id: clouddeploy.automation_runs + id: google.clouddeploy.automation_runs name: automation_runs title: Automation_runs methods: @@ -4880,7 +4882,7 @@ components: update: [] delete: [] targets: - id: clouddeploy.targets + id: google.clouddeploy.targets name: targets title: Targets methods: @@ -4925,15 +4927,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/targets/methods/list' - $ref: '#/components/x-stackQL-resources/targets/methods/get' + - $ref: '#/components/x-stackQL-resources/targets/methods/list' insert: - $ref: '#/components/x-stackQL-resources/targets/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/targets/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/targets/methods/delete' targets_iam_policies: - id: clouddeploy.targets_iam_policies + id: google.clouddeploy.targets_iam_policies name: targets_iam_policies title: Targets_iam_policies methods: @@ -4970,7 +4973,7 @@ components: update: [] delete: [] custom_target_types: - id: clouddeploy.custom_target_types + id: google.clouddeploy.custom_target_types name: custom_target_types title: Custom_target_types methods: @@ -5015,17 +5018,18 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/custom_target_types/methods/list' - $ref: '#/components/x-stackQL-resources/custom_target_types/methods/get' + - $ref: '#/components/x-stackQL-resources/custom_target_types/methods/list' insert: - $ref: >- #/components/x-stackQL-resources/custom_target_types/methods/create - update: [] + update: + - $ref: '#/components/x-stackQL-resources/custom_target_types/methods/patch' delete: - $ref: >- #/components/x-stackQL-resources/custom_target_types/methods/delete custom_target_types_iam_policies: - id: clouddeploy.custom_target_types_iam_policies + id: google.clouddeploy.custom_target_types_iam_policies name: custom_target_types_iam_policies title: Custom_target_types_iam_policies methods: 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 d9c7b091..a469568c 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: '20240524' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/error-reporting/ servers: @@ -544,7 +544,7 @@ components: - '2' x-stackQL-resources: events: - id: clouderrorreporting.events + id: google.clouderrorreporting.events name: events title: Events methods: @@ -578,7 +578,7 @@ components: delete: - $ref: '#/components/x-stackQL-resources/events/methods/delete_events' groups: - id: clouderrorreporting.groups + id: google.clouderrorreporting.groups name: groups title: Groups methods: @@ -598,10 +598,11 @@ components: select: - $ref: '#/components/x-stackQL-resources/groups/methods/get' insert: [] - update: [] + update: + - $ref: '#/components/x-stackQL-resources/groups/methods/update' delete: [] group_stats: - id: clouderrorreporting.group_stats + id: google.clouderrorreporting.group_stats name: group_stats title: Group_stats methods: 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 0e48d23e..2bcaea34 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudfunctions.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudfunctions.yaml @@ -8,7 +8,7 @@ info: description: Manages lightweight user-provided functions executed in response to events. version: v2 x-discovery-doc-revision: '20240523' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/functions servers: @@ -2093,7 +2093,7 @@ components: - '2' x-stackQL-resources: locations: - id: cloudfunctions.locations + id: google.cloudfunctions.locations name: locations title: Locations methods: @@ -2114,7 +2114,7 @@ components: update: [] delete: [] operations: - id: cloudfunctions.operations + id: google.cloudfunctions.operations name: operations title: Operations methods: @@ -2138,13 +2138,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: [] functions_iam_policies: - id: cloudfunctions.functions_iam_policies + id: google.cloudfunctions.functions_iam_policies name: functions_iam_policies title: Functions_iam_policies methods: @@ -2181,7 +2181,7 @@ components: update: [] delete: [] functions: - id: cloudfunctions.functions + id: google.cloudfunctions.functions name: functions title: Functions methods: @@ -2279,11 +2279,12 @@ components: - $ref: '#/components/x-stackQL-resources/functions/methods/list' insert: - $ref: '#/components/x-stackQL-resources/functions/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/functions/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/functions/methods/delete' runtimes: - id: cloudfunctions.runtimes + id: google.cloudfunctions.runtimes name: runtimes title: Runtimes methods: 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 44156272..ef7f9bc4 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudidentity.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudidentity.yaml @@ -8,7 +8,7 @@ info: description: API for provisioning and managing identity resources. version: v1 x-discovery-doc-revision: '20240527' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/identity/ servers: @@ -2401,7 +2401,7 @@ components: - '2' x-stackQL-resources: devices: - id: cloudidentity.devices + id: google.cloudidentity.devices name: devices title: Devices methods: @@ -2447,15 +2447,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/devices/methods/list' - $ref: '#/components/x-stackQL-resources/devices/methods/get' + - $ref: '#/components/x-stackQL-resources/devices/methods/list' insert: - $ref: '#/components/x-stackQL-resources/devices/methods/create' update: [] delete: - $ref: '#/components/x-stackQL-resources/devices/methods/delete' device_users: - id: cloudidentity.device_users + id: google.cloudidentity.device_users name: device_users title: Device_users methods: @@ -2526,7 +2526,7 @@ components: delete: - $ref: '#/components/x-stackQL-resources/device_users/methods/delete' client_states: - id: cloudidentity.client_states + id: google.cloudidentity.client_states name: client_states title: Client_states methods: @@ -2560,10 +2560,11 @@ components: - $ref: '#/components/x-stackQL-resources/client_states/methods/get' - $ref: '#/components/x-stackQL-resources/client_states/methods/list' insert: [] - update: [] + update: + - $ref: '#/components/x-stackQL-resources/client_states/methods/patch' delete: [] groups: - id: cloudidentity.groups + id: google.cloudidentity.groups name: groups title: Groups methods: @@ -2615,15 +2616,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/groups/methods/list' - $ref: '#/components/x-stackQL-resources/groups/methods/get' + - $ref: '#/components/x-stackQL-resources/groups/methods/list' insert: - $ref: '#/components/x-stackQL-resources/groups/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/groups/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/groups/methods/delete' groups_security_settings: - id: cloudidentity.groups_security_settings + id: google.cloudidentity.groups_security_settings name: groups_security_settings title: Groups_security_settings methods: @@ -2647,7 +2649,7 @@ components: update: [] delete: [] memberships: - id: cloudidentity.memberships + id: google.cloudidentity.memberships name: memberships title: Memberships methods: @@ -2723,15 +2725,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/memberships/methods/list' - $ref: '#/components/x-stackQL-resources/memberships/methods/get' + - $ref: '#/components/x-stackQL-resources/memberships/methods/list' insert: - $ref: '#/components/x-stackQL-resources/memberships/methods/create' update: [] delete: - $ref: '#/components/x-stackQL-resources/memberships/methods/delete' memberships_membership_graph: - id: cloudidentity.memberships_membership_graph + id: google.cloudidentity.memberships_membership_graph name: memberships_membership_graph title: Memberships_membership_graph methods: @@ -2750,7 +2752,7 @@ components: update: [] delete: [] inbound_saml_sso_profiles: - id: cloudidentity.inbound_saml_sso_profiles + id: google.cloudidentity.inbound_saml_sso_profiles name: inbound_saml_sso_profiles title: Inbound_saml_sso_profiles methods: @@ -2793,19 +2795,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/inbound_saml_sso_profiles/methods/list - $ref: >- #/components/x-stackQL-resources/inbound_saml_sso_profiles/methods/get + - $ref: >- + #/components/x-stackQL-resources/inbound_saml_sso_profiles/methods/list insert: - $ref: >- #/components/x-stackQL-resources/inbound_saml_sso_profiles/methods/create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/inbound_saml_sso_profiles/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/inbound_saml_sso_profiles/methods/delete idp_credentials: - id: cloudidentity.idp_credentials + id: google.cloudidentity.idp_credentials name: idp_credentials title: Idp_credentials methods: @@ -2850,7 +2854,7 @@ components: delete: - $ref: '#/components/x-stackQL-resources/idp_credentials/methods/delete' inbound_sso_assignments: - id: cloudidentity.inbound_sso_assignments + id: google.cloudidentity.inbound_sso_assignments name: inbound_sso_assignments title: Inbound_sso_assignments methods: @@ -2899,12 +2903,14 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/inbound_sso_assignments/methods/create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/inbound_sso_assignments/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/inbound_sso_assignments/methods/delete userinvitations: - id: cloudidentity.userinvitations + id: google.cloudidentity.userinvitations name: userinvitations title: Userinvitations methods: 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 4bcbf74c..f4dcc552 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudkms.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudkms.yaml @@ -10,7 +10,7 @@ info: service, for direct use by other cloud resources and applications. version: v1 x-discovery-doc-revision: '20240523' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/kms/ servers: @@ -3071,7 +3071,7 @@ components: - '2' x-stackQL-resources: autokey_config: - id: cloudkms.autokey_config + id: google.cloudkms.autokey_config name: autokey_config title: Autokey_config methods: @@ -3095,7 +3095,7 @@ components: update: [] delete: [] projects: - id: cloudkms.projects + id: google.cloudkms.projects name: projects title: Projects methods: @@ -3112,7 +3112,7 @@ components: update: [] delete: [] ekm_config: - id: cloudkms.ekm_config + id: google.cloudkms.ekm_config name: ekm_config title: Ekm_config methods: @@ -3137,7 +3137,7 @@ components: update: [] delete: [] locations: - id: cloudkms.locations + id: google.cloudkms.locations name: locations title: Locations methods: @@ -3166,13 +3166,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: cloudkms.operations + id: google.cloudkms.operations name: operations title: Operations methods: @@ -3190,7 +3190,7 @@ components: update: [] delete: [] key_handles: - id: cloudkms.key_handles + id: google.cloudkms.key_handles name: key_handles title: Key_handles methods: @@ -3217,14 +3217,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/key_handles/methods/list' - $ref: '#/components/x-stackQL-resources/key_handles/methods/get' + - $ref: '#/components/x-stackQL-resources/key_handles/methods/list' insert: - $ref: '#/components/x-stackQL-resources/key_handles/methods/create' update: [] delete: [] ekm_connections: - id: cloudkms.ekm_connections + id: google.cloudkms.ekm_connections name: ekm_connections title: Ekm_connections methods: @@ -3269,14 +3269,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/ekm_connections/methods/list' - $ref: '#/components/x-stackQL-resources/ekm_connections/methods/get' + - $ref: '#/components/x-stackQL-resources/ekm_connections/methods/list' insert: - $ref: '#/components/x-stackQL-resources/ekm_connections/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/ekm_connections/methods/patch' delete: [] ekm_connections_iam_policies: - id: cloudkms.ekm_connections_iam_policies + id: google.cloudkms.ekm_connections_iam_policies name: ekm_connections_iam_policies title: Ekm_connections_iam_policies methods: @@ -3313,7 +3314,7 @@ components: update: [] delete: [] key_rings: - id: cloudkms.key_rings + id: google.cloudkms.key_rings name: key_rings title: Key_rings methods: @@ -3344,14 +3345,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/key_rings/methods/list' - $ref: '#/components/x-stackQL-resources/key_rings/methods/get' + - $ref: '#/components/x-stackQL-resources/key_rings/methods/list' insert: - $ref: '#/components/x-stackQL-resources/key_rings/methods/create' update: [] delete: [] key_rings_iam_policies: - id: cloudkms.key_rings_iam_policies + id: google.cloudkms.key_rings_iam_policies name: key_rings_iam_policies title: Key_rings_iam_policies methods: @@ -3388,7 +3389,7 @@ components: update: [] delete: [] crypto_keys: - id: cloudkms.crypto_keys + id: google.cloudkms.crypto_keys name: crypto_keys title: Crypto_keys methods: @@ -3440,14 +3441,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/crypto_keys/methods/list' - $ref: '#/components/x-stackQL-resources/crypto_keys/methods/get' + - $ref: '#/components/x-stackQL-resources/crypto_keys/methods/list' insert: - $ref: '#/components/x-stackQL-resources/crypto_keys/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/crypto_keys/methods/patch' delete: [] crypto_keys_primary_version: - id: cloudkms.crypto_keys_primary_version + id: google.cloudkms.crypto_keys_primary_version name: crypto_keys_primary_version title: Crypto_keys_primary_version methods: @@ -3464,7 +3466,7 @@ components: update: [] delete: [] crypto_keys_iam_policies: - id: cloudkms.crypto_keys_iam_policies + id: google.cloudkms.crypto_keys_iam_policies name: crypto_keys_iam_policies title: Crypto_keys_iam_policies methods: @@ -3501,7 +3503,7 @@ components: update: [] delete: [] crypto_key_versions: - id: cloudkms.crypto_key_versions + id: google.cloudkms.crypto_key_versions name: crypto_key_versions title: Crypto_key_versions methods: @@ -3602,15 +3604,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/crypto_key_versions/methods/list' - $ref: '#/components/x-stackQL-resources/crypto_key_versions/methods/get' + - $ref: '#/components/x-stackQL-resources/crypto_key_versions/methods/list' insert: - $ref: >- #/components/x-stackQL-resources/crypto_key_versions/methods/create - update: [] + update: + - $ref: '#/components/x-stackQL-resources/crypto_key_versions/methods/patch' delete: [] crypto_key_versions_public_key: - id: cloudkms.crypto_key_versions_public_key + id: google.cloudkms.crypto_key_versions_public_key name: crypto_key_versions_public_key title: Crypto_key_versions_public_key methods: @@ -3629,7 +3632,7 @@ components: update: [] delete: [] import_jobs: - id: cloudkms.import_jobs + id: google.cloudkms.import_jobs name: import_jobs title: Import_jobs methods: @@ -3660,14 +3663,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/import_jobs/methods/list' - $ref: '#/components/x-stackQL-resources/import_jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/import_jobs/methods/list' insert: - $ref: '#/components/x-stackQL-resources/import_jobs/methods/create' update: [] delete: [] import_jobs_iam_policies: - id: cloudkms.import_jobs_iam_policies + id: google.cloudkms.import_jobs_iam_policies name: import_jobs_iam_policies title: Import_jobs_iam_policies methods: @@ -3704,7 +3707,7 @@ components: update: [] delete: [] ekm_config_iam_policies: - id: cloudkms.ekm_config_iam_policies + id: google.cloudkms.ekm_config_iam_policies name: ekm_config_iam_policies title: Ekm_config_iam_policies methods: 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 1f361767..842c2cfd 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: '20240520' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/profiler/ servers: @@ -304,7 +304,7 @@ components: - '2' x-stackQL-resources: profiles: - id: cloudprofiler.profiles + id: google.cloudprofiler.profiles name: profiles title: Profiles methods: @@ -335,10 +335,11 @@ components: - $ref: '#/components/x-stackQL-resources/profiles/methods/list' insert: - $ref: '#/components/x-stackQL-resources/profiles/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/profiles/methods/patch' delete: [] profiles_offline: - id: cloudprofiler.profiles_offline + id: google.cloudprofiler.profiles_offline name: profiles_offline title: Profiles_offline methods: 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 15166a5f..8fc9b7c3 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: '20240526' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/resource-manager servers: @@ -1665,7 +1665,7 @@ components: - '2' x-stackQL-resources: liens: - id: cloudresourcemanager.liens + id: google.cloudresourcemanager.liens name: liens title: Liens methods: @@ -1699,15 +1699,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/liens/methods/list' - $ref: '#/components/x-stackQL-resources/liens/methods/get' + - $ref: '#/components/x-stackQL-resources/liens/methods/list' insert: - $ref: '#/components/x-stackQL-resources/liens/methods/create' update: [] delete: - $ref: '#/components/x-stackQL-resources/liens/methods/delete' operations: - id: cloudresourcemanager.operations + id: google.cloudresourcemanager.operations name: operations title: Operations methods: @@ -1724,7 +1724,7 @@ components: update: [] delete: [] folders: - id: cloudresourcemanager.folders + id: google.cloudresourcemanager.folders name: folders title: Folders methods: @@ -1786,11 +1786,12 @@ components: - $ref: '#/components/x-stackQL-resources/folders/methods/list' insert: - $ref: '#/components/x-stackQL-resources/folders/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/folders/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/folders/methods/delete' folders_iam_policies: - id: cloudresourcemanager.folders_iam_policies + id: google.cloudresourcemanager.folders_iam_policies name: folders_iam_policies title: Folders_iam_policies methods: @@ -1824,7 +1825,7 @@ components: update: [] delete: [] organizations: - id: cloudresourcemanager.organizations + id: google.cloudresourcemanager.organizations name: organizations title: Organizations methods: @@ -1847,7 +1848,7 @@ components: update: [] delete: [] organizations_iam_policies: - id: cloudresourcemanager.organizations_iam_policies + id: google.cloudresourcemanager.organizations_iam_policies name: organizations_iam_policies title: Organizations_iam_policies methods: @@ -1882,7 +1883,7 @@ components: update: [] delete: [] projects: - id: cloudresourcemanager.projects + id: google.cloudresourcemanager.projects name: projects title: Projects methods: @@ -1944,11 +1945,12 @@ components: - $ref: '#/components/x-stackQL-resources/projects/methods/list' insert: - $ref: '#/components/x-stackQL-resources/projects/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/projects/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/projects/methods/delete' projects_iam_policies: - id: cloudresourcemanager.projects_iam_policies + id: google.cloudresourcemanager.projects_iam_policies name: projects_iam_policies title: Projects_iam_policies methods: @@ -1982,7 +1984,7 @@ components: update: [] delete: [] tag_bindings: - id: cloudresourcemanager.tag_bindings + id: google.cloudresourcemanager.tag_bindings name: tag_bindings title: Tag_bindings methods: @@ -2017,7 +2019,7 @@ components: delete: - $ref: '#/components/x-stackQL-resources/tag_bindings/methods/delete' effective_tags: - id: cloudresourcemanager.effective_tags + id: google.cloudresourcemanager.effective_tags name: effective_tags title: Effective_tags methods: @@ -2038,7 +2040,7 @@ components: update: [] delete: [] tag_keys: - id: cloudresourcemanager.tag_keys + id: google.cloudresourcemanager.tag_keys name: tag_keys title: Tag_keys methods: @@ -2078,15 +2080,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/tag_keys/methods/list' - $ref: '#/components/x-stackQL-resources/tag_keys/methods/get' + - $ref: '#/components/x-stackQL-resources/tag_keys/methods/list' insert: - $ref: '#/components/x-stackQL-resources/tag_keys/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/tag_keys/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/tag_keys/methods/delete' tag_keys_namespaced: - id: cloudresourcemanager.tag_keys_namespaced + id: google.cloudresourcemanager.tag_keys_namespaced name: tag_keys_namespaced title: Tag_keys_namespaced methods: @@ -2104,7 +2107,7 @@ components: update: [] delete: [] tag_keys_iam_policies: - id: cloudresourcemanager.tag_keys_iam_policies + id: google.cloudresourcemanager.tag_keys_iam_policies name: tag_keys_iam_policies title: Tag_keys_iam_policies methods: @@ -2138,7 +2141,7 @@ components: update: [] delete: [] tag_values: - id: cloudresourcemanager.tag_values + id: google.cloudresourcemanager.tag_values name: tag_values title: Tag_values methods: @@ -2178,15 +2181,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/tag_values/methods/list' - $ref: '#/components/x-stackQL-resources/tag_values/methods/get' + - $ref: '#/components/x-stackQL-resources/tag_values/methods/list' insert: - $ref: '#/components/x-stackQL-resources/tag_values/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/tag_values/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/tag_values/methods/delete' tag_values_namespaced: - id: cloudresourcemanager.tag_values_namespaced + id: google.cloudresourcemanager.tag_values_namespaced name: tag_values_namespaced title: Tag_values_namespaced methods: @@ -2204,7 +2208,7 @@ components: update: [] delete: [] tag_values_iam_policies: - id: cloudresourcemanager.tag_values_iam_policies + id: google.cloudresourcemanager.tag_values_iam_policies name: tag_values_iam_policies title: Tag_values_iam_policies methods: @@ -2238,7 +2242,7 @@ components: update: [] delete: [] tag_holds: - id: cloudresourcemanager.tag_holds + id: google.cloudresourcemanager.tag_holds name: tag_holds title: Tag_holds methods: 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 572cfaf6..2cc257a4 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: '20240524' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/scheduler/ servers: @@ -804,7 +804,7 @@ components: - '2' x-stackQL-resources: locations: - id: cloudscheduler.locations + id: google.cloudscheduler.locations name: locations title: Locations methods: @@ -826,13 +826,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] jobs: - id: cloudscheduler.jobs + id: google.cloudscheduler.jobs name: jobs title: Jobs methods: @@ -898,11 +898,12 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/jobs/methods/list' - $ref: '#/components/x-stackQL-resources/jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/jobs/methods/list' insert: - $ref: '#/components/x-stackQL-resources/jobs/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/jobs/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/jobs/methods/delete' paths: 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 32f47d72..4fa372b4 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudshell.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudshell.yaml @@ -10,7 +10,7 @@ info: running in the cloud. version: v1 x-discovery-doc-revision: '20240528' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/shell/docs/ servers: @@ -474,7 +474,7 @@ components: - '2' x-stackQL-resources: operations: - id: cloudshell.operations + id: google.cloudshell.operations name: operations title: Operations methods: @@ -508,14 +508,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' environments: - id: cloudshell.environments + id: google.cloudshell.environments name: environments title: Environments methods: @@ -546,7 +546,7 @@ components: update: [] delete: [] environments_public_key: - id: cloudshell.environments_public_key + id: google.cloudshell.environments_public_key name: environments_public_key title: Environments_public_key methods: 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 ad22fc59..6887afd4 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudsupport.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudsupport.yaml @@ -10,7 +10,7 @@ info: offerings. version: v2 x-discovery-doc-revision: '20240529' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/support/docs/apis servers: @@ -36,156 +36,116 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - Media: + ContentTypeInfo: + type: object properties: - mediaId: - format: byte - description: '# gdata.* are outside protos with mising documentation' - type: string - contentTypeInfo: - $ref: '#/components/schemas/ContentTypeInfo' - description: '# gdata.* are outside protos with mising documentation' - hashVerified: - type: boolean - description: '# gdata.* are outside protos with mising documentation' - hash: - deprecated: true - description: '# gdata.* are outside protos with mising documentation' - type: string - length: - format: int64 - type: string - description: '# gdata.* are outside protos with mising documentation' - algorithm: - deprecated: true + bestGuess: description: '# gdata.* are outside protos with mising documentation' type: string - contentType: - type: string - description: '# gdata.* are outside protos with mising documentation' - diffUploadRequest: - description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/DiffUploadRequest' - downloadParameters: - $ref: '#/components/schemas/DownloadParameters' - description: '# gdata.* are outside protos with mising documentation' - objectId: - $ref: '#/components/schemas/ObjectId' - description: '# gdata.* are outside protos with mising documentation' - cosmoBinaryReference: + fromBytes: description: '# gdata.* are outside protos with mising documentation' type: string - format: byte - md5Hash: + fromHeader: type: string description: '# gdata.* are outside protos with mising documentation' - format: byte - diffUploadResponse: - $ref: '#/components/schemas/DiffUploadResponse' + fromUrlPath: description: '# gdata.* are outside protos with mising documentation' - inline: type: string - description: '# gdata.* are outside protos with mising documentation' - format: byte - timestamp: - format: uint64 + fromFileName: description: '# gdata.* are outside protos with mising documentation' type: string - isPotentialRetry: - description: '# gdata.* are outside protos with mising documentation' - type: boolean - compositeMedia: - description: '# gdata.* are outside protos with mising documentation' - items: - $ref: '#/components/schemas/CompositeMedia' - type: array - diffVersionResponse: - $ref: '#/components/schemas/DiffVersionResponse' - description: '# gdata.* are outside protos with mising documentation' - diffChecksumsResponse: - description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/DiffChecksumsResponse' - blobstore2Info: - $ref: '#/components/schemas/Blobstore2Info' + description: '# gdata.* are outside protos with mising documentation' + id: ContentTypeInfo + DiffDownloadResponse: + description: '# gdata.* are outside protos with mising documentation' + id: DiffDownloadResponse + type: object + properties: + objectLocation: + $ref: '#/components/schemas/CompositeMedia' description: '# gdata.* are outside protos with mising documentation' - sha1Hash: - type: string - format: byte + CloseCaseRequest: + properties: {} + description: The request message for the CloseCase endpoint. + type: object + id: CloseCaseRequest + DiffChecksumsResponse: + properties: + objectSizeBytes: description: '# gdata.* are outside protos with mising documentation' - sha256Hash: type: string - format: byte + format: int64 + objectLocation: + $ref: '#/components/schemas/CompositeMedia' description: '# gdata.* are outside protos with mising documentation' - bigstoreObjectRef: + objectVersion: description: '# gdata.* are outside protos with mising documentation' - format: byte type: string - deprecated: true - filename: + chunkSizeBytes: description: '# gdata.* are outside protos with mising documentation' type: string - path: - type: string - description: '# gdata.* are outside protos with mising documentation' - referenceType: + format: int64 + checksumsLocation: description: '# gdata.* are outside protos with mising documentation' - 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 + $ref: '#/components/schemas/CompositeMedia' + id: DiffChecksumsResponse + description: '# gdata.* are outside protos with mising documentation' + type: object + CaseClassification: + 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 + properties: + displayName: 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' - crc32cHash: - type: integer - description: '# gdata.* are outside protos with mising documentation' - format: uint32 - token: - description: '# gdata.* are outside protos with mising documentation' + 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. + id: type: string - blobRef: - format: byte - deprecated: true + 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. + ListCasesResponse: + description: The response message for the ListCases endpoint. + id: ListCasesResponse + 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: type: string - description: '# gdata.* are outside protos with mising documentation' - diffDownloadResponse: - $ref: '#/components/schemas/DiffDownloadResponse' - description: '# gdata.* are outside protos with mising documentation' + 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: object - id: Media - description: '# gdata.* are outside protos with mising documentation' Escalation: + id: Escalation description: An escalation of a support case. properties: - justification: - description: >- - Required. A free text description to accompany the `reason` field - above. Provides additional context on why the case is being - escalated. - type: string reason: + enum: + - REASON_UNSPECIFIED + - RESOLUTION_TIME + - TECHNICAL_EXPERTISE + - BUSINESS_IMPACT + type: string enumDescriptions: - >- The escalation reason is in an unknown state or has not been @@ -196,490 +156,415 @@ components: successfully resolve the issue. - The issue is having a significant business impact. description: Required. The reason why the Case is being escalated. + justification: + description: >- + Required. A free text description to accompany the `reason` field + above. Provides additional context on why the case is being + escalated. type: string - enum: - - REASON_UNSPECIFIED - - RESOLUTION_TIME - - TECHNICAL_EXPERTISE - - BUSINESS_IMPACT type: object - id: Escalation - CreateAttachmentRequest: - id: CreateAttachmentRequest + EscalateCaseRequest: properties: - attachment: - description: Required. The attachment to be created. - $ref: '#/components/schemas/Attachment' - type: object - description: The request message for the CreateAttachment endpoint. - ObjectId: - description: '# gdata.* are outside protos with mising documentation' + escalation: + $ref: '#/components/schemas/Escalation' + description: The escalation information to be sent with the escalation request. + description: The request message for the EscalateCase endpoint. type: object - id: ObjectId + id: EscalateCaseRequest + SearchCaseClassificationsResponse: + description: The response message for SearchCaseClassifications endpoint. properties: - generation: - type: string - description: '# gdata.* are outside protos with mising documentation' - format: int64 - bucketName: - type: string - description: '# gdata.* are outside protos with mising documentation' - objectName: + caseClassifications: + items: + $ref: '#/components/schemas/CaseClassification' + type: array + description: The classifications retrieved. + nextPageToken: + 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. type: string - description: '# gdata.* are outside protos with mising documentation' - DiffUploadResponse: - description: '# gdata.* are outside protos with mising documentation' type: object + id: SearchCaseClassificationsResponse + 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: - originalObject: - description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/CompositeMedia' - objectVersion: - description: '# gdata.* are outside protos with mising documentation' - type: string - id: DiffUploadResponse - ContentTypeInfo: - id: ContentTypeInfo - type: object - description: '# gdata.* are outside protos with mising documentation' - properties: - fromHeader: - type: string - description: '# gdata.* are outside protos with mising documentation' - bestGuess: - description: '# gdata.* are outside protos with mising documentation' - type: string - fromUrlPath: - description: '# gdata.* are outside protos with mising documentation' - type: string - fromBytes: - description: '# gdata.* are outside protos with mising documentation' - type: string - fromFileName: - type: string - description: '# gdata.* are outside protos with mising documentation' - ListCasesResponse: - type: object - description: The response message for the ListCases endpoint. - properties: - nextPageToken: + classification: + $ref: '#/components/schemas/CaseClassification' + description: The issue classification applicable to this case. + testCase: 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. + Whether this case was created for internal API testing and should + not be acted on by the support team. + type: boolean + state: + enum: + - STATE_UNSPECIFIED + - NEW + - IN_PROGRESS_GOOGLE_SUPPORT + - ACTION_REQUIRED + - SOLUTION_PROVIDED + - CLOSED + 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. + readOnly: true + description: Output only. The current status of the support case. type: string - cases: + subscriberEmailAddresses: + description: The email addresses to receive updates on this case. items: - $ref: '#/components/schemas/Case' - description: >- - The list of cases associated with the parent after any filters have - been applied. + type: string type: array - id: ListCasesResponse - Blobstore2Info: - type: object - id: Blobstore2Info - description: '# gdata.* are outside protos with mising documentation' - properties: - downloadReadHandle: - format: byte - type: string - description: '# gdata.* are outside protos with mising documentation' - blobId: - type: string - description: '# gdata.* are outside protos with mising documentation' - readToken: - description: '# gdata.* are outside protos with mising documentation' + name: type: string - blobGeneration: + description: The resource name for the case. + updateTime: + description: Output only. The time this case was last updated. + readOnly: true + format: google-datetime type: string - description: '# gdata.* are outside protos with mising documentation' - format: int64 - uploadMetadataContainer: + createTime: type: string - format: byte - description: '# gdata.* are outside protos with mising documentation' - EscalateCaseRequest: - type: object - description: The request message for the EscalateCase endpoint. - id: EscalateCaseRequest - properties: - escalation: - description: The escalation information to be sent with the escalation request. - $ref: '#/components/schemas/Escalation' - 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. - properties: - 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 + format: google-datetime + description: Output only. The time this case was created. + 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 displayName: + type: string + description: The short summary of the issue reported in this case. + contactEmail: + 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 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. + priority: type: string - googleSupport: - description: Output only. Whether the actor is a Google support actor. - readOnly: true - type: boolean - email: + description: The priority of this case. + 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: type: string - deprecated: true + description: A broad description of the issue. + creator: + $ref: '#/components/schemas/Actor' 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: object - ListCommentsResponse: - description: The response message for the ListComments endpoint. + The user who created the case. Note: The name and email will be + obfuscated if the case was created by Google Support. + escalated: + type: boolean + description: Whether the case is currently escalated. + 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 type: object - id: ListCommentsResponse + WorkflowOperationMetadata: + description: Metadata about the operation. Used to lookup the current status. + id: WorkflowOperationMetadata properties: - comments: - description: List of the comments associated with the case. - items: - $ref: '#/components/schemas/Comment' - type: array - nextPageToken: + workflowOperationType: + 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. type: string + namespace: 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. + The namespace that the job was scheduled in. Must be included in the + workflow metadata so the workflow status can be retrieved. + type: string + operationAction: + 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. + description: The type of action the operation is classified as. + type: string + enum: + - OPERATION_ACTION_UNSPECIFIED + - CREATE_SUPPORT_ACCOUNT + - UPDATE_SUPPORT_ACCOUNT + - PURCHASE_SUPPORT_ACCOUNT + type: object CompositeMedia: description: '# gdata.* are outside protos with mising documentation' - id: CompositeMedia type: object + id: CompositeMedia properties: - path: - description: '# gdata.* are outside protos with mising documentation' - type: string cosmoBinaryReference: - format: byte type: string + format: byte description: '# gdata.* are outside protos with mising documentation' - objectId: - $ref: '#/components/schemas/ObjectId' - description: '# gdata.* are outside protos with mising documentation' - length: - format: int64 - description: '# gdata.* are outside protos with mising documentation' - type: string 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' - '# 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' - crc32cHash: - description: '# gdata.* are outside protos with mising documentation' - type: integer - format: uint32 - blobRef: type: string - format: byte - description: '# gdata.* are outside protos with mising documentation' - deprecated: true - blobstore2Info: - $ref: '#/components/schemas/Blobstore2Info' - description: '# gdata.* are outside protos with mising documentation' + enum: + - PATH + - BLOB_REF + - INLINE + - BIGSTORE_REF + - COSMO_BINARY_REFERENCE sha1Hash: - description: '# gdata.* are outside protos with mising documentation' type: string - format: byte - md5Hash: description: '# gdata.* are outside protos with mising documentation' format: byte - type: string - inline: - description: '# gdata.* are outside protos with mising documentation' - format: byte - type: string - DiffChecksumsResponse: - type: object - id: DiffChecksumsResponse - description: '# gdata.* are outside protos with mising documentation' - properties: - objectLocation: - $ref: '#/components/schemas/CompositeMedia' - description: '# gdata.* are outside protos with mising documentation' - objectVersion: - type: string - description: '# gdata.* are outside protos with mising documentation' - objectSizeBytes: - description: '# gdata.* are outside protos with mising documentation' - type: string - format: int64 - checksumsLocation: - description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/CompositeMedia' - chunkSizeBytes: - description: '# gdata.* are outside protos with mising documentation' - format: int64 - type: string - DiffVersionResponse: - id: DiffVersionResponse - description: '# gdata.* are outside protos with mising documentation' - properties: - objectSizeBytes: - format: int64 + crc32cHash: + type: integer + format: uint32 description: '# gdata.* are outside protos with mising documentation' + blobstore2Info: + description: '# gdata.* are outside protos with mising documentation' + $ref: '#/components/schemas/Blobstore2Info' + length: type: string - objectVersion: + description: '# gdata.* are outside protos with mising documentation' + format: int64 + blobRef: + deprecated: true type: string description: '# gdata.* are outside protos with mising documentation' - type: object - WorkflowOperationMetadata: - properties: - namespace: + format: byte + objectId: + $ref: '#/components/schemas/ObjectId' + description: '# gdata.* are outside protos with mising documentation' + md5Hash: 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. - workflowOperationType: + format: byte + description: '# gdata.* are outside protos with mising documentation' + inline: + format: byte + description: '# gdata.* are outside protos with mising documentation' 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. - operationAction: - 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 + path: + description: '# gdata.* are outside protos with mising documentation' type: string - description: The type of action the operation is classified as. - type: object - id: WorkflowOperationMetadata - description: Metadata about the operation. Used to lookup the current status. DiffUploadRequest: type: object + id: DiffUploadRequest description: '# gdata.* are outside protos with mising documentation' properties: - objectInfo: - description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/CompositeMedia' checksumsInfo: + $ref: '#/components/schemas/CompositeMedia' description: '# gdata.* are outside protos with mising documentation' + objectInfo: $ref: '#/components/schemas/CompositeMedia' + description: '# gdata.* are outside protos with mising documentation' objectVersion: - type: string description: '# gdata.* are outside protos with mising documentation' - id: DiffUploadRequest - SearchCaseClassificationsResponse: - description: The response message for SearchCaseClassifications endpoint. - type: object + type: string + SearchCasesResponse: properties: nextPageToken: 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. + `page_token` field of subsequent `cases.search` requests. If + unspecified, there are no more results to retrieve. type: string - caseClassifications: + cases: + description: >- + The list of cases associated with the parent after any filters have + been applied. items: - $ref: '#/components/schemas/CaseClassification' + $ref: '#/components/schemas/Case' type: array - description: The classifications retrieved. - id: SearchCaseClassificationsResponse - DiffDownloadResponse: - description: '# gdata.* are outside protos with mising documentation' - properties: - objectLocation: - description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/CompositeMedia' - id: DiffDownloadResponse + description: The response message for the SearchCases endpoint. type: object - CaseClassification: + id: SearchCasesResponse + Actor: 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. - type: string - 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. - id: 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. - 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 + 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. properties: - displayName: - description: The short summary of the issue reported in this case. - type: string - name: - type: string - description: The resource name for the case. - description: + email: type: string - description: A broad description of the issue. - escalated: - description: Whether the case is currently escalated. + 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. + deprecated: true + googleSupport: type: boolean - state: - 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. - type: string - enum: - - STATE_UNSPECIFIED - - NEW - - IN_PROGRESS_GOOGLE_SUPPORT - - ACTION_REQUIRED - - SOLUTION_PROVIDED - - CLOSED - description: Output only. The current status of the support case. readOnly: true - contactEmail: - type: string + description: Output only. Whether the actor is a Google support actor. + username: + readOnly: true 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. - updateTime: + 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. + type: string + displayName: type: string - description: Output only. The time this case was last updated. - format: google-datetime - readOnly: true - classification: - $ref: '#/components/schemas/CaseClassification' - description: The issue classification applicable to this case. - 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' - languageCode: + 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. + id: Actor + CreateAttachmentRequest: + description: The request message for the CreateAttachment endpoint. + id: CreateAttachmentRequest + properties: + attachment: + description: Required. The attachment to be created. + $ref: '#/components/schemas/Attachment' + type: object + DiffUploadResponse: + description: '# gdata.* are outside protos with mising documentation' + type: object + id: DiffUploadResponse + properties: + originalObject: + description: '# gdata.* are outside protos with mising documentation' + $ref: '#/components/schemas/CompositeMedia' + objectVersion: + description: '# gdata.* are outside protos with mising documentation' type: string + ListCommentsResponse: + type: object + properties: + nextPageToken: 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 - createTime: - format: google-datetime + 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. + type: string + comments: + description: List of the comments associated with the case. + type: array + items: + $ref: '#/components/schemas/Comment' + description: The response message for the ListComments endpoint. + id: ListCommentsResponse + Blobstore2Info: + description: '# gdata.* are outside protos with mising documentation' + id: Blobstore2Info + properties: + blobGeneration: + format: int64 + description: '# gdata.* are outside protos with mising documentation' + type: string + readToken: + description: '# gdata.* are outside protos with mising documentation' type: string - readOnly: true - description: Output only. The time this case was created. - testCase: - type: boolean - description: >- - Whether this case was created for internal API testing and should - not be acted on by the support team. - timeZone: + blobId: 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: '# gdata.* are outside protos with mising documentation' + downloadReadHandle: + description: '# gdata.* are outside protos with mising documentation' + format: byte + type: string + uploadMetadataContainer: + format: byte + type: string + description: '# gdata.* are outside protos with mising documentation' + type: object + ListAttachmentsResponse: + properties: + attachments: + description: The list of attachments associated with a case. items: - type: string + $ref: '#/components/schemas/Attachment' type: array - description: The email addresses to receive updates on this case. - priority: - description: The priority of this case. - 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 + nextPageToken: + 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. type: string + id: ListAttachmentsResponse + description: The response message for the ListAttachments endpoint. type: object - Attachment: - id: Attachment + ObjectId: + id: ObjectId + properties: + generation: + description: '# gdata.* are outside protos with mising documentation' + format: int64 + type: string + bucketName: + description: '# gdata.* are outside protos with mising documentation' + type: string + objectName: + type: string + description: '# gdata.* are outside protos with mising documentation' + description: '# gdata.* are outside protos with mising documentation' type: object + Attachment: 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 @@ -687,120 +572,256 @@ components: `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 + id: Attachment properties: - filename: - description: The filename of the attachment (e.g. `"graph.jpg"`). - type: string - creator: - 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. - readOnly: true - $ref: '#/components/schemas/Actor' mimeType: readOnly: true - type: string description: Output only. The MIME type of the attachment (e.g. text/plain). + type: string sizeBytes: - description: Output only. The size of the attachment in bytes. readOnly: true + type: string format: int64 + description: Output only. The size of the attachment in bytes. + name: + description: Output only. The resource name of the attachment. type: string - createTime: readOnly: true - description: Output only. The time at which the attachment was created. + filename: type: string + description: The filename of the attachment (e.g. `"graph.jpg"`). + createTime: + description: Output only. The time at which the attachment was created. + readOnly: true format: google-datetime - name: - description: Output only. The resource name of the attachment. type: string + creator: readOnly: true - ListAttachmentsResponse: - id: ListAttachmentsResponse + 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' + DownloadParameters: type: object - description: The response message for the ListAttachments endpoint. + id: DownloadParameters + description: '# gdata.* are outside protos with mising documentation' properties: - nextPageToken: - 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. + ignoreRange: + description: '# gdata.* are outside protos with mising documentation' + type: boolean + allowGzipCompression: + type: boolean + description: '# gdata.* are outside protos with mising documentation' + Media: + id: Media + properties: + diffDownloadResponse: + $ref: '#/components/schemas/DiffDownloadResponse' + description: '# gdata.* are outside protos with mising documentation' + sha1Hash: + format: byte + type: string + description: '# gdata.* are outside protos with mising documentation' + length: + format: int64 + description: '# gdata.* are outside protos with mising documentation' + type: string + hash: + deprecated: true + type: string + description: '# gdata.* are outside protos with mising documentation' + contentTypeInfo: + $ref: '#/components/schemas/ContentTypeInfo' + description: '# gdata.* are outside protos with mising documentation' + cosmoBinaryReference: + format: byte + type: string + description: '# gdata.* are outside protos with mising documentation' + hashVerified: + description: '# gdata.* are outside protos with mising documentation' + type: boolean + compositeMedia: + description: '# gdata.* are outside protos with mising documentation' + items: + $ref: '#/components/schemas/CompositeMedia' + type: array + crc32cHash: + description: '# gdata.* are outside protos with mising documentation' + type: integer + format: uint32 + sha256Hash: + 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' + isPotentialRetry: + description: '# gdata.* are outside protos with mising documentation' + type: boolean + mediaId: + description: '# gdata.* are outside protos with mising documentation' + format: byte + type: string + downloadParameters: + description: '# gdata.* are outside protos with mising documentation' + $ref: '#/components/schemas/DownloadParameters' + diffChecksumsResponse: + $ref: '#/components/schemas/DiffChecksumsResponse' + description: '# gdata.* are outside protos with mising documentation' + filename: + type: string + description: '# gdata.* are outside protos with mising documentation' + bigstoreObjectRef: + format: byte + description: '# gdata.* are outside protos with mising documentation' + type: string + deprecated: true + timestamp: + type: string + format: uint64 + description: '# gdata.* are outside protos with mising documentation' + diffUploadResponse: + description: '# gdata.* are outside protos with mising documentation' + $ref: '#/components/schemas/DiffUploadResponse' + referenceType: + 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' + 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 + inline: + format: byte + description: '# gdata.* are outside protos with mising documentation' + type: string + 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 + diffVersionResponse: + $ref: '#/components/schemas/DiffVersionResponse' + description: '# gdata.* are outside protos with mising documentation' + blobstore2Info: + description: '# gdata.* are outside protos with mising documentation' + $ref: '#/components/schemas/Blobstore2Info' + path: + type: string + description: '# gdata.* are outside protos with mising documentation' + blobRef: + description: '# gdata.* are outside protos with mising documentation' type: string - attachments: - description: The list of attachments associated with a case. - type: array - items: - $ref: '#/components/schemas/Attachment' - Comment: - properties: - body: + deprecated: true + format: byte + token: + description: '# gdata.* are outside protos with mising documentation' type: string - description: The full comment body. Maximum of 12800 characters. - createTime: - description: Output only. The time when the comment was created. + md5Hash: + format: byte + description: '# gdata.* are outside protos with mising documentation' type: string - readOnly: true - format: google-datetime - name: - readOnly: true + contentType: type: string - description: Output only. Identifier. The resource name of the comment. + description: '# gdata.* are outside protos with mising documentation' + description: '# gdata.* are outside protos with mising documentation' + type: object + Comment: + id: Comment + 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. + properties: creator: - $ref: '#/components/schemas/Actor' + readOnly: true description: >- Output only. The user or Google Support agent who created the comment. + $ref: '#/components/schemas/Actor' + name: + type: string + description: Output only. Identifier. The resource name of the comment. readOnly: true + body: + description: The full comment body. Maximum of 12800 characters. + type: string plainTextBody: description: >- Output only. DEPRECATED. DO NOT USE. A duplicate of the `body` field. This field is only present for legacy reasons. + readOnly: true type: string deprecated: true + createTime: + format: google-datetime + description: Output only. The time when the comment was created. readOnly: true + type: string type: object - id: Comment - 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. - DownloadParameters: - description: '# gdata.* are outside protos with mising documentation' - id: DownloadParameters + DiffVersionResponse: + id: DiffVersionResponse properties: - allowGzipCompression: - description: '# gdata.* are outside protos with mising documentation' - type: boolean - ignoreRange: - type: boolean + objectVersion: description: '# gdata.* are outside protos with mising documentation' - type: object - CloseCaseRequest: - id: CloseCaseRequest - description: The request message for the CloseCase endpoint. - properties: {} - type: object - SearchCasesResponse: - description: The response message for the SearchCases endpoint. - properties: - 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 - cases: - type: array - description: >- - The list of cases associated with the parent after any filters have - been applied. - items: - $ref: '#/components/schemas/Case' + objectSizeBytes: + type: string + format: int64 + description: '# gdata.* are outside protos with mising documentation' + description: '# gdata.* are outside protos with mising documentation' type: object - id: SearchCasesResponse parameters: + _.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 + 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 @@ -816,51 +837,24 @@ components: name: key 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 - 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: >- - 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 - 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 alt: description: Data format for response. in: query @@ -871,268 +865,178 @@ components: - json - media - proto - _.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 + callback: + description: JSONP + in: query + name: callback schema: type: string - enum: - - '1' - - '2' x-stackQL-resources: - case_classifications: - id: cloudsupport.case_classifications - name: case_classifications - title: Case_classifications + comments: + id: google.cloudsupport.comments + name: comments + title: Comments methods: - search: - operation: - $ref: '#/paths/~1v2~1caseClassifications:search/get' - response: + _list: + operation: &ref_1 + $ref: '#/paths/~1v2~1{parentType}~1{parent}~1comments/get' + response: &ref_2 mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - media: - id: cloudsupport.media - name: media - title: Media - methods: - upload: + objectKey: $.comments + list: + operation: *ref_1 + response: *ref_2 + create: operation: - $ref: '#/paths/~1v2~1{parentType}~1{parent}~1attachments/post' + $ref: '#/paths/~1v2~1{parentType}~1{parent}~1comments/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] + select: + - $ref: '#/components/x-stackQL-resources/comments/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/comments/methods/create' update: [] delete: [] attachments: - id: cloudsupport.attachments + id: google.cloudsupport.attachments name: attachments title: Attachments methods: _list: - operation: &ref_1 + operation: &ref_3 $ref: '#/paths/~1v2~1{parentType}~1{parent}~1attachments/get' - response: &ref_2 + response: &ref_4 mediaType: application/json openAPIDocKey: '200' objectKey: $.attachments list: - operation: *ref_1 - response: *ref_2 + operation: *ref_3 + response: *ref_4 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/attachments/methods/list' insert: [] update: [] delete: [] - cases: - id: cloudsupport.cases - name: cases - title: Cases + media: + id: google.cloudsupport.media + name: media + title: Media methods: - get: - operation: - $ref: '#/paths/~1v2~1{name}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - escalate: - operation: - $ref: '#/paths/~1v2~1{name}/post' - response: - mediaType: application/json - openAPIDocKey: '200' - patch: + upload: operation: - $ref: '#/paths/~1v2~1{name}/patch' + $ref: '#/paths/~1v2~1{parentType}~1{parent}~1attachments/post' response: mediaType: application/json openAPIDocKey: '200' - create: + download: operation: - $ref: '#/paths/~1v2~1{parentType}~1{parent}~1cases/post' + $ref: '#/paths/~1v2~1{name}/get' response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 - $ref: '#/paths/~1v2~1{parentType}~1{parent}~1cases/get' - response: &ref_4 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.cases - list: - operation: *ref_3 - response: *ref_4 sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/cases/methods/get' - - $ref: '#/components/x-stackQL-resources/cases/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/cases/methods/create' + select: [] + insert: [] update: [] - delete: [] - comments: - id: cloudsupport.comments - name: comments - title: Comments + delete: [] + cases: + id: google.cloudsupport.cases + name: cases + title: Cases methods: _list: operation: &ref_5 - $ref: '#/paths/~1v2~1{parentType}~1{parent}~1comments/get' + $ref: '#/paths/~1v2~1{parentType}~1{parent}~1cases/get' response: &ref_6 mediaType: application/json openAPIDocKey: '200' - objectKey: $.comments + objectKey: $.cases list: operation: *ref_5 response: *ref_6 create: operation: - $ref: '#/paths/~1v2~1{parentType}~1{parent}~1comments/post' + $ref: '#/paths/~1v2~1{parentType}~1{parent}~1cases/post' + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: '#/paths/~1v2~1{name}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + escalate: + operation: + $ref: '#/paths/~1v2~1{name}/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/comments/methods/list' + - $ref: '#/components/x-stackQL-resources/cases/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/comments/methods/create' + - $ref: '#/components/x-stackQL-resources/cases/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/cases/methods/patch' + 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: [] delete: [] paths: - /v2/caseClassifications:search: + /v2/{parentType}/{parent}/comments: parameters: &ref_7 + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/_.xgafv' - 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 - /v2/{parentType}/{parent}/attachments: - parameters: *ref_7 - 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 + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/callback' get: description: >- - List all the attachments associated with a support case. EXAMPLES: cURL: - ```shell case="projects/some-project/cases/23598314" curl \ --header + 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/attachments" ``` Python: + "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() .attachments() + ) request = ( supportApiService.cases() .comments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ``` - operationId: cloudsupport.cases.attachments.list + operationId: cloudsupport.cases.comments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1144,7 +1048,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListAttachmentsResponse' + $ref: '#/components/schemas/ListCommentsResponse' parameters: - in: path name: parentType @@ -1156,113 +1060,37 @@ paths: 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_7 - 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 - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Case' - parameters: - - in: path - name: name - required: true + - in: query + name: pageToken schema: type: string 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: + 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().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/EscalateCaseRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Case' - parameters: - - in: path - name: name - required: true - schema: - type: string - patch: - description: >- - Update a case. Only some fields can be updated. EXAMPLES: cURL: ```shell - case="projects/some-project/cases/43595344" curl \ --request PATCH \ - --header "Authorization: Bearer $(gcloud auth print-access-token)" \ - --header "Content-Type: application/json" \ --data '{ "priority": "P1" - }' \ "https://cloudsupport.googleapis.com/v2/$case?updateMask=priority" - ``` 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().patch( - name="projects/some-project/cases/43112854", body={ "displayName": "This - is Now a New Title", "priority": "P2", }, ) print(request.execute()) ``` - operationId: cloudsupport.cases.patch + ) 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/Case' + $ref: '#/components/schemas/Comment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1274,34 +1102,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Case' + $ref: '#/components/schemas/Comment' parameters: - in: path - name: name + name: parentType required: true schema: type: string - - in: query - name: updateMask + - in: path + name: parent + required: true schema: type: string - format: google-fieldmask - /v2/{parentType}/{parent}/comments: + /v2/{parentType}/{parent}/attachments: parameters: *ref_7 get: description: >- - List all the comments associated with a case. EXAMPLES: cURL: ```shell - case="projects/some-project/cases/43595344" curl \ --header + 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/comments" ``` Python: + "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() .comments() + ) request = ( supportApiService.cases() .attachments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ``` - operationId: cloudsupport.cases.comments.list + operationId: cloudsupport.cases.attachments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1313,7 +1141,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListCommentsResponse' + $ref: '#/components/schemas/ListAttachmentsResponse' parameters: - in: path name: parentType @@ -1336,26 +1164,30 @@ paths: format: int32 post: 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 \ + 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)" \ - --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( + --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}", - ) 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 + ) 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/Comment' + $ref: '#/components/schemas/CreateAttachmentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1367,7 +1199,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Comment' + $ref: '#/components/schemas/Attachment' parameters: - in: path name: parentType @@ -1381,6 +1213,59 @@ paths: type: string /v2/{parentType}/{parent}/cases: parameters: *ref_7 + get: + 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: + ```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 + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListCasesResponse' + 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 + - in: query + name: filter + schema: + type: string post: description: >- Create a new case and associate it with a parent. It must have the @@ -1435,23 +1320,28 @@ paths: required: true schema: type: string - get: + /v2/{name}: + parameters: *ref_7 + patch: 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: - ```python import googleapiclient.discovery api_version = "v2" - supportApiService = googleapiclient.discovery.build( + Update a case. Only some fields can be updated. EXAMPLES: cURL: ```shell + case="projects/some-project/cases/43595344" curl \ --request PATCH \ + --header "Authorization: Bearer $(gcloud auth print-access-token)" \ + --header "Content-Type: application/json" \ --data '{ "priority": "P1" + }' \ "https://cloudsupport.googleapis.com/v2/$case?updateMask=priority" + ``` 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().patch( + name="projects/some-project/cases/43112854", body={ "displayName": "This + is Now a New Title", "priority": "P2", }, ) print(request.execute()) ``` + operationId: cloudsupport.cases.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Case' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1463,24 +1353,133 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListCasesResponse' + $ref: '#/components/schemas/Case' parameters: - in: path - name: parentType + name: name required: true schema: type: string + - in: query + name: updateMask + schema: + type: string + 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: + ```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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EscalateCaseRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Case' + parameters: - in: path - name: parent + name: name required: true schema: type: string - - in: query - name: pageToken + 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" + 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" + print(request.execute()) ``` + operationId: cloudsupport.media.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/Media' + parameters: + - in: path + name: name + required: true schema: type: string + /v2/caseClassifications:search: + parameters: *ref_7 + 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: filter + name: query schema: type: string - in: query @@ -1488,3 +1487,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/cloudtasks.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudtasks.yaml index ad410485..b25d1e9b 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudtasks.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudtasks.yaml @@ -8,7 +8,7 @@ info: description: Manages the execution of large numbers of distributed requests. version: v2 x-discovery-doc-revision: '20240412' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/tasks/ servers: @@ -1646,7 +1646,7 @@ components: - '2' x-stackQL-resources: locations: - id: cloudtasks.locations + id: google.cloudtasks.locations name: locations title: Locations methods: @@ -1668,13 +1668,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] cmek_config: - id: cloudtasks.cmek_config + id: google.cloudtasks.cmek_config name: cmek_config title: Cmek_config methods: @@ -1700,7 +1700,7 @@ components: update: [] delete: [] queues: - id: cloudtasks.queues + id: google.cloudtasks.queues name: queues title: Queues methods: @@ -1766,15 +1766,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/queues/methods/list' - $ref: '#/components/x-stackQL-resources/queues/methods/get' + - $ref: '#/components/x-stackQL-resources/queues/methods/list' insert: - $ref: '#/components/x-stackQL-resources/queues/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/queues/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/queues/methods/delete' queues_iam_policies: - id: cloudtasks.queues_iam_policies + id: google.cloudtasks.queues_iam_policies name: queues_iam_policies title: Queues_iam_policies methods: @@ -1811,7 +1812,7 @@ components: update: [] delete: [] tasks: - id: cloudtasks.tasks + id: google.cloudtasks.tasks name: tasks title: Tasks methods: @@ -1863,8 +1864,8 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/tasks/methods/list' - $ref: '#/components/x-stackQL-resources/tasks/methods/get' + - $ref: '#/components/x-stackQL-resources/tasks/methods/list' insert: - $ref: '#/components/x-stackQL-resources/tasks/methods/create' update: [] 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 c3a26053..35474020 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: '20240426' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/trace servers: @@ -587,7 +587,7 @@ components: - '2' x-stackQL-resources: traces: - id: cloudtrace.traces + id: google.cloudtrace.traces name: traces title: Traces methods: @@ -603,7 +603,7 @@ components: update: [] delete: [] spans_span: - id: cloudtrace.spans_span + id: google.cloudtrace.spans_span name: spans_span title: Spans_span methods: 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 802a47eb..9ff82bc4 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: '20240520' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/composer/ servers: @@ -1869,7 +1869,7 @@ components: - '2' x-stackQL-resources: operations: - id: composer.operations + id: google.composer.operations name: operations title: Operations methods: @@ -1900,14 +1900,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' environments: - id: composer.environments + id: google.composer.environments name: environments title: Environments methods: @@ -2001,15 +2001,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/environments/methods/list' - $ref: '#/components/x-stackQL-resources/environments/methods/get' + - $ref: '#/components/x-stackQL-resources/environments/methods/list' insert: - $ref: '#/components/x-stackQL-resources/environments/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/environments/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/environments/methods/delete' environments_database_properties: - id: composer.environments_database_properties + id: google.composer.environments_database_properties name: environments_database_properties title: Environments_database_properties methods: @@ -2026,7 +2027,7 @@ components: update: [] delete: [] workloads: - id: composer.workloads + id: google.composer.workloads name: workloads title: Workloads methods: @@ -2048,7 +2049,7 @@ components: update: [] delete: [] user_workloads_secrets: - id: composer.user_workloads_secrets + id: google.composer.user_workloads_secrets name: user_workloads_secrets title: User_workloads_secrets methods: @@ -2093,19 +2094,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/user_workloads_secrets/methods/list - $ref: >- #/components/x-stackQL-resources/user_workloads_secrets/methods/get + - $ref: >- + #/components/x-stackQL-resources/user_workloads_secrets/methods/list insert: - $ref: >- #/components/x-stackQL-resources/user_workloads_secrets/methods/create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/user_workloads_secrets/methods/update delete: - $ref: >- #/components/x-stackQL-resources/user_workloads_secrets/methods/delete user_workloads_config_maps: - id: composer.user_workloads_config_maps + id: google.composer.user_workloads_config_maps name: user_workloads_config_maps title: User_workloads_config_maps methods: @@ -2150,19 +2153,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/user_workloads_config_maps/methods/list - $ref: >- #/components/x-stackQL-resources/user_workloads_config_maps/methods/get + - $ref: >- + #/components/x-stackQL-resources/user_workloads_config_maps/methods/list insert: - $ref: >- #/components/x-stackQL-resources/user_workloads_config_maps/methods/create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/user_workloads_config_maps/methods/update delete: - $ref: >- #/components/x-stackQL-resources/user_workloads_config_maps/methods/delete image_versions: - id: composer.image_versions + id: google.composer.image_versions name: image_versions title: Image_versions methods: 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 01623612..530f4578 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: '20240526' - x-generated-date: '2024-06-02' + x-discovery-doc-revision: '20240521' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/compute/ servers: @@ -58980,7 +58980,7 @@ components: description: >- Represents a Zone resource. A zone is a deployment area. These deployment areas are subsets of a region. For example the zone - us-east1-b is located in the us-east1 region. For more information, read + us-east1-a is located in the us-east1 region. For more information, read Regions and Zones. type: object properties: @@ -59155,7 +59155,7 @@ components: - '2' x-stackQL-resources: accelerator_types: - id: compute.accelerator_types + id: google.compute.accelerator_types name: accelerator_types title: Accelerator_types methods: @@ -59184,15 +59184,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/accelerator_types/methods/get' - $ref: '#/components/x-stackQL-resources/accelerator_types/methods/list' - $ref: >- #/components/x-stackQL-resources/accelerator_types/methods/aggregated_list - - $ref: '#/components/x-stackQL-resources/accelerator_types/methods/get' insert: [] update: [] delete: [] global_operations: - id: compute.global_operations + id: google.compute.global_operations name: global_operations title: Global_operations methods: @@ -59224,14 +59224,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/global_operations/methods/list' - $ref: '#/components/x-stackQL-resources/global_operations/methods/get' + - $ref: '#/components/x-stackQL-resources/global_operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/global_operations/methods/delete' global_operations_aggregated: - id: compute.global_operations_aggregated + id: google.compute.global_operations_aggregated name: global_operations_aggregated title: Global_operations_aggregated methods: @@ -59253,7 +59253,7 @@ components: update: [] delete: [] global_organization_operations: - id: compute.global_organization_operations + id: google.compute.global_organization_operations name: global_organization_operations title: Global_organization_operations methods: @@ -59277,17 +59277,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/global_organization_operations/methods/list - $ref: >- #/components/x-stackQL-resources/global_organization_operations/methods/get + - $ref: >- + #/components/x-stackQL-resources/global_organization_operations/methods/list insert: [] update: [] delete: - $ref: >- #/components/x-stackQL-resources/global_organization_operations/methods/delete zone_operations: - id: compute.zone_operations + id: google.compute.zone_operations name: zone_operations title: Zone_operations methods: @@ -59320,14 +59320,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/zone_operations/methods/list' - $ref: '#/components/x-stackQL-resources/zone_operations/methods/get' + - $ref: '#/components/x-stackQL-resources/zone_operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/zone_operations/methods/delete' region_operations: - id: compute.region_operations + id: google.compute.region_operations name: region_operations title: Region_operations methods: @@ -59360,14 +59360,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/region_operations/methods/list' - $ref: '#/components/x-stackQL-resources/region_operations/methods/get' + - $ref: '#/components/x-stackQL-resources/region_operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/region_operations/methods/delete' global_addresses: - id: compute.global_addresses + id: google.compute.global_addresses name: global_addresses title: Global_addresses methods: @@ -59411,15 +59411,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/global_addresses/methods/list' - $ref: '#/components/x-stackQL-resources/global_addresses/methods/get' + - $ref: '#/components/x-stackQL-resources/global_addresses/methods/list' insert: - $ref: '#/components/x-stackQL-resources/global_addresses/methods/insert' update: [] delete: - $ref: '#/components/x-stackQL-resources/global_addresses/methods/delete' addresses: - id: compute.addresses + id: google.compute.addresses name: addresses title: Addresses methods: @@ -59475,16 +59475,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/addresses/methods/get' - $ref: '#/components/x-stackQL-resources/addresses/methods/list' - $ref: '#/components/x-stackQL-resources/addresses/methods/aggregated_list' - - $ref: '#/components/x-stackQL-resources/addresses/methods/get' insert: - $ref: '#/components/x-stackQL-resources/addresses/methods/insert' update: [] delete: - $ref: '#/components/x-stackQL-resources/addresses/methods/delete' images: - id: compute.images + id: google.compute.images name: images title: Images methods: @@ -59534,15 +59534,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/images/methods/list' - $ref: '#/components/x-stackQL-resources/images/methods/get' + - $ref: '#/components/x-stackQL-resources/images/methods/list' insert: - $ref: '#/components/x-stackQL-resources/images/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/images/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/images/methods/delete' images_from_family: - id: compute.images_from_family + id: google.compute.images_from_family name: images_from_family title: Images_from_family methods: @@ -59561,7 +59562,7 @@ components: update: [] delete: [] images_iam_policies: - id: compute.images_iam_policies + id: google.compute.images_iam_policies name: images_iam_policies title: Images_iam_policies methods: @@ -59598,7 +59599,7 @@ components: update: [] delete: [] image_family_views: - id: compute.image_family_views + id: google.compute.image_family_views name: image_family_views title: Image_family_views methods: @@ -59616,7 +59617,7 @@ components: update: [] delete: [] snapshots: - id: compute.snapshots + id: google.compute.snapshots name: snapshots title: Snapshots methods: @@ -59654,15 +59655,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/snapshots/methods/list' - $ref: '#/components/x-stackQL-resources/snapshots/methods/get' + - $ref: '#/components/x-stackQL-resources/snapshots/methods/list' insert: - $ref: '#/components/x-stackQL-resources/snapshots/methods/insert' update: [] delete: - $ref: '#/components/x-stackQL-resources/snapshots/methods/delete' snapshots_iam_policies: - id: compute.snapshots_iam_policies + id: google.compute.snapshots_iam_policies name: snapshots_iam_policies title: Snapshots_iam_policies methods: @@ -59699,7 +59700,7 @@ components: update: [] delete: [] disks: - id: compute.disks + id: google.compute.disks name: disks title: Disks methods: @@ -59787,16 +59788,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/disks/methods/get' - $ref: '#/components/x-stackQL-resources/disks/methods/list' - $ref: '#/components/x-stackQL-resources/disks/methods/aggregated_list' - - $ref: '#/components/x-stackQL-resources/disks/methods/get' insert: - $ref: '#/components/x-stackQL-resources/disks/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/disks/methods/update' delete: - $ref: '#/components/x-stackQL-resources/disks/methods/delete' disks_snapshot: - id: compute.disks_snapshot + id: google.compute.disks_snapshot name: disks_snapshot title: Disks_snapshot methods: @@ -59815,7 +59817,7 @@ components: update: [] delete: [] disks_resource_policies: - id: compute.disks_resource_policies + id: google.compute.disks_resource_policies name: disks_resource_policies title: Disks_resource_policies methods: @@ -59839,7 +59841,7 @@ components: update: [] delete: [] disks_iam_policies: - id: compute.disks_iam_policies + id: google.compute.disks_iam_policies name: disks_iam_policies title: Disks_iam_policies methods: @@ -59876,7 +59878,7 @@ components: update: [] delete: [] region_disks: - id: compute.region_disks + id: google.compute.region_disks name: region_disks title: Region_disks methods: @@ -59957,15 +59959,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/region_disks/methods/list' - $ref: '#/components/x-stackQL-resources/region_disks/methods/get' + - $ref: '#/components/x-stackQL-resources/region_disks/methods/list' insert: - $ref: '#/components/x-stackQL-resources/region_disks/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/region_disks/methods/update' delete: - $ref: '#/components/x-stackQL-resources/region_disks/methods/delete' region_disks_snapshot: - id: compute.region_disks_snapshot + id: google.compute.region_disks_snapshot name: region_disks_snapshot title: Region_disks_snapshot methods: @@ -59984,7 +59987,7 @@ components: update: [] delete: [] region_disks_resource_policies: - id: compute.region_disks_resource_policies + id: google.compute.region_disks_resource_policies name: region_disks_resource_policies title: Region_disks_resource_policies methods: @@ -60008,7 +60011,7 @@ components: update: [] delete: [] region_disks_iam_policies: - id: compute.region_disks_iam_policies + id: google.compute.region_disks_iam_policies name: region_disks_iam_policies title: Region_disks_iam_policies methods: @@ -60045,7 +60048,7 @@ components: update: [] delete: [] firewalls: - id: compute.firewalls + id: google.compute.firewalls name: firewalls title: Firewalls methods: @@ -60088,15 +60091,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/firewalls/methods/list' - $ref: '#/components/x-stackQL-resources/firewalls/methods/get' + - $ref: '#/components/x-stackQL-resources/firewalls/methods/list' insert: - $ref: '#/components/x-stackQL-resources/firewalls/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/firewalls/methods/update' + - $ref: '#/components/x-stackQL-resources/firewalls/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/firewalls/methods/delete' firewall_policies: - id: compute.firewall_policies + id: google.compute.firewall_policies name: firewall_policies title: Firewall_policies methods: @@ -60156,15 +60161,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/firewall_policies/methods/list' - $ref: '#/components/x-stackQL-resources/firewall_policies/methods/get' + - $ref: '#/components/x-stackQL-resources/firewall_policies/methods/list' insert: - $ref: '#/components/x-stackQL-resources/firewall_policies/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/firewall_policies/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/firewall_policies/methods/delete' firewall_policies_rule: - id: compute.firewall_policies_rule + id: google.compute.firewall_policies_rule name: firewall_policies_rule title: Firewall_policies_rule methods: @@ -60197,7 +60203,7 @@ components: update: [] delete: [] firewall_policies_association: - id: compute.firewall_policies_association + id: google.compute.firewall_policies_association name: firewall_policies_association title: Firewall_policies_association methods: @@ -60230,7 +60236,7 @@ components: update: [] delete: [] firewall_policies_associations: - id: compute.firewall_policies_associations + id: google.compute.firewall_policies_associations name: firewall_policies_associations title: Firewall_policies_associations methods: @@ -60249,7 +60255,7 @@ components: update: [] delete: [] firewall_policies_iam_policies: - id: compute.firewall_policies_iam_policies + id: google.compute.firewall_policies_iam_policies name: firewall_policies_iam_policies title: Firewall_policies_iam_policies methods: @@ -60286,7 +60292,7 @@ components: update: [] delete: [] network_firewall_policies: - id: compute.network_firewall_policies + id: google.compute.network_firewall_policies name: network_firewall_policies title: Network_firewall_policies methods: @@ -60339,19 +60345,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/network_firewall_policies/methods/list - $ref: >- #/components/x-stackQL-resources/network_firewall_policies/methods/get + - $ref: >- + #/components/x-stackQL-resources/network_firewall_policies/methods/list insert: - $ref: >- #/components/x-stackQL-resources/network_firewall_policies/methods/insert - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/network_firewall_policies/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/network_firewall_policies/methods/delete network_firewall_policies_rule: - id: compute.network_firewall_policies_rule + id: google.compute.network_firewall_policies_rule name: network_firewall_policies_rule title: Network_firewall_policies_rule methods: @@ -60384,7 +60392,7 @@ components: update: [] delete: [] network_firewall_policies_iam_policies: - id: compute.network_firewall_policies_iam_policies + id: google.compute.network_firewall_policies_iam_policies name: network_firewall_policies_iam_policies title: Network_firewall_policies_iam_policies methods: @@ -60421,7 +60429,7 @@ components: update: [] delete: [] network_firewall_policies_association: - id: compute.network_firewall_policies_association + id: google.compute.network_firewall_policies_association name: network_firewall_policies_association title: Network_firewall_policies_association methods: @@ -60454,7 +60462,7 @@ components: update: [] delete: [] region_network_firewall_policies: - id: compute.region_network_firewall_policies + id: google.compute.region_network_firewall_policies name: region_network_firewall_policies title: Region_network_firewall_policies methods: @@ -60509,19 +60517,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/region_network_firewall_policies/methods/list - $ref: >- #/components/x-stackQL-resources/region_network_firewall_policies/methods/get + - $ref: >- + #/components/x-stackQL-resources/region_network_firewall_policies/methods/list insert: - $ref: >- #/components/x-stackQL-resources/region_network_firewall_policies/methods/insert - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/region_network_firewall_policies/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/region_network_firewall_policies/methods/delete region_network_firewall_policies_rule: - id: compute.region_network_firewall_policies_rule + id: google.compute.region_network_firewall_policies_rule name: region_network_firewall_policies_rule title: Region_network_firewall_policies_rule methods: @@ -60554,7 +60564,7 @@ components: update: [] delete: [] region_network_firewall_policies_association: - id: compute.region_network_firewall_policies_association + id: google.compute.region_network_firewall_policies_association name: region_network_firewall_policies_association title: Region_network_firewall_policies_association methods: @@ -60587,7 +60597,7 @@ components: update: [] delete: [] region_network_firewall_policies_effective_firewalls: - id: compute.region_network_firewall_policies_effective_firewalls + id: google.compute.region_network_firewall_policies_effective_firewalls name: region_network_firewall_policies_effective_firewalls title: Region_network_firewall_policies_effective_firewalls methods: @@ -60606,7 +60616,7 @@ components: update: [] delete: [] region_network_firewall_policies_iam_policies: - id: compute.region_network_firewall_policies_iam_policies + id: google.compute.region_network_firewall_policies_iam_policies name: region_network_firewall_policies_iam_policies title: Region_network_firewall_policies_iam_policies methods: @@ -60643,7 +60653,7 @@ components: update: [] delete: [] security_policies: - id: compute.security_policies + id: google.compute.security_policies name: security_policies title: Security_policies methods: @@ -60696,15 +60706,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/security_policies/methods/list' - $ref: '#/components/x-stackQL-resources/security_policies/methods/get' + - $ref: '#/components/x-stackQL-resources/security_policies/methods/list' insert: - $ref: '#/components/x-stackQL-resources/security_policies/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/security_policies/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/security_policies/methods/delete' security_policies_rule: - id: compute.security_policies_rule + id: google.compute.security_policies_rule name: security_policies_rule title: Security_policies_rule methods: @@ -60737,7 +60748,7 @@ components: update: [] delete: [] security_policies_preconfigured_expression_sets: - id: compute.security_policies_preconfigured_expression_sets + id: google.compute.security_policies_preconfigured_expression_sets name: security_policies_preconfigured_expression_sets title: Security_policies_preconfigured_expression_sets methods: @@ -60756,7 +60767,7 @@ components: update: [] delete: [] security_policies_aggregated: - id: compute.security_policies_aggregated + id: google.compute.security_policies_aggregated name: security_policies_aggregated title: Security_policies_aggregated methods: @@ -60778,7 +60789,7 @@ components: update: [] delete: [] region_security_policies: - id: compute.region_security_policies + id: google.compute.region_security_policies name: region_security_policies title: Region_security_policies methods: @@ -60826,19 +60837,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/region_security_policies/methods/list - $ref: >- #/components/x-stackQL-resources/region_security_policies/methods/get + - $ref: >- + #/components/x-stackQL-resources/region_security_policies/methods/list insert: - $ref: >- #/components/x-stackQL-resources/region_security_policies/methods/insert - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/region_security_policies/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/region_security_policies/methods/delete region_security_policies_rule: - id: compute.region_security_policies_rule + id: google.compute.region_security_policies_rule name: region_security_policies_rule title: Region_security_policies_rule methods: @@ -60871,7 +60884,7 @@ components: update: [] delete: [] instances: - id: compute.instances + id: google.compute.instances name: instances title: Instances methods: @@ -61095,16 +61108,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/instances/methods/get' - $ref: '#/components/x-stackQL-resources/instances/methods/list' - $ref: '#/components/x-stackQL-resources/instances/methods/aggregated_list' - - $ref: '#/components/x-stackQL-resources/instances/methods/get' insert: - $ref: '#/components/x-stackQL-resources/instances/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/instances/methods/update' delete: - $ref: '#/components/x-stackQL-resources/instances/methods/delete' instances_referrers: - id: compute.instances_referrers + id: google.compute.instances_referrers name: instances_referrers title: Instances_referrers methods: @@ -61123,7 +61137,7 @@ components: update: [] delete: [] instances_access_config: - id: compute.instances_access_config + id: google.compute.instances_access_config name: instances_access_config title: Instances_access_config methods: @@ -61154,7 +61168,7 @@ components: update: [] delete: [] instances_network_interface: - id: compute.instances_network_interface + id: google.compute.instances_network_interface name: instances_network_interface title: Instances_network_interface methods: @@ -61171,7 +61185,7 @@ components: update: [] delete: [] instances_serial_port_output: - id: compute.instances_serial_port_output + id: google.compute.instances_serial_port_output name: instances_serial_port_output title: Instances_serial_port_output methods: @@ -61190,7 +61204,7 @@ components: update: [] delete: [] instances_screenshot: - id: compute.instances_screenshot + id: google.compute.instances_screenshot name: instances_screenshot title: Instances_screenshot methods: @@ -61209,7 +61223,7 @@ components: update: [] delete: [] instances_guest_attributes: - id: compute.instances_guest_attributes + id: google.compute.instances_guest_attributes name: instances_guest_attributes title: Instances_guest_attributes methods: @@ -61228,7 +61242,7 @@ components: update: [] delete: [] instances_iam_policies: - id: compute.instances_iam_policies + id: google.compute.instances_iam_policies name: instances_iam_policies title: Instances_iam_policies methods: @@ -61265,7 +61279,7 @@ components: update: [] delete: [] instances_resource_policies: - id: compute.instances_resource_policies + id: google.compute.instances_resource_policies name: instances_resource_policies title: Instances_resource_policies methods: @@ -61289,7 +61303,7 @@ components: update: [] delete: [] instances_shielded_instance_config: - id: compute.instances_shielded_instance_config + id: google.compute.instances_shielded_instance_config name: instances_shielded_instance_config title: Instances_shielded_instance_config methods: @@ -61306,7 +61320,7 @@ components: update: [] delete: [] instances_display_device: - id: compute.instances_display_device + id: google.compute.instances_display_device name: instances_display_device title: Instances_display_device methods: @@ -61323,7 +61337,7 @@ components: update: [] delete: [] instances_shielded_instance_identity: - id: compute.instances_shielded_instance_identity + id: google.compute.instances_shielded_instance_identity name: instances_shielded_instance_identity title: Instances_shielded_instance_identity methods: @@ -61342,7 +61356,7 @@ components: update: [] delete: [] instances_effective_firewalls: - id: compute.instances_effective_firewalls + id: google.compute.instances_effective_firewalls name: instances_effective_firewalls title: Instances_effective_firewalls methods: @@ -61361,7 +61375,7 @@ components: update: [] delete: [] region_instances: - id: compute.region_instances + id: google.compute.region_instances name: region_instances title: Region_instances methods: @@ -61378,7 +61392,7 @@ components: update: [] delete: [] reservations: - id: compute.reservations + id: google.compute.reservations name: reservations title: Reservations methods: @@ -61434,17 +61448,18 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/reservations/methods/get' - $ref: '#/components/x-stackQL-resources/reservations/methods/list' - $ref: >- #/components/x-stackQL-resources/reservations/methods/aggregated_list - - $ref: '#/components/x-stackQL-resources/reservations/methods/get' insert: - $ref: '#/components/x-stackQL-resources/reservations/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/reservations/methods/update' delete: - $ref: '#/components/x-stackQL-resources/reservations/methods/delete' reservations_iam_policies: - id: compute.reservations_iam_policies + id: google.compute.reservations_iam_policies name: reservations_iam_policies title: Reservations_iam_policies methods: @@ -61481,7 +61496,7 @@ components: update: [] delete: [] instance_groups: - id: compute.instance_groups + id: google.compute.instance_groups name: instance_groups title: Instance_groups methods: @@ -61530,17 +61545,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/instance_groups/methods/get' - $ref: '#/components/x-stackQL-resources/instance_groups/methods/list' - $ref: >- #/components/x-stackQL-resources/instance_groups/methods/aggregated_list - - $ref: '#/components/x-stackQL-resources/instance_groups/methods/get' insert: - $ref: '#/components/x-stackQL-resources/instance_groups/methods/insert' update: [] delete: - $ref: '#/components/x-stackQL-resources/instance_groups/methods/delete' instance_groups_instances: - id: compute.instance_groups_instances + id: google.compute.instance_groups_instances name: instance_groups_instances title: Instance_groups_instances methods: @@ -61571,7 +61586,7 @@ components: update: [] delete: [] region_instance_groups: - id: compute.region_instance_groups + id: google.compute.region_instance_groups name: region_instance_groups title: Region_instance_groups methods: @@ -61598,15 +61613,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/region_instance_groups/methods/list - $ref: >- #/components/x-stackQL-resources/region_instance_groups/methods/get + - $ref: >- + #/components/x-stackQL-resources/region_instance_groups/methods/list insert: [] update: [] delete: [] region_instance_groups_instances: - id: compute.region_instance_groups_instances + id: google.compute.region_instance_groups_instances name: region_instance_groups_instances title: Region_instance_groups_instances methods: @@ -61623,7 +61638,7 @@ components: update: [] delete: [] instance_group_managers: - id: compute.instance_group_managers + id: google.compute.instance_group_managers name: instance_group_managers title: Instance_group_managers methods: @@ -61724,21 +61739,23 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: >- + #/components/x-stackQL-resources/instance_group_managers/methods/get - $ref: >- #/components/x-stackQL-resources/instance_group_managers/methods/list - $ref: >- #/components/x-stackQL-resources/instance_group_managers/methods/aggregated_list - - $ref: >- - #/components/x-stackQL-resources/instance_group_managers/methods/get insert: - $ref: >- #/components/x-stackQL-resources/instance_group_managers/methods/insert - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/instance_group_managers/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/instance_group_managers/methods/delete instance_group_managers_instances: - id: compute.instance_group_managers_instances + id: google.compute.instance_group_managers_instances name: instance_group_managers_instances title: Instance_group_managers_instances methods: @@ -61764,7 +61781,7 @@ components: update: [] delete: [] instance_group_managers_managed_instances: - id: compute.instance_group_managers_managed_instances + id: google.compute.instance_group_managers_managed_instances name: instance_group_managers_managed_instances title: Instance_group_managers_managed_instances methods: @@ -61781,7 +61798,7 @@ components: update: [] delete: [] instance_group_managers_errors: - id: compute.instance_group_managers_errors + id: google.compute.instance_group_managers_errors name: instance_group_managers_errors title: Instance_group_managers_errors methods: @@ -61800,7 +61817,7 @@ components: update: [] delete: [] instance_group_managers_per_instance_configs: - id: compute.instance_group_managers_per_instance_configs + id: google.compute.instance_group_managers_per_instance_configs name: instance_group_managers_per_instance_configs title: Instance_group_managers_per_instance_configs methods: @@ -61831,7 +61848,7 @@ components: update: [] delete: [] instance_group_manager_resize_requests: - id: compute.instance_group_manager_resize_requests + id: google.compute.instance_group_manager_resize_requests name: instance_group_manager_resize_requests title: Instance_group_manager_resize_requests methods: @@ -61884,7 +61901,7 @@ components: - $ref: >- #/components/x-stackQL-resources/instance_group_manager_resize_requests/methods/delete region_instance_group_managers: - id: compute.region_instance_group_managers + id: google.compute.region_instance_group_managers name: region_instance_group_managers title: Region_instance_group_managers methods: @@ -61974,19 +61991,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/region_instance_group_managers/methods/list - $ref: >- #/components/x-stackQL-resources/region_instance_group_managers/methods/get + - $ref: >- + #/components/x-stackQL-resources/region_instance_group_managers/methods/list insert: - $ref: >- #/components/x-stackQL-resources/region_instance_group_managers/methods/insert - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/region_instance_group_managers/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/region_instance_group_managers/methods/delete region_instance_group_managers_instances: - id: compute.region_instance_group_managers_instances + id: google.compute.region_instance_group_managers_instances name: region_instance_group_managers_instances title: Region_instance_group_managers_instances methods: @@ -62012,7 +62031,7 @@ components: update: [] delete: [] region_instance_group_managers_managed_instances: - id: compute.region_instance_group_managers_managed_instances + id: google.compute.region_instance_group_managers_managed_instances name: region_instance_group_managers_managed_instances title: Region_instance_group_managers_managed_instances methods: @@ -62029,7 +62048,7 @@ components: update: [] delete: [] region_instance_group_managers_errors: - id: compute.region_instance_group_managers_errors + id: google.compute.region_instance_group_managers_errors name: region_instance_group_managers_errors title: Region_instance_group_managers_errors methods: @@ -62048,7 +62067,7 @@ components: update: [] delete: [] region_instance_group_managers_per_instance_configs: - id: compute.region_instance_group_managers_per_instance_configs + id: google.compute.region_instance_group_managers_per_instance_configs name: region_instance_group_managers_per_instance_configs title: Region_instance_group_managers_per_instance_configs methods: @@ -62079,7 +62098,7 @@ components: update: [] delete: [] autoscalers: - id: compute.autoscalers + id: google.compute.autoscalers name: autoscalers title: Autoscalers methods: @@ -62133,17 +62152,19 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/autoscalers/methods/get' - $ref: '#/components/x-stackQL-resources/autoscalers/methods/list' - $ref: >- #/components/x-stackQL-resources/autoscalers/methods/aggregated_list - - $ref: '#/components/x-stackQL-resources/autoscalers/methods/get' insert: - $ref: '#/components/x-stackQL-resources/autoscalers/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/autoscalers/methods/update' + - $ref: '#/components/x-stackQL-resources/autoscalers/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/autoscalers/methods/delete' region_autoscalers: - id: compute.region_autoscalers + id: google.compute.region_autoscalers name: region_autoscalers title: Region_autoscalers methods: @@ -62188,15 +62209,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/region_autoscalers/methods/list' - $ref: '#/components/x-stackQL-resources/region_autoscalers/methods/get' + - $ref: '#/components/x-stackQL-resources/region_autoscalers/methods/list' insert: - $ref: '#/components/x-stackQL-resources/region_autoscalers/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/region_autoscalers/methods/update' + - $ref: '#/components/x-stackQL-resources/region_autoscalers/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/region_autoscalers/methods/delete' backend_buckets: - id: compute.backend_buckets + id: google.compute.backend_buckets name: backend_buckets title: Backend_buckets methods: @@ -62249,15 +62272,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/backend_buckets/methods/list' - $ref: '#/components/x-stackQL-resources/backend_buckets/methods/get' + - $ref: '#/components/x-stackQL-resources/backend_buckets/methods/list' insert: - $ref: '#/components/x-stackQL-resources/backend_buckets/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/backend_buckets/methods/update' + - $ref: '#/components/x-stackQL-resources/backend_buckets/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/backend_buckets/methods/delete' backend_buckets_signed_url_key: - id: compute.backend_buckets_signed_url_key + id: google.compute.backend_buckets_signed_url_key name: backend_buckets_signed_url_key title: Backend_buckets_signed_url_key methods: @@ -62281,7 +62306,7 @@ components: update: [] delete: [] backend_buckets_iam_policies: - id: compute.backend_buckets_iam_policies + id: google.compute.backend_buckets_iam_policies name: backend_buckets_iam_policies title: Backend_buckets_iam_policies methods: @@ -62318,7 +62343,7 @@ components: update: [] delete: [] backend_services: - id: compute.backend_services + id: google.compute.backend_services name: backend_services title: Backend_services methods: @@ -62378,15 +62403,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/backend_services/methods/list' - $ref: '#/components/x-stackQL-resources/backend_services/methods/get' + - $ref: '#/components/x-stackQL-resources/backend_services/methods/list' insert: - $ref: '#/components/x-stackQL-resources/backend_services/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/backend_services/methods/update' + - $ref: '#/components/x-stackQL-resources/backend_services/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/backend_services/methods/delete' backend_services_aggregated: - id: compute.backend_services_aggregated + id: google.compute.backend_services_aggregated name: backend_services_aggregated title: Backend_services_aggregated methods: @@ -62408,7 +62435,7 @@ components: update: [] delete: [] backend_services_usable: - id: compute.backend_services_usable + id: google.compute.backend_services_usable name: backend_services_usable title: Backend_services_usable methods: @@ -62427,7 +62454,7 @@ components: update: [] delete: [] backend_services_signed_url_key: - id: compute.backend_services_signed_url_key + id: google.compute.backend_services_signed_url_key name: backend_services_signed_url_key title: Backend_services_signed_url_key methods: @@ -62451,7 +62478,7 @@ components: update: [] delete: [] backend_services_health: - id: compute.backend_services_health + id: google.compute.backend_services_health name: backend_services_health title: Backend_services_health methods: @@ -62468,7 +62495,7 @@ components: update: [] delete: [] backend_services_iam_policies: - id: compute.backend_services_iam_policies + id: google.compute.backend_services_iam_policies name: backend_services_iam_policies title: Backend_services_iam_policies methods: @@ -62505,7 +62532,7 @@ components: update: [] delete: [] region_backend_services: - id: compute.region_backend_services + id: google.compute.region_backend_services name: region_backend_services title: Region_backend_services methods: @@ -62560,19 +62587,23 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/region_backend_services/methods/list - $ref: >- #/components/x-stackQL-resources/region_backend_services/methods/get + - $ref: >- + #/components/x-stackQL-resources/region_backend_services/methods/list insert: - $ref: >- #/components/x-stackQL-resources/region_backend_services/methods/insert - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/region_backend_services/methods/update + - $ref: >- + #/components/x-stackQL-resources/region_backend_services/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/region_backend_services/methods/delete region_backend_services_usable: - id: compute.region_backend_services_usable + id: google.compute.region_backend_services_usable name: region_backend_services_usable title: Region_backend_services_usable methods: @@ -62591,7 +62622,7 @@ components: update: [] delete: [] region_backend_services_health: - id: compute.region_backend_services_health + id: google.compute.region_backend_services_health name: region_backend_services_health title: Region_backend_services_health methods: @@ -62608,7 +62639,7 @@ components: update: [] delete: [] region_backend_services_iam_policies: - id: compute.region_backend_services_iam_policies + id: google.compute.region_backend_services_iam_policies name: region_backend_services_iam_policies title: Region_backend_services_iam_policies methods: @@ -62645,7 +62676,7 @@ components: update: [] delete: [] region_commitments: - id: compute.region_commitments + id: google.compute.region_commitments name: region_commitments title: Region_commitments methods: @@ -62687,16 +62718,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/region_commitments/methods/get' - $ref: '#/components/x-stackQL-resources/region_commitments/methods/list' - $ref: >- #/components/x-stackQL-resources/region_commitments/methods/aggregated_list - - $ref: '#/components/x-stackQL-resources/region_commitments/methods/get' insert: - $ref: '#/components/x-stackQL-resources/region_commitments/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/region_commitments/methods/update' delete: [] disk_types: - id: compute.disk_types + id: google.compute.disk_types name: disk_types title: Disk_types methods: @@ -62725,15 +62757,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/disk_types/methods/get' - $ref: '#/components/x-stackQL-resources/disk_types/methods/list' - $ref: >- #/components/x-stackQL-resources/disk_types/methods/aggregated_list - - $ref: '#/components/x-stackQL-resources/disk_types/methods/get' insert: [] update: [] delete: [] region_disk_types: - id: compute.region_disk_types + id: google.compute.region_disk_types name: region_disk_types title: Region_disk_types methods: @@ -62752,13 +62784,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/region_disk_types/methods/list' - $ref: '#/components/x-stackQL-resources/region_disk_types/methods/get' + - $ref: '#/components/x-stackQL-resources/region_disk_types/methods/list' insert: [] update: [] delete: [] external_vpn_gateways: - id: compute.external_vpn_gateways + id: google.compute.external_vpn_gateways name: external_vpn_gateways title: External_vpn_gateways methods: @@ -62797,9 +62829,9 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/external_vpn_gateways/methods/get' - $ref: >- #/components/x-stackQL-resources/external_vpn_gateways/methods/list - - $ref: '#/components/x-stackQL-resources/external_vpn_gateways/methods/get' insert: - $ref: >- #/components/x-stackQL-resources/external_vpn_gateways/methods/insert @@ -62808,7 +62840,7 @@ components: - $ref: >- #/components/x-stackQL-resources/external_vpn_gateways/methods/delete external_vpn_gateways_iam_policies: - id: compute.external_vpn_gateways_iam_policies + id: google.compute.external_vpn_gateways_iam_policies name: external_vpn_gateways_iam_policies title: External_vpn_gateways_iam_policies methods: @@ -62825,7 +62857,7 @@ components: update: [] delete: [] global_forwarding_rules: - id: compute.global_forwarding_rules + id: google.compute.global_forwarding_rules name: global_forwarding_rules title: Global_forwarding_rules methods: @@ -62878,19 +62910,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/global_forwarding_rules/methods/list - $ref: >- #/components/x-stackQL-resources/global_forwarding_rules/methods/get + - $ref: >- + #/components/x-stackQL-resources/global_forwarding_rules/methods/list insert: - $ref: >- #/components/x-stackQL-resources/global_forwarding_rules/methods/insert - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/global_forwarding_rules/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/global_forwarding_rules/methods/delete forwarding_rules: - id: compute.forwarding_rules + id: google.compute.forwarding_rules name: forwarding_rules title: Forwarding_rules methods: @@ -62955,17 +62989,18 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/forwarding_rules/methods/get' - $ref: '#/components/x-stackQL-resources/forwarding_rules/methods/list' - $ref: >- #/components/x-stackQL-resources/forwarding_rules/methods/aggregated_list - - $ref: '#/components/x-stackQL-resources/forwarding_rules/methods/get' insert: - $ref: '#/components/x-stackQL-resources/forwarding_rules/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/forwarding_rules/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/forwarding_rules/methods/delete' region_health_check_services: - id: compute.region_health_check_services + id: google.compute.region_health_check_services name: region_health_check_services title: Region_health_check_services methods: @@ -63006,19 +63041,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/region_health_check_services/methods/list - $ref: >- #/components/x-stackQL-resources/region_health_check_services/methods/get + - $ref: >- + #/components/x-stackQL-resources/region_health_check_services/methods/list insert: - $ref: >- #/components/x-stackQL-resources/region_health_check_services/methods/insert - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/region_health_check_services/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/region_health_check_services/methods/delete health_checks: - id: compute.health_checks + id: google.compute.health_checks name: health_checks title: Health_checks methods: @@ -63064,15 +63101,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/health_checks/methods/list' - $ref: '#/components/x-stackQL-resources/health_checks/methods/get' + - $ref: '#/components/x-stackQL-resources/health_checks/methods/list' insert: - $ref: '#/components/x-stackQL-resources/health_checks/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/health_checks/methods/update' + - $ref: '#/components/x-stackQL-resources/health_checks/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/health_checks/methods/delete' health_checks_aggregated: - id: compute.health_checks_aggregated + id: google.compute.health_checks_aggregated name: health_checks_aggregated title: Health_checks_aggregated methods: @@ -63094,7 +63133,7 @@ components: update: [] delete: [] region_health_checks: - id: compute.region_health_checks + id: google.compute.region_health_checks name: region_health_checks title: Region_health_checks methods: @@ -63141,17 +63180,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/region_health_checks/methods/list' - $ref: '#/components/x-stackQL-resources/region_health_checks/methods/get' + - $ref: '#/components/x-stackQL-resources/region_health_checks/methods/list' insert: - $ref: >- #/components/x-stackQL-resources/region_health_checks/methods/insert - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/region_health_checks/methods/update + - $ref: >- + #/components/x-stackQL-resources/region_health_checks/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/region_health_checks/methods/delete http_health_checks: - id: compute.http_health_checks + id: google.compute.http_health_checks name: http_health_checks title: Http_health_checks methods: @@ -63197,15 +63240,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/http_health_checks/methods/list' - $ref: '#/components/x-stackQL-resources/http_health_checks/methods/get' + - $ref: '#/components/x-stackQL-resources/http_health_checks/methods/list' insert: - $ref: '#/components/x-stackQL-resources/http_health_checks/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/http_health_checks/methods/update' + - $ref: '#/components/x-stackQL-resources/http_health_checks/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/http_health_checks/methods/delete' https_health_checks: - id: compute.https_health_checks + id: google.compute.https_health_checks name: https_health_checks title: Https_health_checks methods: @@ -63251,17 +63296,20 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/https_health_checks/methods/list' - $ref: '#/components/x-stackQL-resources/https_health_checks/methods/get' + - $ref: '#/components/x-stackQL-resources/https_health_checks/methods/list' insert: - $ref: >- #/components/x-stackQL-resources/https_health_checks/methods/insert - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/https_health_checks/methods/update + - $ref: '#/components/x-stackQL-resources/https_health_checks/methods/patch' delete: - $ref: >- #/components/x-stackQL-resources/https_health_checks/methods/delete instance_templates: - id: compute.instance_templates + id: google.compute.instance_templates name: instance_templates title: Instance_templates methods: @@ -63293,15 +63341,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/instance_templates/methods/list' - $ref: '#/components/x-stackQL-resources/instance_templates/methods/get' + - $ref: '#/components/x-stackQL-resources/instance_templates/methods/list' insert: - $ref: '#/components/x-stackQL-resources/instance_templates/methods/insert' update: [] delete: - $ref: '#/components/x-stackQL-resources/instance_templates/methods/delete' instance_templates_aggregated: - id: compute.instance_templates_aggregated + id: google.compute.instance_templates_aggregated name: instance_templates_aggregated title: Instance_templates_aggregated methods: @@ -63323,7 +63371,7 @@ components: update: [] delete: [] instance_templates_iam_policies: - id: compute.instance_templates_iam_policies + id: google.compute.instance_templates_iam_policies name: instance_templates_iam_policies title: Instance_templates_iam_policies methods: @@ -63360,7 +63408,7 @@ components: update: [] delete: [] region_instance_templates: - id: compute.region_instance_templates + id: google.compute.region_instance_templates name: region_instance_templates title: Region_instance_templates methods: @@ -63394,10 +63442,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/region_instance_templates/methods/list - $ref: >- #/components/x-stackQL-resources/region_instance_templates/methods/get + - $ref: >- + #/components/x-stackQL-resources/region_instance_templates/methods/list insert: - $ref: >- #/components/x-stackQL-resources/region_instance_templates/methods/insert @@ -63406,7 +63454,7 @@ components: - $ref: >- #/components/x-stackQL-resources/region_instance_templates/methods/delete instance_settings: - id: compute.instance_settings + id: google.compute.instance_settings name: instance_settings title: Instance_settings methods: @@ -63427,10 +63475,11 @@ components: select: - $ref: '#/components/x-stackQL-resources/instance_settings/methods/get' insert: [] - update: [] + update: + - $ref: '#/components/x-stackQL-resources/instance_settings/methods/patch' delete: [] instant_snapshots: - id: compute.instant_snapshots + id: google.compute.instant_snapshots name: instant_snapshots title: Instant_snapshots methods: @@ -63480,8 +63529,8 @@ components: response: *ref_60 sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/instant_snapshots/methods/list' - $ref: '#/components/x-stackQL-resources/instant_snapshots/methods/get' + - $ref: '#/components/x-stackQL-resources/instant_snapshots/methods/list' - $ref: >- #/components/x-stackQL-resources/instant_snapshots/methods/aggregated_list insert: @@ -63490,7 +63539,7 @@ components: delete: - $ref: '#/components/x-stackQL-resources/instant_snapshots/methods/delete' instant_snapshots_iam_policies: - id: compute.instant_snapshots_iam_policies + id: google.compute.instant_snapshots_iam_policies name: instant_snapshots_iam_policies title: Instant_snapshots_iam_policies methods: @@ -63527,7 +63576,7 @@ components: update: [] delete: [] region_instant_snapshots: - id: compute.region_instant_snapshots + id: google.compute.region_instant_snapshots name: region_instant_snapshots title: Region_instant_snapshots methods: @@ -63568,10 +63617,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/region_instant_snapshots/methods/list - $ref: >- #/components/x-stackQL-resources/region_instant_snapshots/methods/get + - $ref: >- + #/components/x-stackQL-resources/region_instant_snapshots/methods/list insert: - $ref: >- #/components/x-stackQL-resources/region_instant_snapshots/methods/insert @@ -63580,7 +63629,7 @@ components: - $ref: >- #/components/x-stackQL-resources/region_instant_snapshots/methods/delete region_instant_snapshots_iam_policies: - id: compute.region_instant_snapshots_iam_policies + id: google.compute.region_instant_snapshots_iam_policies name: region_instant_snapshots_iam_policies title: Region_instant_snapshots_iam_policies methods: @@ -63617,7 +63666,7 @@ components: update: [] delete: [] interconnect_attachments: - id: compute.interconnect_attachments + id: google.compute.interconnect_attachments name: interconnect_attachments title: Interconnect_attachments methods: @@ -63676,21 +63725,23 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: >- + #/components/x-stackQL-resources/interconnect_attachments/methods/get - $ref: >- #/components/x-stackQL-resources/interconnect_attachments/methods/list - $ref: >- #/components/x-stackQL-resources/interconnect_attachments/methods/aggregated_list - - $ref: >- - #/components/x-stackQL-resources/interconnect_attachments/methods/get insert: - $ref: >- #/components/x-stackQL-resources/interconnect_attachments/methods/insert - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/interconnect_attachments/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/interconnect_attachments/methods/delete interconnects: - id: compute.interconnects + id: google.compute.interconnects name: interconnects title: Interconnects methods: @@ -63736,15 +63787,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/interconnects/methods/list' - $ref: '#/components/x-stackQL-resources/interconnects/methods/get' + - $ref: '#/components/x-stackQL-resources/interconnects/methods/list' insert: - $ref: '#/components/x-stackQL-resources/interconnects/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/interconnects/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/interconnects/methods/delete' interconnects_diagnostics: - id: compute.interconnects_diagnostics + id: google.compute.interconnects_diagnostics name: interconnects_diagnostics title: Interconnects_diagnostics methods: @@ -63763,7 +63815,7 @@ components: update: [] delete: [] interconnects_macsec_config: - id: compute.interconnects_macsec_config + id: google.compute.interconnects_macsec_config name: interconnects_macsec_config title: Interconnects_macsec_config methods: @@ -63782,7 +63834,7 @@ components: update: [] delete: [] interconnect_locations: - id: compute.interconnect_locations + id: google.compute.interconnect_locations name: interconnect_locations title: Interconnect_locations methods: @@ -63801,15 +63853,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/interconnect_locations/methods/list - $ref: >- #/components/x-stackQL-resources/interconnect_locations/methods/get + - $ref: >- + #/components/x-stackQL-resources/interconnect_locations/methods/list insert: [] update: [] delete: [] interconnect_remote_locations: - id: compute.interconnect_remote_locations + id: google.compute.interconnect_remote_locations name: interconnect_remote_locations title: Interconnect_remote_locations methods: @@ -63829,15 +63881,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/interconnect_remote_locations/methods/list - $ref: >- #/components/x-stackQL-resources/interconnect_remote_locations/methods/get + - $ref: >- + #/components/x-stackQL-resources/interconnect_remote_locations/methods/list insert: [] update: [] delete: [] license_codes: - id: compute.license_codes + id: google.compute.license_codes name: license_codes title: License_codes methods: @@ -63855,7 +63907,7 @@ components: update: [] delete: [] license_codes_iam_policies: - id: compute.license_codes_iam_policies + id: google.compute.license_codes_iam_policies name: license_codes_iam_policies title: License_codes_iam_policies methods: @@ -63872,7 +63924,7 @@ components: update: [] delete: [] licenses: - id: compute.licenses + id: google.compute.licenses name: licenses title: Licenses methods: @@ -63910,7 +63962,7 @@ components: delete: - $ref: '#/components/x-stackQL-resources/licenses/methods/delete' licenses_iam_policies: - id: compute.licenses_iam_policies + id: google.compute.licenses_iam_policies name: licenses_iam_policies title: Licenses_iam_policies methods: @@ -63947,7 +63999,7 @@ components: update: [] delete: [] machine_images: - id: compute.machine_images + id: google.compute.machine_images name: machine_images title: Machine_images methods: @@ -63979,15 +64031,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/machine_images/methods/list' - $ref: '#/components/x-stackQL-resources/machine_images/methods/get' + - $ref: '#/components/x-stackQL-resources/machine_images/methods/list' insert: - $ref: '#/components/x-stackQL-resources/machine_images/methods/insert' update: [] delete: - $ref: '#/components/x-stackQL-resources/machine_images/methods/delete' machine_images_iam_policies: - id: compute.machine_images_iam_policies + id: google.compute.machine_images_iam_policies name: machine_images_iam_policies title: Machine_images_iam_policies methods: @@ -64024,7 +64076,7 @@ components: update: [] delete: [] machine_types: - id: compute.machine_types + id: google.compute.machine_types name: machine_types title: Machine_types methods: @@ -64053,15 +64105,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/machine_types/methods/get' - $ref: '#/components/x-stackQL-resources/machine_types/methods/list' - $ref: >- #/components/x-stackQL-resources/machine_types/methods/aggregated_list - - $ref: '#/components/x-stackQL-resources/machine_types/methods/get' insert: [] update: [] delete: [] network_attachments: - id: compute.network_attachments + id: google.compute.network_attachments name: network_attachments title: Network_attachments methods: @@ -64112,19 +64164,20 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/network_attachments/methods/get' + - $ref: '#/components/x-stackQL-resources/network_attachments/methods/list' - $ref: >- #/components/x-stackQL-resources/network_attachments/methods/aggregated_list - - $ref: '#/components/x-stackQL-resources/network_attachments/methods/list' - - $ref: '#/components/x-stackQL-resources/network_attachments/methods/get' insert: - $ref: >- #/components/x-stackQL-resources/network_attachments/methods/insert - update: [] + update: + - $ref: '#/components/x-stackQL-resources/network_attachments/methods/patch' delete: - $ref: >- #/components/x-stackQL-resources/network_attachments/methods/delete network_attachments_iam_policies: - id: compute.network_attachments_iam_policies + id: google.compute.network_attachments_iam_policies name: network_attachments_iam_policies title: Network_attachments_iam_policies methods: @@ -64161,7 +64214,7 @@ components: update: [] delete: [] network_edge_security_services: - id: compute.network_edge_security_services + id: google.compute.network_edge_security_services name: network_edge_security_services title: Network_edge_security_services methods: @@ -64213,12 +64266,14 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/network_edge_security_services/methods/insert - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/network_edge_security_services/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/network_edge_security_services/methods/delete network_endpoint_groups: - id: compute.network_endpoint_groups + id: google.compute.network_endpoint_groups name: network_endpoint_groups title: Network_endpoint_groups methods: @@ -64277,12 +64332,12 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: >- + #/components/x-stackQL-resources/network_endpoint_groups/methods/get - $ref: >- #/components/x-stackQL-resources/network_endpoint_groups/methods/list - $ref: >- #/components/x-stackQL-resources/network_endpoint_groups/methods/aggregated_list - - $ref: >- - #/components/x-stackQL-resources/network_endpoint_groups/methods/get insert: - $ref: >- #/components/x-stackQL-resources/network_endpoint_groups/methods/insert @@ -64291,7 +64346,7 @@ components: - $ref: >- #/components/x-stackQL-resources/network_endpoint_groups/methods/delete network_endpoint_groups_network_endpoints: - id: compute.network_endpoint_groups_network_endpoints + id: google.compute.network_endpoint_groups_network_endpoints name: network_endpoint_groups_network_endpoints title: Network_endpoint_groups_network_endpoints methods: @@ -64308,7 +64363,7 @@ components: update: [] delete: [] network_endpoint_groups_iam_policies: - id: compute.network_endpoint_groups_iam_policies + id: google.compute.network_endpoint_groups_iam_policies name: network_endpoint_groups_iam_policies title: Network_endpoint_groups_iam_policies methods: @@ -64325,7 +64380,7 @@ components: update: [] delete: [] global_network_endpoint_groups: - id: compute.global_network_endpoint_groups + id: google.compute.global_network_endpoint_groups name: global_network_endpoint_groups title: Global_network_endpoint_groups methods: @@ -64371,10 +64426,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/global_network_endpoint_groups/methods/list - $ref: >- #/components/x-stackQL-resources/global_network_endpoint_groups/methods/get + - $ref: >- + #/components/x-stackQL-resources/global_network_endpoint_groups/methods/list insert: - $ref: >- #/components/x-stackQL-resources/global_network_endpoint_groups/methods/insert @@ -64383,7 +64438,7 @@ components: - $ref: >- #/components/x-stackQL-resources/global_network_endpoint_groups/methods/delete global_network_endpoint_groups_network_endpoints: - id: compute.global_network_endpoint_groups_network_endpoints + id: google.compute.global_network_endpoint_groups_network_endpoints name: global_network_endpoint_groups_network_endpoints title: Global_network_endpoint_groups_network_endpoints methods: @@ -64400,7 +64455,7 @@ components: update: [] delete: [] region_network_endpoint_groups: - id: compute.region_network_endpoint_groups + id: google.compute.region_network_endpoint_groups name: region_network_endpoint_groups title: Region_network_endpoint_groups methods: @@ -64448,10 +64503,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/region_network_endpoint_groups/methods/list - $ref: >- #/components/x-stackQL-resources/region_network_endpoint_groups/methods/get + - $ref: >- + #/components/x-stackQL-resources/region_network_endpoint_groups/methods/list insert: - $ref: >- #/components/x-stackQL-resources/region_network_endpoint_groups/methods/insert @@ -64460,7 +64515,7 @@ components: - $ref: >- #/components/x-stackQL-resources/region_network_endpoint_groups/methods/delete region_network_endpoint_groups_network_endpoints: - id: compute.region_network_endpoint_groups_network_endpoints + id: google.compute.region_network_endpoint_groups_network_endpoints name: region_network_endpoint_groups_network_endpoints title: Region_network_endpoint_groups_network_endpoints methods: @@ -64477,7 +64532,7 @@ components: update: [] delete: [] networks: - id: compute.networks + id: google.compute.networks name: networks title: Networks methods: @@ -64520,15 +64575,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/networks/methods/list' - $ref: '#/components/x-stackQL-resources/networks/methods/get' + - $ref: '#/components/x-stackQL-resources/networks/methods/list' insert: - $ref: '#/components/x-stackQL-resources/networks/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/networks/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/networks/methods/delete' networks_peering: - id: compute.networks_peering + id: google.compute.networks_peering name: networks_peering title: Networks_peering methods: @@ -64559,7 +64615,7 @@ components: update: [] delete: [] networks_effective_firewalls: - id: compute.networks_effective_firewalls + id: google.compute.networks_effective_firewalls name: networks_effective_firewalls title: Networks_effective_firewalls methods: @@ -64578,7 +64634,7 @@ components: update: [] delete: [] networks_peering_routes: - id: compute.networks_peering_routes + id: google.compute.networks_peering_routes name: networks_peering_routes title: Networks_peering_routes methods: @@ -64597,7 +64653,7 @@ components: update: [] delete: [] node_groups: - id: compute.node_groups + id: google.compute.node_groups name: node_groups title: Node_groups methods: @@ -64667,17 +64723,18 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/node_groups/methods/get' - $ref: '#/components/x-stackQL-resources/node_groups/methods/list' - $ref: >- #/components/x-stackQL-resources/node_groups/methods/aggregated_list - - $ref: '#/components/x-stackQL-resources/node_groups/methods/get' insert: - $ref: '#/components/x-stackQL-resources/node_groups/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/node_groups/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/node_groups/methods/delete' node_groups_nodes: - id: compute.node_groups_nodes + id: google.compute.node_groups_nodes name: node_groups_nodes title: Node_groups_nodes methods: @@ -64708,7 +64765,7 @@ components: update: [] delete: [] node_groups_iam_policies: - id: compute.node_groups_iam_policies + id: google.compute.node_groups_iam_policies name: node_groups_iam_policies title: Node_groups_iam_policies methods: @@ -64745,7 +64802,7 @@ components: update: [] delete: [] node_templates: - id: compute.node_templates + id: google.compute.node_templates name: node_templates title: Node_templates methods: @@ -64789,17 +64846,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/node_templates/methods/get' - $ref: '#/components/x-stackQL-resources/node_templates/methods/list' - $ref: >- #/components/x-stackQL-resources/node_templates/methods/aggregated_list - - $ref: '#/components/x-stackQL-resources/node_templates/methods/get' insert: - $ref: '#/components/x-stackQL-resources/node_templates/methods/insert' update: [] delete: - $ref: '#/components/x-stackQL-resources/node_templates/methods/delete' node_templates_iam_policies: - id: compute.node_templates_iam_policies + id: google.compute.node_templates_iam_policies name: node_templates_iam_policies title: Node_templates_iam_policies methods: @@ -64836,7 +64893,7 @@ components: update: [] delete: [] node_types: - id: compute.node_types + id: google.compute.node_types name: node_types title: Node_types methods: @@ -64865,15 +64922,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/node_types/methods/get' - $ref: '#/components/x-stackQL-resources/node_types/methods/list' - $ref: >- #/components/x-stackQL-resources/node_types/methods/aggregated_list - - $ref: '#/components/x-stackQL-resources/node_types/methods/get' insert: [] update: [] delete: [] region_notification_endpoints: - id: compute.region_notification_endpoints + id: google.compute.region_notification_endpoints name: region_notification_endpoints title: Region_notification_endpoints methods: @@ -64907,10 +64964,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/region_notification_endpoints/methods/list - $ref: >- #/components/x-stackQL-resources/region_notification_endpoints/methods/get + - $ref: >- + #/components/x-stackQL-resources/region_notification_endpoints/methods/list insert: - $ref: >- #/components/x-stackQL-resources/region_notification_endpoints/methods/insert @@ -64919,7 +64976,7 @@ components: - $ref: >- #/components/x-stackQL-resources/region_notification_endpoints/methods/delete packet_mirrorings: - id: compute.packet_mirrorings + id: google.compute.packet_mirrorings name: packet_mirrorings title: Packet_mirrorings methods: @@ -64976,11 +65033,12 @@ components: #/components/x-stackQL-resources/packet_mirrorings/methods/aggregated_list insert: - $ref: '#/components/x-stackQL-resources/packet_mirrorings/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/packet_mirrorings/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/packet_mirrorings/methods/delete' packet_mirrorings_iam_policies: - id: compute.packet_mirrorings_iam_policies + id: google.compute.packet_mirrorings_iam_policies name: packet_mirrorings_iam_policies title: Packet_mirrorings_iam_policies methods: @@ -64997,7 +65055,7 @@ components: update: [] delete: [] projects: - id: compute.projects + id: google.compute.projects name: projects title: Projects methods: @@ -65074,7 +65132,7 @@ components: update: [] delete: [] xpn_hosts: - id: compute.xpn_hosts + id: google.compute.xpn_hosts name: xpn_hosts title: Xpn_hosts methods: @@ -65090,7 +65148,7 @@ components: update: [] delete: [] xpn_host: - id: compute.xpn_host + id: google.compute.xpn_host name: xpn_host title: Xpn_host methods: @@ -65107,7 +65165,7 @@ components: update: [] delete: [] xpn_resources: - id: compute.xpn_resources + id: google.compute.xpn_resources name: xpn_resources title: Xpn_resources methods: @@ -65129,7 +65187,7 @@ components: update: [] delete: [] public_advertised_prefixes: - id: compute.public_advertised_prefixes + id: google.compute.public_advertised_prefixes name: public_advertised_prefixes title: Public_advertised_prefixes methods: @@ -65184,19 +65242,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/public_advertised_prefixes/methods/list - $ref: >- #/components/x-stackQL-resources/public_advertised_prefixes/methods/get + - $ref: >- + #/components/x-stackQL-resources/public_advertised_prefixes/methods/list insert: - $ref: >- #/components/x-stackQL-resources/public_advertised_prefixes/methods/insert - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/public_advertised_prefixes/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/public_advertised_prefixes/methods/delete global_public_delegated_prefixes: - id: compute.global_public_delegated_prefixes + id: google.compute.global_public_delegated_prefixes name: global_public_delegated_prefixes title: Global_public_delegated_prefixes methods: @@ -65236,19 +65296,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/global_public_delegated_prefixes/methods/list - $ref: >- #/components/x-stackQL-resources/global_public_delegated_prefixes/methods/get + - $ref: >- + #/components/x-stackQL-resources/global_public_delegated_prefixes/methods/list insert: - $ref: >- #/components/x-stackQL-resources/global_public_delegated_prefixes/methods/insert - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/global_public_delegated_prefixes/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/global_public_delegated_prefixes/methods/delete public_delegated_prefixes: - id: compute.public_delegated_prefixes + id: google.compute.public_delegated_prefixes name: public_delegated_prefixes title: Public_delegated_prefixes methods: @@ -65314,21 +65376,23 @@ components: response: *ref_96 sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/public_delegated_prefixes/methods/list - $ref: >- #/components/x-stackQL-resources/public_delegated_prefixes/methods/get + - $ref: >- + #/components/x-stackQL-resources/public_delegated_prefixes/methods/list - $ref: >- #/components/x-stackQL-resources/public_delegated_prefixes/methods/aggregated_list insert: - $ref: >- #/components/x-stackQL-resources/public_delegated_prefixes/methods/insert - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/public_delegated_prefixes/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/public_delegated_prefixes/methods/delete regions: - id: compute.regions + id: google.compute.regions name: regions title: Regions methods: @@ -65346,13 +65410,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/regions/methods/list' - $ref: '#/components/x-stackQL-resources/regions/methods/get' + - $ref: '#/components/x-stackQL-resources/regions/methods/list' insert: [] update: [] delete: [] resource_policies: - id: compute.resource_policies + id: google.compute.resource_policies name: resource_policies title: Resource_policies methods: @@ -65403,17 +65467,18 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/get' - $ref: '#/components/x-stackQL-resources/resource_policies/methods/list' - $ref: >- #/components/x-stackQL-resources/resource_policies/methods/aggregated_list - - $ref: '#/components/x-stackQL-resources/resource_policies/methods/get' insert: - $ref: '#/components/x-stackQL-resources/resource_policies/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/resource_policies/methods/delete' resource_policies_iam_policies: - id: compute.resource_policies_iam_policies + id: google.compute.resource_policies_iam_policies name: resource_policies_iam_policies title: Resource_policies_iam_policies methods: @@ -65450,7 +65515,7 @@ components: update: [] delete: [] routes: - id: compute.routes + id: google.compute.routes name: routes title: Routes methods: @@ -65480,15 +65545,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/routes/methods/list' - $ref: '#/components/x-stackQL-resources/routes/methods/get' + - $ref: '#/components/x-stackQL-resources/routes/methods/list' insert: - $ref: '#/components/x-stackQL-resources/routes/methods/insert' update: [] delete: - $ref: '#/components/x-stackQL-resources/routes/methods/delete' routers: - id: compute.routers + id: google.compute.routers name: routers title: Routers methods: @@ -65556,11 +65621,13 @@ components: - $ref: '#/components/x-stackQL-resources/routers/methods/aggregated_list' insert: - $ref: '#/components/x-stackQL-resources/routers/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/routers/methods/update' + - $ref: '#/components/x-stackQL-resources/routers/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/routers/methods/delete' routers_router_status: - id: compute.routers_router_status + id: google.compute.routers_router_status name: routers_router_status title: Routers_router_status methods: @@ -65579,7 +65646,7 @@ components: update: [] delete: [] routers_nat_mapping_info: - id: compute.routers_nat_mapping_info + id: google.compute.routers_nat_mapping_info name: routers_nat_mapping_info title: Routers_nat_mapping_info methods: @@ -65602,7 +65669,7 @@ components: update: [] delete: [] routers_nat_ip_info: - id: compute.routers_nat_ip_info + id: google.compute.routers_nat_ip_info name: routers_nat_ip_info title: Routers_nat_ip_info methods: @@ -65621,7 +65688,7 @@ components: update: [] delete: [] service_attachments: - id: compute.service_attachments + id: google.compute.service_attachments name: service_attachments title: Service_attachments methods: @@ -65672,19 +65739,20 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/service_attachments/methods/get' + - $ref: '#/components/x-stackQL-resources/service_attachments/methods/list' - $ref: >- #/components/x-stackQL-resources/service_attachments/methods/aggregated_list - - $ref: '#/components/x-stackQL-resources/service_attachments/methods/list' - - $ref: '#/components/x-stackQL-resources/service_attachments/methods/get' insert: - $ref: >- #/components/x-stackQL-resources/service_attachments/methods/insert - update: [] + update: + - $ref: '#/components/x-stackQL-resources/service_attachments/methods/patch' delete: - $ref: >- #/components/x-stackQL-resources/service_attachments/methods/delete service_attachments_iam_policies: - id: compute.service_attachments_iam_policies + id: google.compute.service_attachments_iam_policies name: service_attachments_iam_policies title: Service_attachments_iam_policies methods: @@ -65721,7 +65789,7 @@ components: update: [] delete: [] snapshot_settings: - id: compute.snapshot_settings + id: google.compute.snapshot_settings name: snapshot_settings title: Snapshot_settings methods: @@ -65741,10 +65809,11 @@ components: select: - $ref: '#/components/x-stackQL-resources/snapshot_settings/methods/get' insert: [] - update: [] + update: + - $ref: '#/components/x-stackQL-resources/snapshot_settings/methods/patch' delete: [] ssl_certificates: - id: compute.ssl_certificates + id: google.compute.ssl_certificates name: ssl_certificates title: Ssl_certificates methods: @@ -65776,15 +65845,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/ssl_certificates/methods/list' - $ref: '#/components/x-stackQL-resources/ssl_certificates/methods/get' + - $ref: '#/components/x-stackQL-resources/ssl_certificates/methods/list' insert: - $ref: '#/components/x-stackQL-resources/ssl_certificates/methods/insert' update: [] delete: - $ref: '#/components/x-stackQL-resources/ssl_certificates/methods/delete' ssl_certificates_aggregated: - id: compute.ssl_certificates_aggregated + id: google.compute.ssl_certificates_aggregated name: ssl_certificates_aggregated title: Ssl_certificates_aggregated methods: @@ -65806,7 +65875,7 @@ components: update: [] delete: [] region_ssl_certificates: - id: compute.region_ssl_certificates + id: google.compute.region_ssl_certificates name: region_ssl_certificates title: Region_ssl_certificates methods: @@ -65840,10 +65909,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/region_ssl_certificates/methods/list - $ref: >- #/components/x-stackQL-resources/region_ssl_certificates/methods/get + - $ref: >- + #/components/x-stackQL-resources/region_ssl_certificates/methods/list insert: - $ref: >- #/components/x-stackQL-resources/region_ssl_certificates/methods/insert @@ -65852,7 +65921,7 @@ components: - $ref: >- #/components/x-stackQL-resources/region_ssl_certificates/methods/delete ssl_policies: - id: compute.ssl_policies + id: google.compute.ssl_policies name: ssl_policies title: Ssl_policies methods: @@ -65891,15 +65960,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/ssl_policies/methods/list' - $ref: '#/components/x-stackQL-resources/ssl_policies/methods/get' + - $ref: '#/components/x-stackQL-resources/ssl_policies/methods/list' insert: - $ref: '#/components/x-stackQL-resources/ssl_policies/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/ssl_policies/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/ssl_policies/methods/delete' ssl_policies_available_features: - id: compute.ssl_policies_available_features + id: google.compute.ssl_policies_available_features name: ssl_policies_available_features title: Ssl_policies_available_features methods: @@ -65918,7 +65988,7 @@ components: update: [] delete: [] ssl_policies_aggregated: - id: compute.ssl_policies_aggregated + id: google.compute.ssl_policies_aggregated name: ssl_policies_aggregated title: Ssl_policies_aggregated methods: @@ -65940,7 +66010,7 @@ components: update: [] delete: [] region_ssl_policies: - id: compute.region_ssl_policies + id: google.compute.region_ssl_policies name: region_ssl_policies title: Region_ssl_policies methods: @@ -65979,17 +66049,18 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/region_ssl_policies/methods/list' - $ref: '#/components/x-stackQL-resources/region_ssl_policies/methods/get' + - $ref: '#/components/x-stackQL-resources/region_ssl_policies/methods/list' insert: - $ref: >- #/components/x-stackQL-resources/region_ssl_policies/methods/insert - update: [] + update: + - $ref: '#/components/x-stackQL-resources/region_ssl_policies/methods/patch' delete: - $ref: >- #/components/x-stackQL-resources/region_ssl_policies/methods/delete region_ssl_policies_available_features: - id: compute.region_ssl_policies_available_features + id: google.compute.region_ssl_policies_available_features name: region_ssl_policies_available_features title: Region_ssl_policies_available_features methods: @@ -66008,7 +66079,7 @@ components: update: [] delete: [] storage_pool_types: - id: compute.storage_pool_types + id: google.compute.storage_pool_types name: storage_pool_types title: Storage_pool_types methods: @@ -66037,15 +66108,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/storage_pool_types/methods/get' - $ref: '#/components/x-stackQL-resources/storage_pool_types/methods/list' - $ref: >- #/components/x-stackQL-resources/storage_pool_types/methods/aggregated_list - - $ref: '#/components/x-stackQL-resources/storage_pool_types/methods/get' insert: [] update: [] delete: [] storage_pools: - id: compute.storage_pools + id: google.compute.storage_pools name: storage_pools title: Storage_pools methods: @@ -66094,17 +66165,18 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/storage_pools/methods/get' - $ref: '#/components/x-stackQL-resources/storage_pools/methods/list' - $ref: >- #/components/x-stackQL-resources/storage_pools/methods/aggregated_list - - $ref: '#/components/x-stackQL-resources/storage_pools/methods/get' insert: - $ref: '#/components/x-stackQL-resources/storage_pools/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/storage_pools/methods/update' delete: - $ref: '#/components/x-stackQL-resources/storage_pools/methods/delete' storage_pools_iam_policies: - id: compute.storage_pools_iam_policies + id: google.compute.storage_pools_iam_policies name: storage_pools_iam_policies title: Storage_pools_iam_policies methods: @@ -66141,7 +66213,7 @@ components: update: [] delete: [] storage_pools_disks: - id: compute.storage_pools_disks + id: google.compute.storage_pools_disks name: storage_pools_disks title: Storage_pools_disks methods: @@ -66160,7 +66232,7 @@ components: update: [] delete: [] subnetworks: - id: compute.subnetworks + id: google.compute.subnetworks name: subnetworks title: Subnetworks methods: @@ -66223,17 +66295,18 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/subnetworks/methods/get' - $ref: '#/components/x-stackQL-resources/subnetworks/methods/list' - $ref: >- #/components/x-stackQL-resources/subnetworks/methods/aggregated_list - - $ref: '#/components/x-stackQL-resources/subnetworks/methods/get' insert: - $ref: '#/components/x-stackQL-resources/subnetworks/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/subnetworks/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/subnetworks/methods/delete' subnetworks_usable: - id: compute.subnetworks_usable + id: google.compute.subnetworks_usable name: subnetworks_usable title: Subnetworks_usable methods: @@ -66252,7 +66325,7 @@ components: update: [] delete: [] subnetworks_iam_policies: - id: compute.subnetworks_iam_policies + id: google.compute.subnetworks_iam_policies name: subnetworks_iam_policies title: Subnetworks_iam_policies methods: @@ -66289,7 +66362,7 @@ components: update: [] delete: [] target_grpc_proxies: - id: compute.target_grpc_proxies + id: google.compute.target_grpc_proxies name: target_grpc_proxies title: Target_grpc_proxies methods: @@ -66328,17 +66401,18 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/target_grpc_proxies/methods/list' - $ref: '#/components/x-stackQL-resources/target_grpc_proxies/methods/get' + - $ref: '#/components/x-stackQL-resources/target_grpc_proxies/methods/list' insert: - $ref: >- #/components/x-stackQL-resources/target_grpc_proxies/methods/insert - update: [] + update: + - $ref: '#/components/x-stackQL-resources/target_grpc_proxies/methods/patch' delete: - $ref: >- #/components/x-stackQL-resources/target_grpc_proxies/methods/delete target_http_proxies: - id: compute.target_http_proxies + id: google.compute.target_http_proxies name: target_http_proxies title: Target_http_proxies methods: @@ -66384,17 +66458,18 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/target_http_proxies/methods/list' - $ref: '#/components/x-stackQL-resources/target_http_proxies/methods/get' + - $ref: '#/components/x-stackQL-resources/target_http_proxies/methods/list' insert: - $ref: >- #/components/x-stackQL-resources/target_http_proxies/methods/insert - update: [] + update: + - $ref: '#/components/x-stackQL-resources/target_http_proxies/methods/patch' delete: - $ref: >- #/components/x-stackQL-resources/target_http_proxies/methods/delete target_http_proxies_aggregated: - id: compute.target_http_proxies_aggregated + id: google.compute.target_http_proxies_aggregated name: target_http_proxies_aggregated title: Target_http_proxies_aggregated methods: @@ -66416,7 +66491,7 @@ components: update: [] delete: [] region_target_http_proxies: - id: compute.region_target_http_proxies + id: google.compute.region_target_http_proxies name: region_target_http_proxies title: Region_target_http_proxies methods: @@ -66457,10 +66532,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/region_target_http_proxies/methods/list - $ref: >- #/components/x-stackQL-resources/region_target_http_proxies/methods/get + - $ref: >- + #/components/x-stackQL-resources/region_target_http_proxies/methods/list insert: - $ref: >- #/components/x-stackQL-resources/region_target_http_proxies/methods/insert @@ -66469,7 +66544,7 @@ components: - $ref: >- #/components/x-stackQL-resources/region_target_http_proxies/methods/delete target_https_proxies: - id: compute.target_https_proxies + id: google.compute.target_https_proxies name: target_https_proxies title: Target_https_proxies methods: @@ -66543,17 +66618,19 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/target_https_proxies/methods/list' - $ref: '#/components/x-stackQL-resources/target_https_proxies/methods/get' + - $ref: '#/components/x-stackQL-resources/target_https_proxies/methods/list' insert: - $ref: >- #/components/x-stackQL-resources/target_https_proxies/methods/insert - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/target_https_proxies/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/target_https_proxies/methods/delete target_https_proxies_aggregated: - id: compute.target_https_proxies_aggregated + id: google.compute.target_https_proxies_aggregated name: target_https_proxies_aggregated title: Target_https_proxies_aggregated methods: @@ -66575,7 +66652,7 @@ components: update: [] delete: [] region_target_https_proxies: - id: compute.region_target_https_proxies + id: google.compute.region_target_https_proxies name: region_target_https_proxies title: Region_target_https_proxies methods: @@ -66630,19 +66707,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/region_target_https_proxies/methods/list - $ref: >- #/components/x-stackQL-resources/region_target_https_proxies/methods/get + - $ref: >- + #/components/x-stackQL-resources/region_target_https_proxies/methods/list insert: - $ref: >- #/components/x-stackQL-resources/region_target_https_proxies/methods/insert - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/region_target_https_proxies/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/region_target_https_proxies/methods/delete target_instances: - id: compute.target_instances + id: google.compute.target_instances name: target_instances title: Target_instances methods: @@ -66691,17 +66770,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/target_instances/methods/get' - $ref: '#/components/x-stackQL-resources/target_instances/methods/list' - $ref: >- #/components/x-stackQL-resources/target_instances/methods/aggregated_list - - $ref: '#/components/x-stackQL-resources/target_instances/methods/get' insert: - $ref: '#/components/x-stackQL-resources/target_instances/methods/insert' update: [] delete: - $ref: '#/components/x-stackQL-resources/target_instances/methods/delete' target_pools: - id: compute.target_pools + id: google.compute.target_pools name: target_pools title: Target_pools methods: @@ -66757,17 +66836,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/target_pools/methods/get' - $ref: '#/components/x-stackQL-resources/target_pools/methods/list' - $ref: >- #/components/x-stackQL-resources/target_pools/methods/aggregated_list - - $ref: '#/components/x-stackQL-resources/target_pools/methods/get' insert: - $ref: '#/components/x-stackQL-resources/target_pools/methods/insert' update: [] delete: - $ref: '#/components/x-stackQL-resources/target_pools/methods/delete' target_pools_health: - id: compute.target_pools_health + id: google.compute.target_pools_health name: target_pools_health title: Target_pools_health methods: @@ -66784,7 +66863,7 @@ components: update: [] delete: [] target_pools_health_check: - id: compute.target_pools_health_check + id: google.compute.target_pools_health_check name: target_pools_health_check title: Target_pools_health_check methods: @@ -66808,7 +66887,7 @@ components: update: [] delete: [] target_pools_instance: - id: compute.target_pools_instance + id: google.compute.target_pools_instance name: target_pools_instance title: Target_pools_instance methods: @@ -66832,7 +66911,7 @@ components: update: [] delete: [] target_ssl_proxies: - id: compute.target_ssl_proxies + id: google.compute.target_ssl_proxies name: target_ssl_proxies title: Target_ssl_proxies methods: @@ -66899,15 +66978,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/target_ssl_proxies/methods/list' - $ref: '#/components/x-stackQL-resources/target_ssl_proxies/methods/get' + - $ref: '#/components/x-stackQL-resources/target_ssl_proxies/methods/list' insert: - $ref: '#/components/x-stackQL-resources/target_ssl_proxies/methods/insert' update: [] delete: - $ref: '#/components/x-stackQL-resources/target_ssl_proxies/methods/delete' target_tcp_proxies: - id: compute.target_tcp_proxies + id: google.compute.target_tcp_proxies name: target_tcp_proxies title: Target_tcp_proxies methods: @@ -66953,15 +67032,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/target_tcp_proxies/methods/list' - $ref: '#/components/x-stackQL-resources/target_tcp_proxies/methods/get' + - $ref: '#/components/x-stackQL-resources/target_tcp_proxies/methods/list' insert: - $ref: '#/components/x-stackQL-resources/target_tcp_proxies/methods/insert' update: [] delete: - $ref: '#/components/x-stackQL-resources/target_tcp_proxies/methods/delete' target_tcp_proxies_aggregated: - id: compute.target_tcp_proxies_aggregated + id: google.compute.target_tcp_proxies_aggregated name: target_tcp_proxies_aggregated title: Target_tcp_proxies_aggregated methods: @@ -66983,7 +67062,7 @@ components: update: [] delete: [] region_target_tcp_proxies: - id: compute.region_target_tcp_proxies + id: google.compute.region_target_tcp_proxies name: region_target_tcp_proxies title: Region_target_tcp_proxies methods: @@ -67017,10 +67096,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/region_target_tcp_proxies/methods/list - $ref: >- #/components/x-stackQL-resources/region_target_tcp_proxies/methods/get + - $ref: >- + #/components/x-stackQL-resources/region_target_tcp_proxies/methods/list insert: - $ref: >- #/components/x-stackQL-resources/region_target_tcp_proxies/methods/insert @@ -67029,7 +67108,7 @@ components: - $ref: >- #/components/x-stackQL-resources/region_target_tcp_proxies/methods/delete target_vpn_gateways: - id: compute.target_vpn_gateways + id: google.compute.target_vpn_gateways name: target_vpn_gateways title: Target_vpn_gateways methods: @@ -67080,10 +67159,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/target_vpn_gateways/methods/get' - $ref: '#/components/x-stackQL-resources/target_vpn_gateways/methods/list' - $ref: >- #/components/x-stackQL-resources/target_vpn_gateways/methods/aggregated_list - - $ref: '#/components/x-stackQL-resources/target_vpn_gateways/methods/get' insert: - $ref: >- #/components/x-stackQL-resources/target_vpn_gateways/methods/insert @@ -67092,7 +67171,7 @@ components: - $ref: >- #/components/x-stackQL-resources/target_vpn_gateways/methods/delete url_maps: - id: compute.url_maps + id: google.compute.url_maps name: url_maps title: Url_maps methods: @@ -67148,15 +67227,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/url_maps/methods/list' - $ref: '#/components/x-stackQL-resources/url_maps/methods/get' + - $ref: '#/components/x-stackQL-resources/url_maps/methods/list' insert: - $ref: '#/components/x-stackQL-resources/url_maps/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/url_maps/methods/update' + - $ref: '#/components/x-stackQL-resources/url_maps/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/url_maps/methods/delete' url_maps_aggregated: - id: compute.url_maps_aggregated + id: google.compute.url_maps_aggregated name: url_maps_aggregated title: Url_maps_aggregated methods: @@ -67178,7 +67259,7 @@ components: update: [] delete: [] region_url_maps: - id: compute.region_url_maps + id: google.compute.region_url_maps name: region_url_maps title: Region_url_maps methods: @@ -67231,15 +67312,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/region_url_maps/methods/list' - $ref: '#/components/x-stackQL-resources/region_url_maps/methods/get' + - $ref: '#/components/x-stackQL-resources/region_url_maps/methods/list' insert: - $ref: '#/components/x-stackQL-resources/region_url_maps/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/region_url_maps/methods/update' + - $ref: '#/components/x-stackQL-resources/region_url_maps/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/region_url_maps/methods/delete' vpn_gateways: - id: compute.vpn_gateways + id: google.compute.vpn_gateways name: vpn_gateways title: Vpn_gateways methods: @@ -67288,17 +67371,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/vpn_gateways/methods/get' - $ref: '#/components/x-stackQL-resources/vpn_gateways/methods/list' - $ref: >- #/components/x-stackQL-resources/vpn_gateways/methods/aggregated_list - - $ref: '#/components/x-stackQL-resources/vpn_gateways/methods/get' insert: - $ref: '#/components/x-stackQL-resources/vpn_gateways/methods/insert' update: [] delete: - $ref: '#/components/x-stackQL-resources/vpn_gateways/methods/delete' vpn_gateways_status: - id: compute.vpn_gateways_status + id: google.compute.vpn_gateways_status name: vpn_gateways_status title: Vpn_gateways_status methods: @@ -67317,7 +67400,7 @@ components: update: [] delete: [] vpn_gateways_iam_policies: - id: compute.vpn_gateways_iam_policies + id: google.compute.vpn_gateways_iam_policies name: vpn_gateways_iam_policies title: Vpn_gateways_iam_policies methods: @@ -67334,7 +67417,7 @@ components: update: [] delete: [] vpn_tunnels: - id: compute.vpn_tunnels + id: google.compute.vpn_tunnels name: vpn_tunnels title: Vpn_tunnels methods: @@ -67383,17 +67466,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/vpn_tunnels/methods/get' - $ref: '#/components/x-stackQL-resources/vpn_tunnels/methods/list' - $ref: >- #/components/x-stackQL-resources/vpn_tunnels/methods/aggregated_list - - $ref: '#/components/x-stackQL-resources/vpn_tunnels/methods/get' insert: - $ref: '#/components/x-stackQL-resources/vpn_tunnels/methods/insert' update: [] delete: - $ref: '#/components/x-stackQL-resources/vpn_tunnels/methods/delete' zones: - id: compute.zones + id: google.compute.zones name: zones title: Zones methods: @@ -67411,13 +67494,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/zones/methods/list' - $ref: '#/components/x-stackQL-resources/zones/methods/get' + - $ref: '#/components/x-stackQL-resources/zones/methods/list' insert: [] update: [] delete: [] region_zones: - id: compute.region_zones + id: google.compute.region_zones name: region_zones title: Region_zones methods: 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 11ef987c..42f2cf8a 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/config.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/config.yaml @@ -8,7 +8,7 @@ info: description: Creates and manages Google Cloud Platform resources and infrastructure. version: v1 x-discovery-doc-revision: '20240515' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/infrastructure-manager/docs servers: @@ -1811,7 +1811,7 @@ components: - '2' x-stackQL-resources: locations: - id: config.locations + id: google.config.locations name: locations title: Locations methods: @@ -1833,13 +1833,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: config.operations + id: google.config.operations name: operations title: Operations methods: @@ -1877,14 +1877,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' deployments: - id: config.deployments + id: google.config.deployments name: deployments title: Deployments methods: @@ -1964,15 +1964,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/deployments/methods/list' - $ref: '#/components/x-stackQL-resources/deployments/methods/get' + - $ref: '#/components/x-stackQL-resources/deployments/methods/list' insert: - $ref: '#/components/x-stackQL-resources/deployments/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/deployments/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/deployments/methods/delete' deployments_state: - id: config.deployments_state + id: google.config.deployments_state name: deployments_state title: Deployments_state methods: @@ -1989,7 +1990,7 @@ components: update: [] delete: [] deployments_iam_policies: - id: config.deployments_iam_policies + id: google.config.deployments_iam_policies name: deployments_iam_policies title: Deployments_iam_policies methods: @@ -2026,7 +2027,7 @@ components: update: [] delete: [] revisions: - id: config.revisions + id: google.config.revisions name: revisions title: Revisions methods: @@ -2057,13 +2058,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/revisions/methods/list' - $ref: '#/components/x-stackQL-resources/revisions/methods/get' + - $ref: '#/components/x-stackQL-resources/revisions/methods/list' insert: [] update: [] delete: [] resources: - id: config.resources + id: google.config.resources name: resources title: Resources methods: @@ -2093,7 +2094,7 @@ components: update: [] delete: [] previews: - id: config.previews + id: google.config.previews name: previews title: Previews methods: @@ -2138,15 +2139,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/previews/methods/list' - $ref: '#/components/x-stackQL-resources/previews/methods/get' + - $ref: '#/components/x-stackQL-resources/previews/methods/list' insert: - $ref: '#/components/x-stackQL-resources/previews/methods/create' update: [] delete: - $ref: '#/components/x-stackQL-resources/previews/methods/delete' terraform_versions: - id: config.terraform_versions + id: google.config.terraform_versions name: terraform_versions title: Terraform_versions methods: @@ -2170,8 +2171,8 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/terraform_versions/methods/list' - $ref: '#/components/x-stackQL-resources/terraform_versions/methods/get' + - $ref: '#/components/x-stackQL-resources/terraform_versions/methods/list' insert: [] update: [] delete: [] 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 ce051a42..22a7aea0 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: '20240515' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: >- https://cloud.google.com/apigee/docs/api-platform/connectors/about-connectors @@ -1946,7 +1946,7 @@ components: - '2' x-stackQL-resources: connections: - id: connectors.connections + id: google.connectors.connections name: connections title: Connections methods: @@ -1991,7 +1991,7 @@ components: update: [] delete: [] actions: - id: connectors.actions + id: google.connectors.actions name: actions title: Actions methods: @@ -2022,13 +2022,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/actions/methods/list' - $ref: '#/components/x-stackQL-resources/actions/methods/get' + - $ref: '#/components/x-stackQL-resources/actions/methods/list' insert: [] update: [] delete: [] entity_types: - id: connectors.entity_types + id: google.connectors.entity_types name: entity_types title: Entity_types methods: @@ -2058,7 +2058,7 @@ components: update: [] delete: [] entities: - id: connectors.entities + id: google.connectors.entities name: entities title: Entities methods: @@ -2103,15 +2103,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/entities/methods/list' - $ref: '#/components/x-stackQL-resources/entities/methods/get' + - $ref: '#/components/x-stackQL-resources/entities/methods/list' insert: - $ref: '#/components/x-stackQL-resources/entities/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/entities/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/entities/methods/delete' entities_entities_with_conditions: - id: connectors.entities_entities_with_conditions + id: google.connectors.entities_entities_with_conditions name: entities_entities_with_conditions title: Entities_entities_with_conditions methods: 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 c968cfa0..25ec678e 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/contactcenteraiplatform.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/contactcenteraiplatform.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1alpha1 x-discovery-doc-revision: '20240531' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/solutions/contact-center-ai-platform servers: @@ -949,7 +949,7 @@ components: - '2' x-stackQL-resources: locations: - id: contactcenteraiplatform.locations + id: google.contactcenteraiplatform.locations name: locations title: Locations methods: @@ -979,13 +979,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: contactcenteraiplatform.operations + id: google.contactcenteraiplatform.operations name: operations title: Operations methods: @@ -1023,14 +1023,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' contact_centers: - id: contactcenteraiplatform.contact_centers + id: google.contactcenteraiplatform.contact_centers name: contact_centers title: Contact_centers methods: @@ -1075,11 +1075,12 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/contact_centers/methods/list' - $ref: '#/components/x-stackQL-resources/contact_centers/methods/get' + - $ref: '#/components/x-stackQL-resources/contact_centers/methods/list' insert: - $ref: '#/components/x-stackQL-resources/contact_centers/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/contact_centers/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/contact_centers/methods/delete' paths: 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 46a5d777..cbfaee57 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/contactcenterinsights.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/contactcenterinsights.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1 x-discovery-doc-revision: '20240527' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/contact-center/insights/docs servers: @@ -34,1349 +34,1089 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerIntentMatchingSource: - id: >- - GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerIntentMatchingSource - type: object - properties: - title: - type: string - description: Title of the document. - uri: - description: URI the data is sourced from. - type: string - description: Details about source of Intent Matching answer. - GoogleCloudContactcenterinsightsV1ConversationLevelSentiment: + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest: + id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest + description: The request to ingest conversations. type: object - description: One channel of conversation-level sentiment data. properties: - sentimentData: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' - description: Data specifying sentiment. - channelTag: + sampleSize: type: integer format: int32 - description: The channel of the audio that the data applies to. - id: GoogleCloudContactcenterinsightsV1ConversationLevelSentiment - GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseSuggestedQuery: - properties: - queryText: - type: string - description: Suggested query text. - score: - type: number - format: float - description: Suggested query score. - id: >- - GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseSuggestedQuery - type: object - description: Represents a suggested query. - GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponse: - type: object - description: >- - Response for Knowledge Assist. Contains suggested query and optionally - includes an answer for the query. - properties: - suggestedQueryAnswer: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswer - description: >- - The answer generated for the suggested query. Whether or not an - answer is generated depends on how confident we are about the - generated query. - suggestedQuery: description: >- - The query suggested based on the context. Suggestion is made only if - it is different from the previous suggestion. + 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. Note that conversations produced via sampling will + not be ingested by subsequent ingest requests unless they are first + deleted. + gcsSource: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseSuggestedQuery - id: GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponse - GoogleCloudContactcenterinsightsV1GcsSource: - id: GoogleCloudContactcenterinsightsV1GcsSource - type: object - description: A Cloud Storage source of conversation data. - properties: - transcriptUri: - type: string - description: >- - Immutable. Cloud Storage URI that points to a file that contains the - conversation transcript. - audioUri: - type: string + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource description: >- - Cloud Storage URI that points to a file that contains the - conversation audio. - GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest: - properties: - conversation: + A cloud storage bucket source. Note that any previously ingested + objects from the source will be skipped to avoid duplication. + conversationConfig: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Conversation - description: Required. The conversation resource to create. - conversationId: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig + description: Configuration that applies to all conversations. + speechConfig: 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-` + Optional. Default Speech-to-Text configuration. Optional, will + default to the config specified in Settings. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SpeechConfig + parent: + description: Required. The parent resource for new conversations. type: string + transcriptObjectConfig: + description: Configuration for when `source` contains conversation transcripts. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig redactionConfig: description: >- - Optional. DLP settings for transcript redaction. Will default to the - config specified in Settings. + Optional. DLP settings for transcript redaction. Optional, 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. - parent: - type: string - description: Required. The parent resource of the conversation. - type: object - description: Request to upload a conversation. - id: GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest - GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation: - description: >- - An annotation that was generated during the customer and agent - interaction. - id: GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation + GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata: type: object + description: Metadata for deploying an issue model. properties: - dialogflowInteraction: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData - description: Dialogflow interaction data. - annotationId: - description: >- - The unique identifier of the annotation. Format: - projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} + endTime: + description: Output only. The time the operation finished running. type: string - answerFeedback: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback - description: The feedback that the customer has about the answer in `data`. - faqAnswer: - description: Agent Assist FAQ answer data. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData - smartComposeSuggestion: - description: Agent Assist Smart Compose suggestion data. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData - endBoundary: - description: >- - The boundary in the conversation where the annotation ends, - inclusive. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary - knowledgeAssistResult: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponse - description: The Knowledge Assist result. - conversationSummarizationSuggestion: - description: Conversation summarization suggestion data. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData - startBoundary: - description: >- - The boundary in the conversation where the annotation starts, - inclusive. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary - generatorSuggestionResult: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GetGeneratorSuggestionResponse - description: The generator suggestion result. - knowledgeSearchResult: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SearchKnowledgeAnswer - description: The Knowledge Search result. - articleSuggestion: - description: Agent Assist Article Suggestion data. + format: google-datetime + readOnly: true + request: + description: The original request for deployment. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest createTime: + description: Output only. The time the operation was created. format: google-datetime type: string - description: The time at which this annotation was created. - smartReply: - description: Agent Assist Smart Reply data. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SmartReplyData - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment: + readOnly: true + id: GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata + GoogleCloudContactcenterinsightsV1ListIssueModelsResponse: + type: object + description: The response of listing issue models. + id: GoogleCloudContactcenterinsightsV1ListIssueModelsResponse + properties: + issueModels: + items: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel' + type: array + description: The issue models that match the request. + GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig: id: >- - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment + GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig properties: - languageCode: - type: string + customerChannel: + format: int32 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". - sentiment: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData - description: The sentiment for this transcript segment. - channelTag: + 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: 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. + 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 - segmentParticipant: - description: The participant of this segment. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant - text: - description: The text of this segment. - type: string - dialogflowSegmentMetadata: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata - description: CCAI metadata relating to the current transcript segment. - messageTime: + type: integer + agentId: type: string - description: The time that the message occurred, if provided. - format: google-datetime - 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 - words: - type: array description: >- - A list of the word-specific information for each word in the - segment. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo + 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 via the + `metadata_bucket_uri`. type: object - description: A segment of a full transcript. - GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup: + description: Configuration that applies to all conversations. + GoogleCloudContactcenterinsightsV1alpha1HoldData: type: object - description: A message representing a rule in the phrase matcher. - id: GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup + id: GoogleCloudContactcenterinsightsV1alpha1HoldData + properties: {} + description: The data for a hold annotation. + GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestion: properties: - phraseMatchRules: + applicableInstructions: items: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRule - description: A list of phrase match rules that are included in this group. + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AgentCoachingInstruction + description: Optional. Instructions applicable based on the current context. type: array - type: - description: Required. The type of this phrase match rule group. - enum: - - PHRASE_MATCH_RULE_GROUP_TYPE_UNSPECIFIED - - ALL_OF - - ANY_OF - type: string - 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. - GoogleCloudContactcenterinsightsV1DialogflowInteractionData: - id: GoogleCloudContactcenterinsightsV1DialogflowInteractionData - description: Dialogflow interaction data. + suggestionEval: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentCoachingSuggestionEval + description: Self evaluation of the suggestion. + agentActionSuggestions: + description: Optional. Suggested actions for the agent to take. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentActionSuggestion + sampleResponses: + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionSampleResponse + description: Optional. Sample response for the Agent. + type: array + suggestionReasoning: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentCoachingSuggestionReasoning + description: Reasoning for the suggestion. + id: GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestion + description: Suggestion for coaching agents. + type: object + GoogleCloudContactcenterinsightsV1alpha1InterruptionData: + properties: {} + id: GoogleCloudContactcenterinsightsV1alpha1InterruptionData + type: object + description: The data for an interruption annotation. + GoogleCloudContactcenterinsightsV1ConversationTranscript: + id: GoogleCloudContactcenterinsightsV1ConversationTranscript properties: - confidence: - description: >- - The confidence of the match ranging from 0.0 (completely uncertain) - to 1.0 (completely certain). - format: float - type: number - dialogflowIntentId: + transcriptSegments: + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment + type: array description: >- - The Dialogflow intent resource path. Format: - projects/{project}/agent/{agent}/intents/{intent} - type: string + A list of sequential transcript segments that comprise the + conversation. + description: A message representing the transcript of a conversation. + type: object + GoogleCloudContactcenterinsightsV1ListConversationsResponse: type: object - GoogleCloudContactcenterinsightsV1CalculateStatsResponse: properties: - issueMatchesStats: - additionalProperties: + conversations: + description: The conversations that match the request. + items: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats - 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/` - issueMatches: - type: object - additionalProperties: - type: integer - format: int32 - 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 - averageTurnCount: - format: int32 - type: integer - description: The average number of turns per conversation. - averageDuration: + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + type: array + nextPageToken: description: >- - The average duration of all conversations. The average is calculated - using only conversations that have a time duration. - format: google-duration + 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 - conversationCount: - type: integer - format: int32 - 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. - customHighlighterMatches: - type: object + id: GoogleCloudContactcenterinsightsV1ListConversationsResponse + description: The response of listing conversations. + GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerFaqSource: + properties: + document: description: >- - A map associating each custom highlighter resource name with its - respective number of matches in the set of conversations. - additionalProperties: - type: integer - format: int32 - id: GoogleCloudContactcenterinsightsV1CalculateStatsResponse - description: The response for calculating conversation statistics. + Indicates which Knowledge Document this answer was extracted from. + Format: `projects//knowledgeBases//documents/`. + type: string + question: + type: string + description: The corresponding FAQ question. + id: >- + GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerFaqSource + description: Details about source of FAQ answer. type: object - GoogleCloudContactcenterinsightsV1ConversationDataSource: - id: GoogleCloudContactcenterinsightsV1ConversationDataSource + GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentActionSuggestion: type: object + id: >- + GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentActionSuggestion + description: >- + Actions suggested for the agent. This is based on applicable + instructions. properties: - gcsSource: - description: A Cloud Storage location specification for the audio and transcript. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1GcsSource' - dialogflowSource: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowSource - description: The source when the conversation comes from Dialogflow. - description: The conversation source, which is a combination of transcript and audio. - GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig: - properties: - 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: - 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 - agentId: + agentAction: 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 via the - `metadata_bucket_uri`. - description: Configuration that applies to all conversations. - id: >- - GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig + description: Optional. The suggested action for the agent. + GoogleCloudContactcenterinsightsV1alpha1SilenceData: + description: The data for a silence annotation. + properties: {} type: object - GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata: - description: The metadata for a bulk delete conversations operation. - id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata + id: GoogleCloudContactcenterinsightsV1alpha1SilenceData + GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest: + description: Request to export an issue model. + id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest type: object + properties: + name: + description: Required. The issue model to export + type: string + gcsDestination: + description: Google Cloud Storage URI to export the Issue Model to. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination + GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata: properties: request: - description: The original request for bulk delete. + description: The original request for undeployment. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest endTime: - format: google-datetime type: string - description: The time the operation finished running. - 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 - createTime: - description: The time the operation was created. + readOnly: true + description: Output only. The time the operation finished running. format: google-datetime + createTime: + description: Output only. The time the operation was created. + readOnly: true type: string - GoogleCloudContactcenterinsightsV1alpha1SearchKnowledgeAnswer: + format: google-datetime + description: Metadata for undeploying an issue model. + type: object + id: GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata + GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest: + description: The request to undeploy an issue model. + id: GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest + type: object properties: - answerRecord: - description: >- - The name of the answer record. Format: `projects//locations//answer - Records/` - type: string - answer: - type: string - description: >- - The piece of text from the knowledge base documents that answers the - search query - answerType: - enumDescriptions: - - The answer has a unspecified type. - - The answer is from FAQ documents. - - The answer is from generative model. - - The answer is from intent matching. + name: type: string - enum: - - ANSWER_TYPE_UNSPECIFIED - - FAQ - - GENERATIVE - - INTENT - description: The type of the answer. - answerSources: - description: All sources used to generate the answer. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SearchKnowledgeAnswerAnswerSource - confidenceScore: - format: float - type: number - description: The confidence score in [0.0, 1.0] range. - id: GoogleCloudContactcenterinsightsV1alpha1SearchKnowledgeAnswer - description: Represents a SearchKnowledge answer. - type: object - GoogleCloudContactcenterinsightsV1Intent: - type: object - description: >- - The data for an intent. Represents a detected intent in the - conversation, for example MAKES_PROMISE. + description: Required. The issue model to undeploy. + GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest: properties: - displayName: - description: The human-readable name of the intent. - type: string - id: + parent: + description: Required. The parent resource of the issue model. type: string - description: The unique identifier of the intent. - id: GoogleCloudContactcenterinsightsV1Intent - GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse: - description: The response to undeploy an issue model. - id: GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse + issueModel: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModel + description: Required. The issue model to create. + id: GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest + description: The request to create an issue model. type: object - properties: {} - GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentCoachingSuggestionEval: - properties: - actionActionSuggestionEval: - type: string - description: Optional. Eval for Agent action suggestion. - sampleResponseEval: - type: string - description: Optional. Eval for sample response. + GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData: id: >- - GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentCoachingSuggestionEval + GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData type: object - description: Self evaluations of the suggestion. - GoogleCloudContactcenterinsightsV1ArticleSuggestionData: + description: Conversation summarization suggestion data. properties: - uri: - description: Article URI. - type: string - title: + textSections: + 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. + additionalProperties: + type: string + type: object + text: type: string - description: Article title. - queryRecord: + description: The summarization content that is concatenated into one string. + answerRecord: type: string description: >- The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} - source: + confidence: + format: float + description: The confidence score of the summarization. + type: number + conversationModel: description: >- - The knowledge document that this answer was extracted from. Format: - projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} + The name of the model that generates this summary. Format: + projects/{project}/locations/{location}/conversationModels/{conversation_model} 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). - type: number - format: float metadata: - additionalProperties: - type: string type: object description: >- - Map that contains metadata about the Article Suggestion and the - document that it originates from. - description: Agent Assist Article Suggestion data. - id: GoogleCloudContactcenterinsightsV1ArticleSuggestionData - type: object - GoogleCloudContactcenterinsightsV1SmartReplyData: - description: Agent Assist Smart Reply data. - id: GoogleCloudContactcenterinsightsV1SmartReplyData - properties: - metadata: - description: >- - Map that contains metadata about the Smart Reply and the document - from which it originates. - type: object + A map that contains metadata about the summarization and the + document from which it originates. additionalProperties: type: string - queryRecord: - description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} + GoogleCloudContactcenterinsightsV1alpha1SearchKnowledgeAnswerAnswerSource: + id: >- + GoogleCloudContactcenterinsightsV1alpha1SearchKnowledgeAnswerAnswerSource + description: The sources of the answers. + properties: + snippet: + description: The relevant snippet of the article. type: string - reply: - description: The content of the reply. + title: type: string - confidenceScore: - format: double + description: The title of the article. + document: 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 + The document from which the snippet was extracted. Format: + `projects//knowledgeBases//documents/` + type: string + uri: + type: string + description: The URI of the article. type: object - GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentActionSuggestion: - description: >- - Actions suggested for the agent. This is based on applicable - instructions. - id: >- - GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentActionSuggestion + GoogleCloudContactcenterinsightsV1DeployIssueModelRequest: properties: - agentAction: + name: + description: Required. The issue model to deploy. type: string - description: Optional. The suggested action for the agent. + description: The request to deploy an issue model. type: object - GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSourceSnippet: - description: Snippet Source for a Generative Prediction. + id: GoogleCloudContactcenterinsightsV1DeployIssueModelRequest + GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest: + id: GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest properties: - title: - type: string - description: Title of the document. - uri: - type: string - description: URI the data is sourced from. - document: + filter: + description: Filter used to select the subset of conversations to delete. type: string + parent: description: >- - Indicates which Knowledge Document this snippet was extracted from. - Format: `projects//knowledgeBases//documents/`. - text: - description: text taken from that URI. + Required. The parent resource to delete conversations from. Format: + projects/{project}/locations/{location} type: string - id: >- - GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSourceSnippet + 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. type: object - GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo: - id: >- - GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo - description: Information about an agent involved in the conversation. + description: The request to delete conversations in bulk. + GoogleCloudContactcenterinsightsV1DialogflowSource: type: object + description: A Dialogflow source of conversation data. properties: - displayName: - description: The agent's name. - type: string - team: - description: A user-specified string representing the agent's team. + audioUri: + description: >- + Cloud Storage URI that points to a file that contains the + conversation audio. type: string - dispositionCode: + dialogflowConversation: type: string description: >- - A user-provided string indicating the outcome of the agent's segment - of the call. - agentId: - type: string - description: A user-specified string representing the agent. - GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse: - properties: {} - id: GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse - description: The response to undeploy an issue model. + Output only. The name of the Dialogflow conversation that this + conversation resource is derived from. Format: + projects/{project}/locations/{location}/conversations/{conversation} + readOnly: true + id: GoogleCloudContactcenterinsightsV1DialogflowSource + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats: + id: >- + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats + description: Statistics for IngestConversations operation. type: object - GoogleCloudContactcenterinsightsV1IngestConversationsRequest: properties: - conversationConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig - description: Configuration that applies to all conversations. - transcriptObjectConfig: - description: Configuration for when `source` contains conversation transcripts. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig - sampleSize: - 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. Note that conversations produced via sampling will - not be ingested by subsequent ingest requests unless they are first - deleted. - type: integer + duplicatesSkippedCount: + readOnly: true format: int32 - speechConfig: description: >- - Optional. Default Speech-to-Text configuration. Optional, will - default to the config specified in Settings. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig' - redactionConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig + Output only. The number of objects skipped because another + conversation with the same transcript uri had already been ingested. + type: integer + successfulIngestCount: + readOnly: true 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 - gcsSource: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource + Output only. The number of new conversations added during this + ingest operation. + type: integer + format: int32 + failedIngestCount: + format: int32 + readOnly: true + type: integer description: >- - A cloud storage bucket source. Note that any previously ingested - objects from the source will be skipped to avoid duplication. - type: object - id: GoogleCloudContactcenterinsightsV1IngestConversationsRequest - description: The request to ingest conversations. - GoogleCloudContactcenterinsightsV1ExactMatchConfig: + 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: + readOnly: true + type: integer + format: int32 + description: >- + Output only. The number of objects processed during the ingest + operation. + GoogleCloudContactcenterinsightsV1IngestConversationsMetadata: type: object - id: GoogleCloudContactcenterinsightsV1ExactMatchConfig properties: - caseSensitive: - type: boolean - description: Whether to consider case sensitivity when performing an exact match. - description: Exact match configuration. - GoogleCloudContactcenterinsightsV1FaqAnswerData: + createTime: + format: google-datetime + description: Output only. The time the operation was created. + type: string + readOnly: true + ingestConversationsStats: + description: Output only. Statistics for IngestConversations operation. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats + endTime: + format: google-datetime + readOnly: true + description: Output only. The time the operation finished running. + type: string + request: + description: Output only. The original request for ingest. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequest + partialErrors: + type: array + description: >- + Output only. Partial errors during ingest operation that might cause + the operation output to be incomplete. + items: + $ref: '#/components/schemas/GoogleRpcStatus' + readOnly: true + id: GoogleCloudContactcenterinsightsV1IngestConversationsMetadata + description: The metadata for an IngestConversations operation. + GoogleCloudContactcenterinsightsV1Conversation: + description: The conversation resource. type: object - id: GoogleCloudContactcenterinsightsV1FaqAnswerData - description: Agent Assist frequently-asked-question answer data. properties: - answer: - description: The piece of text from the `source` knowledge base document. + startTime: + description: The time at which the conversation started. type: string - confidenceScore: - type: number - format: float - 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: + format: google-datetime + createTime: + description: Output only. The time at which the conversation was created. + format: google-datetime + readOnly: true type: string + duration: + readOnly: true + type: string + description: Output only. The duration of the conversation. + format: google-duration + qualityMetadata: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationQualityMetadata + description: Conversation metadata related to quality management. + obfuscatedUserId: + description: Obfuscated user ID which the customer sent to us. + type: string + transcript: + readOnly: true + description: Output only. The conversation transcript. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscript + latestSummary: + description: Output only. Latest summary of the conversation. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData + readOnly: true + 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. description: >- - The knowledge document that this answer was extracted from. Format: - projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. - metadata: - type: object - description: >- - Map that contains metadata about the FAQ answer and the document - that it originates from. - additionalProperties: - type: string - queryRecord: + Immutable. The conversation medium, if unspecified will default to + PHONE_CALL. type: string + enum: + - MEDIUM_UNSPECIFIED + - PHONE_CALL + - CHAT + turnCount: + description: Output only. The number of turns in the conversation. + type: integer + format: int32 + readOnly: true + updateTime: + readOnly: true description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - question: + Output only. The most recent time at which the conversation was + updated. type: string - description: The corresponding FAQ question. - GoogleCloudContactcenterinsightsV1Settings: - id: GoogleCloudContactcenterinsightsV1Settings - description: The settings resource. - properties: - conversationTtl: + format: google-datetime + agentId: type: string 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 + An opaque, user-specified string representing the human agent who + handled the conversation. name: - description: >- - Immutable. The resource name of the settings resource. Format: - projects/{project}/locations/{location}/settings type: string - languageCode: + description: >- + Immutable. The resource name of the conversation. Format: + projects/{project}/locations/{location}/conversations/{conversation} + dataSource: + description: The source of the audio and transcription for the conversation. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationDataSource + 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 + latestAnalysis: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' + description: Output only. The conversation's latest analysis, if one exists. + readOnly: true + dialogflowIntents: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowIntent + readOnly: true 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. - createTime: - format: google-datetime + 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 + runtimeAnnotations: + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1RuntimeAnnotation + description: >- + Output only. The annotations that were generated during the customer + and agent interaction. + type: array readOnly: true - description: Output only. The time at which the settings was created. - type: string - updateTime: - format: google-datetime + languageCode: + description: A user-specified language code for the conversation. type: string - description: Output only. The time at which the settings were last updated. - readOnly: true - pubsubNotificationSettings: + callMetadata: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationCallMetadata + description: Call-specific metadata. + labels: 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 completes. * "update-conversation": Notify - each time a conversation is updated via UpdateConversation. * - "upload-conversation": Notify when an UploadConversation LRO - completes. Values are Pub/Sub topics. The format of each Pub/Sub - topic is: projects/{project}/topics/{topic} + 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 - speechConfig: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig' + expireTime: + type: string + format: google-datetime description: >- - Optional. Default Speech-to-Text resources to be used 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. - analysisConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig - description: Default analysis settings. - 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/GoogleCloudContactcenterinsightsV1RedactionConfig - type: object - GoogleCloudContactcenterinsightsV1alpha1IssueAssignment: + The time at which this conversation should expire. After this time, + the conversation data and any associated analyses will be deleted. + id: GoogleCloudContactcenterinsightsV1Conversation + GoogleCloudContactcenterinsightsV1IntentMatchData: + id: GoogleCloudContactcenterinsightsV1IntentMatchData properties: - score: - format: double - description: >- - Score indicating the likelihood of the issue assignment. currently - bounded on [0,1]. - type: number - issue: - type: string - description: Resource name of the assigned issue. - displayName: + intentUniqueId: description: >- - Immutable. Display name of the assigned issue. This field is set at - time of analyis and immutable since then. + The id of the matched intent. Can be used to retrieve the + corresponding intent information. type: string - description: Information about the issue. + 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 - id: GoogleCloudContactcenterinsightsV1alpha1IssueAssignment - GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswerAnswerSource: - description: The sources of the answers. - id: GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswerAnswerSource + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment: properties: - snippet: - description: The relevant snippet of the article. - type: string - uri: - description: The URI of the article. + segmentParticipant: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationParticipant + description: The participant of this segment. + words: + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo + type: array + description: >- + A list of the word-specific information for each word in the + segment. + text: type: string - document: + description: The text of this segment. + languageCode: type: string description: >- - The document from which the snippet was extracted. Format: - `projects//knowledgeBases//documents/` - title: + The language code of this segment as a + [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. + Example: "en-US". + 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 + 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' + messageTime: + description: The time that the message occurred, if provided. + format: google-datetime type: string - description: The title of the article. - type: object - GoogleCloudContactcenterinsightsV1ListIssuesResponse: - properties: - issues: - description: The issues that match the request. - type: array - items: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' - description: The response of listing issues. + 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 type: object - id: GoogleCloudContactcenterinsightsV1ListIssuesResponse - GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswer: - description: Represents a SearchKnowledge answer. - id: GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswer + id: >- + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment + description: A segment of a full transcript. + GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig: type: object + id: GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig properties: - confidenceScore: - description: The confidence score in [0.0, 1.0] range. - type: number - format: float - answerType: - description: The type of the answer. + trainingConversationsCount: + readOnly: true + description: Output only. Number of conversations used in training. Output only. + type: string + format: int64 + medium: enumDescriptions: - - The answer has a unspecified type. - - The answer is from FAQ documents. - - The answer is from generative model. - - The answer is from intent matching. + - 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`. enum: - - ANSWER_TYPE_UNSPECIFIED - - FAQ - - GENERATIVE - - INTENT + - MEDIUM_UNSPECIFIED + - PHONE_CALL + - CHAT type: string - answerSources: - description: All sources used to generate the answer. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswerAnswerSource - answer: + deprecated: true + filter: type: string description: >- - The piece of text from the knowledge base documents that answers the - search query - answerRecord: - description: >- - The name of the answer record. Format: `projects//locations//answer - Records/` - type: string - GoogleCloudContactcenterinsightsV1alpha1AnalysisResult: - id: GoogleCloudContactcenterinsightsV1alpha1AnalysisResult - properties: - callAnalysisMetadata: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata - description: Call-specific metadata created by the analysis. - endTime: - description: The time at which the analysis ended. - format: google-datetime - type: string - description: The result of an analysis. + 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. + GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentCoachingSuggestionEval: type: object - GoogleCloudContactcenterinsightsV1IngestConversationsMetadata: + description: Self evaluations of the suggestion. properties: - createTime: - readOnly: true - description: Output only. The time the operation was created. + actionActionSuggestionEval: type: string - format: google-datetime - endTime: - format: google-datetime + description: Optional. Eval for Agent action suggestion. + sampleResponseEval: type: string - description: Output only. The time the operation finished running. + description: Optional. Eval for sample response. + id: >- + GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentCoachingSuggestionEval + GoogleCloudContactcenterinsightsV1ExactMatchConfig: + type: object + description: Exact match configuration. + id: GoogleCloudContactcenterinsightsV1ExactMatchConfig + properties: + caseSensitive: + description: Whether to consider case sensitivity when performing an exact match. + type: boolean + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata + type: object + description: The metadata for an IngestConversations operation. + properties: + ingestConversationsStats: + description: Output only. Statistics for IngestConversations operation. readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats partialErrors: - items: - $ref: '#/components/schemas/GoogleRpcStatus' type: array description: >- Output only. Partial errors during ingest operation that might cause the operation output to be incomplete. + items: + $ref: '#/components/schemas/GoogleRpcStatus' readOnly: true - ingestConversationsStats: - description: Output only. Statistics for IngestConversations operation. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats + endTime: + description: Output only. The time the operation finished running. + format: google-datetime readOnly: true + type: string request: description: Output only. The original request for ingest. + readOnly: true $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest + createTime: + type: string readOnly: true - id: GoogleCloudContactcenterinsightsV1IngestConversationsMetadata - description: The metadata for an IngestConversations operation. - type: object - GoogleCloudContactcenterinsightsV1alpha1AgentCoachingInstruction: + description: Output only. The time the operation was created. + format: google-datetime + GoogleCloudContactcenterinsightsV1FaqAnswerData: + id: GoogleCloudContactcenterinsightsV1FaqAnswerData type: object properties: - agentAction: + source: description: >- - Optional. The action that human agent should take. For example, - "apologize for the slow shipping". If the users only want to use - agent coaching for intent detection, agent_action can be empty + The knowledge document that this answer was extracted from. Format: + projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. type: string - condition: - description: >- - Optional. The condition of the instruction. For example, "the - customer wants to cancel an order". If the users want the - instruction to be triggered unconditionally, the condition can be - empty. + question: + description: The corresponding FAQ question. type: string - displayName: + queryRecord: type: string - description: Optional. Display name for the instruction. - systemAction: description: >- - Optional. The action that system should take. For example, "call - GetOrderTime with order_number={order number provided by the - customer}". If the users don't have plugins or don't want to trigger - plugins, the system_action can be empty - type: string - description: - type: string - description: Optional. The detailed description of this instruction. + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} + 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). + answer: + description: The piece of text from the `source` knowledge base document. + type: string metadata: additionalProperties: type: string + description: >- + Map that contains metadata about the FAQ answer and the document + that it originates from. type: object - description: Optional. Additional information attached to this instruction. - description: Agent Coaching instructions that customer can configure. - id: GoogleCloudContactcenterinsightsV1alpha1AgentCoachingInstruction - GoogleCloudContactcenterinsightsV1DialogflowSource: + description: Agent Assist frequently-asked-question answer data. + GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata: + description: Metadata for a create analysis operation. + type: object + id: GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata properties: - audioUri: + conversation: + type: string description: >- - Cloud Storage URI that points to a file that contains the - conversation audio. + Output only. The Conversation that this Analysis Operation belongs + to. + readOnly: true + annotatorSelector: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector + description: Output only. The annotator selector used for the analysis (if any). + readOnly: true + createTime: type: string - dialogflowConversation: + description: Output only. The time the operation was created. + format: google-datetime readOnly: true + endTime: 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} - type: object - id: GoogleCloudContactcenterinsightsV1DialogflowSource - description: A Dialogflow source of conversation data. - GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination: - id: GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination + description: Output only. The time the operation finished running. + format: google-datetime + readOnly: true + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource: type: object - description: Google Cloud Storage Object URI to save the issue model to. + id: >- + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource + description: Configuration for Cloud Storage bucket sources. properties: - objectUri: - description: 'Required. Format: `gs:///`' + bucketUri: type: string - GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse: - description: The response to deploy an issue model. - id: GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse + 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. + type: array + items: + type: string + bucketObjectType: + enum: + - BUCKET_OBJECT_TYPE_UNSPECIFIED + - TRANSCRIPT + - AUDIO + type: string + 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`. + metadataBucketUri: + type: string + description: >- + Optional. The Cloud Storage path to the source object metadata. Note + that: [1] metadata files are expected to be in JSON format [2] + metadata and source objects must be in separate buckets [3] a source + object's metadata object must share the same name to be properly + ingested + GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries: + description: A time series representing conversations over time. type: object - properties: {} - GoogleCloudContactcenterinsightsV1ImportIssueModelRequest: + id: GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries properties: - gcsSource: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource - description: Google Cloud Storage source message. - createNewModel: - type: boolean + points: description: >- - Optional. If set to true, will create a new 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: + 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 + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval + intervalDuration: + format: google-duration type: string - description: Required. The parent resource of the issue model. - description: Request to import an issue model. - type: object - id: GoogleCloudContactcenterinsightsV1ImportIssueModelRequest - GoogleLongrunningListOperationsResponse: - description: The response message for Operations.ListOperations. + description: The duration of each interval. + GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig: type: object properties: - nextPageToken: + trainingConversationsCount: + readOnly: true + format: int64 + description: Output only. Number of conversations used in training. Output only. type: string - description: The standard List next-page token. - operations: + filter: description: >- - A list of operations that matches the specified filter in the - request. - items: - $ref: '#/components/schemas/GoogleLongrunningOperation' - type: array - id: GoogleLongrunningListOperationsResponse - GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata: - properties: - customerChannel: - type: integer - description: The audio channel that contains the customer. - format: int32 - agentChannel: - format: int32 - type: integer - description: The audio channel that contains the agent. - id: GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata - description: Call-specific metadata. - type: object - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript: - description: A message representing the transcript of a conversation. + A filter to reduce the conversations used for training the model to + a specific subset. + type: string + medium: + deprecated: true + 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: >- + 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`. + description: Configs for the input data used to create the issue model. + id: GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig + GoogleCloudContactcenterinsightsV1GeneratorSuggestion: + description: Suggestion generated using a Generator. type: object - id: GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript properties: - transcriptSegments: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment - type: array - description: >- - A list of sequential transcript segments that comprise the - conversation. - GoogleCloudContactcenterinsightsV1HoldData: + summarySuggestion: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1SummarySuggestion + description: Optional. Suggested summary. + agentCoachingSuggestion: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AgentCoachingSuggestion + description: Optional. Suggestion to coach the agent. + freeFormSuggestion: + description: Optional. Free form suggestion. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1FreeFormSuggestion + id: GoogleCloudContactcenterinsightsV1GeneratorSuggestion + GoogleCloudContactcenterinsightsV1SilenceData: type: object - id: GoogleCloudContactcenterinsightsV1HoldData - description: The data for a hold annotation. + id: GoogleCloudContactcenterinsightsV1SilenceData + description: The data for a silence annotation. properties: {} - GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata: - type: object - description: Metadata for creating an issue model. - id: GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata + GoogleCloudContactcenterinsightsV1CallAnnotation: properties: - request: + silenceData: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SilenceData' + description: Data specifying silence. + sentimentData: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' + description: Data specifying sentiment. + holdData: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1HoldData' + description: Data specifying a hold. + intentMatchData: + description: Data specifying an intent match. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest - description: The original request for creation. - createTime: - format: google-datetime - type: string - readOnly: true - description: Output only. The time the operation was created. - endTime: - format: google-datetime - type: string - description: Output only. The time the operation finished running. - readOnly: true - GoogleCloudContactcenterinsightsV1RuntimeAnnotation: - description: >- - An annotation that was generated during the customer and agent - interaction. - properties: - endBoundary: + #/components/schemas/GoogleCloudContactcenterinsightsV1IntentMatchData + channelTag: + description: >- + The channel of the audio where the annotation occurs. For + single-channel audio, this field is not populated. + type: integer + format: int32 + annotationStartBoundary: $ref: >- #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary description: >- - The boundary in the conversation where the annotation ends, + The boundary in the conversation where the annotation starts, inclusive. - dialogflowInteraction: + issueMatchData: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowInteractionData - description: Dialogflow interaction data. - createTime: - format: google-datetime - type: string - description: The time at which this annotation was created. - conversationSummarizationSuggestion: - description: Conversation summarization suggestion data. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData - faqAnswer: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1FaqAnswerData' - description: Agent Assist FAQ answer data. - smartComposeSuggestion: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData - description: Agent Assist Smart Compose suggestion data. - generatorSuggestionResult: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1GetGeneratorSuggestionResponse - description: The generator suggestion result. - knowledgeSearchResult: - description: The Knowledge Search result. + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueMatchData + description: Data specifying an issue match. + annotationEndBoundary: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswer - answerFeedback: + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary + description: >- + The boundary in the conversation where the annotation ends, + inclusive. + interruptionData: + description: Data specifying an interruption. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnswerFeedback - description: The feedback that the customer has about the answer in `data`. - articleSuggestion: + #/components/schemas/GoogleCloudContactcenterinsightsV1InterruptionData + phraseMatchData: + description: Data specifying a phrase match. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ArticleSuggestionData - description: Agent Assist Article Suggestion data. - knowledgeAssistResult: - description: The Knowledge Assist result. + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchData + entityMentionData: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponse - smartReply: - description: Agent Assist Smart Reply data. + #/components/schemas/GoogleCloudContactcenterinsightsV1EntityMentionData + description: Data specifying an entity mention. + description: A piece of metadata that applies to a window of a call. + id: GoogleCloudContactcenterinsightsV1CallAnnotation + type: object + GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest: + properties: + bigQueryDestination: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1SmartReplyData - annotationId: + #/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. + enum: + - WRITE_DISPOSITION_UNSPECIFIED + - WRITE_TRUNCATE + - WRITE_APPEND type: string + description: Options for what to do if the destination table already exists. + filter: description: >- - The unique identifier of the annotation. Format: - projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} - startBoundary: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary + A filter to reduce results to a specific subset. Useful for + exporting conversations with specific properties. + type: string + parent: + type: string + description: Required. The parent resource to export data from. + kmsKey: description: >- - The boundary in the conversation where the annotation starts, - inclusive. + 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 type: object - id: GoogleCloudContactcenterinsightsV1RuntimeAnnotation - GoogleCloudContactcenterinsightsV1FreeFormSuggestion: - description: Suggestion generated using free form generator. + id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest + description: The request to export insights. + GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse: type: object + properties: {} + description: The response to undeploy an issue model. + id: GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse + GoogleCloudContactcenterinsightsV1DialogflowInteractionData: + id: GoogleCloudContactcenterinsightsV1DialogflowInteractionData properties: - labels: - type: array - items: - type: string - description: Optional. Labels for the generator. - response: + confidence: + type: number + description: >- + The confidence of the match ranging from 0.0 (completely uncertain) + to 1.0 (completely certain). + format: float + dialogflowIntentId: type: string - description: Required. Free form suggestion. - id: GoogleCloudContactcenterinsightsV1FreeFormSuggestion - GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata: + description: >- + The Dialogflow intent resource path. Format: + projects/{project}/agent/{agent}/intents/{intent} + description: Dialogflow interaction data. + type: object + GoogleCloudContactcenterinsightsV1alpha1Intent: + id: GoogleCloudContactcenterinsightsV1alpha1Intent type: object + description: >- + The data for an intent. Represents a detected intent in the + conversation, for example MAKES_PROMISE. properties: - failedAnalysesCount: - type: integer - format: int32 - description: The number of requested analyses that have failed so far. - endTime: - description: The time the operation finished running. + displayName: type: string - format: google-datetime - request: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest - description: The original request for bulk analyze. - createTime: - format: google-datetime - description: The time the operation was created. + description: The human-readable name of the intent. + id: type: string - partialErrors: - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - readOnly: true - description: >- - Output only. Partial errors during bulk analyze operation that might - cause the operation output to be incomplete. - 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 - completedAnalysesCount: - type: integer - format: int32 - description: >- - The number of requested analyses that have completed successfully so - far. - id: GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata - description: The metadata for a bulk analyze conversations operation. - GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval: - type: object + description: The unique identifier of the intent. + GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest: properties: - startTime: - format: google-datetime - description: The start time of this interval. + name: + description: Required. The name of the issue model to delete. type: string - conversationCount: - description: The number of conversations created in this interval. - format: int32 - type: integer - description: A single interval in a time series. - id: >- - GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval - GoogleCloudContactcenterinsightsV1SummarySuggestionSummarySection: + description: The request to delete an issue model. + id: GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest + type: object + GoogleCloudContactcenterinsightsV1ConversationDataSource: + id: GoogleCloudContactcenterinsightsV1ConversationDataSource + type: object properties: - summary: + gcsSource: + description: A Cloud Storage location specification for the audio and transcript. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1GcsSource' + dialogflowSource: + description: The source when the conversation comes from Dialogflow. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowSource + description: The conversation source, which is a combination of transcript and audio. + GoogleCloudContactcenterinsightsV1alpha1SmartReplyData: + id: GoogleCloudContactcenterinsightsV1alpha1SmartReplyData + properties: + reply: + description: The content of the reply. type: string - description: Required. Summary text for the section. - section: - description: Required. Name of the section. + 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 - description: A component of the generated summary. + confidenceScore: + format: double + 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 + description: Agent Assist Smart Reply data. type: object - id: GoogleCloudContactcenterinsightsV1SummarySuggestionSummarySection - GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata: + GoogleCloudContactcenterinsightsV1alpha1Analysis: properties: - analysisOperation: + analysisResult: readOnly: true + description: >- + Output only. The result of the analysis, which is populated when the + analysis finishes. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnalysisResult + name: type: string description: >- - Output only. The operation name for a successfully created analysis - operation, if any. + Immutable. The resource name of the analysis. Format: + projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} + 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. createTime: - type: string - description: Output only. The time the operation was created. format: google-datetime - readOnly: true - appliedRedactionConfig: description: >- - Output only. The redaction config applied to the uploaded - conversation. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig - readOnly: true - endTime: + Output only. The time at which the analysis was created, which + occurs when the long-running operation completes. readOnly: true type: string - description: Output only. The time the operation finished running. - format: google-datetime - request: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest - description: Output only. The original request. - description: The metadata for an UploadConversation operation. - type: object - id: GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata - GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats: - description: Statistics for IngestConversations operation. - id: >- - GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats - type: object - properties: - successfulIngestCount: - description: >- - Output only. The number of new conversations added during this - ingest operation. - format: int32 - type: integer - readOnly: true - 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 - failedIngestCount: - readOnly: true - type: integer - format: int32 - 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: - readOnly: true - format: int32 - description: >- - Output only. The number of objects processed during the ingest - operation. - type: integer - GoogleCloudContactcenterinsightsV1View: - type: object - properties: - updateTime: + requestTime: type: string + description: Output only. The time at which the analysis was requested. format: google-datetime readOnly: true - description: Output only. The most recent time at which the view was updated. - createTime: - readOnly: true - type: string - format: google-datetime - description: Output only. The time at which this view was created. - value: - description: String with specific view properties, must be non-empty. - type: string - displayName: - type: string - description: The human-readable display name of the view. - name: - type: string - description: >- - Immutable. The resource name of the view. Format: - projects/{project}/locations/{location}/views/{view} - id: GoogleCloudContactcenterinsightsV1View - description: The View resource. - GoogleCloudContactcenterinsightsV1alpha1SmartReplyData: - id: GoogleCloudContactcenterinsightsV1alpha1SmartReplyData - description: Agent Assist Smart Reply data. + id: GoogleCloudContactcenterinsightsV1alpha1Analysis + type: object + description: The analysis resource. + GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData: properties: - queryRecord: - type: string - description: >- - 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 reply is a good match for - this conversation, ranging from 0.0 (completely uncertain) to 1.0 - (completely certain). format: double - reply: - type: string - description: The content of the reply. - metadata: - type: object - description: >- - Map that contains metadata about the Smart Reply and the document - from which it originates. - additionalProperties: - type: string - type: object - GoogleCloudContactcenterinsightsV1AnalysisResult: - properties: - endTime: - type: string - description: The time at which the analysis ended. - format: google-datetime - callAnalysisMetadata: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata - description: Call-specific metadata created by the analysis. - description: The result of an analysis. - id: GoogleCloudContactcenterinsightsV1AnalysisResult - type: object - GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentActionSuggestion: - type: object - properties: - agentAction: - description: Optional. The suggested action for the agent. - type: string - id: >- - GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentActionSuggestion - description: >- - Actions suggested for the agent. This is based on applicable - instructions. - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats: - description: Statistics for IngestConversations operation. - type: object - properties: - duplicatesSkippedCount: - description: >- - Output only. The number of objects skipped because another - conversation with the same transcript uri had already been ingested. - format: int32 - type: integer - readOnly: true - processedObjectCount: - description: >- - Output only. The number of objects processed during the ingest - operation. - type: integer - 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: - format: int32 - readOnly: true - type: integer description: >- - Output only. The number of new conversations added during this - ingest operation. - id: >- - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats - GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData: - properties: + 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 suggestion: - type: string description: The content of the suggestion. + type: string metadata: additionalProperties: type: string @@ -1384,1689 +1124,1452 @@ components: description: >- Map that contains metadata about the Smart Compose suggestion and the document from which it originates. - confidenceScore: - 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). - type: number - format: double queryRecord: type: string description: >- The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} - description: Agent Assist Smart Compose suggestion data. type: object id: GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData - GoogleCloudContactcenterinsightsV1alpha1Conversation: + description: Agent Assist Smart Compose suggestion data. + GoogleCloudContactcenterinsightsV1alpha1GeneratorSuggestion: + id: GoogleCloudContactcenterinsightsV1alpha1GeneratorSuggestion type: object - description: The conversation resource. + properties: + agentCoachingSuggestion: + description: Optional. Suggestion to coach the agent. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestion + freeFormSuggestion: + description: Optional. Free form suggestion. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FreeFormSuggestion + summarySuggestion: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SummarySuggestion + description: Optional. Suggested summary. + description: Suggestion generated using a Generator. + GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata: + description: The metadata for a bulk delete conversations operation. properties: createTime: format: google-datetime - description: Output only. The time at which the conversation was created. - readOnly: true type: string - latestSummary: - description: Output only. Latest summary of the conversation. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData - ttl: - format: google-duration + description: The time the operation was created. + partialErrors: description: >- - Input only. The TTL for this resource. If specified, then this TTL - will be used to calculate the expire time. + Partial errors during bulk delete conversations operation that might + cause the operation output to be incomplete. + items: + $ref: '#/components/schemas/GoogleRpcStatus' + type: array + request: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest + description: The original request for bulk delete. + endTime: type: string - duration: + format: google-datetime + description: The time the operation finished running. + type: object + id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata + GoogleCloudContactcenterinsightsV1Analysis: + description: The analysis resource. + 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. + requestTime: + description: Output only. The time at which the analysis was requested. + readOnly: true type: string - description: Output only. The duration of the conversation. - format: google-duration + format: google-datetime + analysisResult: readOnly: true - transcript: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript - readOnly: true - description: Output only. The conversation transcript. - updateTime: + #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisResult + description: >- + Output only. The result of the analysis, which is populated when the + analysis finishes. + createTime: + description: >- + Output only. The time at which the analysis was created, which + occurs when the long-running operation completes. format: google-datetime type: string readOnly: true + name: description: >- - Output only. The most recent time at which the conversation was - updated. - 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 - startTime: - description: The time at which the conversation started. - format: google-datetime + Immutable. The resource name of the analysis. Format: + projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} type: string - dataSource: - description: The source of the audio and transcription for the conversation. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource - agentId: + id: GoogleCloudContactcenterinsightsV1Analysis + type: object + GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata: + properties: + customerChannel: + type: integer + description: The audio channel that contains the customer. + format: int32 + agentChannel: + description: The audio channel that contains the agent. + type: integer + format: int32 + id: GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata + description: Call-specific metadata. + type: object + GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats: + description: Aggregated statistics about an issue. + type: object + id: GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats + properties: + labeledConversationsCount: + format: int64 + description: Number of conversations attached to the issue at this point in time. type: string + issue: description: >- - An opaque, user-specified string representing the human agent who - handled the conversation. - qualityMetadata: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata - description: Conversation metadata related to quality management. - medium: - enum: - - MEDIUM_UNSPECIFIED - - PHONE_CALL - - CHAT + Issue resource. Format: + projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} 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. - obfuscatedUserId: + displayName: + description: Display name of the issue. type: string - description: Obfuscated user ID which the customer sent to us. - name: + GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata: + id: GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata + type: object + description: The metadata for a bulk delete conversations operation. + properties: + endTime: + type: string + format: google-datetime + description: The time the operation finished running. + createTime: + format: google-datetime + description: The time the operation was created. type: string + partialErrors: description: >- - Immutable. The resource name of the conversation. Format: - projects/{project}/locations/{location}/conversations/{conversation} - latestAnalysis: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Analysis - description: Output only. The conversation's latest analysis, if one exists. - runtimeAnnotations: + Partial errors during bulk delete conversations operation that might + cause the operation output to be incomplete. items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation + $ref: '#/components/schemas/GoogleRpcStatus' type: array - readOnly: true - description: >- - Output only. The annotations that were generated during the customer - and agent interaction. - dialogflowIntents: - 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 - readOnly: true - languageCode: - type: string - description: A user-specified language code for the conversation. - callMetadata: + request: + description: The original request for bulk delete. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata - description: Call-specific metadata. - turnCount: - readOnly: true - description: Output only. The number of turns in the conversation. - type: integer - format: int32 - expireTime: + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest + GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSourceSnippet: + properties: + document: + type: string description: >- - The time at which this conversation should expire. After this time, - the conversation data and any associated analyses will be deleted. + Indicates which Knowledge Document this snippet was extracted from. + Format: `projects//knowledgeBases//documents/`. + text: type: string - format: google-datetime - id: GoogleCloudContactcenterinsightsV1alpha1Conversation - GoogleCloudContactcenterinsightsV1alpha1IssueModel: - description: The issue model resource. + description: text taken from that URI. + title: + type: string + description: Title of the document. + uri: + type: string + description: URI the data is sourced from. type: object - id: GoogleCloudContactcenterinsightsV1alpha1IssueModel + id: >- + GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSourceSnippet + description: Snippet Source for a Generative Prediction. + GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant: properties: - languageCode: + dialogflowParticipant: type: string - description: Language of the model. - trainingStats: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats description: >- - Output only. Immutable. The issue model's label statistics on its - training data. - issueCount: - format: int64 - description: Output only. Number of issues in this issue model. - type: string - readOnly: true - inputDataConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig - description: Configs for the input data that used to create the issue model. - state: - 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. + 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 - enum: - - STATE_UNSPECIFIED - - UNDEPLOYED - - DEPLOYING - - DEPLOYED - - UNDEPLOYING - - DELETING - description: Output only. State of the model. - readOnly: true - displayName: - description: The representative name for the issue model. + dialogflowParticipantName: type: string - name: description: >- - Immutable. The resource name of the issue model. Format: - projects/{project}/locations/{location}/issueModels/{issue_model} + The name of the participant provided by Dialogflow. Format: + projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} + role: type: string - modelType: enum: - - MODEL_TYPE_UNSPECIFIED - - TYPE_V1 - - TYPE_V2 + - ROLE_UNSPECIFIED + - HUMAN_AGENT + - AUTOMATED_AGENT + - END_USER + - ANY_AGENT + description: The role of the participant. enumDescriptions: - - Unspecified model type. - - Type V1. - - Type V2. - description: Type of the model. - type: string - updateTime: - readOnly: true - type: string - format: google-datetime - description: >- - Output only. The most recent time at which the issue model was - updated. - createTime: - format: google-datetime - description: Output only. The time at which this issue model was created. - readOnly: true + - 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. + userId: type: string - GoogleCloudContactcenterinsightsV1alpha1GeneratorSuggestion: - id: GoogleCloudContactcenterinsightsV1alpha1GeneratorSuggestion + description: A user-specified ID representing the participant. + description: The call participant speaking for a given utterance. + id: GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant type: object - properties: - summarySuggestion: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SummarySuggestion - description: Optional. Suggested summary. - agentCoachingSuggestion: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestion - description: Optional. Suggestion to coach the agent. - freeFormSuggestion: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FreeFormSuggestion - description: Optional. Free form suggestion. - description: Suggestion generated using a Generator. - GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig: - description: Default configuration when creating Analyses in Insights. - id: GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig + GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData: type: object 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: + confidenceScore: type: number description: >- - Percentage of conversations created using Dialogflow runtime - integration to analyze automatically, between [0, 100]. - format: double - uploadConversationAnalysisPercentage: + 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 + title: + description: Article title. + type: string + uri: + type: string + description: Article URI. + metadata: description: >- - Percentage of conversations created using the UploadConversation - endpoint to analyze automatically, between [0, 100]. - format: double - type: number - GoogleCloudContactcenterinsightsV1alpha1GetGeneratorSuggestionResponse: - id: GoogleCloudContactcenterinsightsV1alpha1GetGeneratorSuggestionResponse + Map that contains metadata about the Article Suggestion and the + document that it originates from. + additionalProperties: + type: string + type: object + queryRecord: + type: string + description: >- + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} + source: + type: string + description: >- + The knowledge document that this answer was extracted from. Format: + projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} + description: Agent Assist Article Suggestion data. + id: GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData + GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig: + id: GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig + type: object properties: - generatorSuggestion: + exactMatchConfig: + description: The configuration for the exact match rule. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GeneratorSuggestion - description: The suggestion generated from the Generator. - type: object - description: Represents response from generators. - GoogleCloudContactcenterinsightsV1alpha1SilenceData: - type: object - properties: {} - id: GoogleCloudContactcenterinsightsV1alpha1SilenceData - description: The data for a silence annotation. - GoogleCloudContactcenterinsightsV1alpha1EntityMentionData: - description: >- - The data for an entity mention annotation. This represents a mention of - an `Entity` in the conversation. - id: GoogleCloudContactcenterinsightsV1alpha1EntityMentionData + #/components/schemas/GoogleCloudContactcenterinsightsV1ExactMatchConfig + description: Configuration information of a phrase match rule. + GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup: + description: A message representing a rule in the phrase matcher. type: object + id: GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup 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. + phraseMatchRules: + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRule + type: array + 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. - - Proper noun. - - Common noun (or noun compound). - description: The type of the entity mention. + - Must meet all phrase match rules or there is no match. + - If any of the phrase match rules are met, there is a match. type: string enum: - - MENTION_TYPE_UNSPECIFIED - - PROPER - - COMMON - sentiment: - description: Sentiment expressed for this mention of the entity. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData - GoogleCloudContactcenterinsightsV1IntentMatchData: - id: GoogleCloudContactcenterinsightsV1IntentMatchData + - PHRASE_MATCH_RULE_GROUP_TYPE_UNSPECIFIED + - ALL_OF + - ANY_OF + GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponse: 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. + Response for Knowledge Assist. Contains suggested query and optionally + includes an answer for the query. + id: GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponse properties: - intentUniqueId: - type: string + suggestedQueryAnswer: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswer description: >- - The id of the matched intent. Can be used to retrieve the - corresponding intent information. - type: object - GoogleCloudContactcenterinsightsV1ExportIssueModelRequest: - description: Request to export an issue model. - properties: - gcsDestination: + The answer generated for the suggested query. Whether or not an + answer is generated depends on how confident we are about the + generated query. + suggestedQuery: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination - description: Google Cloud Storage URI to export the Issue Model to. - name: - description: Required. The issue model to export - type: string - id: GoogleCloudContactcenterinsightsV1ExportIssueModelRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseSuggestedQuery + description: >- + The query suggested based on the context. Suggestion is made only if + it is different from the previous suggestion. type: object - GoogleCloudContactcenterinsightsV1alpha1GcsSource: - id: GoogleCloudContactcenterinsightsV1alpha1GcsSource + GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata: properties: - transcriptUri: + request: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequest + description: The original export request. + createTime: type: string - description: >- - Immutable. Cloud Storage URI that points to a file that contains the - conversation transcript. - audioUri: + description: The time the operation was created. + format: google-datetime + endTime: + format: google-datetime + description: The time the operation finished running. type: string - description: >- - Cloud Storage URI that points to a file that contains the - conversation audio. - description: A Cloud Storage source of conversation data. - type: object - 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 + id: GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata + description: Metadata used for export issue model. type: object - GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest: + GoogleCloudContactcenterinsightsV1View: + id: GoogleCloudContactcenterinsightsV1View + description: The View resource. type: object - id: GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest - description: The request to undeploy an issue model. properties: - name: + displayName: + description: The human-readable display name of the view. type: string - description: Required. The issue model to undeploy. - 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: + name: type: string description: >- - The id of the matched intent. Can be used to retrieve the - corresponding intent information. - type: object - GoogleCloudContactcenterinsightsV1ListConversationsResponse: - description: The response of listing conversations. - id: GoogleCloudContactcenterinsightsV1ListConversationsResponse - properties: - 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. + Immutable. The resource name of the view. Format: + projects/{project}/locations/{location}/views/{view} + updateTime: + readOnly: true + format: google-datetime + description: Output only. The most recent time at which the view was updated. type: string - conversations: - description: The conversations that match the request. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation - type: object - GoogleCloudContactcenterinsightsV1ListAnalysesResponse: - id: GoogleCloudContactcenterinsightsV1ListAnalysesResponse + createTime: + description: Output only. The time at which this view was created. + readOnly: true + type: string + format: google-datetime + value: + type: string + description: String with specific view properties, must be non-empty. + GoogleCloudContactcenterinsightsV1AnnotatorSelector: type: object + id: GoogleCloudContactcenterinsightsV1AnnotatorSelector properties: - nextPageToken: + runEntityAnnotator: + type: boolean + description: Whether to run the entity annotator. + runSummarizationAnnotator: + type: boolean + description: Whether to run the summarization annotator. + runSentimentAnnotator: + description: Whether to run the sentiment annotator. + type: boolean + runPhraseMatcherAnnotator: + type: boolean + description: Whether to run the active phrase matcher annotator(s). + phraseMatchers: 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 - analyses: + 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: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' + type: string type: array - description: The analyses that match the request. - description: The response to list analyses. - GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig: - type: object - properties: - medium: - enum: - - MEDIUM_UNSPECIFIED - - PHONE_CALL - - CHAT - type: string + runSilenceAnnotator: + description: Whether to run the silence annotator. + type: boolean + issueModels: + items: + 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`. - 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. - deprecated: true - filter: - 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 + runInterruptionAnnotator: + description: Whether to run the interruption annotator. + type: boolean + runIntentAnnotator: + description: Whether to run the intent annotator. + type: boolean + runIssueModelAnnotator: + type: boolean description: >- - A filter to reduce the conversations used for training the model to - a specific subset. - trainingConversationsCount: - description: Output only. Number of conversations used in training. Output only. - type: string - readOnly: true - format: int64 - id: GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig - description: Configs for the input data used to create the issue model. - GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata: - id: GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata - description: Metadata for a create analysis operation. - type: object - properties: - annotatorSelector: - readOnly: true - description: Output only. The annotator selector used for the analysis (if any). + Whether to run the issue model annotator. A model should have + already been deployed for this to take effect. + summarizationConfig: + description: Configuration for the summarization annotator. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector - createTime: - description: Output only. The time the operation was created. - type: string - readOnly: true - format: google-datetime - conversation: - readOnly: true - type: string - description: >- - Output only. The Conversation that this Analysis Operation belongs - to. - endTime: - readOnly: true - format: google-datetime - type: string - description: Output only. The time the operation finished running. - 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. - type: object - id: GoogleCloudContactcenterinsightsV1RedactionConfig + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig + description: Selector of all available annotators and phrase matchers to run. + GoogleCloudContactcenterinsightsV1alpha1AgentCoachingInstruction: + description: Agent Coaching instructions that customer can configure. properties: - inspectTemplate: + description: + description: Optional. The detailed description of this instruction. type: string - description: >- - The fully-qualified DLP inspect template resource name. Format: - `projects/{project}/locations/{location}/inspectTemplates/{template}` - deidentifyTemplate: + displayName: + description: Optional. Display name for the instruction. + type: string + condition: type: string description: >- - The fully-qualified DLP deidentify template resource name. Format: - `projects/{project}/deidentifyTemplates/{template}` - GoogleCloudContactcenterinsightsV1Analysis: - description: The analysis resource. - type: object - properties: - analysisResult: - description: >- - Output only. The result of the analysis, which is populated when the - analysis finishes. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisResult - readOnly: true - name: + Optional. The condition of the instruction. For example, "the + customer wants to cancel an order". If the users want the + instruction to be triggered unconditionally, the condition can be + empty. + metadata: + type: object + additionalProperties: + type: string + description: Optional. Additional information attached to this instruction. + agentAction: description: >- - Immutable. The resource name of the analysis. Format: - projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} - type: string - requestTime: - format: google-datetime + Optional. The action that human agent should take. For example, + "apologize for the slow shipping". If the users only want to use + agent coaching for intent detection, agent_action can be empty type: string - readOnly: true - description: Output only. The time at which the analysis was requested. - createTime: + systemAction: type: string description: >- - Output only. The time at which the analysis was created, which - occurs when the long-running operation completes. - readOnly: true - format: google-datetime - 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. - id: GoogleCloudContactcenterinsightsV1Analysis - GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest: + Optional. The action that system should take. For example, "call + GetOrderTime with order_number={order number provided by the + customer}". If the users don't have plugins or don't want to trigger + plugins, the system_action can be empty + type: object + id: GoogleCloudContactcenterinsightsV1alpha1AgentCoachingInstruction + GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswer: + id: >- + GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswer type: object + description: >- + Represents an answer from Knowledge. Cuurently supports FAQ and + Generative answers. properties: - analysisPercentage: + intentMatchingSource: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerIntentMatchingSource + description: Populated if the prediction was from intent matching. + answerText: description: >- - Required. Percentage of selected conversation to analyze, between - [0, 100]. - type: number - format: float - filter: + The piece of text from the `source` that answers this suggested + query. type: string + matchConfidence: + type: number description: >- - Required. Filter used to select the subset of conversations to - analyze. - annotatorSelector: - description: >- - To select the annotators to run and the phrase matchers to use (if - any). If not specified, all annotators will be run. + The system's confidence score that this answer is a good match for + this conversational query. The range is from 0.0 (completely + uncertain) to 1.0 (completely certain). + format: float + faqSource: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector - parent: - description: Required. The parent resource to create analyses in. - type: string - id: GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest - description: The request to analyze conversations in bulk. - GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata: - description: Metadata for deleting an issue model. + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerFaqSource + description: Populated if the prediction came from FAQ. + generativeSource: + description: Populated if the prediction was Generative. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSource + GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata: + description: Metadata for deploying an issue model. + id: GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata type: object properties: endTime: readOnly: true + type: string description: Output only. The time the operation finished running. format: google-datetime - type: string createTime: + type: string format: google-datetime description: Output only. The time the operation was created. - type: string readOnly: true request: - description: The original request for deletion. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest - id: GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata - GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats: - type: object + #/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelRequest + description: The original request for deployment. + GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest: + description: The request to undeploy an issue model. properties: - issue: + name: type: string + description: Required. The issue model to undeploy. + id: GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest + type: object + GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource: + id: GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource + description: The conversation source, which is a combination of transcript and audio. + properties: + gcsSource: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GcsSource + description: A Cloud Storage location specification for the audio and transcript. + dialogflowSource: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowSource + description: The source when the conversation comes from Dialogflow. + type: object + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo: + id: >- + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo + description: Word-level info for words in a transcript. + properties: + endOffset: description: >- - Issue resource. Format: - projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} - displayName: + Time offset of the end of this word relative to the beginning of the + total conversation. type: string - description: Display name of the issue. - labeledConversationsCount: - type: string - format: int64 - description: Number of conversations attached to the issue at this point in time. - description: Aggregated statistics about an issue. - id: GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats - GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData: - id: GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData - description: >- - The data for a matched phrase matcher. Represents information - identifying a phrase matcher for a given match. - 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 - type: object - GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata: - properties: - 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 - conversation: + format: google-duration + startOffset: + format: google-duration type: string description: >- - Output only. The Conversation that this Analysis Operation belongs - to. - readOnly: true - annotatorSelector: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector - description: Output only. The annotator selector used for the analysis (if any). - readOnly: true - id: GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata - description: Metadata for a create analysis operation. + 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: + description: The word itself. Includes punctuation marks that surround the word. + type: string type: object - GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse: - properties: - successfulAnalysisCount: - description: Count of successful analyses. - format: int32 - type: integer - failedAnalysisCount: - description: Count of failed analyses. - format: int32 - type: integer + GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse: type: object - id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse - description: The response for a bulk analyze conversations operation. - GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent: - id: GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent - description: >- - The data for a Dialogflow intent. Represents a detected intent in the - conversation, e.g. MAKES_PROMISE. + properties: {} + id: GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse + description: The response to deploy an issue model. + GoogleCloudContactcenterinsightsV1IssueAssignment: + id: GoogleCloudContactcenterinsightsV1IssueAssignment type: object + description: Information about the issue. properties: displayName: + description: >- + Immutable. Display name of the assigned issue. This field is set at + time of analyis and immutable since then. type: string - description: The human-readable name of the intent. - GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse: - id: GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse - properties: {} - type: object - description: The response for a bulk delete conversations operation. - GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest: - type: object - description: The request to create an issue model. - id: GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest - properties: - issueModel: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModel - description: Required. The issue model to create. - parent: + issue: + description: Resource name of the assigned issue. type: string - description: Required. The parent resource of the issue model. + score: + format: double + description: >- + Score indicating the likelihood of the issue assignment. currently + bounded on [0,1]. + type: number GoogleCloudContactcenterinsightsV1alpha1IssueModelResult: description: Issue Modeling result on a conversation. - id: GoogleCloudContactcenterinsightsV1alpha1IssueModelResult - type: object properties: - issues: - description: All the matched issues. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueAssignment - type: array issueModel: - type: string description: >- Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model} - GoogleCloudContactcenterinsightsV1IssueMatchData: - id: GoogleCloudContactcenterinsightsV1IssueMatchData - properties: - issueAssignment: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueAssignment - description: Information about the issue's assignment. - type: object - description: The data for an issue match annotation. - GoogleCloudContactcenterinsightsV1DialogflowIntent: - type: object - properties: - displayName: - type: string - description: The human-readable name of the intent. - description: >- - The data for a Dialogflow intent. Represents a detected intent in the - conversation, e.g. MAKES_PROMISE. - id: GoogleCloudContactcenterinsightsV1DialogflowIntent - GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence: - description: Conversation-level silence data. - properties: - silencePercentage: - type: number - format: float - description: Percentage of the total conversation spent in silence. - silenceDuration: type: string - description: Amount of time calculated to be in silence. - format: google-duration + issues: + type: array + description: All the matched issues. + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueAssignment type: object - id: GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence - GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource: - description: Google Cloud Storage Object URI to get the issue model file from. + id: GoogleCloudContactcenterinsightsV1alpha1IssueModelResult + GoogleCloudContactcenterinsightsV1IngestConversationsResponse: + properties: {} + description: The response to an IngestConversations operation. type: object - properties: - objectUri: - type: string - description: 'Required. Format: `gs:///`' - id: GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource - GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource: - id: GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource - properties: - dialogflowSource: - description: The source when the conversation comes from Dialogflow. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowSource - gcsSource: - description: A Cloud Storage location specification for the audio and transcript. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GcsSource - description: The conversation source, which is a combination of transcript and audio. + id: GoogleCloudContactcenterinsightsV1IngestConversationsResponse + GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData: type: object - GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata: + id: GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData + description: Agent Assist Smart Compose suggestion data. properties: - request: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest - description: The original export request. - endTime: + metadata: + type: object + additionalProperties: + type: string + description: >- + Map that contains metadata about the Smart Compose suggestion and + the document from which it originates. + queryRecord: + description: >- + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} type: string - format: google-datetime - description: The time the operation finished running. - createTime: - format: google-datetime - description: The time the operation was created. + suggestion: + description: The content of the suggestion. type: string - id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata - type: object - description: Metadata used for export issue model. + confidenceScore: + 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 + type: number GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig: - description: Configuration for summarization. - id: >- - GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig - type: object properties: + conversationProfile: + description: >- + Resource name of the Dialogflow conversation profile. Format: + projects/{project}/locations/{location}/conversationProfiles/{conversation_profile} + type: string summarizationModel: type: string - enumDescriptions: - - Unspecified summarization model. - - The CCAI baseline model. - - The CCAI baseline model, V2.0. - description: Default summarization model to be used. enum: - SUMMARIZATION_MODEL_UNSPECIFIED - BASELINE_MODEL - BASELINE_MODEL_V2_0 - conversationProfile: - description: >- - Resource name of the Dialogflow conversation profile. Format: - projects/{project}/locations/{location}/conversationProfiles/{conversation_profile} - type: string - GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata: - id: GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata - description: Metadata for undeploying an issue model. + description: Default summarization model to be used. + enumDescriptions: + - Unspecified summarization model. + - The CCAI baseline model. + - The CCAI baseline model, V2.0. type: object + id: >- + GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig + description: Configuration for summarization. + GoogleCloudContactcenterinsightsV1PhraseMatchData: properties: - createTime: - format: google-datetime + displayName: type: string - description: Output only. The time the operation was created. - readOnly: true - request: - description: The original request for undeployment. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest - endTime: - format: google-datetime - readOnly: true + description: The human-readable name of the phrase matcher. + phraseMatcher: type: string - description: Output only. The time the operation finished running. - GoogleCloudContactcenterinsightsV1alpha1Analysis: + 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. + id: GoogleCloudContactcenterinsightsV1PhraseMatchData type: object - description: The analysis resource. - id: GoogleCloudContactcenterinsightsV1alpha1Analysis - properties: - name: - type: string + GoogleCloudContactcenterinsightsV1alpha1Entity: + type: object + id: GoogleCloudContactcenterinsightsV1alpha1Entity + properties: + sentiment: description: >- - Immutable. The resource name of the analysis. Format: - projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} - analysisResult: + The aggregate sentiment expressed for this entity in the + conversation. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnalysisResult + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData + metadata: description: >- - Output only. The result of the analysis, which is populated when the - analysis finishes. - readOnly: true - createTime: + 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: object + displayName: type: string - format: google-datetime - readOnly: true - 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. - requestTime: + description: The representative name for the entity. + type: + description: The entity type. + 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`. type: string - readOnly: true - description: Output only. The time at which the analysis was requested. - format: google-datetime - GoogleCloudContactcenterinsightsV1alpha1SummarySuggestion: - id: GoogleCloudContactcenterinsightsV1alpha1SummarySuggestion - properties: - summarySections: - type: array - description: Required. All the parts of generated summary. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SummarySuggestionSummarySection + salience: + type: number + 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. + format: float + 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. + GoogleCloudContactcenterinsightsV1ConversationLevelSentiment: type: object - description: Suggested summary of the conversation. - GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerFaqSource: + description: One channel of conversation-level sentiment data. + id: GoogleCloudContactcenterinsightsV1ConversationLevelSentiment properties: - question: - type: string - description: The corresponding FAQ question. - document: + sentimentData: + description: Data specifying sentiment. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' + channelTag: + format: int32 + type: integer + description: The channel of the audio that the data applies to. + GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest: + properties: + name: + description: Required. The name of the issue model to delete. type: string - description: >- - Indicates which Knowledge Document this answer was extracted from. - Format: `projects//knowledgeBases//documents/`. - type: object - id: >- - GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerFaqSource - description: Details about source of FAQ answer. - GoogleCloudContactcenterinsightsV1ListIssueModelsResponse: - description: The response of listing issue models. - id: GoogleCloudContactcenterinsightsV1ListIssueModelsResponse + id: GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest type: object - properties: - issueModels: - items: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel' - description: The issue models that match the request. - type: array - GoogleCloudContactcenterinsightsV1DeployIssueModelResponse: - id: GoogleCloudContactcenterinsightsV1DeployIssueModelResponse - description: The response to deploy an issue model. + description: The request to delete an issue model. + GoogleCloudContactcenterinsightsV1ExportIssueModelResponse: type: object + id: GoogleCloudContactcenterinsightsV1ExportIssueModelResponse properties: {} - GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData: + description: Response from export issue model + GoogleCloudContactcenterinsightsV1Settings: + id: GoogleCloudContactcenterinsightsV1Settings properties: - metadata: + redactionConfig: description: >- - A map that contains metadata about the summarization and the - document from which it originates. - type: object - additionalProperties: - type: string - answerRecord: + 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/GoogleCloudContactcenterinsightsV1RedactionConfig + languageCode: type: string description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - conversationModel: + 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. + speechConfig: description: >- - The name of the model that generates this summary. Format: - projects/{project}/locations/{location}/conversationModels/{conversation_model} + Optional. Default Speech-to-Text resources to be used 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' + createTime: type: string - text: + description: Output only. The time at which the settings was created. + readOnly: true + format: google-datetime + name: type: string - description: The summarization content that is concatenated into one string. - textSections: 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. + Immutable. The resource name of the settings resource. Format: + projects/{project}/locations/{location}/settings + pubsubNotificationSettings: + 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 completes. * "update-conversation": Notify + each time a conversation is updated via UpdateConversation. * + "upload-conversation": Notify when an UploadConversation LRO + completes. Values are Pub/Sub topics. The format of each Pub/Sub + topic is: projects/{project}/topics/{topic} type: object additionalProperties: type: string - confidence: - description: The confidence score of the summarization. - type: number - format: float - description: Conversation summarization suggestion data. - id: >- - GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData - type: object - GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest: - description: Request to export an issue model. - id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest - type: object - properties: - gcsDestination: - description: Google Cloud Storage URI to export the Issue Model to. + updateTime: + description: Output only. The time at which the settings were last updated. + type: string + format: google-datetime + readOnly: true + analysisConfig: + description: Default analysis settings. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination - name: - description: Required. The issue model to export + #/components/schemas/GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig + conversationTtl: type: string - GoogleCloudContactcenterinsightsV1alpha1SummarySuggestionSummarySection: + 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: object - id: GoogleCloudContactcenterinsightsV1alpha1SummarySuggestionSummarySection - properties: - section: - type: string - description: Required. Name of the section. - summary: - type: string - description: Required. Summary text for the section. - description: A component of the generated summary. - GoogleCloudContactcenterinsightsV1PhraseMatchRule: - id: GoogleCloudContactcenterinsightsV1PhraseMatchRule + description: The settings resource. + GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo: + description: Information about an agent involved in the conversation. type: object - description: The data for a phrase match rule. + id: >- + GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo properties: - config: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig - description: >- - Provides additional information about the rule that specifies how to - apply the rule. - query: - description: Required. The phrase to be matched. + displayName: type: string - negated: - type: boolean + description: The agent's name. + dispositionCode: description: >- - Specifies whether the phrase must be missing from the transcript - segment or present in the transcript segment. - GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentCoachingSuggestionReasoning: - properties: - agentActionTaken: + A user-provided string indicating the outcome of the agent's segment + of the call. type: string - description: Optional. The actions that the agent has taken already. - issueSummary: + team: type: string - description: Optional. Summary of the issue. - description: Reasoning for the suggestion. - id: >- - GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentCoachingSuggestionReasoning - type: object - GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector: - type: object + description: A user-specified string representing the agent's team. + agentId: + type: string + description: A user-specified string representing the agent. + GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest: properties: - runIntentAnnotator: - type: boolean - description: Whether to run the intent annotator. - issueModels: + filter: + 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. - items: - type: string - type: array - runEntityAnnotator: - type: boolean - description: Whether to run the entity annotator. - summarizationConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig - description: Configuration for the summarization annotator. - phraseMatchers: + Required. Filter used to select the subset of conversations to + analyze. + analysisPercentage: + type: number 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 - runSilenceAnnotator: - type: boolean - description: Whether to run the silence annotator. - runSummarizationAnnotator: - description: Whether to run the summarization 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. - runIssueModelAnnotator: - type: boolean + Required. Percentage of selected conversation to analyze, between + [0, 100]. + format: float + annotatorSelector: description: >- - Whether to run the issue model annotator. A model should have - already been deployed for this to take effect. - runSentimentAnnotator: - type: boolean - description: Whether to run the sentiment annotator. - id: GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector - description: Selector of all available annotators and phrase matchers to run. - GoogleCloudContactcenterinsightsV1IssueModelResult: - description: Issue Modeling result on a conversation. - id: GoogleCloudContactcenterinsightsV1IssueModelResult + 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: + description: Required. The parent resource to create analyses in. + type: string + description: The request to analyze conversations in bulk. + id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest + type: object + GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionSampleResponse: + description: >- + Sample response that the agent can use. This could be based on + applicable instructions and ingested data from other systems. type: object + id: >- + GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionSampleResponse properties: - issueModel: - description: >- - Issue model that generates the result. Format: - projects/{project}/locations/{location}/issueModels/{issue_model} + responseText: type: string - issues: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueAssignment - type: array - description: All the matched issues. - GoogleCloudContactcenterinsightsV1DeployIssueModelRequest: - id: GoogleCloudContactcenterinsightsV1DeployIssueModelRequest - type: object + description: Optional. Sample response for Agent in text. + GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswerAnswerSource: + description: The sources of the answers. properties: - name: - description: Required. The issue model to deploy. + document: + description: >- + The document from which the snippet was extracted. Format: + `projects//knowledgeBases//documents/` type: string - description: The request to deploy an issue model. - GoogleCloudContactcenterinsightsV1ConversationLevelSilence: + snippet: + type: string + description: The relevant snippet of the article. + uri: + description: The URI of the article. + type: string + title: + description: The title of the article. + type: string + id: GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswerAnswerSource type: object - id: GoogleCloudContactcenterinsightsV1ConversationLevelSilence + GoogleCloudContactcenterinsightsV1alpha1IssueAssignment: + description: Information about the issue. + id: GoogleCloudContactcenterinsightsV1alpha1IssueAssignment properties: - silencePercentage: - description: Percentage of the total conversation spent in silence. + displayName: + description: >- + Immutable. Display name of the assigned issue. This field is set at + time of analyis and immutable since then. + type: string + score: + format: double + description: >- + Score indicating the likelihood of the issue assignment. currently + bounded on [0,1]. type: number - format: float - silenceDuration: - description: Amount of time calculated to be in silence. + issue: type: string - format: google-duration - description: Conversation-level silence data. - GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata: + description: Resource name of the assigned issue. + type: object + GoogleCloudContactcenterinsightsV1UploadConversationMetadata: + id: GoogleCloudContactcenterinsightsV1UploadConversationMetadata + description: The metadata for an UploadConversation operation. properties: + request: + readOnly: true + description: Output only. The original request. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1UploadConversationRequest + appliedRedactionConfig: + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig + description: >- + Output only. The redaction config applied to the uploaded + conversation. + analysisOperation: + readOnly: true + type: string + description: >- + Output only. The operation name for a successfully created analysis + operation, if any. createTime: format: google-datetime + type: string readOnly: true description: Output only. The time the operation was created. - type: string endTime: + description: Output only. The time the operation finished running. type: string format: google-datetime - description: Output only. The time the operation finished running. readOnly: true - request: - description: The original request for undeployment. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest - id: GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata - type: object - description: Metadata for undeploying an issue model. - GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata: type: object - description: Call-specific metadata created during analysis. + GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest: + description: The request to export insights. + id: GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest properties: - sentiments: - description: Overall conversation-level sentiment for each channel of the call. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationLevelSentiment - silence: + bigQueryDestination: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationLevelSilence - description: Overall conversation-level silence during the call. - annotations: - type: array - description: A list of call annotations that apply to this call. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1CallAnnotation - intents: - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Intent' - description: All the matched intents in the call. - entities: - description: All the entities in the call. - additionalProperties: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Entity' - type: object - phraseMatchers: - type: object - description: All the matched phrase matchers in the call. - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchData - issueModelResult: - description: Overall conversation-level issue modeling result. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelResult - id: GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata - GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswer: - type: object - description: >- - Represents an answer from Knowledge. Cuurently supports FAQ and - Generative answers. - properties: - faqSource: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerFaqSource - description: Populated if the prediction came from FAQ. - matchConfidence: - type: number - format: float - description: >- - The system's confidence score that this answer is a good match for - this conversational query. The range is from 0.0 (completely - uncertain) to 1.0 (completely certain). - answerText: + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination + 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. + enum: + - WRITE_DISPOSITION_UNSPECIFIED + - WRITE_TRUNCATE + - WRITE_APPEND + description: Options for what to do if the destination table already exists. + type: string + kmsKey: + type: string description: >- - The piece of text from the `source` that answers this suggested - query. + A fully qualified KMS key name for BigQuery tables protected by + CMEK. Format: + projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version} + parent: type: string - generativeSource: - description: Populated if the prediction was Generative. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSource - intentMatchingSource: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerIntentMatchingSource - description: Populated if the prediction was from intent matching. - id: >- - GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswer - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment: - id: >- - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment + description: Required. The parent resource to export data from. + filter: + type: string + description: >- + A filter to reduce results to a specific subset. Useful for + exporting conversations with specific properties. type: object + GoogleCloudContactcenterinsightsV1IssueModel: + description: The issue model resource. + id: GoogleCloudContactcenterinsightsV1IssueModel properties: - sentiment: - description: The sentiment for this transcript segment. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' - channelTag: - 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. - format: int32 - text: - type: string - description: The text of this segment. - dialogflowSegmentMetadata: + inputDataConfig: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata - description: CCAI metadata relating to the current transcript segment. - confidence: - type: number - format: float + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig + description: Configs for the input data that used to create the issue model. + name: + type: string 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. - messageTime: + 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. + languageCode: + type: string + description: Language of the model. + createTime: + readOnly: true + type: string + format: google-datetime + description: Output only. The time at which this issue model was created. + issueCount: + readOnly: true + type: string + format: int64 + description: Output only. Number of issues in this issue model. + updateTime: type: string - description: The time that the message occurred, if provided. format: google-datetime - words: - type: array description: >- - A list of the word-specific information for each word in the - segment. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo - languageCode: + Output only. The most recent time at which the issue model was + updated. + readOnly: true + state: + enum: + - STATE_UNSPECIFIED + - UNDEPLOYED + - DEPLOYING + - DEPLOYED + - UNDEPLOYING + - DELETING + description: Output only. State of the model. + readOnly: true + 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. type: string + trainingStats: 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: + Output only. Immutable. The issue model's label statistics on its + training data. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationParticipant - description: The participant of this segment. - description: A segment of a full transcript. - GoogleCloudContactcenterinsightsV1alpha1SearchKnowledgeAnswerAnswerSource: - properties: - document: - description: >- - The document from which the snippet was extracted. Format: - `projects//knowledgeBases//documents/` - type: string - snippet: - type: string - description: The relevant snippet of the article. - uri: + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStats + readOnly: true + modelType: + description: Type of the model. + enumDescriptions: + - Unspecified model type. + - Type V1. + - Type V2. + enum: + - MODEL_TYPE_UNSPECIFIED + - TYPE_V1 + - TYPE_V2 type: string - description: The URI of the article. - title: + type: object + GoogleLongrunningListOperationsResponse: + properties: + nextPageToken: + description: The standard List next-page token. type: string - description: The title of the article. - description: The sources of the answers. + operations: + type: array + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' + description: >- + A list of operations that matches the specified filter in the + request. + id: GoogleLongrunningListOperationsResponse type: object - id: >- - GoogleCloudContactcenterinsightsV1alpha1SearchKnowledgeAnswerAnswerSource - GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata: + description: The response message for Operations.ListOperations. + GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata: + id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata properties: - customerSatisfactionRating: + failedAnalysesCount: + format: int32 + description: The number of requested analyses that have failed so far. type: integer + totalRequestedAnalysesCount: format: int32 description: >- - An arbitrary integer value indicating the customer's satisfaction - rating. - menuPath: - type: string + Total number of analyses requested. Computed by the number of + conversations returned by `filter` multiplied by + `analysis_percentage` in the request. + type: integer + request: + description: The original request for bulk analyze. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest + completedAnalysesCount: description: >- - An arbitrary string value specifying the menu path the customer - took. - waitDuration: - format: google-duration - description: The amount of time the customer waited to connect with an agent. + The number of requested analyses that have completed successfully so + far. + format: int32 + type: integer + createTime: + format: google-datetime type: string - agentInfo: + description: The time the operation was created. + partialErrors: + description: >- + Output only. Partial errors during bulk analyze operation that might + cause the operation output to be incomplete. type: array items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo - description: Information about agents involved in the call. - description: Conversation metadata related to quality management. + $ref: '#/components/schemas/GoogleRpcStatus' + readOnly: true + endTime: + description: The time the operation finished running. + format: google-datetime + type: string type: object - id: GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata - GoogleCloudContactcenterinsightsV1SentimentData: + description: The metadata for a bulk analyze conversations operation. + GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata properties: - score: - format: float - type: number - description: The sentiment score between -1.0 (negative) and 1.0 (positive). - magnitude: - description: >- - A non-negative number from 0 to infinity which represents the - abolute magnitude of sentiment regardless of score. - type: number - format: float + createTime: + description: The time the operation was created. + type: string + format: google-datetime + request: + description: The original import request. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest + endTime: + type: string + description: The time the operation finished running. + format: google-datetime + description: Metadata used for import issue model. type: object - description: The data for a sentiment annotation. - id: GoogleCloudContactcenterinsightsV1SentimentData - GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig: + GoogleCloudContactcenterinsightsV1HoldData: type: object + description: The data for a hold annotation. + properties: {} + id: GoogleCloudContactcenterinsightsV1HoldData + GoogleCloudContactcenterinsightsV1AnswerFeedback: + description: >- + The feedback that the customer has about a certain answer in the + conversation. properties: - filter: + clicked: + description: Indicates whether an answer or item was clicked by the human agent. + type: boolean + displayed: description: >- - A filter to reduce the conversations used for training the model to - a specific subset. + Indicates whether an answer or item was displayed to the human agent + in the agent desktop UI. + type: boolean + correctnessLevel: type: string - medium: 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`. + - CORRECTNESS_LEVEL_UNSPECIFIED + - NOT_CORRECT + - PARTIALLY_CORRECT + - FULLY_CORRECT 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 - deprecated: true - trainingConversationsCount: - type: string - readOnly: true - format: int64 - description: Output only. Number of conversations used in training. Output only. - description: Configs for the input data used to create the issue model. - id: GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig - GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest: - id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest - description: The request to analyze conversations in bulk. + - Correctness level unspecified. + - Answer is totally wrong. + - Answer is partially correct. + - Answer is fully correct. + description: The correctness level of an answer. + type: object + id: GoogleCloudContactcenterinsightsV1AnswerFeedback + GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse: + properties: {} + id: GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse + description: The response to undeploy an issue model. + type: object + GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData: + description: Conversation summarization suggestion data. + id: >- + GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData properties: - analysisPercentage: - format: float + text: + type: string + description: The summarization content that is concatenated into one string. + metadata: description: >- - Required. Percentage of selected conversation to analyze, between - [0, 100]. + A map that contains metadata about the summarization and the + document from which it originates. + type: object + additionalProperties: + type: string + confidence: + description: The confidence score of the summarization. type: number - parent: - description: Required. The parent resource to create analyses in. + format: float + answerRecord: 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. - filter: + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} + conversationModel: + description: >- + The name of the model that generates this summary. Format: + projects/{project}/locations/{location}/conversationModels/{conversation_model} type: string + textSections: + additionalProperties: + type: string description: >- - Required. Filter used to select the subset of conversations to - analyze. - type: object - GoogleCloudContactcenterinsightsV1alpha1IssueMatchData: - description: The data for an issue match annotation. + 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 type: object + GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse: properties: - issueAssignment: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueAssignment - description: Information about the issue's assignment. - id: GoogleCloudContactcenterinsightsV1alpha1IssueMatchData - GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata: - properties: - request: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest - description: The original request for export. - partialErrors: - description: >- - Partial errors during export operation that might cause the - operation output to be incomplete. - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - createTime: - description: Output only. The time the operation was created. - format: google-datetime - readOnly: true - type: string - endTime: - readOnly: true - format: google-datetime - type: string - description: Output only. The time the operation finished running. - id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata - description: Metadata for an export insights operation. + successfulAnalysisCount: + description: Count of successful analyses. + type: integer + format: int32 + failedAnalysisCount: + type: integer + description: Count of failed analyses. + format: int32 + id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse + type: object + description: The response for a bulk analyze conversations operation. + GoogleCloudContactcenterinsightsV1UploadConversationRequest: + id: GoogleCloudContactcenterinsightsV1UploadConversationRequest + description: Request to upload a conversation. type: object - GoogleLongrunningOperation: properties: - name: + parent: + description: Required. The parent resource of the conversation. type: string + conversation: + description: Required. The conversation resource to create. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation' + conversationId: 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 + 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 + speechConfig: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig' 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: + Optional. Speech-to-Text configuration. Will default to the config + specified in Settings. + redactionConfig: 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 - metadata: + Optional. DLP settings for transcript redaction. Will default to the + config specified in Settings. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig + GoogleCloudContactcenterinsightsV1RedactionConfig: + properties: + deidentifyTemplate: + 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 - error: - $ref: '#/components/schemas/GoogleRpcStatus' + The fully-qualified DLP deidentify template resource name. Format: + `projects/{project}/deidentifyTemplates/{template}` + inspectTemplate: description: >- - The error result of the operation in case of failure or - cancellation. - id: GoogleLongrunningOperation + The fully-qualified DLP inspect template resource name. Format: + `projects/{project}/locations/{location}/inspectTemplates/{template}` + type: string type: object + id: GoogleCloudContactcenterinsightsV1RedactionConfig description: >- - This resource represents a long-running operation that is the result of - a network API call. - GoogleCloudContactcenterinsightsV1PhraseMatcher: - properties: - displayName: - type: string - description: The human-readable name of the phrase matcher. - activationUpdateTime: - description: >- - Output only. The most recent time at which the activation status was - updated. - format: google-datetime - type: string - readOnly: true - revisionCreateTime: - 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. - readOnly: true - type: string - name: - description: >- - The resource name of the phrase matcher. Format: - projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} + 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. + GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse: + type: object + id: GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse + description: The response for a bulk analyze conversations operation. + properties: + successfulAnalysisCount: + description: Count of successful analyses. + format: int32 + type: integer + failedAnalysisCount: + description: Count of failed analyses. + type: integer + format: int32 + GoogleCloudContactcenterinsightsV1Intent: + id: GoogleCloudContactcenterinsightsV1Intent + type: object + description: >- + The data for an intent. Represents a detected intent in the + conversation, for example MAKES_PROMISE. + properties: + displayName: type: string - roleMatch: + description: The human-readable name of the intent. + id: + description: The unique identifier of the intent. 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: >- - 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. - versionTag: - description: >- - The customized version tag to use for the phrase matcher. If not - specified, it will default to `revision_id`. + GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse: + id: GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse + properties: {} + description: The response for a bulk delete conversations operation. + type: object + GoogleCloudContactcenterinsightsV1GcsSource: + type: object + id: GoogleCloudContactcenterinsightsV1GcsSource + description: A Cloud Storage source of conversation data. + properties: + transcriptUri: type: string - active: - type: boolean - description: Applies the phrase matcher only when it is active. - phraseMatchRuleGroups: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup - description: A list of phase match rule groups that are included in this matcher. - type: array - revisionId: 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 + Immutable. Cloud Storage URI that points to a file that contains the + conversation transcript. + audioUri: type: string - readOnly: true - updateTime: description: >- - Output only. The most recent time at which the phrase matcher was - updated. - format: google-datetime - readOnly: true - type: string - type: - type: string - description: Required. The type of this phrase matcher. - 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. - enum: - - PHRASE_MATCHER_TYPE_UNSPECIFIED - - ALL_OF - - ANY_OF - description: The phrase matcher resource. - id: GoogleCloudContactcenterinsightsV1PhraseMatcher - type: object - GoogleCloudContactcenterinsightsV1UploadConversationRequest: + Cloud Storage URI that points to a file that contains the + conversation audio. + GoogleCloudContactcenterinsightsV1IngestConversationsRequest: + id: GoogleCloudContactcenterinsightsV1IngestConversationsRequest type: object + description: The request to ingest conversations. properties: - conversation: - description: Required. The conversation resource to create. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation' + transcriptObjectConfig: + description: Configuration for when `source` contains conversation transcripts. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig + speechConfig: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig' + description: >- + Optional. Default Speech-to-Text configuration. Optional, will + default to the config specified in Settings. + sampleSize: + format: int32 + 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. Note that conversations produced via sampling will + not be ingested by subsequent ingest requests unless they are first + deleted. + 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. parent: + description: Required. The parent resource for new conversations. type: string - description: Required. The parent resource of the conversation. redactionConfig: - description: >- - 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 - speechConfig: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig' description: >- - Optional. Speech-to-Text configuration. Will default to the config - specified in Settings. - id: GoogleCloudContactcenterinsightsV1UploadConversationRequest - description: Request to upload a conversation. - GoogleCloudContactcenterinsightsV1ImportIssueModelResponse: - description: Response from import issue model - id: GoogleCloudContactcenterinsightsV1ImportIssueModelResponse - properties: {} + Optional. DLP settings for transcript redaction. Optional, will + default to the config specified in Settings. + conversationConfig: + description: Configuration that applies to all conversations. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig + GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation: type: object - GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation properties: - request: + knowledgeSearchResult: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest - description: The original request for deployment. + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SearchKnowledgeAnswer + description: The Knowledge Search result. + smartComposeSuggestion: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData + description: Agent Assist Smart Compose suggestion data. createTime: - description: Output only. The time the operation was created. - format: google-datetime - readOnly: true type: string - endTime: - readOnly: true + description: The time at which this annotation was created. format: google-datetime + annotationId: type: string - description: Output only. The time the operation finished running. - type: object - description: Metadata for deploying an issue model. - id: GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata - GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries: - type: object - properties: - intervalDuration: - type: string - description: The duration of each interval. - format: google-duration - points: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval - 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 - id: GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries - description: A time series representing conversations over time. - GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerIntentMatchingSource: - id: >- - GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerIntentMatchingSource - properties: - uri: - description: URI the data is sourced from. - type: string - title: - type: string - description: Title of the document. - type: object - description: Details about source of Intent Matching answer. - GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSourceSnippet: - properties: - document: description: >- - Indicates which Knowledge Document this snippet was extracted from. - Format: `projects//knowledgeBases//documents/`. - type: string - uri: - description: URI the data is sourced from. - type: string - text: - type: string - description: text taken from that URI. - title: - description: Title of the document. - type: string - description: Snippet Source for a Generative Prediction. - id: >- - GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSourceSnippet - type: object - GoogleCloudContactcenterinsightsV1EntityMentionData: - description: >- - The data for an entity mention annotation. This represents a mention of - an `Entity` in the conversation. - id: GoogleCloudContactcenterinsightsV1EntityMentionData - properties: - entityUniqueId: - type: string + The unique identifier of the annotation. Format: + projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} + answerFeedback: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback + description: The feedback that the customer has about the answer in `data`. + generatorSuggestionResult: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GetGeneratorSuggestionResponse + description: The generator suggestion result. + faqAnswer: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData + description: Agent Assist FAQ answer data. + knowledgeAssistResult: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponse + description: The Knowledge Assist result. + conversationSummarizationSuggestion: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData + description: Conversation summarization suggestion data. + startBoundary: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary description: >- - 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/GoogleCloudContactcenterinsightsV1SentimentData' - description: Sentiment expressed for this mention of the entity. - type: - enum: - - MENTION_TYPE_UNSPECIFIED - - PROPER - - COMMON - enumDescriptions: - - Unspecified. - - Proper noun. - - Common noun (or noun compound). - description: The type of the entity mention. - type: string - type: object - GoogleCloudContactcenterinsightsV1alpha1InterruptionData: - id: GoogleCloudContactcenterinsightsV1alpha1InterruptionData - description: The data for an interruption annotation. - properties: {} - type: object - GoogleCloudContactcenterinsightsV1IssueModel: - type: object - properties: - displayName: - type: string - description: The representative name for the issue model. - modelType: - type: string - enumDescriptions: - - Unspecified model type. - - Type V1. - - Type V2. - enum: - - MODEL_TYPE_UNSPECIFIED - - TYPE_V1 - - TYPE_V2 - description: Type of the model. - languageCode: - type: string - description: Language of the model. - trainingStats: - readOnly: true + The boundary in the conversation where the annotation starts, + inclusive. + articleSuggestion: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData + description: Agent Assist Article Suggestion data. + smartReply: + description: Agent Assist Smart Reply data. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SmartReplyData + endBoundary: description: >- - Output only. Immutable. The issue model's label statistics on its - training data. + The boundary in the conversation where the annotation ends, + inclusive. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStats - issueCount: - description: Output only. Number of issues in this issue model. - type: string - readOnly: true - format: int64 - inputDataConfig: - description: Configs for the input data that used to create the issue model. + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + dialogflowInteraction: + description: Dialogflow interaction data. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig - createTime: - type: string - readOnly: true - format: google-datetime - description: Output only. The time at which this issue model was created. - updateTime: - readOnly: true + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData + description: >- + An annotation that was generated during the customer and agent + interaction. + GoogleCloudContactcenterinsightsV1SmartReplyData: + id: GoogleCloudContactcenterinsightsV1SmartReplyData + type: object + properties: + confidenceScore: + format: double + type: number description: >- - Output only. The most recent time at which the issue model was - updated. - type: string - format: google-datetime - name: + 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). + reply: type: string + description: The content of the reply. + metadata: + type: object description: >- - Immutable. The resource name of the issue model. Format: - projects/{project}/locations/{location}/issueModels/{issue_model} - state: - 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. - readOnly: true - enum: - - STATE_UNSPECIFIED - - UNDEPLOYED - - DEPLOYING - - DEPLOYED - - UNDEPLOYING - - DELETING + Map that contains metadata about the Smart Reply and the document + from which it originates. + additionalProperties: + type: string + queryRecord: type: string - description: The issue model resource. - id: GoogleCloudContactcenterinsightsV1IssueModel + description: >- + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} + description: Agent Assist Smart Reply data. GoogleCloudContactcenterinsightsV1alpha1RedactionConfig: - id: GoogleCloudContactcenterinsightsV1alpha1RedactionConfig type: object description: >- DLP resources used for redaction while ingesting conversations. DLP @@ -3084,447 +2587,287 @@ components: The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}` deidentifyTemplate: - type: string description: >- The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}` - GoogleCloudContactcenterinsightsV1SilenceData: - description: The data for a silence annotation. + type: string + id: GoogleCloudContactcenterinsightsV1alpha1RedactionConfig + GoogleCloudContactcenterinsightsV1ListIssuesResponse: type: object - id: GoogleCloudContactcenterinsightsV1SilenceData - properties: {} - GoogleCloudContactcenterinsightsV1AgentCoachingSuggestion: + description: The response of listing issues. properties: - agentActionSuggestions: - description: Optional. Suggested actions for the agent to take. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentActionSuggestion - type: array - sampleResponses: - description: Optional. Sample response for the Agent. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionSampleResponse + issues: + description: The issues that match the request. type: array - applicableInstructions: items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AgentCoachingInstruction - type: array - description: Optional. Instructions applicable based on the current context. - suggestionReasoning: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentCoachingSuggestionReasoning - description: Reasoning for the suggestion. - suggestionEval: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentCoachingSuggestionEval - description: Self evaluation of the suggestion. - description: Suggestion for coaching agents. - id: GoogleCloudContactcenterinsightsV1AgentCoachingSuggestion - type: object - GoogleCloudContactcenterinsightsV1alpha1FreeFormSuggestion: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' + id: GoogleCloudContactcenterinsightsV1ListIssuesResponse + GoogleCloudContactcenterinsightsV1ArticleSuggestionData: + id: GoogleCloudContactcenterinsightsV1ArticleSuggestionData properties: - labels: - description: Optional. Labels for the generator. - type: array - items: + metadata: + type: object + additionalProperties: type: string - response: + description: >- + Map that contains metadata about the Article Suggestion and the + document that it originates from. + title: + description: Article title. type: string - description: Required. Free form suggestion. - type: object - id: GoogleCloudContactcenterinsightsV1alpha1FreeFormSuggestion - description: Suggestion generated using free form generator. - GoogleCloudContactcenterinsightsV1GetGeneratorSuggestionResponse: + queryRecord: + type: string + description: >- + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} + 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 + uri: + type: string + description: Article URI. + source: + type: string + description: >- + The knowledge document that this answer was extracted from. Format: + projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} + description: Agent Assist Article Suggestion data. type: object + GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerIntentMatchingSource: properties: - generatorSuggestion: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1GeneratorSuggestion - description: The suggestion generated from the Generator. - id: GoogleCloudContactcenterinsightsV1GetGeneratorSuggestionResponse - description: Represents response from generators. - GoogleCloudContactcenterinsightsV1AnnotatorSelector: + title: + type: string + description: Title of the document. + uri: + type: string + description: URI the data is sourced from. + description: Details about source of Intent Matching answer. type: object - description: Selector of all available annotators and phrase matchers to run. + id: >- + GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerIntentMatchingSource + GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource: + description: Configuration for Cloud Storage bucket sources. + type: object + id: GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource properties: - summarizationConfig: - description: Configuration for the summarization annotator. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig - runSummarizationAnnotator: - type: boolean - description: Whether to run the summarization annotator. - runPhraseMatcherAnnotator: - type: boolean - description: Whether to run the active phrase matcher annotator(s). - runSilenceAnnotator: - description: Whether to run the silence annotator. - type: boolean - issueModels: + bucketUri: + description: Required. The Cloud Storage bucket containing source objects. + type: string + customMetadataKeys: items: type: string - type: array - 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. - runInterruptionAnnotator: - description: Whether to run the interruption annotator. - type: boolean - 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. - runIntentAnnotator: - description: Whether to run the intent 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 + 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 - runSentimentAnnotator: - type: boolean - description: Whether to run the sentiment annotator. - id: GoogleCloudContactcenterinsightsV1AnnotatorSelector - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig: - description: Configuration that applies to all conversations. - type: object - id: >- - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig - properties: - agentId: + metadataBucketUri: 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 via the - `metadata_bucket_uri`. + Optional. The Cloud Storage path to the source object metadata. Note + that: [1] metadata files are expected to be in JSON format [2] + metadata and source objects must be in separate buckets [3] a source + object's metadata object must share the same name to be properly + ingested 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. - type: integer - format: int32 - agentChannel: - 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 - type: integer - GoogleCloudContactcenterinsightsV1ConversationQualityMetadata: + bucketObjectType: + enum: + - BUCKET_OBJECT_TYPE_UNSPECIFIED + - TRANSCRIPT + - AUDIO + 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. + GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata: + description: Metadata used for export issue model. + type: object + id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata properties: - menuPath: + createTime: + type: string + format: google-datetime + description: The time the operation was created. + endTime: + description: The time the operation finished running. type: string + format: google-datetime + request: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest + description: The original export request. + 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: + details: description: >- - An arbitrary string value specifying the menu path the customer - took. - agentInfo: - description: Information about agents involved in the call. + 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/GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. type: array - customerSatisfactionRating: - type: integer - format: int32 + message: description: >- - An arbitrary integer value indicating the customer's satisfaction - rating. - waitDuration: + 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 amount of time the customer waited to connect with an agent. - format: google-duration + code: + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 + type: integer type: object - id: GoogleCloudContactcenterinsightsV1ConversationQualityMetadata - description: Conversation metadata related to quality management. - GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse: - id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse + GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData: type: object - description: Response for an export insights operation. - properties: {} - GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData: + id: GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData properties: - metadata: - additionalProperties: - type: string - type: object - description: >- - Map that contains metadata about the FAQ answer and the document - that it originates from. - confidenceScore: + confidence: 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). + The confidence of the match 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. - queryRecord: - description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - type: string - question: - description: The corresponding FAQ question. - type: string - source: + dialogflowIntentId: type: string description: >- - The knowledge document that this answer was extracted from. Format: - projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. + The Dialogflow intent resource path. Format: + projects/{project}/agent/{agent}/intents/{intent} + description: Dialogflow interaction data. + GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback: type: object - description: Agent Assist frequently-asked-question answer data. - id: GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData - GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentCoachingSuggestionEval: + description: >- + The feedback that the customer has about a certain answer in the + conversation. + id: GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback properties: - actionActionSuggestionEval: - description: Optional. Eval for Agent action suggestion. - type: string - sampleResponseEval: - description: Optional. Eval for sample response. + clicked: + description: Indicates whether an answer or item was clicked by the human agent. + type: boolean + correctnessLevel: + description: The correctness level of an answer. + enumDescriptions: + - Correctness level unspecified. + - Answer is totally wrong. + - Answer is partially correct. + - Answer is fully correct. type: string - id: >- - GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentCoachingSuggestionEval - description: Self evaluations of the suggestion. - type: object - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest: - type: object - id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest - description: The request to ingest conversations. - properties: - sampleSize: - format: int32 + enum: + - CORRECTNESS_LEVEL_UNSPECIFIED + - NOT_CORRECT + - PARTIALLY_CORRECT + - FULLY_CORRECT + displayed: 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. Note that conversations produced via sampling will - not be ingested by subsequent ingest requests unless they are first - deleted. - type: integer - parent: - type: string - description: Required. The parent resource for new conversations. - speechConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SpeechConfig - description: >- - Optional. Default Speech-to-Text configuration. Optional, will - default to the config specified in Settings. - redactionConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig - description: >- - Optional. DLP settings for transcript redaction. Optional, will - default to the config specified in Settings. - gcsSource: - 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 - transcriptObjectConfig: + Indicates whether an answer or item was displayed to the human agent + in the agent desktop UI. + type: boolean + GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata: + description: Call-specific metadata created during analysis. + id: GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata + properties: + phraseMatchers: + description: All the matched phrase matchers in the call. + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchData + type: object + sentiments: + type: array + description: Overall conversation-level sentiment for each channel of the call. + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationLevelSentiment + annotations: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1CallAnnotation + description: A list of call annotations that apply to this call. + issueModelResult: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig - description: Configuration for when `source` contains conversation transcripts. - conversationConfig: + #/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' + silence: + description: Overall conversation-level silence during the call. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig - description: Configuration that applies to all conversations. - GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata: - id: GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata - description: Metadata for creating an issue model. + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationLevelSilence type: object + GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata: properties: + request: + description: The original request for deletion. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest createTime: - type: string readOnly: true - description: Output only. The time the operation was created. + type: string format: google-datetime + description: Output only. The time the operation was created. endTime: - readOnly: true - type: string description: Output only. The time the operation finished running. + readOnly: true format: google-datetime - request: - description: The original request for creation. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1CreateIssueModelRequest - GoogleCloudContactcenterinsightsV1PhraseMatchData: - id: GoogleCloudContactcenterinsightsV1PhraseMatchData - properties: - phraseMatcher: - description: The unique identifier (the resource name) of the phrase matcher. - type: string - displayName: - type: string - description: The human-readable 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 - GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource: - description: Google Cloud Storage Object URI to get the issue model file from. - id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource - type: object - properties: - objectUri: - description: 'Required. Format: `gs:///`' - type: string - GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats: - id: GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats - type: object - properties: - 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 - labeledConversationsCount: - format: int64 type: string - description: Number of conversations attached to the issue at this point in time. - description: Aggregated statistics about an issue. - GoogleCloudContactcenterinsightsV1ExportIssueModelResponse: - description: Response from export issue model - id: GoogleCloudContactcenterinsightsV1ExportIssueModelResponse - properties: {} - type: object - GoogleCloudContactcenterinsightsV1alpha1SentimentData: - description: The data for a sentiment annotation. + description: Metadata for deleting an issue model. + id: GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata type: object - id: 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: - type: number - format: float - description: The sentiment score between -1.0 (negative) and 1.0 (positive). - GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData: + GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata: + description: Metadata for an export insights operation. properties: - metadata: - type: object - additionalProperties: - type: string - description: >- - Map that contains metadata about the Article Suggestion 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 - uri: - description: Article URI. - type: string - source: - description: >- - The knowledge document that this answer was extracted from. Format: - projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} - 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). - type: number - format: float - title: - description: Article title. + createTime: + readOnly: true type: string - id: GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData - description: Agent Assist Article Suggestion data. - type: object - GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse: - id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse - properties: {} - description: Response from export issue model - type: object - GoogleCloudContactcenterinsightsV1ConversationCallMetadata: - type: object - description: Call-specific metadata. - id: GoogleCloudContactcenterinsightsV1ConversationCallMetadata - properties: - customerChannel: - description: The audio channel that contains the customer. - format: int32 - type: integer - agentChannel: - type: integer - format: int32 - description: The audio channel that contains the agent. - GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata: - id: GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata - type: object - description: Metadata for deploying an issue model. - properties: + description: Output only. The time the operation was created. + format: google-datetime request: + description: The original request for export. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelRequest - description: The original request for deployment. + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest endTime: - description: Output only. The time the operation finished running. - readOnly: true type: string format: google-datetime - createTime: + description: Output only. The time the operation finished running. readOnly: true - type: string - format: google-datetime - description: Output only. The time the operation was created. - GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination: - id: >- - GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination - type: object - properties: - dataset: - type: string - 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. - 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. - projectId: - type: string + partialErrors: + items: + $ref: '#/components/schemas/GoogleRpcStatus' 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. - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig: + Partial errors during export operation that might cause the + operation output to be incomplete. + type: array + id: GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata + type: object + GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig: type: object + id: >- + GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig properties: medium: enum: @@ -3532,220 +2875,329 @@ components: - PHONE_CALL - CHAT description: Required. The medium transcript objects represent. + 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. - type: string description: Configuration for processing transcript objects. - id: >- - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig - GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata: + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata: + description: Metadata from Dialogflow relating to the current transcript segment. + properties: + smartReplyAllowlistCovered: + type: boolean + description: >- + Whether the transcript segment was covered under the configured + smart reply allowlist in Agent Assist. + id: >- + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata + type: object + GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentActionSuggestion: + type: object + id: >- + GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentActionSuggestion + properties: + agentAction: + type: string + description: Optional. The suggested action for the agent. + description: >- + Actions suggested for the agent. This is based on applicable + instructions. + GoogleCloudContactcenterinsightsV1ListViewsResponse: + id: GoogleCloudContactcenterinsightsV1ListViewsResponse + type: object + description: The response of listing views. + properties: + views: + type: array + items: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' + description: The views that match 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 + GoogleCloudContactcenterinsightsV1GetGeneratorSuggestionResponse: + id: GoogleCloudContactcenterinsightsV1GetGeneratorSuggestionResponse + properties: + generatorSuggestion: + description: The suggestion generated from the Generator. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1GeneratorSuggestion + description: Represents response from generators. + type: object + GoogleCloudContactcenterinsightsV1alpha1IssueModel: + id: GoogleCloudContactcenterinsightsV1alpha1IssueModel + description: The issue model resource. type: object - description: Metadata used for import issue model. - id: GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata properties: + languageCode: + description: Language of the model. + type: string + inputDataConfig: + description: Configs for the input data that used to create the issue model. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig + displayName: + type: string + description: The representative name for the issue model. + issueCount: + type: string + format: int64 + description: Output only. Number of issues in this issue model. + readOnly: true createTime: - description: The time the operation was created. + format: google-datetime + description: Output only. The time at which this issue model was created. + readOnly: true type: string + updateTime: format: google-datetime - request: - description: The original import request. + description: >- + Output only. The most recent time at which the issue model was + updated. + type: string + readOnly: true + state: + readOnly: true + description: Output only. State of the model. + type: string + 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. + name: + description: >- + Immutable. The resource name of the issue model. Format: + projects/{project}/locations/{location}/issueModels/{issue_model} + type: string + trainingStats: + description: >- + Output only. Immutable. The issue model's label statistics on its + training data. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequest - endTime: - format: google-datetime - description: The time the operation finished running. + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats + readOnly: true + modelType: + description: Type of the model. + enumDescriptions: + - Unspecified model type. + - Type V1. + - Type V2. + enum: + - MODEL_TYPE_UNSPECIFIED + - TYPE_V1 + - TYPE_V2 type: string - GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse: - id: GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse + GoogleCloudContactcenterinsightsV1alpha1GetGeneratorSuggestionResponse: type: object properties: - currentStats: + generatorSuggestion: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStats + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GeneratorSuggestion + description: The suggestion generated from the Generator. + id: GoogleCloudContactcenterinsightsV1alpha1GetGeneratorSuggestionResponse + description: Represents response from generators. + GoogleCloudContactcenterinsightsV1IssueMatchData: + description: The data for an issue match annotation. + properties: + issueAssignment: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueAssignment + description: Information about the issue's assignment. + type: object + id: GoogleCloudContactcenterinsightsV1IssueMatchData + GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse: + type: object + properties: + nextPageToken: + type: string description: >- - The latest label statistics for the queried issue model. Includes - results on both training data and data labeled after deployment. - description: Response of querying an issue model's statistics. + 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: + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher + type: array + description: The phrase matchers that match the request. + description: The response of listing phrase matchers. + id: GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse GoogleCloudContactcenterinsightsV1alpha1CallAnnotation: - id: GoogleCloudContactcenterinsightsV1alpha1CallAnnotation + type: object properties: + annotationStartBoundary: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + description: >- + The boundary in the conversation where the annotation starts, + inclusive. + issueMatchData: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueMatchData + description: Data specifying an issue match. + sentimentData: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData + description: Data specifying sentiment. + annotationEndBoundary: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + description: >- + The boundary in the conversation where the annotation ends, + inclusive. intentMatchData: + description: Data specifying an intent match. $ref: >- #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IntentMatchData - description: Data specifying an intent match. interruptionData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1InterruptionData description: Data specifying an interruption. - silenceData: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SilenceData - description: Data specifying silence. + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1InterruptionData phraseMatchData: description: Data specifying a phrase match. $ref: >- #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData - annotationEndBoundary: - description: >- - The boundary in the conversation where the annotation ends, - inclusive. + silenceData: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SilenceData + description: Data specifying silence. channelTag: - type: integer format: int32 + type: integer description: >- The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated. - issueMatchData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueMatchData - description: Data specifying an issue match. holdData: description: Data specifying a hold. $ref: >- #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1HoldData - annotationStartBoundary: - description: >- - The boundary in the conversation where the annotation starts, - inclusive. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary entityMentionData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1EntityMentionData description: Data specifying an entity mention. - sentimentData: - description: Data specifying sentiment. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1EntityMentionData description: A piece of metadata that applies to a window of a call. - type: object - GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse: - description: The response for a bulk delete conversations operation. - id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse - type: object - properties: {} - GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback: + id: GoogleCloudContactcenterinsightsV1alpha1CallAnnotation + GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSourceSnippet: + description: Snippet Source for a Generative Prediction. properties: - correctnessLevel: + text: + description: text taken from that URI. + type: string + document: type: string - 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. - clicked: - type: boolean - description: Indicates whether an answer or item was clicked by the human agent. - displayed: - type: boolean description: >- - Indicates whether an answer or item was displayed to the human agent - in the agent desktop UI. - description: >- - The feedback that the customer has about a certain answer in the - conversation. - type: object - id: GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback - GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentCoachingSuggestionReasoning: - description: Reasoning for the suggestion. - type: object - id: >- - GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentCoachingSuggestionReasoning - properties: - agentActionTaken: + Indicates which Knowledge Document this snippet was extracted from. + Format: `projects//knowledgeBases//documents/`. + uri: type: string - description: Optional. The actions that the agent has taken already. - issueSummary: - description: Optional. Summary of the issue. + description: URI the data is sourced from. + title: type: string - GoogleCloudContactcenterinsightsV1alpha1DialogflowSource: - description: A Dialogflow source of conversation data. + description: Title of the document. + id: >- + GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSourceSnippet type: object + GoogleCloudContactcenterinsightsV1SummarySuggestionSummarySection: properties: - dialogflowConversation: + section: 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} - readOnly: true - audioUri: + description: Required. Name of the section. + summary: type: string - description: >- - Cloud Storage URI that points to a file that contains the - conversation audio. - id: GoogleCloudContactcenterinsightsV1alpha1DialogflowSource - GoogleCloudContactcenterinsightsV1UploadConversationMetadata: - id: GoogleCloudContactcenterinsightsV1UploadConversationMetadata - description: The metadata for an UploadConversation operation. + description: Required. Summary text for the section. + type: object + description: A component of the generated summary. + id: GoogleCloudContactcenterinsightsV1SummarySuggestionSummarySection + GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig: + id: GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig properties: - appliedRedactionConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig + runtimeIntegrationAnalysisPercentage: + type: number description: >- - Output only. The redaction config applied to the uploaded - conversation. - readOnly: true - request: - description: Output only. The original request. + Percentage of conversations created using Dialogflow runtime + integration to analyze automatically, between [0, 100]. + format: double + uploadConversationAnalysisPercentage: + type: number + format: double + description: >- + Percentage of conversations created using the UploadConversation + endpoint to analyze automatically, between [0, 100]. + annotatorSelector: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1UploadConversationRequest - readOnly: true - createTime: - readOnly: true - description: Output only. The time the operation was created. - type: string - format: google-datetime - analysisOperation: + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector 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. - format: google-datetime - readOnly: true - type: string + To select the annotators to run and the phrase matchers to use (if + any). If not specified, all annotators will be run. + description: Default configuration when creating Analyses in Insights. type: object - GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData: - id: GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData + GoogleLongrunningOperation: type: object + id: GoogleLongrunningOperation properties: - confidenceScore: - type: number - format: double + name: 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). - suggestion: + 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: The content of the suggestion. + 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 + 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: + 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: string - description: >- - Map that contains metadata about the Smart Compose suggestion and - the document from which it originates. - queryRecord: - type: string + type: any + description: Properties of the object. Contains field @type with type URL. + error: + $ref: '#/components/schemas/GoogleRpcStatus' description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - description: Agent Assist Smart Compose suggestion data. - GoogleCloudContactcenterinsightsV1alpha1SpeechConfig: + 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. + GoogleCloudContactcenterinsightsV1SpeechConfig: + type: object + id: GoogleCloudContactcenterinsightsV1SpeechConfig properties: speechRecognizer: type: string @@ -3758,526 +3210,452 @@ components: IngestConversations endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the CreateConversation endpoint. - id: GoogleCloudContactcenterinsightsV1alpha1SpeechConfig + GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata: type: object - GoogleCloudContactcenterinsightsV1InterruptionData: - properties: {} + properties: + createTime: + format: google-datetime + description: The time the operation was created. + type: string + endTime: + type: string + description: The time the operation finished running. + format: google-datetime + request: + description: The original import request. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequest + description: Metadata used for import issue model. + id: GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata + GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse: type: object - description: The data for an interruption annotation. - id: GoogleCloudContactcenterinsightsV1InterruptionData - GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse: + properties: + currentStats: + 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 + id: GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse + description: Response of querying an issue model's statistics. + GoogleCloudContactcenterinsightsV1AgentCoachingInstruction: type: object - description: Response for an export insights operation. - properties: {} - id: GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource: + description: Agent Coaching instructions that customer can configure. properties: - bucketUri: - description: Required. The Cloud Storage bucket containing source objects. + displayName: + description: Optional. Display name for the instruction. type: string - bucketObjectType: + systemAction: + description: >- + Optional. The action that system should take. For example, "call + GetOrderTime with order_number={order number provided by the + customer}". If the users don't have plugins or don't want to trigger + plugins, the system_action can be empty type: string - enum: - - BUCKET_OBJECT_TYPE_UNSPECIFIED - - TRANSCRIPT - - AUDIO - 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. - metadataBucketUri: + condition: + description: >- + Optional. The condition of the instruction. For example, "the + customer wants to cancel an order". If the users want the + instruction to be triggered unconditionally, the condition can be + empty. + type: string + metadata: + type: object + description: Optional. Additional information attached to this instruction. + additionalProperties: + type: string + description: + description: Optional. The detailed description of this instruction. + type: string + agentAction: type: string description: >- - Optional. The Cloud Storage path to the source object metadata. Note - that: [1] metadata files are expected to be in JSON format [2] - metadata and source objects must be in separate buckets [3] a source - object's metadata object must share the same name to be properly - ingested - customMetadataKeys: + Optional. The action that human agent should take. For example, + "apologize for the slow shipping". If the users only want to use + agent coaching for intent detection, agent_action can be empty + id: GoogleCloudContactcenterinsightsV1AgentCoachingInstruction + GoogleCloudContactcenterinsightsV1SentimentData: + type: object + id: GoogleCloudContactcenterinsightsV1SentimentData + properties: + magnitude: 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. + A non-negative number from 0 to infinity which represents the + abolute magnitude of sentiment regardless of score. + format: float + type: number + score: + type: number + format: float + description: The sentiment score between -1.0 (negative) and 1.0 (positive). + description: The data for a sentiment annotation. + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript: + properties: + transcriptSegments: type: array items: - type: string - id: >- - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource - description: Configuration for Cloud Storage bucket sources. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment + description: >- + A list of sequential transcript segments that comprise the + conversation. type: object - GoogleCloudContactcenterinsightsV1CallAnnotation: - description: A piece of metadata that applies to a window of a call. - id: GoogleCloudContactcenterinsightsV1CallAnnotation + description: A message representing the transcript of a conversation. + id: GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata: type: object + description: Metadata from Dialogflow relating to the current transcript segment. + id: >- + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata properties: - sentimentData: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' - description: Data specifying sentiment. - issueMatchData: - description: Data specifying an issue match. + smartReplyAllowlistCovered: + description: >- + Whether the transcript segment was covered under the configured + smart reply allowlist in Agent Assist. + type: boolean + GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse: + description: Response for an export insights operation. + properties: {} + type: object + id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse + GoogleCloudContactcenterinsightsV1RuntimeAnnotation: + description: >- + An annotation that was generated during the customer and agent + interaction. + id: GoogleCloudContactcenterinsightsV1RuntimeAnnotation + properties: + articleSuggestion: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueMatchData - interruptionData: - description: Data specifying an interruption. + #/components/schemas/GoogleCloudContactcenterinsightsV1ArticleSuggestionData + description: Agent Assist Article Suggestion data. + faqAnswer: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1FaqAnswerData' + description: Agent Assist FAQ answer data. + smartReply: + description: Agent Assist Smart Reply data. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1InterruptionData - intentMatchData: + #/components/schemas/GoogleCloudContactcenterinsightsV1SmartReplyData + dialogflowInteraction: + description: Dialogflow interaction data. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IntentMatchData - description: Data specifying an intent match. - entityMentionData: + #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowInteractionData + smartComposeSuggestion: + description: Agent Assist Smart Compose suggestion data. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1EntityMentionData - description: Data specifying an entity mention. - annotationStartBoundary: + #/components/schemas/GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData + conversationSummarizationSuggestion: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData + description: Conversation summarization suggestion data. + endBoundary: description: >- - The boundary in the conversation where the annotation starts, + The boundary in the conversation where the annotation ends, inclusive. - channelTag: - format: int32 + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary + createTime: + format: google-datetime + description: The time at which this annotation was created. + type: string + knowledgeSearchResult: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswer + description: The Knowledge Search result. + annotationId: description: >- - The channel of the audio where the annotation occurs. For - single-channel audio, this field is not populated. - type: integer - annotationEndBoundary: + The unique identifier of the annotation. Format: + projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} + type: string + answerFeedback: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnswerFeedback + description: The feedback that the customer has about the answer in `data`. + knowledgeAssistResult: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponse + description: The Knowledge Assist result. + generatorSuggestionResult: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1GetGeneratorSuggestionResponse + description: The generator suggestion result. + startBoundary: description: >- - The boundary in the conversation where the annotation ends, + The boundary in the conversation where the annotation starts, inclusive. $ref: >- #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary - silenceData: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SilenceData' - description: Data specifying silence. - phraseMatchData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchData - description: Data specifying a phrase match. - holdData: - description: Data specifying a hold. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1HoldData' - GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSource: - description: Details about source of Generative answer. type: object + GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination: + description: A BigQuery Table Reference. + type: object + 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: + 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 + id: >- + GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination + GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination: + properties: + objectUri: + type: string + description: 'Required. Format: `gs:///`' + description: Google Cloud Storage Object URI to save the issue model to. + type: object + id: GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination + GoogleCloudContactcenterinsightsV1CreateIssueModelRequest: + description: The request to create an issue model. + type: object + properties: + issueModel: + description: Required. The issue model to create. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel' + parent: + type: string + description: Required. The parent resource of the issue model. + id: GoogleCloudContactcenterinsightsV1CreateIssueModelRequest + GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSource: properties: snippets: + type: array items: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSourceSnippet + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSourceSnippet description: >- All snippets used for this Generative Prediction, with their source URI and data. - type: array + description: Details about source of Generative answer. id: >- - GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSource - GoogleCloudContactcenterinsightsV1ConversationParticipant: - id: GoogleCloudContactcenterinsightsV1ConversationParticipant + GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSource + type: object + GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource: + type: object properties: - userId: - description: A user-specified ID representing the participant. - type: string - 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. - enum: - - ROLE_UNSPECIFIED - - HUMAN_AGENT - - AUTOMATED_AGENT - - END_USER - - ANY_AGENT - type: string - dialogflowParticipant: + objectUri: + description: 'Required. Format: `gs:///`' type: string - deprecated: true + id: GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource + description: Google Cloud Storage Object URI to get the issue model file from. + GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponse: + properties: + suggestedQueryAnswer: description: >- - Deprecated. Use `dialogflow_participant_name` instead. The name of - the Dialogflow participant. Format: - projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} - dialogflowParticipantName: - type: string + The answer generated for the suggested query. Whether or not an + answer is generated depends on how confident we are about the + generated query. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswer + suggestedQuery: description: >- - The name of the participant provided by Dialogflow. Format: - projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} - obfuscatedExternalUserId: - description: Obfuscated user ID from Dialogflow. - type: string + The query suggested based on the context. Suggestion is made only if + it is different from the previous suggestion. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseSuggestedQuery + description: >- + Response for Knowledge Assist. Contains suggested query and optionally + includes an answer for the query. type: object - description: The call participant speaking for a given utterance. - GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionSampleResponse: + id: GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponse + GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse: + properties: {} type: object - id: >- - GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionSampleResponse + description: Response from import issue model + id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse + GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionSampleResponse: description: >- Sample response that the agent can use. This could be based on applicable instructions and ingested data from other systems. properties: responseText: - description: Optional. Sample response for Agent in text. type: string - GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination: + description: Optional. Sample response for Agent in text. + type: object + id: GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionSampleResponse + GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseSuggestedQuery: id: >- - GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination + GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseSuggestedQuery + description: Represents a suggested query. type: object properties: - 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 - table: + score: + format: float + description: Suggested query score. + type: number + queryText: 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. - 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. - description: A BigQuery Table Reference. - GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment: + description: Suggested query text. + GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse: + id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse + description: The response for a bulk delete conversations operation. type: object - id: GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment - description: One channel of conversation-level sentiment data. + properties: {} + GoogleCloudContactcenterinsightsV1alpha1EntityMentionData: properties: - sentimentData: - description: Data specifying sentiment. + sentiment: $ref: >- #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData - channelTag: - format: int32 - description: The channel of the audio that the data applies to. - type: integer - GoogleCloudContactcenterinsightsV1IssueAssignment: - id: GoogleCloudContactcenterinsightsV1IssueAssignment - description: Information about the issue. - type: object - properties: - score: - description: >- - Score indicating the likelihood of the issue assignment. currently - bounded on [0,1]. - 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. + description: Sentiment expressed for this mention of the entity. + type: type: string - issue: + enumDescriptions: + - Unspecified. + - Proper noun. + - Common noun (or noun compound). + description: The type of the entity mention. + enum: + - MENTION_TYPE_UNSPECIFIED + - PROPER + - COMMON + entityUniqueId: type: string - description: Resource name of the assigned issue. - GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata: - description: Metadata for deleting an issue model. + description: >- + The key of this entity in conversation entities. Can be used to + retrieve the exact `Entity` this mention is attached to. type: object - id: GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata + id: GoogleCloudContactcenterinsightsV1alpha1EntityMentionData + description: >- + The data for an entity mention annotation. This represents a mention of + an `Entity` in the conversation. + GoogleCloudContactcenterinsightsV1InterruptionData: + id: GoogleCloudContactcenterinsightsV1InterruptionData + properties: {} + type: object + description: The data for an interruption annotation. + GoogleCloudContactcenterinsightsV1alpha1AnalysisResult: + id: GoogleCloudContactcenterinsightsV1alpha1AnalysisResult + type: object + description: The result of an analysis. properties: - createTime: - format: google-datetime - readOnly: true - type: string - description: Output only. The time the operation was created. - request: + callAnalysisMetadata: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest - description: The original request for deletion. + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata + description: Call-specific metadata created by the analysis. endTime: type: string + description: The time at which the analysis ended. format: google-datetime - readOnly: true - description: Output only. The time the operation finished running. - GoogleCloudContactcenterinsightsV1AnswerFeedback: - type: object - id: GoogleCloudContactcenterinsightsV1AnswerFeedback - properties: - correctnessLevel: - 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. - enum: - - CORRECTNESS_LEVEL_UNSPECIFIED - - NOT_CORRECT - - PARTIALLY_CORRECT - - FULLY_CORRECT - displayed: - type: boolean - description: >- - Indicates whether an answer or item was displayed to the human agent - in the agent desktop UI. - clicked: - type: boolean - description: Indicates whether an answer or item was clicked by the human agent. - description: >- - The feedback that the customer has about a certain answer in the - conversation. - GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse: - id: GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse - properties: - failedAnalysisCount: - type: integer - description: Count of failed analyses. - format: int32 - successfulAnalysisCount: - format: int32 - type: integer - description: Count of successful analyses. - type: object - description: The response for a bulk analyze conversations operation. - GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata: - id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata + GoogleCloudContactcenterinsightsV1alpha1Conversation: type: object + id: GoogleCloudContactcenterinsightsV1alpha1Conversation properties: createTime: - type: string - format: google-datetime - description: The time the operation was created. - endTime: format: google-datetime + readOnly: true type: string - description: The time the operation finished running. - request: + description: Output only. The time at which the conversation was created. + latestAnalysis: + description: Output only. The conversation's latest analysis, if one exists. + readOnly: true $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest - description: The original import request. - description: Metadata used for import issue model. - GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest: - type: object - id: GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest - description: The request to delete an issue model. - properties: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Analysis name: - type: string - description: Required. The name of the issue model to delete. - GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination: - description: Google Cloud Storage Object URI to save the issue model to. - id: >- - GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination - properties: - objectUri: - description: 'Required. Format: `gs:///`' - type: string - type: object - GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse: - type: object - description: Response from import issue model - id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse - properties: {} - GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig: - id: GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig - type: object - description: Configuration information of a phrase match rule. - properties: - exactMatchConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExactMatchConfig - description: The configuration for the exact match rule. - GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig: - description: Configuration for summarization. - id: GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig - properties: - conversationProfile: type: string description: >- - Resource name of the Dialogflow conversation profile. Format: - projects/{project}/locations/{location}/conversationProfiles/{conversation_profile} - summarizationModel: + Immutable. The resource name of the conversation. Format: + projects/{project}/locations/{location}/conversations/{conversation} + transcript: + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript + description: Output only. The conversation transcript. + expireTime: type: string - enum: - - SUMMARIZATION_MODEL_UNSPECIFIED - - BASELINE_MODEL - - BASELINE_MODEL_V2_0 - description: Default summarization model to be used. - enumDescriptions: - - Unspecified summarization model. - - The CCAI baseline model. - - The CCAI baseline model, V2.0. - type: object - GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest: - type: object - description: The request to delete conversations in bulk. - properties: - parent: + format: google-datetime description: >- - Required. The parent resource to delete conversations from. Format: - projects/{project}/locations/{location} - type: string - maxDeleteCount: - format: int32 - description: Maximum number of conversations to delete. - type: integer - force: + The time at which this conversation should expire. After this time, + the conversation data and any associated analyses will be deleted. + dialogflowIntents: + readOnly: true 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 - filter: - description: Filter used to select the subset of conversations to delete. + 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 + type: object + duration: type: string - id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata: - id: >- - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata - properties: - smartReplyAllowlistCovered: - type: boolean - description: >- - Whether the transcript segment was covered under the configured - smart reply allowlist in Agent Assist. - type: object - description: Metadata from Dialogflow relating to the current transcript segment. - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo: - type: object - properties: - endOffset: format: google-duration + description: Output only. The duration of the conversation. + readOnly: true + languageCode: type: string - description: >- - Time offset of the end of this word relative to the beginning of the - total conversation. - word: - type: string - description: The word itself. Includes punctuation marks that surround the word. - startOffset: - format: google-duration - type: string - 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 - id: >- - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo - description: Word-level info for words in a transcript. - GoogleCloudContactcenterinsightsV1Conversation: - id: GoogleCloudContactcenterinsightsV1Conversation - properties: - dialogflowIntents: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowIntent - 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 + description: A user-specified language code for the conversation. + dataSource: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource + description: The source of the audio and transcription for the conversation. obfuscatedUserId: type: string description: Obfuscated user ID which the customer sent to us. + startTime: + type: string + format: google-datetime + description: The time at which the conversation started. latestSummary: - description: Output only. Latest summary of the conversation. readOnly: true + description: Output only. Latest summary of the conversation. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData labels: + type: object 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. additionalProperties: type: string - type: object - transcript: - description: Output only. The conversation transcript. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscript turnCount: - format: int32 + type: integer readOnly: true description: Output only. The number of turns in the conversation. - type: integer + format: int32 runtimeAnnotations: readOnly: true - type: array items: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1RuntimeAnnotation + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation + type: array description: >- Output only. The annotations that were generated during the customer and agent interaction. - languageCode: - type: string - description: A user-specified language code for the conversation. - expireTime: + updateTime: + description: >- + Output only. The most recent time at which the conversation was + updated. + readOnly: true 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. callMetadata: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationCallMetadata + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata description: Call-specific metadata. - createTime: - format: google-datetime - readOnly: true - description: Output only. The time at which the conversation was created. - type: string - updateTime: - format: google-datetime - readOnly: true - type: string - description: >- - Output only. The most recent time at which the conversation was - updated. agentId: - type: string description: >- An opaque, user-specified string representing the human agent who handled the conversation. - name: - description: >- - Immutable. The resource name of the conversation. Format: - projects/{project}/locations/{location}/conversations/{conversation} type: string - dataSource: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationDataSource - description: The source of the audio and transcription for the conversation. ttl: - format: google-duration description: >- Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time. - type: string - duration: - readOnly: true - type: string - description: Output only. The duration of the conversation. format: google-duration - startTime: - description: The time at which the conversation started. - format: google-datetime type: string - qualityMetadata: - description: Conversation metadata related to quality management. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationQualityMetadata - latestAnalysis: - readOnly: true - description: Output only. The conversation's latest analysis, if one exists. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' medium: type: string enumDescriptions: @@ -4291,672 +3669,1164 @@ components: - MEDIUM_UNSPECIFIED - PHONE_CALL - CHAT - type: object + qualityMetadata: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata + description: Conversation metadata related to quality management. description: The conversation resource. - GoogleCloudContactcenterinsightsV1alpha1Entity: - id: GoogleCloudContactcenterinsightsV1alpha1Entity + GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata + description: Conversation metadata related to quality management. 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`. + customerSatisfactionRating: + type: integer + format: int32 + description: >- + An arbitrary integer value indicating the customer's satisfaction + rating. + menuPath: type: string - enum: - - TYPE_UNSPECIFIED - - PERSON - - LOCATION - - ORGANIZATION - - EVENT - - WORK_OF_ART - - CONSUMER_GOOD - - OTHER - - PHONE_NUMBER - - ADDRESS - - DATE - - NUMBER - - PRICE - 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 - sentiment: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData + An arbitrary string value specifying the menu path the customer + took. + waitDuration: + description: The amount of time the customer waited to connect with an agent. + format: google-duration + type: string + agentInfo: + type: array + description: Information about agents involved in the call. + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo + type: object + GoogleCloudContactcenterinsightsV1IssueModelResult: + type: object + description: Issue Modeling result on a conversation. + id: GoogleCloudContactcenterinsightsV1IssueModelResult + properties: + issueModel: description: >- - The aggregate sentiment expressed for this entity in the - conversation. - salience: + Issue model that generates the result. Format: + projects/{project}/locations/{location}/issueModels/{issue_model} + type: string + issues: + type: array + description: All the matched issues. + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueAssignment + GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats: + type: object + properties: + analyzedConversationsCount: + format: int64 + type: string 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: + Number of conversations the issue model has analyzed at this point + in time. + unclassifiedConversationsCount: + type: string + format: int64 + description: >- + Number of analyzed conversations for which no issue was applicable + at this point in time. + issueStats: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats + description: Statistics on each issue. Key is the issue's resource name. + type: object + description: Aggregated statistics about an issue model. + id: GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats + GoogleCloudContactcenterinsightsV1alpha1SentimentData: + type: object + id: GoogleCloudContactcenterinsightsV1alpha1SentimentData + description: The data for a sentiment annotation. + properties: + magnitude: + description: >- + A non-negative number from 0 to infinity which represents the + abolute magnitude of sentiment regardless of score. + format: float + type: number + score: + description: The sentiment score between -1.0 (negative) and 1.0 (positive). + format: float + type: number + GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence: + id: GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence + type: object + description: Conversation-level silence data. + properties: + silenceDuration: + type: string + description: Amount of time calculated to be in silence. + format: google-duration + silencePercentage: + type: number + description: Percentage of the total conversation spent in silence. + format: float + GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest: + properties: + conversation: + description: Required. The conversation resource to create. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Conversation + redactionConfig: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig + description: >- + Optional. DLP settings for transcript redaction. Will default to the + config specified in Settings. + 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-` + speechConfig: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SpeechConfig + description: >- + Optional. Speech-to-Text configuration. Will default to the config + specified in Settings. + description: Request to upload a conversation. + id: GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest + type: object + GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata: + description: Metadata for creating an issue model. + properties: + request: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1CreateIssueModelRequest + description: The original request for creation. + createTime: + readOnly: true + format: google-datetime + type: string + description: Output only. The time the operation was created. + endTime: + type: string + readOnly: true + description: Output only. The time the operation finished running. + format: google-datetime + type: object + id: GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata + GoogleCloudContactcenterinsightsV1DeployIssueModelResponse: + properties: {} + id: GoogleCloudContactcenterinsightsV1DeployIssueModelResponse + type: object + description: The response to deploy an issue model. + 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. + type: object + id: GoogleCloudContactcenterinsightsV1alpha1IntentMatchData + properties: + intentUniqueId: + type: string + description: >- + The id of the matched intent. Can be used to retrieve the + corresponding intent information. + GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData: + id: GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData + description: Agent Assist frequently-asked-question answer data. + type: object + properties: + metadata: + additionalProperties: + type: string + description: >- + Map that contains metadata about the FAQ answer and the document + that it originates from. + type: object + question: + type: string + description: The corresponding FAQ question. + 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). + answer: + type: string + description: The piece of text from the `source` knowledge base document. + queryRecord: + description: >- + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} + type: string + source: + type: string + description: >- + The knowledge document that this answer was extracted from. Format: + projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. + GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentCoachingSuggestionReasoning: + type: object + properties: + issueSummary: + type: string + description: Optional. Summary of the issue. + agentActionTaken: + description: Optional. The actions that the agent has taken already. + type: string + id: >- + GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentCoachingSuggestionReasoning + description: Reasoning for the suggestion. + GoogleCloudContactcenterinsightsV1ExportIssueModelRequest: + id: GoogleCloudContactcenterinsightsV1ExportIssueModelRequest + type: object + properties: + name: + description: Required. The issue model to export + type: string + gcsDestination: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination + description: Google Cloud Storage URI to export the Issue Model to. + description: Request to export an issue model. + GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment: + description: One channel of conversation-level sentiment data. + properties: + sentimentData: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData + description: Data specifying sentiment. + channelTag: + description: The channel of the audio that the data applies to. + format: int32 + type: integer + id: GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment + type: object + GoogleCloudContactcenterinsightsV1FreeFormSuggestion: + id: GoogleCloudContactcenterinsightsV1FreeFormSuggestion + description: Suggestion generated using free form generator. + type: object + properties: + labels: + type: array + description: Optional. Labels for the generator. + items: + type: string + response: + type: string + description: Required. Free form suggestion. + GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata: + properties: + createTime: + readOnly: true + description: Output only. The time the operation was created. + type: string + format: google-datetime + endTime: + format: google-datetime + type: string + readOnly: true + description: Output only. The time the operation finished running. + partialErrors: + description: >- + Partial errors during export operation that might cause the + operation output to be incomplete. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + request: + description: The original request for export. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest + id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata + type: object + description: Metadata for an export insights operation. + GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse: + type: object + id: GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse + description: Response for an export insights operation. + properties: {} + GoogleCloudContactcenterinsightsV1alpha1SpeechConfig: + properties: + speechRecognizer: + description: >- + The fully-qualified Speech Recognizer resource name. Format: + `projects/{project_id}/locations/{location}/recognizer/{recognizer}` + type: string + type: object + id: GoogleCloudContactcenterinsightsV1alpha1SpeechConfig + 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. + GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswer: + id: >- + GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswer + type: object + properties: + intentMatchingSource: + description: Populated if the prediction was from intent matching. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerIntentMatchingSource + generativeSource: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSource + description: Populated if the prediction was Generative. + faqSource: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerFaqSource + description: Populated if the prediction came from FAQ. + answerText: + description: >- + The piece of text from the `source` that answers this suggested + query. + type: string + matchConfidence: + description: >- + The system's confidence score that this answer is a good match for + this conversational query. The range is from 0.0 (completely + uncertain) to 1.0 (completely certain). + type: number + format: float + description: >- + Represents an answer from Knowledge. Cuurently supports FAQ and + Generative answers. + GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseSuggestedQuery: + description: Represents a suggested query. + type: object + properties: + score: + type: number + description: Suggested query score. + format: float + queryText: + description: Suggested query text. + type: string + id: >- + GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseSuggestedQuery + 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 + GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata: + properties: + createTime: + readOnly: true + description: Output only. The time the operation was created. + format: google-datetime + type: string + analysisOperation: + readOnly: true + description: >- + Output only. The operation name for a successfully created analysis + operation, if any. + type: string + request: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest + readOnly: true + description: Output only. The original request. + appliedRedactionConfig: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig + description: >- + Output only. The redaction config applied to the uploaded + conversation. + readOnly: true + endTime: + format: google-datetime + description: Output only. The time the operation finished running. + readOnly: true + type: string + description: The metadata for an UploadConversation operation. + id: GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata + type: object + GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentCoachingSuggestionEval: + properties: + sampleResponseEval: + type: string + description: Optional. Eval for sample response. + actionActionSuggestionEval: + type: string + description: Optional. Eval for Agent action suggestion. + id: >- + GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentCoachingSuggestionEval + type: object + description: Self evaluations of the suggestion. + GoogleCloudContactcenterinsightsV1alpha1SearchKnowledgeAnswer: + type: object + properties: + answerSources: + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SearchKnowledgeAnswerAnswerSource + type: array + description: All sources used to generate the answer. + answerType: + enum: + - ANSWER_TYPE_UNSPECIFIED + - FAQ + - GENERATIVE + - INTENT + description: The type of the answer. + type: string + enumDescriptions: + - The answer has a unspecified type. + - The answer is from FAQ documents. + - The answer is from generative model. + - The answer is from intent matching. + answer: + type: string + description: >- + The piece of text from the knowledge base documents that answers the + search query + confidenceScore: + type: number + format: float + description: The confidence score in [0.0, 1.0] range. + answerRecord: + type: string + description: >- + The name of the answer record. Format: `projects//locations//answer + Records/` + id: GoogleCloudContactcenterinsightsV1alpha1SearchKnowledgeAnswer + description: Represents a SearchKnowledge answer. + GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata: + description: The metadata for a bulk analyze conversations operation. + properties: + partialErrors: + items: + $ref: '#/components/schemas/GoogleRpcStatus' + readOnly: true + 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 + totalRequestedAnalysesCount: + type: integer + format: int32 + description: >- + Total number of analyses requested. Computed by the number of + conversations returned by `filter` multiplied by + `analysis_percentage` in the request. + request: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest + description: The original request for bulk analyze. + completedAnalysesCount: + type: integer + format: int32 + description: >- + The number of requested analyses that have completed successfully so + far. + endTime: + format: google-datetime + description: The time the operation finished running. + type: string + createTime: + format: google-datetime + type: string + description: The time the operation was created. + id: GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata + type: object + GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest: + type: object + properties: + gcsSource: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource + description: Google Cloud Storage source message. + parent: + type: string + description: Required. The parent resource of the issue model. + createNewModel: + description: >- + Optional. If set to true, will create a new 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 + id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest + description: Request to import an issue model. + GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata + type: object + description: Metadata for creating an issue model. + properties: + request: + description: The original request for creation. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest + createTime: + type: string + readOnly: true + format: google-datetime + description: Output only. The time the operation was created. + endTime: + format: google-datetime + type: string + readOnly: true + description: Output only. The time the operation finished running. + GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata + properties: + createTime: + type: string + description: Output only. The time the operation was created. + readOnly: true + format: google-datetime + request: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest + description: The original request for deletion. + endTime: + readOnly: true + description: Output only. The time the operation finished running. + type: string + format: google-datetime + description: Metadata for deleting an issue model. + type: object + GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats: + id: GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats + description: Aggregated statistics about an issue. + properties: + labeledConversationsCount: + format: int64 + description: Number of conversations attached to the issue at this point in time. + type: string + displayName: + type: string + description: Display name of the issue. + issue: + description: >- + Issue resource. Format: + projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} + type: string + type: object + GoogleCloudContactcenterinsightsV1AgentCoachingSuggestion: + id: GoogleCloudContactcenterinsightsV1AgentCoachingSuggestion + description: Suggestion for coaching agents. + properties: + agentActionSuggestions: + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentActionSuggestion + type: array + description: Optional. Suggested actions for the agent to take. + sampleResponses: + description: Optional. Sample response for the Agent. + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionSampleResponse + type: array + applicableInstructions: + description: Optional. Instructions applicable based on the current context. + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AgentCoachingInstruction + type: array + suggestionReasoning: + description: Reasoning for the suggestion. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentCoachingSuggestionReasoning + suggestionEval: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentCoachingSuggestionEval + description: Self evaluation of the suggestion. + type: object + GoogleCloudContactcenterinsightsV1ConversationQualityMetadata: + type: object + description: Conversation metadata related to quality management. + properties: + agentInfo: + description: Information about agents involved in the call. + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo + type: array + customerSatisfactionRating: + type: integer + format: int32 + description: >- + An arbitrary integer value indicating the customer's satisfaction + rating. + menuPath: + type: string + description: >- + An arbitrary string value specifying the menu path the customer + took. + waitDuration: + type: string + description: The amount of time the customer waited to connect with an agent. + format: google-duration + id: GoogleCloudContactcenterinsightsV1ConversationQualityMetadata + GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse: + id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse + properties: {} + description: Response from export issue model + type: object + GoogleCloudContactcenterinsightsV1alpha1FreeFormSuggestion: + type: object + id: GoogleCloudContactcenterinsightsV1alpha1FreeFormSuggestion + description: Suggestion generated using free form generator. + properties: + labels: + items: + type: string + type: array + description: Optional. Labels for the generator. + response: + description: Required. Free form suggestion. 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. + GoogleCloudContactcenterinsightsV1PhraseMatcher: + description: The phrase matcher resource. + id: GoogleCloudContactcenterinsightsV1PhraseMatcher type: object - GoogleCloudContactcenterinsightsV1ListViewsResponse: properties: - nextPageToken: + type: + type: string + description: Required. The type of this phrase matcher. + 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. + enum: + - PHRASE_MATCHER_TYPE_UNSPECIFIED + - ALL_OF + - ANY_OF + versionTag: + 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. + The customized version tag to use for the phrase matcher. If not + specified, it will default to `revision_id`. + activationUpdateTime: + description: >- + Output only. The most recent time at which the activation status was + updated. + format: google-datetime + readOnly: true type: string - views: + name: + type: string + description: >- + The resource name of the phrase matcher. Format: + projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} + phraseMatchRuleGroups: + description: A list of phase match rule groups that are included in this matcher. items: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup type: array - description: The views that match the request. - type: object - id: GoogleCloudContactcenterinsightsV1ListViewsResponse - description: The response of listing views. - GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata: - properties: - createTime: + revisionCreateTime: format: google-datetime + readOnly: true + 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 - description: The time the operation was created. - partialErrors: - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' + roleMatch: description: >- - Output only. Partial errors during bulk analyze operation that might - cause the operation output to be incomplete. + 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: 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. + updateTime: readOnly: true - endTime: + type: string + description: >- + Output only. The most recent time at which the phrase matcher was + updated. format: google-datetime - description: The time the operation finished running. + active: + type: boolean + description: Applies the phrase matcher only when it is active. + displayName: type: string - failedAnalysesCount: - description: The number of requested analyses that have failed so far. - format: int32 - type: integer - totalRequestedAnalysesCount: + description: The human-readable name of the phrase matcher. + revisionId: description: >- - Total number of analyses requested. Computed by the number of - conversations returned by `filter` multiplied by - `analysis_percentage` in the request. + 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 + readOnly: true + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig: + type: object + id: >- + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig + description: Configuration for processing transcript objects. + properties: + medium: + 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. + enum: + - MEDIUM_UNSPECIFIED + - PHONE_CALL + - CHAT + GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary: + type: object + description: >- + A point in a conversation that marks the start or the end of an + annotation. + id: GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + properties: + transcriptIndex: format: int32 type: integer - completedAnalysesCount: description: >- - The number of requested analyses that have completed successfully so - far. + The index in the sequence of transcribed pieces of the conversation + where the boundary is located. This index starts at zero. + wordIndex: type: integer format: int32 - request: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest - description: The original request for bulk analyze. - id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata - type: object - description: The metadata for a bulk analyze conversations operation. - GoogleCloudContactcenterinsightsV1SummarySuggestion: - id: GoogleCloudContactcenterinsightsV1SummarySuggestion + description: >- + The word index of this boundary with respect to the first word in + the transcript piece. This index starts at zero. + GoogleCloudContactcenterinsightsV1alpha1DialogflowSource: + description: A Dialogflow source of conversation data. type: object - description: Suggested summary of the conversation. - properties: - summarySections: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1SummarySuggestionSummarySection - type: array - description: Required. All the parts of generated summary. - GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest: + id: GoogleCloudContactcenterinsightsV1alpha1DialogflowSource properties: - 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. - force: - type: boolean + dialogflowConversation: 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: + 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 + audioUri: type: string description: >- - Required. The parent resource to delete conversations from. Format: - projects/{project}/locations/{location} - description: The request to delete conversations in bulk. - id: GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest - type: object - GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource: - id: GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource - description: Configuration for Cloud Storage bucket sources. + Cloud Storage URI that points to a file that contains the + conversation audio. + GoogleCloudContactcenterinsightsV1Issue: type: object + id: GoogleCloudContactcenterinsightsV1Issue + description: The issue resource. properties: - bucketUri: - type: string - description: Required. The Cloud Storage bucket containing source objects. - bucketObjectType: + name: 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 - customMetadataKeys: - type: array - items: - type: string 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. - metadataBucketUri: + Immutable. The resource name of the issue. Format: + projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} + updateTime: + description: Output only. The most recent time that this issue was updated. type: string - description: >- - Optional. The Cloud Storage path to the source object metadata. Note - that: [1] metadata files are expected to be in JSON format [2] - metadata and source objects must be in separate buckets [3] a source - object's metadata object must share the same name to be properly - ingested - GoogleCloudContactcenterinsightsV1GeneratorSuggestion: - id: GoogleCloudContactcenterinsightsV1GeneratorSuggestion - description: Suggestion generated using a Generator. - properties: - summarySuggestion: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1SummarySuggestion - description: Optional. Suggested summary. - freeFormSuggestion: - description: Optional. Free form suggestion. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1FreeFormSuggestion - agentCoachingSuggestion: - description: Optional. Suggestion to coach the agent. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AgentCoachingSuggestion - type: object - GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest: - properties: - name: + format: google-datetime + readOnly: true + createTime: + readOnly: true + description: Output only. The time at which this issue was created. + format: google-datetime type: string - description: Required. The issue model to undeploy. - description: The request to undeploy an issue model. - id: GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest - type: object - GoogleRpcStatus: - properties: - details: + displayName: + type: string + description: The representative name for the issue. + sampleUtterances: + readOnly: true 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: - type: any - description: Properties of the object. Contains field @type with type URL. - code: - format: int32 - type: integer - description: The status code, which should be an enum value of google.rpc.Code. - message: - type: string + 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. + Output only. Resource names of the sample representative utterances + that match to this issue. + GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData: + id: GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData + properties: + phraseMatcher: + description: The unique identifier (the resource name) of the phrase matcher. + type: string + displayName: + type: string + description: The human-readable name of the phrase matcher. 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 + The data for a matched phrase matcher. Represents information + identifying a phrase matcher for a given match. type: object - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata: + GoogleCloudContactcenterinsightsV1PhraseMatchRule: properties: - smartReplyAllowlistCovered: + query: + description: Required. The phrase to be matched. + type: string + config: + description: >- + Provides additional information about the rule that specifies how to + apply the rule. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig + negated: type: boolean description: >- - Whether the transcript segment was covered under the configured - smart reply allowlist in Agent Assist. - id: >- - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata + Specifies whether the phrase must be missing from the transcript + segment or present in the transcript segment. type: object - description: Metadata from Dialogflow relating to the current transcript segment. - GoogleCloudContactcenterinsightsV1AgentCoachingInstruction: - description: Agent Coaching instructions that customer can configure. - id: GoogleCloudContactcenterinsightsV1AgentCoachingInstruction + description: The data for a phrase match rule. + id: GoogleCloudContactcenterinsightsV1PhraseMatchRule + GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo: + description: Information about an agent involved in the conversation. properties: - condition: - description: >- - Optional. The condition of the instruction. For example, "the - customer wants to cancel an order". If the users want the - instruction to be triggered unconditionally, the condition can be - empty. - type: string - agentAction: - description: >- - Optional. The action that human agent should take. For example, - "apologize for the slow shipping". If the users only want to use - agent coaching for intent detection, agent_action can be empty + team: type: string - description: - description: Optional. The detailed description of this instruction. + description: A user-specified string representing the agent's team. + agentId: type: string - systemAction: + description: A user-specified string representing the agent. + dispositionCode: type: string description: >- - Optional. The action that system should take. For example, "call - GetOrderTime with order_number={order number provided by the - customer}". If the users don't have plugins or don't want to trigger - plugins, the system_action can be empty - metadata: - description: Optional. Additional information attached to this instruction. - type: object - additionalProperties: - type: string + A user-provided string indicating the outcome of the agent's segment + of the call. displayName: type: string - description: Optional. Display name for the instruction. + description: The agent's name. type: object - GoogleCloudContactcenterinsightsV1IngestConversationsResponse: - properties: {} - description: The response to an IngestConversations operation. + id: GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo + GoogleCloudContactcenterinsightsV1ConversationCallMetadata: + description: Call-specific metadata. type: object - id: GoogleCloudContactcenterinsightsV1IngestConversationsResponse - GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest: - description: The request to export insights. + id: GoogleCloudContactcenterinsightsV1ConversationCallMetadata properties: - 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} + agentChannel: + type: integer + format: int32 + description: The audio channel that contains the agent. + customerChannel: + type: integer + description: The audio channel that contains the customer. + format: int32 + GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent: + id: GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent + properties: + displayName: + description: The human-readable name of the intent. type: string - parent: - description: Required. The parent resource to export data from. + type: object + description: >- + The data for a Dialogflow intent. Represents a detected intent in the + conversation, e.g. MAKES_PROMISE. + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo: + id: >- + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo + type: object + properties: + startOffset: + format: google-duration type: string - bigQueryDestination: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination - description: Specified if sink is a BigQuery table. - writeDisposition: - enum: - - WRITE_DISPOSITION_UNSPECIFIED - - WRITE_TRUNCATE - - WRITE_APPEND - 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. + description: >- + Time offset of the start of this word relative to the beginning of + the total conversation. + endOffset: + format: google-duration + description: >- + Time offset of the end of this word relative to the beginning of the + total conversation. type: string - filter: + word: + description: The word itself. Includes punctuation marks that surround the word. type: string + confidence: + type: number + format: float description: >- - A filter to reduce results to a specific subset. Useful for - exporting conversations with specific properties. - type: object - id: GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata: - type: object - id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata + 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. + description: Word-level info for words in a transcript. + GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats: + id: >- + GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats + description: Statistics for IngestConversations operation. properties: - request: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest - description: Output only. The original request for ingest. - readOnly: true - ingestConversationsStats: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats - readOnly: true - description: Output only. Statistics for IngestConversations operation. - partialErrors: - items: - $ref: '#/components/schemas/GoogleRpcStatus' - type: array + processedObjectCount: + type: integer + format: int32 description: >- - Output only. Partial errors during ingest operation that might cause - the operation output to be incomplete. - readOnly: true - endTime: - description: Output only. The time the operation finished running. - format: google-datetime - type: string + Output only. The number of objects processed during the ingest + operation. readOnly: true - createTime: - format: google-datetime + failedIngestCount: readOnly: true - type: string - description: Output only. The time the operation was created. - description: The metadata for an IngestConversations operation. - GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionSampleResponse: - description: >- - Sample response that the agent can use. This could be based on - applicable instructions and ingested data from other systems. - properties: - responseText: - description: Optional. Sample response for Agent in text. - type: string - id: GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionSampleResponse - type: object - GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary: - id: GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary - description: >- - A point in a conversation that marks the start or the end of an - annotation. - properties: - transcriptIndex: + type: integer description: >- - The index in the sequence of transcribed pieces of the conversation - where the boundary is located. This index starts at zero. + 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 + successfulIngestCount: + readOnly: true type: integer - wordIndex: + description: >- + Output only. The number of new conversations added during this + ingest operation. format: int32 + duplicatesSkippedCount: type: integer + readOnly: true description: >- - The word index of this boundary with respect to the first word in - the transcript piece. This index starts at zero. + Output only. The number of objects skipped because another + conversation with the same transcript uri had already been ingested. + format: int32 type: object - GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest: + GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination: + description: A BigQuery Table Reference. + id: >- + GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination type: object - description: The request to deploy an issue model. properties: - name: + projectId: type: string - description: Required. The issue model to deploy. - id: GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest - GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerFaqSource: + 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 + 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. + GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination: type: object id: >- - GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerFaqSource - description: Details about source of FAQ answer. + GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination + description: Google Cloud Storage Object URI to save the issue model to. properties: - document: + objectUri: + description: 'Required. Format: `gs:///`' + type: string + GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest: + id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest + properties: + parent: description: >- - Indicates which Knowledge Document this answer was extracted from. - Format: `projects//knowledgeBases//documents/`. + Required. The parent resource to delete conversations from. Format: + projects/{project}/locations/{location} type: string - question: + maxDeleteCount: + format: int32 + description: Maximum number of conversations to delete. + type: integer + filter: type: string - description: The corresponding FAQ question. - GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse: + description: Filter used to select the subset of conversations to delete. + 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. + description: The request to delete conversations in bulk. + type: object + GoogleCloudContactcenterinsightsV1ConversationLevelSilence: type: object - id: GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse - description: The response of listing phrase matchers. properties: - nextPageToken: + silenceDuration: 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. - phraseMatchers: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher - description: The phrase matchers that match the request. - GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData: - description: Conversation summarization suggestion data. - id: >- - GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData + description: Amount of time calculated to be in silence. + format: google-duration + silencePercentage: + description: Percentage of the total conversation spent in silence. + type: number + format: float + id: GoogleCloudContactcenterinsightsV1ConversationLevelSilence + description: Conversation-level silence data. + GoogleCloudContactcenterinsightsV1CalculateStatsResponse: + id: GoogleCloudContactcenterinsightsV1CalculateStatsResponse type: object properties: - answerRecord: - type: string - description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - text: - type: string - description: The summarization content that is concatenated into one string. - textSections: + conversationCount: + type: integer + description: The total number of conversations. + format: int32 + issueMatchesStats: type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats 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 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/` + averageTurnCount: + type: integer + format: int32 + description: The average number of turns per conversation. + customHighlighterMatches: additionalProperties: - type: string - confidence: - format: float - type: number - description: The confidence score of the summarization. - metadata: + format: int32 + type: integer type: object - additionalProperties: - type: string description: >- - A map that contains metadata about the summarization and the - document from which it originates. - conversationModel: + A map associating each custom highlighter resource name with its + respective number of matches in the set of conversations. + averageDuration: description: >- - The name of the model that generates this summary. Format: - projects/{project}/locations/{location}/conversationModels/{conversation_model} + The average duration of all conversations. The average is calculated + using only conversations that have a time duration. + format: google-duration type: string - GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswer: - description: >- - Represents an answer from Knowledge. Cuurently supports FAQ and - Generative answers. - type: object - properties: - faqSource: + issueMatches: + 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. + type: object + deprecated: true + conversationCountTimeSeries: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerFaqSource - description: Populated if the prediction came from FAQ. - answerText: - type: string + #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries description: >- - The piece of text from the `source` that answers this suggested - query. - matchConfidence: - format: float + A time series representing the count of conversations created over + time that match that requested filter criteria. + smartHighlighterMatches: description: >- - The system's confidence score that this answer is a good match for - this conversational query. The range is from 0.0 (completely - uncertain) to 1.0 (completely certain). - type: number - intentMatchingSource: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerIntentMatchingSource - description: Populated if the prediction was from intent matching. - generativeSource: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSource - description: Populated if the prediction was Generative. - id: >- - GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswer - GoogleCloudContactcenterinsightsV1ConversationTranscript: - id: GoogleCloudContactcenterinsightsV1ConversationTranscript + A map associating each smart highlighter display name with its + respective number of matches in the set of conversations. + type: object + additionalProperties: + format: int32 + type: integer + description: The response for calculating conversation statistics. + GoogleCloudContactcenterinsightsV1AnnotationBoundary: type: object - description: A message representing the transcript of a conversation. properties: - transcriptSegments: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment + transcriptIndex: + format: int32 description: >- - A list of sequential transcript segments that comprise the - conversation. - type: array - GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestion: - properties: - suggestionReasoning: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentCoachingSuggestionReasoning - description: Reasoning for the suggestion. - agentActionSuggestions: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentActionSuggestion - type: array - description: Optional. Suggested actions for the agent to take. - sampleResponses: - description: Optional. Sample response for the Agent. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionSampleResponse - suggestionEval: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentCoachingSuggestionEval - description: Self evaluation of the suggestion. - applicableInstructions: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AgentCoachingInstruction - description: Optional. Instructions applicable based on the current context. - type: array - id: GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestion - description: Suggestion for coaching agents. + The index in the sequence of transcribed pieces of the conversation + where the boundary is located. This index starts at zero. + type: integer + wordIndex: + type: integer + format: int32 + description: >- + The word index of this boundary with respect to the first word in + the transcript piece. This index starts at zero. + id: GoogleCloudContactcenterinsightsV1AnnotationBoundary + description: >- + A point in a conversation that marks the start or the end of an + annotation. + GoogleCloudContactcenterinsightsV1DialogflowIntent: + id: GoogleCloudContactcenterinsightsV1DialogflowIntent type: object - GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata: + properties: + displayName: + type: string + description: The human-readable name of the intent. + description: >- + The data for a Dialogflow intent. Represents a detected intent in the + conversation, e.g. MAKES_PROMISE. + GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest: + description: The request to deploy an issue model. + id: GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest type: object - description: Metadata for an export insights operation. - id: GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata 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: + name: type: string + description: Required. The issue model to deploy. + GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata: + properties: + createTime: readOnly: true format: google-datetime - description: Output only. The time the operation finished running. + description: Output only. The time the operation was created. + type: string request: - description: The original request for export. + description: The original request for undeployment. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest - createTime: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest + endTime: readOnly: true type: string + description: Output only. The time the operation finished running. format: google-datetime - description: Output only. The time the operation was created. - GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSource: - id: >- - GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSource - properties: - snippets: - description: >- - All snippets used for this Generative Prediction, with their source - URI and data. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSourceSnippet - type: array + description: Metadata for undeploying an issue model. + id: GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata type: object - description: Details about source of Generative answer. - GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData: + GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerFaqSource: type: object - description: Dialogflow interaction data. + id: >- + GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerFaqSource + description: Details about source of FAQ answer. properties: - dialogflowIntentId: - description: >- - The Dialogflow intent resource path. Format: - projects/{project}/agent/{agent}/intents/{intent} + document: type: string - confidence: - type: number - description: >- - The confidence of the match ranging from 0.0 (completely uncertain) - to 1.0 (completely certain). - format: float - id: GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData - GoogleCloudContactcenterinsightsV1Issue: - description: The issue resource. - id: GoogleCloudContactcenterinsightsV1Issue - properties: - sampleUtterances: - readOnly: true description: >- - Output only. Resource names of the sample representative utterances - that match to this issue. - type: array - items: - type: string - updateTime: - description: Output only. The most recent time that this issue was updated. - format: google-datetime + Indicates which Knowledge Document this answer was extracted from. + Format: `projects//knowledgeBases//documents/`. + question: type: string - readOnly: true - name: + description: The corresponding FAQ question. + GoogleCloudContactcenterinsightsV1ListAnalysesResponse: + description: The response to list analyses. + id: GoogleCloudContactcenterinsightsV1ListAnalysesResponse + properties: + nextPageToken: description: >- - Immutable. The resource name of the issue. Format: - projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} - type: string - displayName: - type: string - description: The representative name for the issue. - createTime: - readOnly: true + 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: Output only. The time at which this issue was created. - format: google-datetime + analyses: + items: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' + description: The analyses that match the request. + type: array type: object GoogleCloudContactcenterinsightsV1Entity: properties: + 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. type: - type: string enumDescriptions: - Unspecified. - Person. @@ -5004,25 +4874,18 @@ components: - DATE - NUMBER - PRICE + type: string description: The entity type. displayName: description: The representative name for the entity. type: string - 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: description: >- The aggregate sentiment expressed for this entity in the conversation. $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' salience: + type: number description: >- The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the @@ -5030,32 +4893,147 @@ components: Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient. format: float - type: number + type: object + id: GoogleCloudContactcenterinsightsV1Entity 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 + GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval: + properties: + conversationCount: + description: The number of conversations created in this interval. + type: integer + format: int32 + startTime: + description: The start time of this interval. + type: string + format: google-datetime type: object - GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest: + description: A single interval in a time series. + id: >- + GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig: + description: Configuration that applies to all conversations. + type: object + id: >- + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig + 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 via 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: + 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 + format: int32 + GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentCoachingSuggestionReasoning: + description: Reasoning for the suggestion. + properties: + issueSummary: + description: Optional. Summary of the issue. + type: string + agentActionTaken: + description: Optional. The actions that the agent has taken already. + type: string + type: object + id: >- + GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentCoachingSuggestionReasoning + GoogleCloudContactcenterinsightsV1alpha1GcsSource: + properties: + transcriptUri: + description: >- + 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 + GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerIntentMatchingSource: + properties: + uri: + type: string + description: URI the data is sourced from. + title: + type: string + description: Title of the document. + id: >- + GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerIntentMatchingSource + type: object + description: Details about source of Intent Matching answer. + GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata: + properties: + intents: + description: All the matched intents in the call. + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Intent + type: object + phraseMatchers: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData + description: All the matched phrase matchers in the call. + type: object + entities: + description: All the entities in the call. + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Entity + annotations: + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CallAnnotation + type: array + description: A list of call annotations that apply to this call. + issueModelResult: + description: Overall conversation-level issue modeling result. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelResult + silence: + description: Overall conversation-level silence during the call. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence + sentiments: + type: array + description: Overall conversation-level sentiment for each channel of the call. + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment + description: Call-specific metadata created during analysis. type: object - id: GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest - properties: - name: - type: string - description: Required. The name of the issue model to delete. - description: The request to delete an issue model. - GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest: + id: >- + GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata + GoogleCloudContactcenterinsightsV1ImportIssueModelRequest: description: Request to import an issue model. type: object properties: + parent: + type: string + description: Required. The parent resource of the issue model. gcsSource: description: Google Cloud Storage source message. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource - parent: - description: Required. The parent resource of the issue model. - type: string + #/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource createNewModel: type: boolean description: >- @@ -5063,351 +5041,269 @@ components: 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. - id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest - GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata: - id: GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata - type: object + id: GoogleCloudContactcenterinsightsV1ImportIssueModelRequest + GoogleCloudContactcenterinsightsV1EntityMentionData: + id: GoogleCloudContactcenterinsightsV1EntityMentionData properties: - request: - description: The original request for bulk delete. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest - endTime: - description: The time the operation finished running. - format: google-datetime + type: type: string - partialErrors: - items: - $ref: '#/components/schemas/GoogleRpcStatus' - type: array + enumDescriptions: + - Unspecified. + - Proper noun. + - Common noun (or noun compound). + description: The type of the entity mention. + enum: + - MENTION_TYPE_UNSPECIFIED + - PROPER + - COMMON + sentiment: + description: Sentiment expressed for this mention of the entity. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' + entityUniqueId: description: >- - Partial errors during bulk delete conversations operation that might - cause the operation output to be incomplete. - createTime: + 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 time the operation was created. - format: google-datetime - description: The metadata for a bulk delete conversations operation. - GoogleCloudContactcenterinsightsV1SpeechConfig: - type: object 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: GoogleCloudContactcenterinsightsV1SpeechConfig + The data for an entity mention annotation. This represents a mention of + an `Entity` in the conversation. + type: object + GoogleCloudContactcenterinsightsV1SummarySuggestion: + type: object properties: - speechRecognizer: + summarySections: + description: Required. All the parts of generated summary. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1SummarySuggestionSummarySection + id: GoogleCloudContactcenterinsightsV1SummarySuggestion + description: Suggested summary of the conversation. + GoogleCloudContactcenterinsightsV1alpha1SummarySuggestionSummarySection: + properties: + summary: type: string - description: >- - The fully-qualified Speech Recognizer resource name. Format: - `projects/{project_id}/locations/{location}/recognizer/{recognizer}` - GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata: - id: >- - GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata + description: Required. Summary text for the section. + section: + type: string + description: Required. Name of the section. + description: A component of the generated summary. type: object - description: Call-specific metadata created during analysis. + id: GoogleCloudContactcenterinsightsV1alpha1SummarySuggestionSummarySection + GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector: + id: GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector properties: + runSilenceAnnotator: + type: boolean + description: Whether to run the silence annotator. + runPhraseMatcherAnnotator: + type: boolean + description: Whether to run the active phrase matcher annotator(s). + runIssueModelAnnotator: + type: boolean + description: >- + Whether to run the issue model annotator. A model should have + already been deployed for this to take effect. + runSummarizationAnnotator: + type: boolean + description: Whether to run the summarization annotator. + runIntentAnnotator: + description: Whether to run the intent annotator. + type: boolean phraseMatchers: - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData - description: All the matched phrase matchers in the call. - annotations: - description: A list of call annotations that apply to this call. + 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: + description: Whether to run the sentiment annotator. + 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 + runEntityAnnotator: + description: Whether to run the entity annotator. + type: boolean + runInterruptionAnnotator: + description: Whether to run the interruption annotator. + type: boolean + summarizationConfig: + description: Configuration for the summarization annotator. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig + type: object + description: Selector of all available annotators and phrase matchers to run. + GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSource: + properties: + snippets: + type: array + description: >- + All snippets used for this Generative Prediction, with their source + URI and data. items: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CallAnnotation - entities: - type: object - description: All the entities in the call. - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Entity - intents: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Intent - type: object - description: All the matched intents in the call. - sentiments: + #/components/schemas/GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSourceSnippet + type: object + description: Details about source of Generative answer. + id: >- + GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSource + GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswer: + description: Represents a SearchKnowledge answer. + id: GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswer + type: object + properties: + answerRecord: + type: string + description: >- + The name of the answer record. Format: `projects//locations//answer + Records/` + answerType: + description: The type of the answer. + type: string + enumDescriptions: + - The answer has a unspecified type. + - The answer is from FAQ documents. + - The answer is from generative model. + - The answer is from intent matching. + enum: + - ANSWER_TYPE_UNSPECIFIED + - FAQ + - GENERATIVE + - INTENT + answerSources: type: array items: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment - description: Overall conversation-level sentiment for each channel of the call. - silence: - description: Overall conversation-level silence during the call. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence - issueModelResult: + #/components/schemas/GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswerAnswerSource + description: All sources used to generate the answer. + answer: + description: >- + The piece of text from the knowledge base documents that answers the + search query + type: string + confidenceScore: + description: The confidence score in [0.0, 1.0] range. + format: float + type: number + GoogleCloudContactcenterinsightsV1AnalysisResult: + description: The result of an analysis. + properties: + callAnalysisMetadata: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelResult - description: Overall conversation-level issue modeling result. - GoogleCloudContactcenterinsightsV1IssueModelLabelStats: + #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata + description: Call-specific metadata created by the analysis. + endTime: + format: google-datetime + type: string + description: The time at which the analysis ended. + type: object + id: GoogleCloudContactcenterinsightsV1AnalysisResult + 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. + 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} + GoogleCloudContactcenterinsightsV1ImportIssueModelResponse: type: object - id: GoogleCloudContactcenterinsightsV1IssueModelLabelStats - description: Aggregated statistics about an issue model. + id: GoogleCloudContactcenterinsightsV1ImportIssueModelResponse + description: Response from import issue model + properties: {} + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse: + type: object + properties: {} + id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse + description: The response to an IngestConversations operation. + GoogleCloudContactcenterinsightsV1IssueModelLabelStats: properties: - issueStats: - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats - description: Statistics on each issue. Key is the issue's resource name. analyzedConversationsCount: - type: string - format: int64 description: >- Number of conversations the issue model has analyzed at this point in time. - unclassifiedConversationsCount: - type: string - description: >- - Number of analyzed conversations for which no issue was applicable - at this point in time. format: int64 - GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig: - properties: - medium: 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. - enum: - - MEDIUM_UNSPECIFIED - - PHONE_CALL - - CHAT - type: object - description: Configuration for processing transcript objects. - id: >- - GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig - GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats: - description: Aggregated statistics about an issue model. - type: object - properties: issueStats: - description: Statistics on each issue. Key is the issue's resource name. additionalProperties: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats + description: Statistics on each issue. Key is the issue's resource name. type: object unclassifiedConversationsCount: - type: string - format: int64 description: >- Number of analyzed conversations for which no issue was applicable at this point in time. - analyzedConversationsCount: - description: >- - Number of conversations the issue model has analyzed at this point - in time. - type: string format: int64 - id: GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats - GoogleCloudContactcenterinsightsV1AnnotationBoundary: - properties: - transcriptIndex: - format: int32 - description: >- - The index in the sequence of transcribed pieces of the conversation - where the boundary is located. This index starts at zero. - type: integer - 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 - description: >- - A point in a conversation that marks the start or the end of an - annotation. - id: GoogleCloudContactcenterinsightsV1AnnotationBoundary - type: object - GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest: - properties: - parent: - type: string - description: Required. The parent resource to export data from. - filter: - description: >- - A filter to reduce results to a specific subset. Useful for - exporting conversations with specific properties. - type: string - bigQueryDestination: - description: Specified if sink is a BigQuery table. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination - 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: - enum: - - WRITE_DISPOSITION_UNSPECIFIED - - WRITE_TRUNCATE - - WRITE_APPEND - 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 - description: Options for what to do if the destination table already exists. - id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest - description: The request to export insights. - type: object - GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo: - description: Information about an agent involved in the conversation. - properties: - dispositionCode: - description: >- - A user-provided string indicating the outcome of the agent's segment - of the call. - type: string - agentId: - type: string - description: A user-specified string representing the agent. - displayName: - description: The agent's name. - type: string - team: - type: string - description: A user-specified string representing the agent's team. - type: object - id: GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo - GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponse: - id: GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponse - description: >- - Response for Knowledge Assist. Contains suggested query and optionally - includes an answer for the query. - properties: - suggestedQueryAnswer: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswer - description: >- - The answer generated for the suggested query. Whether or not an - answer is generated depends on how confident we are about the - generated query. - suggestedQuery: - description: >- - The query suggested based on the context. Suggestion is made only if - it is different from the previous suggestion. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseSuggestedQuery - type: object - 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 - id: GoogleCloudContactcenterinsightsV1CreateIssueModelRequest - GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata: + id: GoogleCloudContactcenterinsightsV1IssueModelLabelStats + description: Aggregated statistics about an issue model. + GoogleCloudContactcenterinsightsV1alpha1IssueMatchData: + id: GoogleCloudContactcenterinsightsV1alpha1IssueMatchData + description: The data for an issue match annotation. properties: - createTime: - format: google-datetime - type: string - description: The time the operation was created. - endTime: - type: string - format: google-datetime - description: The time the operation finished running. - request: - description: The original export request. + issueAssignment: + description: Information about the issue's assignment. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueAssignment type: object - description: Metadata used for export issue model. - id: GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata - GoogleCloudContactcenterinsightsV1alpha1Intent: + GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest: + id: GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest + description: The request to analyze conversations in bulk. type: object properties: - displayName: - description: The human-readable name of the intent. - type: string - id: + filter: type: string - description: The unique identifier of the intent. - id: GoogleCloudContactcenterinsightsV1alpha1Intent - description: >- - The data for an intent. Represents a detected intent in the - conversation, for example MAKES_PROMISE. - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo: - 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 + Required. Filter used to select the subset of conversations to + analyze. + annotatorSelector: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector description: >- - Time offset of the end of this word relative to the beginning of the - total conversation. - startOffset: + To select the annotators to run and the phrase matchers to use (if + any). If not specified, all annotators will be run. + analysisPercentage: description: >- - Time offset of the start of this word relative to the beginning of - the total conversation. - type: string - format: google-duration - id: >- - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo - description: Word-level info for words in a transcript. - type: object - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse: - properties: {} - id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse - type: object - description: The response to an IngestConversations operation. - GoogleCloudContactcenterinsightsV1alpha1HoldData: - id: GoogleCloudContactcenterinsightsV1alpha1HoldData - description: The data for a hold annotation. - type: object - properties: {} - GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseSuggestedQuery: - properties: - score: - description: Suggested query score. + Required. Percentage of selected conversation to analyze, between + [0, 100]. type: number format: float - queryText: + parent: type: string - description: Suggested query text. + description: Required. The parent resource to create analyses in. + GoogleCloudContactcenterinsightsV1ConversationParticipant: type: object - description: Represents a suggested query. - id: >- - GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseSuggestedQuery - GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant: + id: GoogleCloudContactcenterinsightsV1ConversationParticipant 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 role: - type: string description: The role of the participant. enum: - ROLE_UNSPECIFIED @@ -5415,27 +5311,149 @@ components: - AUTOMATED_AGENT - END_USER - ANY_AGENT + type: string 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. + dialogflowParticipant: + description: >- + Deprecated. Use `dialogflow_participant_name` instead. The name of + the Dialogflow participant. Format: + projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} + type: string + deprecated: true + obfuscatedExternalUserId: + type: string + description: Obfuscated user ID from Dialogflow. dialogflowParticipantName: type: string description: >- The name of the participant provided by Dialogflow. Format: projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} userId: + type: string description: A user-specified ID representing the participant. + description: The call participant speaking for a given utterance. + GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata: + type: object + description: Metadata for a create analysis operation. + properties: + endTime: + description: Output only. The time the operation finished running. + readOnly: true type: string - obfuscatedExternalUserId: + format: google-datetime + createTime: + format: google-datetime + description: Output only. The time the operation was created. + readOnly: true type: string - description: Obfuscated user ID from Dialogflow. + conversation: + readOnly: true + description: >- + Output only. The Conversation that this Analysis Operation belongs + to. + type: string + annotatorSelector: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector + description: Output only. The annotator selector used for the analysis (if any). + readOnly: true + id: GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment: + description: A segment of a full transcript. type: object - description: The call participant speaking for a given utterance. - id: GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant + id: >- + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment + properties: + 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 + segmentParticipant: + description: The participant of this segment. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant + 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". + messageTime: + format: google-datetime + description: The time that the message occurred, if provided. + type: string + confidence: + format: float + 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 + dialogflowSegmentMetadata: + description: CCAI metadata relating to the current transcript segment. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata + text: + description: The text of this segment. + type: string + words: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo + description: >- + A list of the word-specific information for each word in the + segment. + sentiment: + description: The sentiment for this transcript segment. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData + GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource: + properties: + objectUri: + type: string + description: 'Required. Format: `gs:///`' + id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource + description: Google Cloud Storage Object URI to get the issue model file from. + type: object + GoogleCloudContactcenterinsightsV1alpha1SummarySuggestion: + type: object + properties: + summarySections: + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SummarySuggestionSummarySection + type: array + description: Required. All the parts of generated summary. + id: GoogleCloudContactcenterinsightsV1alpha1SummarySuggestion + description: Suggested summary of the conversation. parameters: + 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 + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean _.xgafv: description: V1 error format. in: query @@ -5445,10 +5463,13 @@ components: enum: - '1' - '2' - 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 alt: @@ -5461,16 +5482,10 @@ components: - 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. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: oauth_token + name: fields schema: type: string callback: @@ -5479,196 +5494,97 @@ components: 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 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: + 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. - in: query - name: quotaUser - schema: - type: string - prettyPrint: - description: Returns response with indentations and line breaks. + 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 - x-stackQL-resources: - phrase_matchers: - id: 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_1 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers/get - response: &ref_2 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.phraseMatchers - list: - operation: *ref_1 - response: *ref_2 - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers~1{phraseMatchersId}/get - 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' - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers~1{phraseMatchersId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/list' - - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/get' - insert: - - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/create' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/delete' - views: - id: contactcenterinsights.views - name: views - title: Views + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + x-stackQL-resources: + conversations: + id: google.contactcenterinsights.conversations + name: conversations + title: Conversations methods: - _list: - operation: &ref_3 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views/get - response: &ref_4 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.views - list: - operation: *ref_3 - response: *ref_4 - create: + bulk_analyze: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:bulkAnalyze/post response: mediaType: application/json openAPIDocKey: '200' - get: + upload: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views~1{viewsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:upload/post response: mediaType: application/json openAPIDocKey: '200' delete: 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}/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' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/views/methods/list' - - $ref: '#/components/x-stackQL-resources/views/methods/get' - insert: - - $ref: '#/components/x-stackQL-resources/views/methods/create' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/views/methods/delete' - insightsdata: - id: contactcenterinsights.insightsdata - name: insightsdata - title: Insightsdata - methods: - export: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightsdata:export/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - conversations: - id: contactcenterinsights.conversations - name: conversations - title: Conversations - methods: - get: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations/post response: mediaType: application/json openAPIDocKey: '200' - delete: - operation: + _list: + operation: &ref_1 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}/delete - response: + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations/get + response: &ref_2 mediaType: application/json openAPIDocKey: '200' - patch: + objectKey: $.conversations + list: + operation: *ref_1 + response: *ref_2 + calculate_stats: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:calculateStats/get response: mediaType: application/json openAPIDocKey: '200' - bulk_analyze: + ingest: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:bulkAnalyze/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:ingest/post response: mediaType: application/json openAPIDocKey: '200' @@ -5679,201 +5595,247 @@ components: response: mediaType: application/json openAPIDocKey: '200' - upload: + 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' + delete: + - $ref: '#/components/x-stackQL-resources/conversations/methods/delete' + analyses: + id: google.contactcenterinsights.analyses + name: analyses + title: Analyses + methods: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:upload/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}~1analyses~1{analysesId}/get response: mediaType: application/json openAPIDocKey: '200' - create: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}~1analyses~1{analysesId}/delete response: mediaType: application/json openAPIDocKey: '200' _list: - operation: &ref_5 + operation: &ref_3 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations/get - response: &ref_6 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}~1analyses/get + response: &ref_4 mediaType: application/json openAPIDocKey: '200' - objectKey: $.conversations + objectKey: $.analyses list: - operation: *ref_5 - response: *ref_6 - calculate_stats: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:calculateStats/get - response: - mediaType: application/json - openAPIDocKey: '200' - ingest: + operation: *ref_3 + response: *ref_4 + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:ingest/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}~1analyses/post 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/analyses/methods/get' + - $ref: '#/components/x-stackQL-resources/analyses/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/conversations/methods/create' + - $ref: '#/components/x-stackQL-resources/analyses/methods/create' update: [] delete: - - $ref: '#/components/x-stackQL-resources/conversations/methods/delete' - analyses: - id: contactcenterinsights.analyses - name: analyses - title: Analyses + - $ref: '#/components/x-stackQL-resources/analyses/methods/delete' + views: + id: google.contactcenterinsights.views + name: views + title: Views methods: delete: 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}~1views~1{viewsId}/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 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views~1{viewsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views~1{viewsId}/patch response: mediaType: application/json openAPIDocKey: '200' create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}~1analyses/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views/post response: mediaType: application/json openAPIDocKey: '200' _list: - operation: &ref_7 + operation: &ref_5 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}~1analyses/get - response: &ref_8 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views/get + response: &ref_6 mediaType: application/json openAPIDocKey: '200' - objectKey: $.analyses + objectKey: $.views list: - operation: *ref_7 - response: *ref_8 + operation: *ref_5 + response: *ref_6 sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/analyses/methods/get' - - $ref: '#/components/x-stackQL-resources/analyses/methods/list' + - $ref: '#/components/x-stackQL-resources/views/methods/get' + - $ref: '#/components/x-stackQL-resources/views/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/analyses/methods/create' - update: [] + - $ref: '#/components/x-stackQL-resources/views/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/views/methods/patch' delete: - - $ref: '#/components/x-stackQL-resources/analyses/methods/delete' + - $ref: '#/components/x-stackQL-resources/views/methods/delete' operations: - id: contactcenterinsights.operations + id: google.contactcenterinsights.operations name: operations title: Operations methods: + 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_9 + operation: &ref_7 $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_10 + response: &ref_8 mediaType: application/json openAPIDocKey: '200' objectKey: $.operations list: - operation: *ref_9 - response: *ref_10 - cancel: + operation: *ref_7 + response: *ref_8 + 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' - get: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + insert: [] + update: [] + delete: [] + insightsdata: + id: google.contactcenterinsights.insightsdata + name: insightsdata + title: Insightsdata + methods: + export: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/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/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' + select: [] insert: [] update: [] delete: [] - issues: - id: contactcenterinsights.issues - name: issues - title: Issues + 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}~1issueModels~1{issueModelsId}~1issues~1{issuesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers/post response: mediaType: application/json openAPIDocKey: '200' + _list: + operation: &ref_9 + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers/get + response: &ref_10 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.phraseMatchers + list: + operation: *ref_9 + response: *ref_10 delete: 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}~1phraseMatchers~1{phraseMatchersId}/delete response: mediaType: application/json openAPIDocKey: '200' patch: 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}~1phraseMatchers~1{phraseMatchersId}/patch response: mediaType: application/json openAPIDocKey: '200' - list: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues/get + #/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/issues/methods/get' - - $ref: '#/components/x-stackQL-resources/issues/methods/list' - insert: [] - update: [] + - $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' delete: - - $ref: '#/components/x-stackQL-resources/issues/methods/delete' + - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/delete' issue_models: - id: contactcenterinsights.issue_models + id: google.contactcenterinsights.issue_models name: issue_models title: Issue_models methods: - deploy: + export: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:deploy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:export/post response: mediaType: application/json openAPIDocKey: '200' - list: + undeploy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:undeploy/post response: mediaType: application/json openAPIDocKey: '200' - create: + import: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels:import/post response: mediaType: application/json openAPIDocKey: '200' @@ -5898,59 +5860,102 @@ components: response: mediaType: application/json openAPIDocKey: '200' - undeploy: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:undeploy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels/post response: mediaType: application/json openAPIDocKey: '200' - import: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels:import/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels/get response: mediaType: application/json openAPIDocKey: '200' - calculate_issue_model_stats: + deploy: 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}:deploy/post response: mediaType: application/json openAPIDocKey: '200' - export: + calculate_issue_model_stats: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:export/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:calculateIssueModelStats/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/issue_models/methods/list' - $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: [] + update: + - $ref: '#/components/x-stackQL-resources/issue_models/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/issue_models/methods/delete' + issues: + id: google.contactcenterinsights.issues + name: issues + title: Issues + methods: + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues~1{issuesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues~1{issuesId}/delete + 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: + operation: + $ref: >- + #/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/issues/methods/get' + - $ref: '#/components/x-stackQL-resources/issues/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/issues/methods/patch' + delete: + - $ref: '#/components/x-stackQL-resources/issues/methods/delete' settings: - id: contactcenterinsights.settings + id: google.contactcenterinsights.settings name: settings title: Settings methods: - 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' - 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' @@ -5961,28 +5966,28 @@ components: update: [] delete: [] paths: - /v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers: + /v1/projects/{projectsId}/locations/{locationsId}/conversations:bulkAnalyze: parameters: &ref_11 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' post: - description: Creates a phrase matcher. - operationId: contactcenterinsights.projects.locations.phraseMatchers.create + description: Analyzes multiple conversations in a single request. + operationId: contactcenterinsights.projects.locations.conversations.bulkAnalyze requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5994,8 +5999,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6007,9 +6011,20 @@ paths: required: true schema: type: string - get: - description: Lists phrase matchers. - operationId: contactcenterinsights.projects.locations.phraseMatchers.list + /v1/projects/{projectsId}/locations/{locationsId}/conversations:upload: + parameters: *ref_11 + post: + description: >- + Create a longrunning 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 @@ -6021,8 +6036,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6034,24 +6048,89 @@ paths: required: true schema: type: string - - in: query - name: pageSize + /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}: + parameters: *ref_11 + delete: + description: Deletes a conversation. + operationId: contactcenterinsights.projects.locations.conversations.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: integer - format: int32 + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true + schema: + type: string - in: query - name: pageToken + 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 + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: conversationsId + required: true schema: type: string - in: query - name: filter + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}: - parameters: *ref_11 + format: google-fieldmask get: - description: Gets a phrase matcher. - operationId: contactcenterinsights.projects.locations.phraseMatchers.get + description: Gets a conversation. + operationId: contactcenterinsights.projects.locations.conversations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6064,7 +6143,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation parameters: - in: path name: projectsId @@ -6077,19 +6156,59 @@ paths: schema: type: string - in: path - name: phraseMatchersId + name: conversationsId required: true schema: type: string - patch: - description: Updates a phrase matcher. - operationId: contactcenterinsights.projects.locations.phraseMatchers.patch + - in: query + name: view + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/conversations: + parameters: *ref_11 + post: + description: >- + Creates a conversation. DEPRECATED: Use UploadConversation instead. + CreateConversation does not support audio transcription or DLP + redaction. + operationId: contactcenterinsights.projects.locations.conversations.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: conversationId + schema: + type: string + get: + description: Lists conversations. + operationId: contactcenterinsights.projects.locations.conversations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6102,7 +6221,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher + #/components/schemas/GoogleCloudContactcenterinsightsV1ListConversationsResponse parameters: - in: path name: projectsId @@ -6114,19 +6233,32 @@ paths: required: true schema: type: string - - in: path - name: phraseMatchersId - required: true + - in: query + name: view 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 + - 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}/conversations:calculateStats: + parameters: *ref_11 + get: + description: Gets conversation statistics. + operationId: contactcenterinsights.projects.locations.conversations.calculateStats security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6138,7 +6270,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponse parameters: - in: path name: projectsId @@ -6150,16 +6283,23 @@ paths: required: true schema: type: string - - in: path - name: phraseMatchersId - required: true + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/views: + /v1/projects/{projectsId}/locations/{locationsId}/conversations:ingest: parameters: *ref_11 - get: - description: Lists views. - operationId: contactcenterinsights.projects.locations.views.list + 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 @@ -6171,8 +6311,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListViewsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6184,23 +6323,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}/conversations:bulkDelete: + parameters: *ref_11 post: - description: Creates a view. - operationId: contactcenterinsights.projects.locations.views.create + description: Deletes multiple conversations in a single request. + operationId: contactcenterinsights.projects.locations.conversations.bulkDelete requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6212,7 +6345,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6224,11 +6357,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}: + /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses/{analysesId}: parameters: *ref_11 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 @@ -6240,7 +6373,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Analysis parameters: - in: path name: projectsId @@ -6253,13 +6387,18 @@ paths: schema: type: string - in: path - name: viewsId + name: conversationsId + required: true + schema: + type: string + - in: path + name: analysesId required: true schema: type: string delete: - description: Deletes a view. - operationId: contactcenterinsights.projects.locations.views.delete + description: Deletes an analysis. + operationId: contactcenterinsights.projects.locations.conversations.analyses.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6284,18 +6423,20 @@ paths: schema: type: string - in: path - name: viewsId + name: conversationsId 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' + - in: path + name: analysesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses: + parameters: *ref_11 + get: + description: Lists analyses. + operationId: contactcenterinsights.projects.locations.conversations.analyses.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6307,7 +6448,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ListAnalysesResponse parameters: - in: path name: projectsId @@ -6320,26 +6462,33 @@ paths: schema: type: string - in: path - name: viewsId + name: conversationsId required: true schema: type: string - in: query - name: updateMask + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/insightsdata:export: - parameters: *ref_11 post: - description: Export insights data to a destination defined in the request body. - operationId: contactcenterinsights.projects.locations.insightsdata.export + 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/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6363,11 +6512,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}: + - in: path + name: conversationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}: parameters: *ref_11 - get: - description: Gets a conversation. - operationId: contactcenterinsights.projects.locations.conversations.get + delete: + description: Deletes a view. + operationId: contactcenterinsights.projects.locations.views.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6379,8 +6533,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6393,17 +6546,13 @@ paths: schema: type: string - in: path - name: conversationsId + name: viewsId required: true schema: type: string - - in: query - name: view - schema: - type: string - delete: - description: Deletes a conversation. - operationId: contactcenterinsights.projects.locations.conversations.delete + get: + description: Gets a view. + operationId: contactcenterinsights.projects.locations.views.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6415,7 +6564,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' parameters: - in: path name: projectsId @@ -6428,23 +6577,18 @@ paths: schema: type: string - in: path - name: conversationsId + name: viewsId required: true schema: type: string - - in: query - name: force - schema: - type: boolean patch: - description: Updates a conversation. - operationId: contactcenterinsights.projects.locations.conversations.patch + description: Updates a view. + operationId: contactcenterinsights.projects.locations.views.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6456,8 +6600,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' parameters: - in: path name: projectsId @@ -6470,7 +6613,7 @@ paths: schema: type: string - in: path - name: conversationsId + name: viewsId required: true schema: type: string @@ -6479,51 +6622,16 @@ paths: schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/conversations:bulkAnalyze: - parameters: *ref_11 - 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 - 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}/conversations:bulkDelete: + /v1/projects/{projectsId}/locations/{locationsId}/views: parameters: *ref_11 post: - description: Deletes multiple conversations in a single request. - operationId: contactcenterinsights.projects.locations.conversations.bulkDelete + description: Creates a view. + operationId: contactcenterinsights.projects.locations.views.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6535,7 +6643,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' parameters: - in: path name: projectsId @@ -6544,23 +6652,12 @@ paths: type: string - in: path name: locationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations:upload: - parameters: *ref_11 - post: - description: >- - Create a longrunning 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 + required: true + schema: + type: string + get: + description: Lists views. + operationId: contactcenterinsights.projects.locations.views.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6572,7 +6669,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ListViewsResponse parameters: - in: path name: projectsId @@ -6584,20 +6682,29 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: parameters: *ref_11 post: description: >- - Creates a conversation. DEPRECATED: Use UploadConversation instead. - CreateConversation does not support audio transcription or DLP - redaction. - operationId: contactcenterinsights.projects.locations.conversations.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is 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 @@ -6609,8 +6716,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6622,13 +6728,18 @@ paths: required: true schema: type: string - - in: query - name: conversationId + - in: path + name: operationsId + required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations: + parameters: *ref_11 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 @@ -6640,8 +6751,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListConversationsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -6654,15 +6764,11 @@ paths: schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: orderBy + name: pageToken schema: type: string - in: query - name: pageToken + name: filter schema: type: string - in: query @@ -6670,15 +6776,14 @@ paths: schema: type: integer format: int32 - - in: query - name: view - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations:calculateStats: + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: parameters: *ref_11 get: - description: Gets conversation statistics. - operationId: contactcenterinsights.projects.locations.conversations.calculateStats + 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 @@ -6690,8 +6795,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6703,23 +6807,22 @@ paths: required: true schema: type: string - - in: query - name: filter + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations:ingest: + /v1/projects/{projectsId}/locations/{locationsId}/insightsdata:export: parameters: *ref_11 post: - description: >- - Imports conversations and processes them according to the user's - configuration. - operationId: contactcenterinsights.projects.locations.conversations.ingest + 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/GoogleCloudContactcenterinsightsV1IngestConversationsRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6743,11 +6846,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses/{analysesId}: + /v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers: parameters: *ref_11 - delete: - description: Deletes an analysis. - operationId: contactcenterinsights.projects.locations.conversations.analyses.delete + 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 @@ -6759,7 +6868,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher parameters: - in: path name: projectsId @@ -6771,19 +6881,9 @@ 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 + description: Lists phrase matchers. + operationId: contactcenterinsights.projects.locations.phraseMatchers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6796,7 +6896,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Analysis + #/components/schemas/GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse parameters: - in: path name: projectsId @@ -6808,28 +6908,24 @@ paths: required: true schema: type: string - - in: path - name: conversationsId - required: true + - in: query + name: filter schema: type: string - - in: path - name: analysesId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses: + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}: parameters: *ref_11 - 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/GoogleCloudContactcenterinsightsV1Analysis' + delete: + description: Deletes a phrase matcher. + operationId: contactcenterinsights.projects.locations.phraseMatchers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6841,7 +6937,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6854,13 +6950,19 @@ paths: schema: type: string - in: path - name: conversationsId + name: phraseMatchersId required: true schema: type: string - get: - description: Lists analyses. - operationId: contactcenterinsights.projects.locations.conversations.analyses.list + patch: + description: Updates a phrase matcher. + operationId: contactcenterinsights.projects.locations.phraseMatchers.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6873,7 +6975,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListAnalysesResponse + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher parameters: - in: path name: projectsId @@ -6886,30 +6988,18 @@ paths: schema: type: string - in: path - name: conversationsId + name: phraseMatchersId 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: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_11 + 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: contactcenterinsights.projects.locations.operations.list + description: Gets a phrase matcher. + operationId: contactcenterinsights.projects.locations.phraseMatchers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6921,7 +7011,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher parameters: - in: path name: projectsId @@ -6933,33 +7024,22 @@ 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: phraseMatchersId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:export: parameters: *ref_11 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: Exports an issue model to the provided destination. + operationId: contactcenterinsights.projects.locations.issueModels.export + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6971,7 +7051,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6984,18 +7064,23 @@ paths: schema: type: string - in: path - name: operationsId + name: issueModelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:undeploy: parameters: *ref_11 - 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 + 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 @@ -7020,15 +7105,21 @@ paths: schema: type: string - in: path - name: operationsId + name: issueModelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}: + /v1/projects/{projectsId}/locations/{locationsId}/issueModels:import: parameters: *ref_11 - get: - description: Gets an issue. - operationId: contactcenterinsights.projects.locations.issueModels.issues.get + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7040,7 +7131,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -7052,19 +7143,11 @@ paths: required: true schema: type: string - - in: path - name: issueModelsId - required: true - schema: - type: string - - in: path - name: issuesId - required: true - schema: - type: string - delete: - description: Deletes an issue. - operationId: contactcenterinsights.projects.locations.issueModels.issues.delete + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}: + parameters: *ref_11 + get: + description: Gets an issue model. + operationId: contactcenterinsights.projects.locations.issueModels.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7076,7 +7159,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel parameters: - in: path name: projectsId @@ -7093,19 +7177,15 @@ paths: required: true schema: type: string - - in: path - name: issuesId - required: true - schema: - type: string patch: - description: Updates an issue. - operationId: contactcenterinsights.projects.locations.issueModels.issues.patch + description: Updates an issue model. + operationId: contactcenterinsights.projects.locations.issueModels.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7117,7 +7197,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel parameters: - in: path name: projectsId @@ -7134,21 +7215,14 @@ 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_11 - get: - description: Lists issues. - operationId: contactcenterinsights.projects.locations.issueModels.issues.list + delete: + description: Deletes an issue model. + operationId: contactcenterinsights.projects.locations.issueModels.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7160,8 +7234,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListIssuesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -7178,19 +7251,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:deploy: + /v1/projects/{projectsId}/locations/{locationsId}/issueModels: parameters: *ref_11 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 + description: Creates an issue model. + operationId: contactcenterinsights.projects.locations.issueModels.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7214,13 +7285,6 @@ paths: required: true schema: type: string - - in: path - name: issueModelsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels: - parameters: *ref_11 get: description: Lists issue models. operationId: contactcenterinsights.projects.locations.issueModels.list @@ -7248,15 +7312,19 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:deploy: + parameters: *ref_11 post: - description: Creates an issue model. - operationId: contactcenterinsights.projects.locations.issueModels.create + 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/GoogleCloudContactcenterinsightsV1IssueModel + #/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7280,11 +7348,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}: + - in: path + name: issueModelsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:calculateIssueModelStats: parameters: *ref_11 get: - description: Gets an issue model. - operationId: contactcenterinsights.projects.locations.issueModels.get + description: Gets an issue model's statistics. + operationId: >- + contactcenterinsights.projects.locations.issueModels.calculateIssueModelStats security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7297,7 +7371,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel + #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse parameters: - in: path name: projectsId @@ -7314,15 +7388,11 @@ paths: 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}/issueModels/{issueModelsId}/issues/{issuesId}: + parameters: *ref_11 + get: + description: Gets an issue. + operationId: contactcenterinsights.projects.locations.issueModels.issues.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7334,8 +7404,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' parameters: - in: path name: projectsId @@ -7352,14 +7421,14 @@ 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 + description: Deletes an issue. + operationId: contactcenterinsights.projects.locations.issueModels.issues.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7371,7 +7440,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -7388,19 +7457,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:undeploy: - parameters: *ref_11 - 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 + - 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/GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7412,7 +7481,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' parameters: - in: path name: projectsId @@ -7429,46 +7498,21 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels:import: - parameters: *ref_11 - 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 - security: - - Oauth2: - - https://www.googleapis.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: issuesId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:calculateIssueModelStats: + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues: parameters: *ref_11 get: - description: Gets an issue model's statistics. - operationId: >- - contactcenterinsights.projects.locations.issueModels.calculateIssueModelStats + description: Lists issues. + operationId: contactcenterinsights.projects.locations.issueModels.issues.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7481,7 +7525,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse + #/components/schemas/GoogleCloudContactcenterinsightsV1ListIssuesResponse parameters: - in: path name: projectsId @@ -7498,17 +7542,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:export: + /v1/projects/{projectsId}/locations/{locationsId}/settings: parameters: *ref_11 - post: - description: Exports an issue model to the provided destination. - operationId: contactcenterinsights.projects.locations.issueModels.export - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequest + get: + description: Gets project-level settings. + operationId: contactcenterinsights.projects.locations.getSettings security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7520,7 +7558,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Settings parameters: - in: path name: projectsId @@ -7532,13 +7571,6 @@ paths: required: true schema: type: string - - in: path - name: issueModelsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/settings: - parameters: *ref_11 patch: description: Updates project-level settings. operationId: contactcenterinsights.projects.locations.updateSettings @@ -7576,30 +7608,3 @@ paths: 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 - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Settings - 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/container.yaml b/providers/src/googleapis.com/v00.00.00000/services/container.yaml index b4a66393..cb3f958f 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: '20240514' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/container-engine/ servers: @@ -5971,7 +5971,7 @@ components: - '2' x-stackQL-resources: server_config: - id: container.server_config + id: google.container.server_config name: server_config title: Server_config methods: @@ -5990,7 +5990,7 @@ components: update: [] delete: [] clusters: - id: container.clusters + id: google.container.clusters name: clusters title: Clusters methods: @@ -6229,27 +6229,31 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/clusters/methods/projects_locations_clusters_list - $ref: >- #/components/x-stackQL-resources/clusters/methods/projects_locations_clusters_get - - $ref: >- - #/components/x-stackQL-resources/clusters/methods/projects_zones_clusters_list - $ref: >- #/components/x-stackQL-resources/clusters/methods/projects_zones_clusters_get + - $ref: >- + #/components/x-stackQL-resources/clusters/methods/projects_locations_clusters_list + - $ref: >- + #/components/x-stackQL-resources/clusters/methods/projects_zones_clusters_list insert: - $ref: >- #/components/x-stackQL-resources/clusters/methods/projects_locations_clusters_create - $ref: >- #/components/x-stackQL-resources/clusters/methods/projects_zones_clusters_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/clusters/methods/projects_locations_clusters_update + - $ref: >- + #/components/x-stackQL-resources/clusters/methods/projects_zones_clusters_update delete: - $ref: >- #/components/x-stackQL-resources/clusters/methods/projects_locations_clusters_delete - $ref: >- #/components/x-stackQL-resources/clusters/methods/projects_zones_clusters_delete clusters_master: - id: container.clusters_master + id: google.container.clusters_master name: clusters_master title: Clusters_master methods: @@ -6266,7 +6270,7 @@ components: update: [] delete: [] clusters_jwks: - id: container.clusters_jwks + id: google.container.clusters_jwks name: clusters_jwks title: Clusters_jwks methods: @@ -6285,7 +6289,7 @@ components: update: [] delete: [] node_pools: - id: container.node_pools + id: google.container.node_pools name: node_pools title: Node_pools methods: @@ -6426,25 +6430,29 @@ components: select: - $ref: >- #/components/x-stackQL-resources/node_pools/methods/projects_locations_clusters_node_pools_get + - $ref: >- + #/components/x-stackQL-resources/node_pools/methods/projects_zones_clusters_node_pools_get - $ref: >- #/components/x-stackQL-resources/node_pools/methods/projects_locations_clusters_node_pools_list - $ref: >- #/components/x-stackQL-resources/node_pools/methods/projects_zones_clusters_node_pools_list - - $ref: >- - #/components/x-stackQL-resources/node_pools/methods/projects_zones_clusters_node_pools_get insert: - $ref: >- #/components/x-stackQL-resources/node_pools/methods/projects_locations_clusters_node_pools_create - $ref: >- #/components/x-stackQL-resources/node_pools/methods/projects_zones_clusters_node_pools_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/node_pools/methods/projects_locations_clusters_node_pools_update + - $ref: >- + #/components/x-stackQL-resources/node_pools/methods/projects_zones_clusters_node_pools_update delete: - $ref: >- #/components/x-stackQL-resources/node_pools/methods/projects_locations_clusters_node_pools_delete - $ref: >- #/components/x-stackQL-resources/node_pools/methods/projects_zones_clusters_node_pools_delete well_known_openid_configuration: - id: container.well_known_openid_configuration + id: google.container.well_known_openid_configuration name: well_known_openid_configuration title: Well_known_openid_configuration methods: @@ -6463,7 +6471,7 @@ components: update: [] delete: [] operations: - id: container.operations + id: google.container.operations name: operations title: Operations methods: @@ -6510,19 +6518,19 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_zones_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_zones_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_zones_operations_list insert: [] update: [] delete: [] zones_serverconfig: - id: container.zones_serverconfig + id: google.container.zones_serverconfig name: zones_serverconfig title: Zones_serverconfig methods: @@ -6541,7 +6549,7 @@ components: update: [] delete: [] clusters_ons: - id: container.clusters_ons + id: google.container.clusters_ons name: clusters_ons title: Clusters_ons methods: @@ -6558,7 +6566,7 @@ components: update: [] delete: [] usable_subnetworks: - id: container.usable_subnetworks + id: google.container.usable_subnetworks name: usable_subnetworks title: Usable_subnetworks methods: 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 7f89c878..7a5d6326 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/containeranalysis.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/containeranalysis.yaml @@ -13,7 +13,7 @@ info: and retrieval of critical metadata about all of your software artifacts. version: v1 x-discovery-doc-revision: '20240524' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/container-analysis/api/reference/rest/ servers: @@ -39,1174 +39,961 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - SBOMStatus: - type: object - description: The status of an SBOM generation. - 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. - enumDescriptions: - - Default unknown state. - - SBOM scanning is pending. - - SBOM scanning has completed. - type: string - enum: - - SBOM_STATE_UNSPECIFIED - - PENDING - - COMPLETE - id: SBOMStatus - 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. - id: SourceContext - type: object - properties: - gerrit: - description: A SourceContext referring to a Gerrit project. - $ref: '#/components/schemas/GerritSourceContext' - cloudRepo: - description: >- - A SourceContext referring to a revision in a Google Cloud Source - Repo. - $ref: '#/components/schemas/CloudRepoSourceContext' - 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 - ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation: - description: Represents a storage location in Cloud Storage - id: ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation + Category: + description: The category to which the update belongs. type: object + id: Category properties: - generation: - description: >- - Cloud Storage generation for the object. If the generation is - omitted, the latest generation will be used. - format: int64 - type: string - bucket: - description: >- - Cloud Storage bucket. See - https://cloud.google.com/storage/docs/naming#requirements + categoryId: type: string - object: - description: >- - Cloud Storage object. See - https://cloud.google.com/storage/docs/naming#objectnames + description: The identifier of the category. + name: + description: The localized name of the category. type: string - EnvelopeSignature: - id: EnvelopeSignature + GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata: + description: Other properties of the build. type: object properties: - sig: + reproducible: + type: boolean + completeness: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness' + buildInvocationId: type: string - format: byte - keyid: + buildFinishedOn: + format: google-datetime type: string - ComplianceOccurrence: - properties: - nonComplianceReason: + buildStartedOn: + format: google-datetime type: string - version: - description: The OS and config version the benchmark was run on. - $ref: '#/components/schemas/ComplianceVersion' - nonCompliantFiles: - type: array - items: - $ref: '#/components/schemas/NonCompliantFile' - description: >- - An indication that the compliance checks in the associated - ComplianceNote were not satisfied for particular resources or a - specified reason. - id: ComplianceOccurrence - type: object - 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 - 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. - type: object + id: GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata + ExportSBOMRequest: properties: - humanReadableName: - type: string + cloudStorageLocation: + $ref: '#/components/schemas/CloudStorageLocation' description: >- - Required. The human readable name of this attestation authority, for - example "qa". - id: Hint - Empty: - properties: {} + Empty placeholder to denote that this is a Google Cloud Storage + export request. + id: ExportSBOMRequest 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); } - SbomReferenceIntotoPredicate: - description: A predicate which describes the SBOM being referenced. + The request to generate and export SBOM. Target must be specified for + the request. + GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial: + description: >- + The collection of artifacts that influenced the build including sources, + dependencies, build tools, base images, and so on. + id: GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial properties: - location: - description: The location of the SBOM. - type: string - referrerId: - type: string - description: The person or system referring this predicate to the consumer. digest: additionalProperties: type: string - description: A map of algorithm to digest of the contents of the SBOM. type: object - mimeType: + uri: type: string - description: The mime type of the SBOM. type: object - id: SbomReferenceIntotoPredicate - 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. + ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository: type: object - id: AttestationOccurrence + description: >- + Location of the source in a 2nd-gen Google Cloud Build repository + resource. properties: - serializedPayload: - type: string + repository: description: >- - Required. The serialized payload that is verified by one or more - `signatures`. - format: byte - signatures: + Required. Name of the Google Cloud Build repository, formatted as + `projects/*/locations/*/connections/*/repositories/*`. + type: string + dir: + type: string 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' - jwts: - type: array + Optional. Directory, relative to the source root, in which to run + the build. + revision: + type: string 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. - items: - $ref: '#/components/schemas/Jwt' - ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig: + Required. The revision to fetch from the Git repository such as a + branch, a tag, a commit SHA, or any Git ref. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository + Source: + description: Source describes the location of the source used for the build. + id: Source type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig properties: - proxySecretVersionName: - type: string + context: + $ref: '#/components/schemas/SourceContext' description: >- - SecretVersion resource of the HTTP proxy URL. The proxy URL should - be in format protocol://@]proxyhost[:port]. - proxySslCaInfo: + If provided, the source code used for the build came from this + location. + fileHashes: description: >- - Optional. Cloud Storage object storing the certificate to use with - the HTTP proxy. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation - description: HttpConfig is a configuration for HTTP related git operations. - SbomReferenceIntotoPayload: - properties: - _type: + 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. + additionalProperties: + $ref: '#/components/schemas/FileHashes' + type: object + artifactStorageSourceUri: type: string - description: Identifier for the schema of the Statement. - subject: - type: array description: >- - Set of software artifacts that the attestation applies to. Each - element represents a single software artifact. - items: - $ref: '#/components/schemas/Subject' - predicate: - $ref: '#/components/schemas/SbomReferenceIntotoPredicate' + If provided, the input binary artifacts for the build came from this + location. + additionalContexts: description: >- - Additional parameters of the Predicate. Includes the actual data - about the SBOM. - predicateType: - description: URI identifying the type of the Predicate. - 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 - 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 + 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' + FixableTotalByDigest: + id: FixableTotalByDigest + description: Per resource and severity counts of fixable and total vulnerabilities. properties: - fingerprint: - $ref: '#/components/schemas/Fingerprint' - description: Required. Immutable. The fingerprint of the base image. - resourceUrl: + fixableCount: + description: The number of fixable vulnerabilities associated with this resource. + type: string + format: int64 + severity: + enumDescriptions: + - Unknown. + - Minimal severity. + - Low severity. + - Medium severity. + - High severity. + - Critical severity. + enum: + - SEVERITY_UNSPECIFIED + - MINIMAL + - LOW + - MEDIUM + - HIGH + - CRITICAL + type: string description: >- - Required. Immutable. The resource_url for the resource representing - the basis of associated occurrence images. + The severity for this count. SEVERITY_UNSPECIFIED indicates total + across all severities. + resourceUri: + type: string + description: The affected resource. + totalCount: + format: int64 + description: The total number of vulnerabilities associated with this resource. type: string - CloudStorageLocation: type: object - properties: {} - description: >- - Empty placeholder to denote that this is a Google Cloud Storage export - request. - id: CloudStorageLocation - BuildStep: + VulnerabilityOccurrence: type: object - id: BuildStep + description: An occurrence of a severity vulnerability on a resource. properties: - timing: - $ref: '#/components/schemas/TimeSpan' - description: >- - Output only. Stores timing information for executing this build - step. - waitFor: + shortDescription: + description: Output only. A one sentence description of this vulnerability. + type: string + extraDetails: + type: string + description: Occurrence-specific extra details about the vulnerability. + vexAssessment: + $ref: '#/components/schemas/VexAssessment' + relatedUrls: + description: Output only. URLs related to this vulnerability. type: array items: - type: string + $ref: '#/components/schemas/RelatedUrl' + cvssVersion: + type: string + enumDescriptions: + - '' + - '' + - '' + description: Output only. CVSS version used to populate cvss_score and severity. + enum: + - CVSS_VERSION_UNSPECIFIED + - CVSS_VERSION_2 + - CVSS_VERSION_3 + longDescription: + description: Output only. A detailed description of this vulnerability. + type: string + severity: + type: string + enumDescriptions: + - Unknown. + - Minimal severity. + - Low severity. + - Medium severity. + - High severity. + - Critical severity. + enum: + - SEVERITY_UNSPECIFIED + - MINIMAL + - LOW + - MEDIUM + - HIGH + - CRITICAL 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. - args: - type: array + Output only. The note provider assigned severity of this + vulnerability. + type: 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 - name: + 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: >- - 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: + Required. The set of affected locations and their fixes (if + available) within the associated resource. + effectiveSeverity: + enumDescriptions: + - Unknown. + - Minimal severity. + - Low severity. + - Medium severity. + - High severity. + - Critical severity. + enum: + - SEVERITY_UNSPECIFIED + - MINIMAL + - LOW + - MEDIUM + - HIGH + - CRITICAL 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 - dir: + 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. type: string + fixAvailable: 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. - allowFailure: + Output only. Whether at least one of the affected packages has a fix + available. type: boolean + cvssScore: 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. - pullTiming: - description: >- - Output only. Stores timing information for pulling this build step's - builder image only. - $ref: '#/components/schemas/TimeSpan' - timeout: - format: google-duration + 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 + cvssv3: + $ref: '#/components/schemas/CVSS' + description: The cvss v3 score for the vulnerability. + cvssV2: + description: The cvss v2 score for the vulnerability. + $ref: '#/components/schemas/CVSS' + id: VulnerabilityOccurrence + Assessment: + id: Assessment + description: >- + Assessment provides all information that is related to a single + vulnerability for this product. + properties: + shortDescription: 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. - allowExitCodes: - items: - format: int32 - type: integer + description: A one sentence description of this Vex. + impacts: 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. - status: + Contains information about the impact of this vulnerability, this + will change with time. + items: + type: string + cve: + deprecated: 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. + Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) + tracking number for the vulnerability. Deprecated: Use + vulnerability_id instead to denote CVEs. 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`. - enum: - - STATUS_UNKNOWN - - PENDING - - QUEUING - - QUEUED - - WORKING - - SUCCESS - - FAILURE - - INTERNAL_ERROR - - TIMEOUT - - CANCELLED - - EXPIRED - 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 - id: - description: >- - Unique identifier for this build step, used in `wait_for` to - reference this build step as a dependency. - type: string - exitCode: - format: int32 - description: Output only. Return code from running the step. - type: integer - secretEnv: - type: array - items: - type: string + vulnerabilityId: 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`. - script: + 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: >- - A shell script to be executed in the step. When script is provided, - the user cannot specify the entrypoint or args. - env: + Justification provides the justification when the state of the + assessment if NOT_AFFECTED. + relatedUris: items: - type: string - 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". - volumes: + $ref: '#/components/schemas/RelatedUrl' 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. + 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/Volume' - description: 'A step in the build pipeline. Next ID: 21' - ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult: - description: >- - ApprovalResult describes the decision and associated metadata of a - manual approval of a build. - properties: - comment: - description: Optional. An optional comment for this manual approval result. - type: string - approverAccount: - 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. + state: type: string - readOnly: true - decision: + description: Provides the state of this Vulnerability assessment. enumDescriptions: - - Default enum type. This should not be used. - - Build is approved. - - Build is rejected. - type: string + - 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: - - DECISION_UNSPECIFIED - - APPROVED - - REJECTED - description: Required. The decision of this manual approval. - approvalTime: - type: string - format: google-datetime - description: Output only. The time when the approval decision was made. - readOnly: true - url: - type: string + - STATE_UNSPECIFIED + - AFFECTED + - NOT_AFFECTED + - FIXED + - UNDER_INVESTIGATION + remediations: 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. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult - type: object - GrafeasV1FileLocation: - properties: - filePath: + Specifies details on how to handle (and presumably, fix) a + vulnerability. + type: array + items: + $ref: '#/components/schemas/Remediation' + longDescription: type: string - 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. - description: Indicates the location at which a package was found. - id: GrafeasV1FileLocation + description: A detailed description of this Vex. type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact: + CloudRepoSourceContext: type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact - description: >- - A Maven artifact to upload to Artifact Registry upon successful - completion of all build steps. - properties: - artifactId: - type: string - description: >- - Maven `artifactId` value used when uploading the artifact to - Artifact Registry. - 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 - groupId: - description: >- - Maven `groupId` value used when uploading the artifact to Artifact - Registry. - type: string - version: - type: string - description: >- - Maven `version` value used when uploading the artifact to Artifact - Registry. - 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. - GerritSourceContext: properties: + repoId: + description: The ID of the repo. + $ref: '#/components/schemas/RepoId' revisionId: - description: A revision (commit) ID. - type: string - 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. + description: A revision ID. aliasContext: description: An alias, which may be a branch or tag. $ref: '#/components/schemas/AliasContext' - hostUri: + description: >- + A CloudRepoSourceContext denotes a particular revision in a Google Cloud + Source Repo. + id: CloudRepoSourceContext + Jwt: + properties: + compactJwt: + 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 type: string - description: The URI of a running Gerrit instance. - id: GerritSourceContext - description: A SourceContext referring to a Gerrit project. type: object - Binding: - id: Binding + id: Jwt + BatchCreateOccurrencesRequest: + id: BatchCreateOccurrencesRequest + properties: + occurrences: + description: Required. The occurrences to create. Max allowed length is 1000. + items: + $ref: '#/components/schemas/Occurrence' + type: array + type: object + description: Request to create occurrences in batch. + AttestationOccurrence: type: object + 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. + id: AttestationOccurrence properties: - members: + serializedPayload: + format: byte + type: string + description: >- + Required. The serialized payload that is verified by one or more + `signatures`. + 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. + items: + $ref: '#/components/schemas/Signature' type: array + jwts: items: - type: string + $ref: '#/components/schemas/Jwt' + 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: + 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. + Product: + type: object + description: >- + Product contains information about a product and how to uniquely + identify it. + id: Product + properties: + id: 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). + 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 - condition: - $ref: '#/components/schemas/Expr' + genericUri: 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). - description: Associates `members`, or principals, with a `role`. - GitSourceContext: - description: >- - A GitSourceContext denotes a particular revision in a third party Git - repository (e.g., GitHub). - properties: - revisionId: + Contains a URI which is vendor-specific. Example: The artifact + repository URL of an image. type: string - description: Git commit hash. - url: + name: type: string - description: Git repository URL. - id: GitSourceContext + description: Name of the product. + VulnerabilityNote: + description: A security vulnerability that can be found in resources. type: object - VulnerabilityAssessmentNote: + id: VulnerabilityNote properties: - longDescription: - description: A detailed description of this Vex. - type: string - title: - type: string - description: The title of the note. E.g. `Vex-Debian-11.4` - product: - description: The product affected by this vex. - $ref: '#/components/schemas/Product' - assessment: - $ref: '#/components/schemas/Assessment' - description: Represents a vulnerability assessment for the product. - publisher: - $ref: '#/components/schemas/Publisher' - description: Publisher details of this Note. - shortDescription: - type: string - description: A one sentence description of this Vex. - languageCode: - description: >- - Identifies the language used by this document, corresponding to IETF - BCP 47 / RFC 5646. + 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 type: string - id: VulnerabilityAssessmentNote - type: object - description: >- - A single VulnerabilityAssessmentNote represents one particular product's - vulnerability assessment for one CVE. - SlsaMetadata: - id: SlsaMetadata - type: object - properties: - buildInvocationId: + cvssVersion: + enumDescriptions: + - '' + - '' + - '' + description: CVSS version used to populate cvss_score and severity. + enum: + - CVSS_VERSION_UNSPECIFIED + - CVSS_VERSION_2 + - CVSS_VERSION_3 type: string + windowsDetails: + type: array 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/SlsaCompleteness' - description: >- - Indicates that the builder claims certain fields in this message to - be complete. - reproducible: - type: boolean + 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. + items: + $ref: '#/components/schemas/WindowsDetail' + cvssV2: + $ref: '#/components/schemas/CVSS' + description: The full description of the v2 CVSS for this vulnerability. + sourceUpdateTime: description: >- - If true, the builder claims that running the recipe on materials - will produce bit-for-bit identical output. - buildStartedOn: + 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 - description: The timestamp of when the build started. type: string - buildFinishedOn: + details: + items: + $ref: '#/components/schemas/Detail' + description: >- + Details of all known distros and packages affected by this + vulnerability. + type: array + 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 + RepoId: + description: A unique identifier for a Cloud Repo. + id: RepoId + properties: + uid: type: string - description: The timestamp of when the build completed. - format: google-datetime - description: Other properties of the build. - ProvenanceBuilder: + 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: ProvenanceBuilder + FileHashes: properties: - builderDependencies: + fileHash: type: array items: - $ref: '#/components/schemas/ResourceDescriptor' - version: - additionalProperties: - type: string - type: object - id: - type: string - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval: + $ref: '#/components/schemas/Hash' + description: Required. Collection of file hashes. + id: 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. + UpgradeOccurrence: + id: 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. properties: - result: - description: Output only. Result of manual approval for this Build. - readOnly: true - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult - config: - readOnly: true - description: Output only. Configuration for manual approval of this build. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig - state: - 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: string - enum: - - STATE_UNSPECIFIED - - PENDING - - APPROVED - - REJECTED - - CANCELLED - description: Output only. The state of this build's approval. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval - description: >- - BuildApproval describes a build's approval configuration, state, and - result. - ListNoteOccurrencesResponse: - id: ListNoteOccurrencesResponse - properties: - occurrences: - description: The occurrences attached to the specified note. - type: array - items: - $ref: '#/components/schemas/Occurrence' - nextPageToken: + distribution: + 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' + parsedVersion: + description: >- + Required for non-Windows OS. The version of the package in a machine + + human readable form. + $ref: '#/components/schemas/Version' + package: + description: Required for non-Windows OS. The package this Upgrade is for. type: string - description: Token to provide to skip to a particular spot in the list. - type: object - description: Response for listing occurrences for a note. - BatchCreateNotesRequest: - id: BatchCreateNotesRequest - description: Request to create notes in batch. - properties: - notes: - additionalProperties: - $ref: '#/components/schemas/Note' - description: Required. The notes to create. Max allowed length is 1000. - type: object + windowsUpdate: + description: >- + Required for Windows OS. Represents the metadata about the Windows + update. + $ref: '#/components/schemas/WindowsUpdate' type: object - GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness: - id: GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness - description: >- - Indicates that the builder claims certain fields in this message to be - complete. + SlsaProvenance: properties: + metadata: + $ref: '#/components/schemas/SlsaMetadata' materials: - type: boolean - environment: - type: boolean - parameters: - type: boolean - type: object - TestIamPermissionsResponse: - description: Response message for `TestIamPermissions` method. - properties: - permissions: description: >- - A subset of `TestPermissionsRequest.permissions` that the caller is - allowed. - type: array - items: - type: string - type: object - id: TestIamPermissionsResponse - ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes - properties: - fileHash: + 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/ContaineranalysisGoogleDevtoolsCloudbuildV1Hash - description: Collection of file hashes. + $ref: '#/components/schemas/Material' 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. + builder: + $ref: '#/components/schemas/SlsaBuilder' + description: required + 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 type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance: - description: >- - Provenance of the source. Ways to find the original source, or verify - that some source was used for this build. + id: SlsaProvenance + ImageNote: + id: ImageNote type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance + 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. properties: - resolvedStorageSource: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource - description: >- - A copy of the build's `source.storage_source`, if exists, with any - generations resolved. - resolvedRepoSource: - description: >- - A copy of the build's `source.repo_source`, if exists, with any - revisions resolved. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource - 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 - 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. - fileHashes: - readOnly: true - 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. - type: object - resolvedConnectedRepository: + resourceUrl: + type: string description: >- - Output only. A copy of the build's `source.connected_repository`, if - exists, with any revisions resolved. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository - readOnly: true - ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan: + Required. Immutable. The resource_url for the resource representing + the basis of associated occurrence images. + fingerprint: + description: Required. Immutable. The fingerprint of the base image. + $ref: '#/components/schemas/Fingerprint' + InTotoSlsaProvenanceV1: + id: InTotoSlsaProvenanceV1 properties: - startTime: - description: Start of time span. + predicate: + $ref: '#/components/schemas/SlsaProvenanceV1' + subject: + items: + $ref: '#/components/schemas/Subject' + type: array + predicateType: type: string - format: google-datetime - endTime: - format: google-datetime + _type: type: string - description: End of time span. - description: Start and end times for a build execution phase. + description: >- + InToto spec defined at + https://github.com/in-toto/attestation/tree/main/spec#statement type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - ContaineranalysisGoogleDevtoolsCloudbuildV1Hash: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Hash + CloudStorageLocation: + description: >- + Empty placeholder to denote that this is a Google Cloud Storage export + request. + type: object + id: CloudStorageLocation + properties: {} + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning: type: object properties: - value: - description: The hash value. - format: byte + priority: type: string - type: + description: The priority for this warning. enumDescriptions: - - No hash requested. - - Use a sha256 hash. - - Use a md5 hash. - - Use a sha512 hash. - description: The type of hash that was performed. + - 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 enum: - - NONE - - SHA256 - - MD5 - - SHA512 + - PRIORITY_UNSPECIFIED + - INFO + - WARNING + - ALERT + text: type: string - description: Container message for hash values. - Publisher: - id: Publisher + description: Explanation of the warning generated. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning + description: A non-fatal problem encountered during the execution of the build. + AliasContext: + type: object + description: An alias to a repo revision. + id: AliasContext properties: - publisherNamespace: + name: + description: The alias name. 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 - issuingAuthority: + kind: type: string + enum: + - KIND_UNSPECIFIED + - FIXED + - MOVABLE + - OTHER + description: The alias 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". + DSSEAttestationOccurrence: + id: DSSEAttestationOccurrence + properties: + statement: + $ref: '#/components/schemas/InTotoStatement' + envelope: + $ref: '#/components/schemas/Envelope' 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. - name: - type: string - description: 'Name of the publisher. Examples: ''Google'', ''Google Cloud Platform''.' - description: Publisher contains information about the publisher of this Note. + If doing something security critical, make sure to verify the + signatures in this metadata. + description: >- + Deprecated. Prefer to use a regular Occurrence, and populate the + Envelope at the top level of the Occurrence. type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret: + Volume: + type: object + id: Volume properties: - env: - 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. + name: type: string - versionName: + 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: type: string description: >- - Resource name of the SecretVersion. In format: - projects/*/secrets/*/versions/* - type: object - description: >- - Pairs a secret environment variable with a SecretVersion in Secret - Manager. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret - ImageOccurrence: + 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. description: >- - Details of the derived image portion of the DockerImage relationship. - This image would be produced from a Dockerfile with FROM . + Volume describes a Docker container volume which is mounted into build + steps in order to persist files across build step execution. Next ID: 3 + InTotoProvenance: properties: - layerInfo: + metadata: + $ref: '#/components/schemas/Metadata' + 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 + builderConfig: + $ref: '#/components/schemas/BuilderConfig' + description: required + materials: 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. + 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/Layer' - fingerprint: - description: Required. The fingerprint of the derived image. - $ref: '#/components/schemas/Fingerprint' - distance: - type: integer + type: string + type: object + id: InTotoProvenance + ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret + description: >- + Pairs a set of secret environment variables mapped to encrypted values + with the Cloud KMS key to use to decrypt the value. + properties: + envMap: + additionalProperties: + format: byte + type: string + type: object description: >- - Output only. The number of layers by which this image differs from - the associated image basis. - format: int32 - baseResourceUrl: + 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. + kmsKeyName: description: >- - Output only. This contains the base image URL for the derived image - occurrence. + Resource name of Cloud KMS crypto key to decrypt the encrypted + value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/* type: string type: object - id: ImageOccurrence - ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage - type: object + ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest properties: - repository: + object: + 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. + Required. Cloud Storage object containing the source manifest. This + object must be a JSON file. + generation: type: string - packagePath: + format: int64 + description: >- + Cloud Storage generation for the object. If the generation is + omitted, the latest generation will be used. + 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: Path to the package.json. e.g. workspace/path/to/package - description: >- - Npm package to upload to Artifact Registry upon successful completion of - all build steps. - Recipe: + type: object description: >- - Steps taken to build the artifact. For a TaskRun, typically each - container corresponds to one step in the recipe. + 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). + ComplianceVersion: 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 - type: + benchmarkDocument: type: string description: >- - URI indicating what type of recipe was performed. It determines the - meaning of recipe.entryPoint, recipe.arguments, recipe.environment, - and materials. - 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". - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - type: array - definedInMaterial: + The name of the document that defines this benchmark, e.g. "CIS + Container-Optimized OS". + version: 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 - arguments: - items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any + The version of the benchmark. This is set to the version of the + OS-specific CIS document the benchmark is defined in. + cpeUri: 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: array - type: object - id: Recipe - GoogleDevtoolsContaineranalysisV1alpha1OperationMetadata: - id: GoogleDevtoolsContaineranalysisV1alpha1OperationMetadata + The CPE URI (https://cpe.mitre.org/specification/) this benchmark is + applicable to. + type: string + description: >- + Describes the CIS benchmark version that is applicable to a given OS and + os version. + id: ComplianceVersion type: object + BuildNote: + id: BuildNote properties: - createTime: - format: google-datetime + builderVersion: type: string - description: Output only. The time this operation was created. - endTime: description: >- - Output only. The time that this operation was marked completed or - failed. - format: google-datetime - type: string + Required. Immutable. Version of the builder which produced this + build. description: >- - Metadata for all operations used and required for all operations that - created by Container Analysis Providers - UpgradeOccurrence: - id: UpgradeOccurrence + Note holding the version of the provider's builder and the signature of + the provenance message in the build details occurrence. + type: object + Distribution: type: object properties: - distribution: + url: + description: The distribution channel-specific homepage for this package. + type: string + cpeUri: + type: string 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' - windowsUpdate: - $ref: '#/components/schemas/WindowsUpdate' - description: >- - Required for Windows OS. Represents the metadata about the Windows - update. - package: - type: string - description: Required for non-Windows OS. The package this Upgrade is for. - parsedVersion: - description: >- - Required for non-Windows OS. The version of the package in a machine - + human readable form. + Required. The cpe_uri in [CPE + format](https://cpe.mitre.org/specification/) denoting the package + manager version distributing a package. + latestVersion: $ref: '#/components/schemas/Version' - 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. - ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets: - properties: - inline: - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret - description: >- - Secrets encrypted with KMS key and the associated secret environment - variable. - type: array - secretManager: description: >- - Secrets in Secret Manager and associated secret environment - variable. - type: array - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets - description: Secrets and secret environment variables. - type: object - BuildMetadata: - properties: - finishedOn: + The latest available version of this package in this distribution + channel. + maintainer: type: string - format: google-datetime - invocationId: + description: A freeform string denoting the maintainer of this package. + architecture: + description: >- + The CPU architecture for which packages in this distribution channel + were built. type: string - startedOn: + enumDescriptions: + - Unknown architecture. + - X86 architecture. + - X64 architecture. + enum: + - ARCHITECTURE_UNSPECIFIED + - X86 + - X64 + description: type: string - format: google-datetime - id: BuildMetadata + description: The distribution channel-specific description of this package. + description: >- + This represents a particular channel of distribution for a given + package. E.g., Debian's jessie-backports dpkg mirror. + id: Distribution + Material: + id: Material type: object - ResourceDescriptor: - id: ResourceDescriptor properties: - name: - type: string digest: + type: object additionalProperties: type: string + uri: + type: string + BatchCreateNotesRequest: + type: object + description: Request to create notes in batch. + properties: + notes: type: object + additionalProperties: + $ref: '#/components/schemas/Note' + description: Required. The notes to create. Max allowed length is 1000. + id: BatchCreateNotesRequest + ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage: + description: >- + An npm package uploaded to Artifact Registry using the NpmPackage + directive. + type: object + properties: + pushTiming: + readOnly: true + description: >- + Output only. Stores timing information for pushing the specified + artifact. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + fileHashes: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes + description: Hash types and values of the npm package. uri: type: string - downloadLocation: + description: URI of the uploaded npm package. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage + GerritSourceContext: + id: GerritSourceContext + type: object + description: A SourceContext referring to a Gerrit project. + properties: + hostUri: + description: The URI of a running Gerrit instance. type: string - annotations: - additionalProperties: - type: any - type: object - content: - format: byte + revisionId: type: string - mediaType: + description: A revision (commit) ID. + gerritProject: + 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. type: string + aliasContext: + $ref: '#/components/schemas/AliasContext' + description: An alias, which may be a branch or tag. + ListNotesResponse: + id: ListNotesResponse type: object - Completeness: - id: Completeness properties: - arguments: - 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: - description: >- - If true, the builder claims that recipe.environment is claimed to be - complete. - type: boolean - materials: + nextPageToken: + type: string description: >- - If true, the builder claims that materials are complete, usually - through some controls to prevent network access. Sometimes called - "hermetic". - type: boolean + 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. + notes: + items: + $ref: '#/components/schemas/Note' + type: array + description: The notes requested. + description: Response for listing notes. + InTotoStatement: + properties: + _type: + type: string + description: Always `https://in-toto.io/Statement/v0.1`. + subject: + items: + $ref: '#/components/schemas/Subject' + type: array + slsaProvenanceZeroTwo: + $ref: '#/components/schemas/SlsaProvenanceZeroTwo' + slsaProvenance: + $ref: '#/components/schemas/SlsaProvenance' + provenance: + $ref: '#/components/schemas/InTotoProvenance' + predicateType: + type: string + description: '`https://slsa.dev/provenance/v0.1` for SlsaProvenance.' description: >- - Indicates that the builder claims certain fields in this message to be - complete. + 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 type: object - Subject: - id: Subject + VulnerabilityOccurrencesSummary: + description: >- + A summary of how many vulnerability occurrences there are per resource + and severity type. + type: object + id: VulnerabilityOccurrencesSummary properties: - digest: + counts: 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 - FixableTotalByDigest: - id: FixableTotalByDigest + A listing by resource of the number of fixable and total + vulnerabilities. + items: + $ref: '#/components/schemas/FixableTotalByDigest' + type: array + CisBenchmark: + description: A compliance check that is a CIS benchmark. properties: - fixableCount: - type: string - format: int64 - description: The number of fixable vulnerabilities associated with this resource. severity: + type: string enumDescriptions: - Unknown. - Minimal severity. @@ -1214,9 +1001,6 @@ components: - Medium severity. - High severity. - Critical severity. - description: >- - The severity for this count. SEVERITY_UNSPECIFIED indicates total - across all severities. enum: - SEVERITY_UNSPECIFIED - MINIMAL @@ -1224,320 +1008,244 @@ components: - MEDIUM - HIGH - CRITICAL - type: string - totalCount: - description: The total number of vulnerabilities associated with this resource. - format: int64 - type: string - resourceUri: - description: The affected resource. - type: string + profileLevel: + format: int32 + type: integer type: object - description: Per resource and severity counts of fixable and total vulnerabilities. - TestIamPermissionsRequest: - properties: - permissions: - items: - type: string - 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 + id: CisBenchmark + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions: type: object - description: Request message for `TestIamPermissions` method. - InTotoProvenance: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions properties: - materials: + dynamicSubstitutions: + type: boolean 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. + 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. + substitutionOption: + 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. + 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. + enum: + - MUST_MATCH + - ALLOW_LOOSE + secretEnv: items: type: string - type: array - 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' - builderConfig: - $ref: '#/components/schemas/BuilderConfig' - description: required - metadata: - $ref: '#/components/schemas/Metadata' - id: InTotoProvenance - type: object - BatchCreateOccurrencesResponse: - description: Response for creating occurrences in batch. - properties: - occurrences: + 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: - $ref: '#/components/schemas/Occurrence' - description: The occurrences that were created. - id: BatchCreateOccurrencesResponse - type: object - VulnerabilityNote: - id: VulnerabilityNote - properties: - cvssVersion: - description: CVSS version used to populate cvss_score and severity. + requestedVerifyOption: + description: Requested verifiability options. enumDescriptions: - - '' - - '' - - '' + - Not a verifiable build (the default). + - Build must be verified. + type: string enum: - - CVSS_VERSION_UNSPECIFIED - - CVSS_VERSION_2 - - CVSS_VERSION_3 + - NOT_VERIFIED + - VERIFIED + workerPool: + deprecated: true + description: This field deprecated; please use `pool.name` instead. type: string - windowsDetails: - 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. - items: - $ref: '#/components/schemas/WindowsDetail' - type: array - sourceUpdateTime: + diskSizeGb: 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. + 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. type: string - format: google-datetime - cvssV3: - $ref: '#/components/schemas/CVSSv3' - description: The full description of the CVSSv3 for this vulnerability. - details: - description: >- - Details of all known distros and packages affected by this - vulnerability. - type: array - items: - $ref: '#/components/schemas/Detail' - severity: - description: The note provider assigned severity of this vulnerability. + format: int64 + machineType: enum: - - SEVERITY_UNSPECIFIED - - MINIMAL - - LOW - - MEDIUM - - HIGH - - CRITICAL + - UNSPECIFIED + - N1_HIGHCPU_8 + - N1_HIGHCPU_32 + - E2_HIGHCPU_8 + - E2_HIGHCPU_32 + - E2_MEDIUM enumDescriptions: - - Unknown. - - Minimal severity. - - Low severity. - - Medium severity. - - High severity. - - Critical severity. + - 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. type: string - cvssScore: - type: number + enumDeprecated: + - false + - true + - true + - false + - false + - false + description: Compute Engine machine type on which to run the build. + env: 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 - cvssV2: - description: The full description of the v2 CVSS for this vulnerability. - $ref: '#/components/schemas/CVSS' - type: object - description: A security vulnerability that can be found in resources. - RunDetails: - properties: - metadata: - $ref: '#/components/schemas/BuildMetadata' - builder: - $ref: '#/components/schemas/ProvenanceBuilder' - byproducts: + 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: - $ref: '#/components/schemas/ResourceDescriptor' - type: object - id: RunDetails - ContaineranalysisGoogleDevtoolsCloudbuildV1Volume: - properties: - 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: >- - 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 - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Volume - description: >- - Volume describes a Docker container volume which is mounted into build - steps in order to persist files across build step execution. - type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig: - properties: - http: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig - description: Configuration for HTTP related git operations. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig - description: GitConfig is a configuration for git operations. - type: object - Envelope: - properties: - payloadType: + type: string + logStreamingOption: + description: Option to define build log streaming behavior to Cloud Storage. type: string - signatures: - type: array - items: - $ref: '#/components/schemas/EnvelopeSignature' - payload: - format: byte + 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 + 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 - type: object - description: >- - MUST match - https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. - An authenticated message of arbitrary type. - id: Envelope - ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact: - type: object - description: A Maven artifact uploaded using the MavenArtifact directive. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact - properties: - uri: - type: string - description: URI of the uploaded artifact. - fileHashes: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes - description: Hash types and values of the Maven Artifact. - pushTiming: - description: >- - Output only. Stores timing information for pushing the specified - artifact. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - readOnly: true - Material: - properties: - uri: - type: string - digest: - additionalProperties: - type: string - type: object - id: Material - type: object - Version: - id: Version - type: object - description: Version contains structured information about the version of a package. - properties: - name: - type: string - description: >- - Required only when version kind is NORMAL. The main part of the - version name. - fullName: - description: >- - Human readable version string. This string is of the form :- and is - only set when kind is NORMAL. - type: string - epoch: - format: int32 - type: integer - description: Used to correct mistakes in the version numbering scheme. - kind: + enum: + - DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED + - REGIONAL_USER_OWNED_BUCKET + description: Optional. Option to specify how default logs buckets are setup. + logging: type: string + enum: + - LOGGING_UNSPECIFIED + - LEGACY + - GCS_ONLY + - STACKDRIVER_ONLY + - CLOUD_LOGGING_ONLY + - NONE enumDescriptions: - - Unknown. - - A standard package version. - - A special version representing negative infinity. - - A special version representing positive infinity. + - >- + 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: >- - Required. Distinguishes between sentinel MIN/MAX versions and normal - versions. - enum: - - VERSION_KIND_UNSPECIFIED - - NORMAL - - MINIMUM - - MAXIMUM - revision: - type: string - description: The iteration of the package build from the above version. - inclusive: - type: boolean + Option to specify the logging mode, which determines if and where + build logs are stored. + enumDeprecated: + - false + - false + - false + - true + - false + - false + automapSubstitutions: 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. - BuildOccurrence: - type: object - description: Details of a build occurrence. - id: BuildOccurrence - properties: - inTotoSlsaProvenanceV1: + Option to include built-in and custom substitutions as env variables + for all build steps. + type: boolean + volumes: + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Volume 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. - $ref: '#/components/schemas/InTotoSlsaProvenanceV1' - provenance: - description: The actual provenance for the build. - $ref: '#/components/schemas/BuildProvenance' - provenanceBytes: + 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 + sourceProvenanceHash: + type: array + items: + enumDescriptions: + - No hash requested. + - Use a sha256 hash. + - Use a md5 hash. + - Use a sha512 hash. + enum: + - NONE + - SHA256 + - MD5 + - SHA512 + type: string + description: Requested hash for SourceProvenance. + pool: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption 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. + 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. + description: Optional arguments to enable specific features of builds. + UpgradeDistribution: + 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 + properties: + cpeUri: type: string - 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. - $ref: '#/components/schemas/InTotoStatement' - intotoProvenance: + Required - The specific operating system this metadata applies to. + See https://cpe.mitre.org/specification/. + severity: + description: The severity as specified by the upstream operating system. + type: string + classification: + type: string description: >- - Deprecated. See InTotoStatement for the replacement. In-toto - Provenance representation as defined in spec. - $ref: '#/components/schemas/InTotoProvenance' + 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) + cve: + type: array + items: + type: string + description: The cve tied to this Upgrade. + type: object Fingerprint: description: A set of properties that uniquely identify a given Docker image. - type: object properties: v2Blob: - type: array - description: Required. The ordered list of v2 blobs that represent a given image. items: type: string + type: array + description: Required. The ordered list of v2 blobs that represent a given image. v1Name: + type: string description: >- Required. The layer ID of the final layer in the Docker image's v1 representation. - type: string v2Name: type: string description: >- @@ -1545,362 +1253,311 @@ components: := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept. id: Fingerprint - KnowledgeBase: - id: KnowledgeBase + type: object + Status: + id: Status + type: object properties: - name: - description: The KB name (generally of the form KB[0-9]+ (e.g., KB123456)). - type: string - url: + 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: + items: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + type: array description: >- - A link to the KB in the [Windows update catalog] - (https://www.catalog.update.microsoft.com/). + 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). + ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan: + properties: + startTime: + description: Start of time span. + type: string + format: google-datetime + endTime: + format: google-datetime + description: End of time span. + type: string type: object - Note: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + description: Start and end times for a build execution phase. + ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig: + description: HttpConfig is a configuration for HTTP related git operations. properties: - relatedUrl: - type: array - description: URLs associated with this note. - items: - $ref: '#/components/schemas/RelatedUrl' - name: + proxySslCaInfo: + description: >- + Optional. Cloud Storage object storing the certificate to use with + the HTTP proxy. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation + proxySecretVersionName: type: string description: >- - Output only. The name of the note in the form of - `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. - sbomReference: - description: A note describing an SBOM reference. - $ref: '#/components/schemas/SBOMReferenceNote' - deployment: - $ref: '#/components/schemas/DeploymentNote' - description: A note describing something that can be deployed. - package: - $ref: '#/components/schemas/PackageNote' - description: A note describing a package hosted by various package managers. - updateTime: + SecretVersion resource of the HTTP proxy URL. The proxy URL should + be in format protocol://@]proxyhost[:port]. + type: object + id: ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig + GetPolicyOptions: + properties: + requestedPolicyVersion: description: >- - Output only. The time this note was last updated. This field can be - used as a filter in list requests. - type: string + Optional. The maximum policy version that will be used to format the + policy. Valid values are 0, 1, and 3. Requests specifying an invalid + value will be rejected. Requests for policies with any conditional + role bindings must specify version 3. Policies with no conditional + role bindings may specify any valid value or leave the field unset. + The policy in the response might use the policy version that you + specified, or it might use a lower policy version. For example, if + you specify version 3, but the policy has no conditional role + bindings, the response uses version 1. To learn which resources + support conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + format: int32 + type: integer + description: Encapsulates settings provided to GetIamPolicy. + type: object + id: GetPolicyOptions + TimeSpan: + type: object + id: TimeSpan + description: 'Start and end times for a build execution phase. Next ID: 3' + properties: + endTime: format: google-datetime - dsseAttestation: - $ref: '#/components/schemas/DSSEAttestationNote' - description: A note describing a dsse attestation note. - image: - $ref: '#/components/schemas/ImageNote' - description: A note describing a base image. - attestation: - description: A note describing an attestation role. - $ref: '#/components/schemas/AttestationNote' - vulnerability: - $ref: '#/components/schemas/VulnerabilityNote' - description: A note describing a package vulnerability. - shortDescription: - description: A one sentence description of this note. - type: string - relatedNoteNames: - items: - type: string - type: array - description: Other notes related to this note. - longDescription: type: string - description: A detailed description of this note. - createTime: - description: >- - Output only. The time this note was created. This field can be used - as a filter in list requests. - format: google-datetime + description: End of time span. + startTime: + description: Start of time span. type: string - upgrade: - description: A note describing available package upgrades. - $ref: '#/components/schemas/UpgradeNote' - compliance: - description: A note describing a compliance check. - $ref: '#/components/schemas/ComplianceNote' - expirationTime: format: google-datetime - description: Time of expiration for this note. Empty if note does not expire. - type: string - vulnerabilityAssessment: - $ref: '#/components/schemas/VulnerabilityAssessmentNote' - description: A note describing a vulnerability assessment. - 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. - enum: - - NOTE_KIND_UNSPECIFIED - - VULNERABILITY - - BUILD - - IMAGE - - PACKAGE - - DEPLOYMENT - - DISCOVERY - - ATTESTATION - - UPGRADE - - COMPLIANCE - - DSSE_ATTESTATION - - VULNERABILITY_ASSESSMENT - - SBOM_REFERENCE + TestIamPermissionsRequest: + properties: + permissions: + type: array + items: + type: string description: >- - Output only. The type of analysis. This field can be used as a - filter in list requests. - type: string - build: - description: A note describing build provenance for a verifiable build. - $ref: '#/components/schemas/BuildNote' - discovery: - $ref: '#/components/schemas/DiscoveryNote' - description: A note describing the initial analysis of a resource. + 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 - description: A type of analysis that can be done for a resource. - id: Note - ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository + description: Request message for `TestIamPermissions` method. + id: TestIamPermissionsRequest + ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig: type: object + description: GitConfig is a configuration for git operations. properties: - repository: - type: string - description: >- - Required. Name of the Google Cloud Build repository, formatted as - `projects/*/locations/*/connections/*/repositories/*`. - dir: - type: string + http: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig + description: Configuration for HTTP related git operations. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig + Version: + properties: + epoch: + format: int32 + type: integer + description: Used to correct mistakes in the version numbering scheme. + inclusive: description: >- - Optional. Directory, relative to the source root, in which to run - the build. + 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 revision: + type: string + description: The iteration of the package build from the above version. + kind: + enumDescriptions: + - Unknown. + - A standard package version. + - A special version representing negative infinity. + - A special version representing positive infinity. description: >- - Required. The revision to fetch from the Git repository such as a - branch, a tag, a commit SHA, or any Git ref. + Required. Distinguishes between sentinel MIN/MAX versions and normal + versions. type: string - description: >- - Location of the source in a 2nd-gen Google Cloud Build repository - resource. - 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. - type: object - properties: - uri: + enum: + - VERSION_KIND_UNSPECIFIED + - NORMAL + - MINIMUM + - MAXIMUM + name: type: string - digest: - additionalProperties: - type: string - type: object - entryPoint: + description: >- + Required only when version kind is NORMAL. The main part of the + version name. + fullName: type: string - id: GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource - Distribution: + description: >- + Human readable version string. This string is of the form :- and is + only set when kind is NORMAL. type: object + description: Version contains structured information about the version of a package. + id: Version + PackageIssue: properties: - latestVersion: - $ref: '#/components/schemas/Version' + fixAvailable: + description: Output only. Whether a fix is available for this package. + type: boolean + affectedVersion: description: >- - The latest available version of this package in this distribution - channel. - cpeUri: + Required. The version of the package that is installed on the + resource affected by this vulnerability. + $ref: '#/components/schemas/Version' + effectiveSeverity: + readOnly: true + type: string + enumDescriptions: + - Unknown. + - Minimal severity. + - Low severity. + - Medium severity. + - High severity. + - Critical severity. description: >- - Required. The cpe_uri in [CPE - format](https://cpe.mitre.org/specification/) denoting the package - manager version distributing a package. + 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. + enum: + - SEVERITY_UNSPECIFIED + - MINIMAL + - LOW + - MEDIUM + - HIGH + - CRITICAL + packageType: type: string - maintainer: + description: The type of package (e.g. OS, MAVEN, GO). + affectedPackage: + description: Required. The package this vulnerability was found in. type: string - description: A freeform string denoting the maintainer of this package. - url: - description: The distribution channel-specific homepage for this package. + fixedPackage: type: string - description: + description: >- + The package this vulnerability was fixed in. It is possible for this + to be different from the affected_package. + affectedCpeUri: type: string - description: The distribution channel-specific description of this package. - architecture: - enum: - - ARCHITECTURE_UNSPECIFIED - - X86 - - X64 - enumDescriptions: - - Unknown architecture. - - X86 architecture. - - X64 architecture. + description: >- + Required. The [CPE URI](https://cpe.mitre.org/specification/) this + vulnerability was found in. + fixedCpeUri: type: string description: >- - The CPU architecture for which packages in this distribution channel - were built. - id: Distribution + 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. + fileLocation: + type: array + description: The location at which this package was found. + items: + $ref: '#/components/schemas/GrafeasV1FileLocation' + 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. description: >- - This represents a particular channel of distribution for a given - package. E.g., Debian's jessie-backports dpkg mirror. + 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 + SlsaBuilder: + id: SlsaBuilder + properties: + id: + type: string + type: object ContaineranalysisGoogleDevtoolsCloudbuildV1Build: + type: object properties: - logsBucket: - 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`. + serviceAccount: type: string - finishTime: description: >- - Output only. Time at which execution of the build was finished. The - difference between finish_time and start_time is the duration of the - build's execution. - format: google-datetime - readOnly: true - type: string + 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. approval: description: >- Output only. Describes this build's approval configuration, status, and result. - readOnly: true $ref: >- #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval - startTime: - description: Output only. Time at which execution of the build was started. readOnly: true - format: google-datetime - type: string - sourceProvenance: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance + projectId: readOnly: true - description: Output only. A permanent fixed identifier for source. - timeout: - format: google-duration - type: string - 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. - source: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Source - description: Optional. The location of the source files to build. - name: - description: >- - Output only. The 'Build' name with format: - `projects/{project}/locations/{location}/builds/{build}`, where - {build} is a unique identifier generated by the service. + description: Output only. ID of the project. type: string - 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`. - type: array - items: - type: string steps: - description: Required. The operations to be performed on the workspace. type: array items: $ref: >- #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep - availableSecrets: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets - description: Secrets and secret environment variables. - projectId: - readOnly: true - description: Output only. ID of the project. - type: string - substitutions: - type: object - description: Substitutions data for `Build` resource. - additionalProperties: - type: string - queueTtl: - type: string + description: Required. The operations to be performed on the workspace. + timing: 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 - tags: - items: - type: string - description: Tags for annotation of a `Build`. These are not docker tags. - type: array - results: - readOnly: true - description: Output only. Results of the build. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Results - warnings: - type: array - items: + 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. + additionalProperties: $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning - description: >- - Output only. Non-fatal problems encountered during the execution of - the build. + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan readOnly: true - id: + type: object + statusDetail: type: string - description: Output only. Unique identifier of the build. - readOnly: true - failureInfo: - description: >- - Output only. Contains information about the build when - status=FAILURE. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo + description: Output only. Customer-readable message about the current status. readOnly: true - options: - description: Special options for this build. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions createTime: - readOnly: true format: google-datetime - type: string description: >- Output only. Time at which the request to create the build was received. - logUrl: - type: string - readOnly: true - description: Output only. URL to logs for this build in Google Cloud Console. - artifacts: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts - description: >- - Artifacts produced by the build that should be uploaded upon - successful completion of all build steps. - 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: readOnly: true - description: Output only. Customer-readable message about the current status. type: string status: description: Output only. Status of the build. readOnly: true + enum: + - STATUS_UNKNOWN + - PENDING + - QUEUED + - WORKING + - SUCCESS + - FAILURE + - INTERNAL_ERROR + - TIMEOUT + - CANCELLED + - EXPIRED type: string enumDescriptions: - Status of the build is unknown. @@ -1915,462 +1572,431 @@ components: - 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 - gitConfig: - description: Optional. Configuration for git operations. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig - buildTriggerId: - type: string - readOnly: true - description: >- - Output only. The ID of the `BuildTrigger` that triggered this build, - if it was triggered automatically. - timing: - readOnly: true - additionalProperties: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - type: object - 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. secrets: + type: array + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Secret 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 + id: + description: Output only. Unique identifier of the build. + readOnly: true + type: string + images: items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Secret + type: string type: array - 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 + 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`. + sourceProvenance: + description: Output only. A permanent fixed identifier for source. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance + readOnly: true + 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. + readOnly: true + format: google-datetime + failureInfo: + description: >- + Output only. Contains information about the build when + status=FAILURE. + readOnly: true + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo + 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 + startTime: + type: string + description: Output only. Time at which execution of the build was started. + format: google-datetime + readOnly: true + source: + description: Optional. The location of the source files to build. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Source + gitConfig: + description: Optional. Configuration for git operations. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig + queueTtl: + description: >- + TTL in queue for this build. If provided and the build is enqueued + longer than this value, the build will expire and the build status + will be `EXPIRED`. The TTL starts ticking from create_time. + format: google-duration + type: string + tags: + type: array + items: + type: string + description: Tags for annotation of a `Build`. These are not docker tags. + warnings: + description: >- + Output only. Non-fatal problems encountered during the execution of + the build. + readOnly: true + type: array + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning + options: + description: Special options for this build. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions + substitutions: + type: object + additionalProperties: + type: string + description: Substitutions data for `Build` resource. + name: + readOnly: true + description: >- + 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 + availableSecrets: + description: Secrets and secret environment variables. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets + logUrl: + description: Output only. URL to logs for this build in Google Cloud Console. + readOnly: true + type: string + artifacts: + description: >- + Artifacts produced by the build that should be uploaded upon + successful completion of all build steps. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts + buildTriggerId: + readOnly: true + type: string + description: >- + Output only. The ID of the `BuildTrigger` that triggered this build, + if it was triggered automatically. + results: + readOnly: true + description: Output only. Results of the build. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Results + logsBucket: + 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`. + type: string + 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. id: ContaineranalysisGoogleDevtoolsCloudbuildV1Build + ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult: type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest: - type: object + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult properties: - generation: + decision: + enum: + - DECISION_UNSPECIFIED + - APPROVED + - REJECTED type: string + description: Required. The decision of this manual approval. + enumDescriptions: + - Default enum type. This should not be used. + - Build is approved. + - Build is rejected. + url: description: >- - 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 manifest. This - object must be a JSON file. + 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 - bucket: + approvalTime: + type: string + format: google-datetime + readOnly: true + description: Output only. The time when the approval decision was made. + comment: type: string + description: Optional. An optional comment for this manual approval result. + approverAccount: + readOnly: true description: >- - Required. Cloud Storage bucket containing the source manifest (see - [Bucket Name - Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). - id: ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest + 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. + type: string 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). - Category: + ApprovalResult describes the decision and associated metadata of a + manual approval of a build. + ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig: type: object - description: The category to which the update belongs. - id: Category properties: - categoryId: - description: The identifier of the category. + dir: type: string - name: + description: >- + Required. Directory, relative to the source root, in which to run + the build. + revision: type: string - description: The localized name of the category. - License: - id: License + description: >- + Required. The revision to fetch from the Git repository such as a + branch, a tag, a commit SHA, or any Git ref. + gitRepositoryLink: + description: >- + Required. The Developer Connect Git repository link, formatted as + `projects/*/locations/*/connections/*/gitRepositoryLink/*`. + type: string + description: This config defines the location of a source through Developer Connect. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig + ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage type: object + description: Artifact uploaded using the PythonPackage directive. properties: - comments: - description: Comments - type: string - expression: + pushTiming: 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". + Output only. Stores timing information for pushing the specified + artifact. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + readOnly: true + uri: + description: URI of the uploaded artifact. type: string - description: License information. - GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder: - id: GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder - description: >- - Identifies the entity that executed the recipe, which is trusted to have - correctly performed the operation and populated this provenance. + fileHashes: + description: Hash types and values of the Python Artifact. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes + RelatedUrl: + id: RelatedUrl type: object + description: Metadata for any related URL information. properties: - id: + url: + description: Specific URL associated with the resource. type: string - InTotoSlsaProvenanceV1: - id: InTotoSlsaProvenanceV1 + label: + type: string + description: Label to describe usage of the URL. + Digest: type: object + description: Digest information. properties: - predicate: - $ref: '#/components/schemas/SlsaProvenanceV1' - predicateType: + algo: + description: '`SHA1`, `SHA512` etc.' type: string - _type: - description: >- - InToto spec defined at - https://github.com/in-toto/attestation/tree/main/spec#statement + digestBytes: + description: Value of the digest. + format: byte type: string - subject: - type: array - items: - $ref: '#/components/schemas/Subject' - DSSEAttestationNote: - properties: - hint: - description: DSSEHint hints at the purpose of the attestation authority. - $ref: '#/components/schemas/DSSEHint' + id: Digest + DiscoveryNote: type: object - id: DSSEAttestationNote - Assessment: - id: Assessment + 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. properties: - remediations: - items: - $ref: '#/components/schemas/Remediation' + analysisKind: description: >- - Specifies details on how to handle (and presumably, fix) a - vulnerability. - type: array - longDescription: - type: string - description: A detailed description of this Vex. - state: + Required. Immutable. The kind of analysis that is handled by this + discovery. enum: - - STATE_UNSPECIFIED - - AFFECTED - - NOT_AFFECTED - - FIXED - - UNDER_INVESTIGATION + - NOTE_KIND_UNSPECIFIED + - VULNERABILITY + - BUILD + - IMAGE + - PACKAGE + - DEPLOYMENT + - DISCOVERY + - ATTESTATION + - UPGRADE + - COMPLIANCE + - DSSE_ATTESTATION + - VULNERABILITY_ASSESSMENT + - SBOM_REFERENCE 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. + - 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. - >- - 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. - type: string - 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. + 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. + ListNoteOccurrencesResponse: + type: object + properties: + occurrences: items: - $ref: '#/components/schemas/RelatedUrl' + $ref: '#/components/schemas/Occurrence' type: array - vulnerabilityId: - description: >- - The vulnerability identifier for this Assessment. Will hold one of - common identifiers e.g. CVE, GHSA etc. + description: The occurrences attached to the specified note. + nextPageToken: + description: Token to provide to skip to a particular spot in the list. type: string - justification: - $ref: '#/components/schemas/Justification' - description: >- - Justification provides the justification when the state of the - assessment if NOT_AFFECTED. - impacts: + description: Response for listing occurrences for a note. + id: ListNoteOccurrencesResponse + Metadata: + id: Metadata + description: Other properties of the build. + properties: + buildFinishedOn: + format: google-datetime + type: string + description: The timestamp of when the build completed. + completeness: description: >- - Contains information about the impact of this vulnerability, this - will change with time. - type: array - items: - type: string - cve: + Indicates that the builder claims certain fields in this message to + be complete. + $ref: '#/components/schemas/Completeness' + reproducible: + type: boolean 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 + If true, the builder claims that running the recipe on materials + will produce bit-for-bit identical output. + buildStartedOn: + type: string + description: The timestamp of when the build started. + format: google-datetime + 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. type: object - description: >- - Assessment provides all information that is related to a single - vulnerability for this product. - Command: + KnowledgeBase: + type: object + id: KnowledgeBase properties: - id: + url: type: string description: >- - Optional unique identifier for this command, used in wait_for to - reference this command as a dependency. - args: - type: array - items: - type: string - description: Command-line arguments used when executing this command. - dir: - description: >- - Working directory (relative to project source root) used when - running this command. + A link to the KB in the [Windows update catalog] + (https://www.catalog.update.microsoft.com/). + name: type: string - env: + description: The KB name (generally of the form KB[0-9]+ (e.g., KB123456)). + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep: + properties: + 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. + timing: + readOnly: true + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + description: >- + Output only. Stores timing information for executing this build + step. + args: items: type: string type: array - description: Environment variables set before running this command. - name: - type: string 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`. + 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. waitFor: - description: The ID(s) of the command(s) that this command depends on. + 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 type: array - id: Command - type: object - description: Command describes a step performed as part of the build pipeline. - SetIamPolicyRequest: - type: object - id: SetIamPolicyRequest - description: Request message for `SetIamPolicy` method. - properties: - policy: + exitCode: + readOnly: true + description: Output only. Return code from running the step. + type: integer + format: int32 + timeout: 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' - AliasContext: - id: AliasContext - properties: - name: - description: The alias name. - type: string - kind: + 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 - description: The alias 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". - enum: - - KIND_UNSPECIFIED - - FIXED - - MOVABLE - - OTHER - type: object - description: An alias to a repo revision. - SlsaCompleteness: - type: object - 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. - 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". - id: SlsaCompleteness - description: >- - Indicates that the builder claims certain fields in this message to be - complete. - TimeSpan: - id: TimeSpan - type: object - description: 'Start and end times for a build execution phase. Next ID: 3' - properties: - startTime: - format: google-datetime - type: string - description: Start of time span. - endTime: - type: string - description: End of time span. - format: google-datetime - 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: - type: string - description: Cloud KMS key name to use to decrypt these envs. - secretEnv: - additionalProperties: - type: string - format: byte - 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 - Digest: - type: object - properties: - digestBytes: - format: byte - description: Value of the digest. - type: string - algo: - type: string - description: '`SHA1`, `SHA512` etc.' - description: Digest information. - id: Digest - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption - properties: - 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 - 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. - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep: - type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep - properties: - 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. - args: - 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. - type: array - allowFailure: + format: google-duration + 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. - 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. - 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. - allowExitCodes: - items: - format: int32 - type: integer - 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. - pullTiming: - description: >- - Output only. Stores timing information for pulling this build step's - builder image only. - readOnly: true - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - env: - type: array - items: - type: string + id: 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". + Unique identifier for this build step, used in `wait_for` to + reference this build step as a dependency. + type: string 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. volumes: + 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 @@ -2380,23 +2006,13 @@ components: items: $ref: >- #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Volume - type: array - waitFor: - type: array - items: - type: string + script: + 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. - exitCode: - type: integer - format: int32 - description: Output only. Return code from running the step. - readOnly: true + A shell script to be executed in the step. When script is provided, + the user cannot specify the entrypoint or args. 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 @@ -2406,24 +2022,42 @@ components: 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 + secretEnv: + type: array + 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`. + 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 + env: + 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 + items: + type: string + 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 status: 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 - enum: - - STATUS_UNKNOWN - - PENDING - - QUEUED - - WORKING - - SUCCESS - - FAILURE - - INTERNAL_ERROR - - TIMEOUT - - CANCELLED - - EXPIRED enumDescriptions: - Status of the build is unknown. - >- @@ -2438,321 +2072,261 @@ components: - Build or step was canceled by a user. - Build was enqueued for longer than the value of `queue_ttl`. type: string - id: - description: >- - Unique identifier for this build step, used in `wait_for` to - reference this build step as a dependency. - type: string - 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`. - type: array - items: - type: string - timeout: - 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. - timing: + readOnly: true + enum: + - STATUS_UNKNOWN + - PENDING + - QUEUED + - WORKING + - SUCCESS + - FAILURE + - INTERNAL_ERROR + - TIMEOUT + - CANCELLED + - EXPIRED + pullTiming: readOnly: true $ref: >- #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan description: >- - Output only. Stores timing information for executing this build - step. + Output only. Stores timing information for pulling this build step's + builder image only. description: A step in the build pipeline. - BuildProvenance: + type: object + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep + Policy: 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 + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). + id: Policy properties: - creator: + etag: 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 - triggerId: + `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 + version: + format: int32 description: >- - Trigger identifier if the build was triggered automatically; empty - if not. - id: - type: string - description: Required. Unique identifier of the build. - endTime: - format: google-datetime - description: Time at which execution of the build was finished. - type: string - logsUri: - type: string - description: URI where any logs for this provenance were written. - builderVersion: - type: string - description: Version string of the builder at the time this build was executed. - builtArtifacts: - items: - $ref: '#/components/schemas/Artifact' - type: array - description: Output of the build. - startTime: - format: google-datetime - description: Time at which execution of the build was started. - type: string - projectId: - type: string - description: ID of the project. - sourceProvenance: - $ref: '#/components/schemas/Source' - description: Details of the Source input to the build. - commands: + 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: items: - $ref: '#/components/schemas/Command' + $ref: '#/components/schemas/Binding' type: array - description: Commands requested by the build. - createTime: - description: Time at which the build was created. - format: google-datetime - type: string - buildOptions: - 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. - type: object - UpgradeDistribution: + 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`. + 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 + id: ExportSBOMResponse type: object - id: UpgradeDistribution - 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. + ImageOccurrence: properties: - classification: + fingerprint: + description: Required. The fingerprint of the derived image. + $ref: '#/components/schemas/Fingerprint' + baseResourceUrl: type: string 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 - cpeUri: + Output only. This contains the base image URL for the derived image + occurrence. + distance: + format: int32 description: >- - Required - The specific operating system this metadata applies to. - See https://cpe.mitre.org/specification/. - type: string - cve: - description: The cve tied to this Upgrade. + Output only. The number of layers by which this image differs from + the associated image basis. + type: integer + layerInfo: type: array items: - type: string - VexAssessment: - id: VexAssessment + $ref: '#/components/schemas/Layer' + 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. + id: ImageOccurrence type: object + description: >- + Details of the derived image portion of the DockerImage relationship. + This image would be produced from a Dockerfile with FROM . + SourceContext: + 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. properties: - state: - description: Provides the state of this Vulnerability assessment. - 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. - impacts: + cloudRepo: + $ref: '#/components/schemas/CloudRepoSourceContext' description: >- - Contains information about the impact of this vulnerability, this - will change with time. - type: array - items: + A SourceContext referring to a revision in a Google Cloud Source + Repo. + gerrit: + description: A SourceContext referring to a Gerrit project. + $ref: '#/components/schemas/GerritSourceContext' + labels: + type: object + additionalProperties: type: string - relatedUris: - items: - $ref: '#/components/schemas/RelatedUrl' - description: >- - Holds a list of references associated with this vulnerability item - and assessment. - type: array - justification: - $ref: '#/components/schemas/Justification' + description: Labels with user defined metadata. + git: description: >- - Justification provides the justification when the state of the - assessment if NOT_AFFECTED. - noteName: + A SourceContext referring to any third party Git repo (e.g., + GitHub). + $ref: '#/components/schemas/GitSourceContext' + type: object + Publisher: + properties: + name: + description: 'Name of the publisher. Examples: ''Google'', ''Google Cloud Platform''.' + type: string + issuingAuthority: type: string description: >- - The VulnerabilityAssessment note from which this VexAssessment was - generated. This will be of the form: - `projects/[PROJECT_ID]/notes/[NOTE_ID]`. - cve: - deprecated: true - 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. - vulnerabilityId: + Provides information about the authority of the issuing party to + release the document, in particular, the party's constituency and + responsibilities or other obligations. + publisherNamespace: description: >- - The vulnerability identifier for this Assessment. Will hold one of - common identifiers e.g. CVE, GHSA etc. + 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 - remediations: - items: - $ref: '#/components/schemas/Remediation' - type: array - description: >- - Specifies details on how to handle (and presumably, fix) a - vulnerability. - description: >- - VexAssessment provides all publisher provided Vex information that is - related to this vulnerability. - Layer: - id: Layer - description: Layer holds metadata specific to a layer of a Docker image. + description: Publisher contains information about the publisher of this Note. type: object + id: Publisher + DSSEAttestationNote: properties: - arguments: - type: string - description: The recovered arguments to the Dockerfile directive. - directive: - type: string - description: >- - Required. The recovered Dockerfile directive used to construct this - layer. See https://docs.docker.com/engine/reference/builder/ for - more information. - ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts: - properties: - images: - items: - type: string - 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 - mavenArtifacts: - 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. - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact - type: array - pythonPackages: - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage - type: array - 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. - 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. - npmPackages: - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage - 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. - type: array - description: >- - Artifacts produced by a build that should be uploaded upon successful - completion of all build steps. + hint: + description: DSSEHint hints at the purpose of the attestation authority. + $ref: '#/components/schemas/DSSEHint' type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts - NonCompliantFile: + id: DSSEAttestationNote + SlsaProvenanceZeroTwo: 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'. - id: NonCompliantFile + description: See full explanation of fields at slsa.dev/provenance/v0.2. properties: - displayCommand: - description: Command to display the non-compliant files. - type: string - reason: - type: string - description: Explains why a file is non compliant for a CIS check. - path: + buildType: type: string - description: Empty if `display_command` is set. - Occurrence: - type: object - description: An instance of an analysis type that has been found on a resource. - id: Occurrence + invocation: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation' + materials: + type: array + items: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial' + buildConfig: + additionalProperties: + description: Properties of the object. + type: any + type: object + builder: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder' + metadata: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata' + id: SlsaProvenanceZeroTwo + Note: + id: Note properties: - vulnerability: - description: Describes a security vulnerability. - $ref: '#/components/schemas/VulnerabilityOccurrence' - updateTime: - description: Output only. The time this occurrence was last updated. - format: google-datetime + package: + $ref: '#/components/schemas/PackageNote' + description: A note describing a package hosted by various package managers. + vulnerabilityAssessment: + description: A note describing a vulnerability assessment. + $ref: '#/components/schemas/VulnerabilityAssessmentNote' + expirationTime: type: string - sbomReference: - description: Describes a specific SBOM reference occurrences. - $ref: '#/components/schemas/SBOMReferenceOccurrence' + description: Time of expiration for this note. Empty if note does not expire. + format: google-datetime + relatedNoteNames: + description: Other notes related to this note. + type: array + items: + type: string image: - $ref: '#/components/schemas/ImageOccurrence' - description: >- - Describes how this resource derives from the basis in the associated - note. - dsseAttestation: - description: Describes an attestation of an artifact using dsse. - $ref: '#/components/schemas/DSSEAttestationOccurrence' - noteName: + description: A note describing a base image. + $ref: '#/components/schemas/ImageNote' + name: 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. + Output only. The name of the note in the form of + `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. type: string - compliance: - description: Describes a compliance violation on a linked resource. - $ref: '#/components/schemas/ComplianceOccurrence' kind: description: >- - Output only. This explicitly denotes which of the occurrence details - are specified. This field can be used as a filter in list requests. + Output only. The type of analysis. This field can be used as a + filter in list requests. type: string enumDescriptions: - Default value. This value is unused. @@ -2784,741 +2358,430 @@ components: - DSSE_ATTESTATION - VULNERABILITY_ASSESSMENT - SBOM_REFERENCE + attestation: + description: A note describing an attestation role. + $ref: '#/components/schemas/AttestationNote' discovery: - description: Describes when a resource was discovered. - $ref: '#/components/schemas/DiscoveryOccurrence' - upgrade: - description: Describes an available package upgrade on the linked resource. - $ref: '#/components/schemas/UpgradeOccurrence' - build: - $ref: '#/components/schemas/BuildOccurrence' - description: Describes a verifiable build. - deployment: - description: Describes the deployment of an artifact on a runtime. - $ref: '#/components/schemas/DeploymentOccurrence' - resourceUri: + $ref: '#/components/schemas/DiscoveryNote' + description: A note describing the initial analysis of a resource. + shortDescription: 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. - attestation: - $ref: '#/components/schemas/AttestationOccurrence' - description: Describes an attestation of an artifact. - name: + description: A one sentence description of this note. + upgrade: + description: A note describing available package upgrades. + $ref: '#/components/schemas/UpgradeNote' + createTime: type: string description: >- - Output only. The name of the occurrence in the form of - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. - envelope: - $ref: '#/components/schemas/Envelope' - description: https://github.com/secure-systems-lab/dsse - createTime: - description: Output only. The time this occurrence was created. + Output only. The time this note was created. This field can be used + as a filter in list requests. format: google-datetime + vulnerability: + description: A note describing a package vulnerability. + $ref: '#/components/schemas/VulnerabilityNote' + compliance: + description: A note describing a compliance check. + $ref: '#/components/schemas/ComplianceNote' + updateTime: type: string - remediation: - type: string - description: A description of actions that can be taken to remedy the note. - package: - $ref: '#/components/schemas/PackageOccurrence' - description: Describes the installation of a package on the linked resource. - ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage - type: object - properties: - pushTiming: + format: google-datetime description: >- - Output only. Stores timing information for pushing the specified - artifact. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - readOnly: true - fileHashes: - description: Hash types and values of the Python Artifact. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes - uri: + Output only. The time this note was last updated. This field can be + used as a filter in list requests. + relatedUrl: + items: + $ref: '#/components/schemas/RelatedUrl' + description: URLs associated with this note. + type: array + sbomReference: + $ref: '#/components/schemas/SBOMReferenceNote' + description: A note describing an SBOM reference. + dsseAttestation: + $ref: '#/components/schemas/DSSEAttestationNote' + description: A note describing a dsse attestation note. + deployment: + description: A note describing something that can be deployed. + $ref: '#/components/schemas/DeploymentNote' + build: + $ref: '#/components/schemas/BuildNote' + description: A note describing build provenance for a verifiable build. + longDescription: + description: A detailed description of this note. type: string - description: URI of the uploaded artifact. - description: Artifact uploaded using the PythonPackage directive. - Policy: - id: Policy + description: A type of analysis that can be done for a resource. type: object + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo: 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/Binding' - version: - 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). - type: integer - etag: + detail: + type: string + description: Explains the failure issue in more detail using hard-coded text. + type: + 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 + 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. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo + type: object + description: A fatal problem encountered during the execution of the build. + EnvelopeSignature: + properties: + sig: 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. + keyid: + type: string + type: object + id: EnvelopeSignature + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption + 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/). - PackageIssue: + 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: - fileLocation: - items: - $ref: '#/components/schemas/GrafeasV1FileLocation' - description: The location at which this package was found. - type: array - affectedCpeUri: + name: type: string description: >- - Required. The [CPE URI](https://cpe.mitre.org/specification/) this - vulnerability was found in. - effectiveSeverity: + 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} + ProjectRepoId: + description: >- + 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 + properties: + projectId: + type: string + description: The ID of the project. + repoName: + description: The name of the repo. Leave empty for the default repo. + type: string + PackageOccurrence: + description: Details on how a particular software package was installed on a system. + type: object + id: PackageOccurrence + properties: + name: + description: Required. Output only. The name of the installed package. readOnly: true type: string + license: + $ref: '#/components/schemas/License' + description: Licenses that have been declared by the authors of the package. + architecture: enum: - - SEVERITY_UNSPECIFIED - - MINIMAL - - LOW - - MEDIUM - - HIGH - - CRITICAL + - ARCHITECTURE_UNSPECIFIED + - X86 + - X64 enumDescriptions: - - Unknown. - - Minimal severity. - - Low severity. - - Medium severity. - - High severity. - - Critical severity. - 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. - fixedVersion: - $ref: '#/components/schemas/Version' + - Unknown architecture. + - X86 architecture. + - X64 architecture. description: >- - Required. The version of the package this vulnerability was fixed - in. Setting this to VersionKind.MAXIMUM means no fix is yet - available. - affectedPackage: + Output only. The CPU architecture for which packages in this + distribution channel were built. Architecture will be blank for + language packages. type: string - description: Required. The package this vulnerability was found in. - affectedVersion: - $ref: '#/components/schemas/Version' - description: >- - Required. The version of the package that is installed on the - resource affected by this vulnerability. - fixedCpeUri: + readOnly: true + packageType: + readOnly: true 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: - type: boolean - description: Output only. Whether a fix is available for this package. - fixedPackage: + Output only. The type of package; whether native or non native + (e.g., ruby gems, node.js packages, etc.). + version: + $ref: '#/components/schemas/Version' + description: Output only. The version of the package. + readOnly: true + cpeUri: type: string + readOnly: true description: >- - The package this vulnerability was fixed in. It is possible for this - to be different from the affected_package. - packageType: - type: string - description: The type of package (e.g. OS, MAVEN, GO). - description: >- - A detail for a distro and package this vulnerability occurrence was - found in and its associated fix (if one is available). - type: object - id: PackageIssue - WindowsDetail: - id: WindowsDetail - properties: - name: - type: string - description: Required. The name of this vulnerability. - fixingKbs: + 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. + location: 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. - type: array + All of the places within the filesystem versions of this package + have been found. items: - $ref: '#/components/schemas/KnowledgeBase' - cpeUri: + $ref: '#/components/schemas/Location' + type: array + ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation: + type: object + id: ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation + description: Represents a storage location in Cloud Storage + properties: + bucket: description: >- - Required. The [CPE URI](https://cpe.mitre.org/specification/) this - vulnerability affects. + Cloud Storage bucket. See + https://cloud.google.com/storage/docs/naming#requirements type: string - description: + object: type: string - description: The description of this vulnerability. - type: object - DiscoveryNote: - properties: - 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: >- + Cloud Storage object. See + https://cloud.google.com/storage/docs/naming#objectnames + generation: type: string + format: int64 description: >- - Required. Immutable. The kind of analysis that is handled by this - discovery. + Cloud Storage generation for the object. If the generation is + omitted, the latest generation will be used. + BuildMetadata: + id: BuildMetadata type: object - 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. - id: DiscoveryNote - Product: properties: - id: + invocationId: + type: string + startedOn: + format: google-datetime + type: string + finishedOn: + type: string + format: google-datetime + ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource: + properties: + tagName: + description: >- + Regex matching tags to build. The syntax of the regular expressions + accepted is the syntax accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax + type: string + dir: type: string 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: + 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. type: string - description: Name of the product. - genericUri: + 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 + branchName: type: string description: >- - Contains a URI which is vendor-specific. Example: The artifact - repository URL of an image. + 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 + 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: + description: >- + Optional. Substitutions to use in a triggered build. Should only be + used with RunBuildTrigger + additionalProperties: + type: string + type: object + description: Location of the source in a Google Cloud Source Repository. type: object - description: >- - Product contains information about a product and how to uniquely - identify it. - id: Product - AnalysisCompleted: - description: >- - Indicates which analysis completed successfully. Multiple types of - analysis can be performed on a single resource. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource + ContaineranalysisGoogleDevtoolsCloudbuildV1Secret: type: object - id: AnalysisCompleted properties: - analysisType: - type: array - items: + kmsKeyName: + 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 + additionalProperties: type: string - Signature: + format: byte 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). - id: Signature + 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 + SlsaRecipe: type: object + id: SlsaRecipe properties: - signature: + entryPoint: type: string - format: byte 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. - publicKeyId: + 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. + 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 + type: type: string 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" - DeploymentNote: - id: DeploymentNote - type: object - properties: - resourceUri: - description: Required. Resource URI for the artifact being deployed. - type: array - items: - type: string - description: An artifact that can be deployed in some runtime. - DiscoveryOccurrence: - properties: - continuousAnalysis: - description: Whether the resource is continuously analyzed. - enumDescriptions: - - Unknown. - - The resource is continuously analyzed. - - The resource is ignored for continuous analysis. - type: string - enum: - - CONTINUOUS_ANALYSIS_UNSPECIFIED - - ACTIVE - - INACTIVE - analysisStatus: - description: The status of discovery for the resource. - enum: - - ANALYSIS_STATUS_UNSPECIFIED - - PENDING - - SCANNING - - FINISHED_SUCCESS - - COMPLETE - - FINISHED_FAILED - - FINISHED_UNSUPPORTED - 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. - type: string - archiveTime: - readOnly: true + URI indicating what type of recipe was performed. It determines the + meaning of recipe.entryPoint, recipe.arguments, recipe.environment, + and materials. + definedInMaterial: description: >- - Output only. The time occurrences related to this discovery - occurrence were archived. - format: google-datetime + 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 type: string - analysisStatusError: - $ref: '#/components/schemas/Status' + environment: 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. - lastScanTime: - description: The last time this resource was scanned. - type: string - format: google-datetime - sbomStatus: - description: The status of an SBOM generation. - $ref: '#/components/schemas/SBOMStatus' - cpe: - type: string - description: The CPE of the resource being scanned. - analysisCompleted: - $ref: '#/components/schemas/AnalysisCompleted' - analysisError: + 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: + description: Properties of the object. Contains field @type with type URL. + type: any + description: >- + Steps taken to build the artifact. For a TaskRun, typically each + container corresponds to one step in the recipe. + DeploymentNote: + description: An artifact that can be deployed in some runtime. + properties: + resourceUri: items: - $ref: '#/components/schemas/Status' + type: string type: array - description: >- - Indicates any errors encountered during analysis of a resource. - There could be 0 or more of these errors. - id: DiscoveryOccurrence - description: Provides information about the analysis status of a discovered resource. - type: object - DSSEAttestationOccurrence: - 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. - description: >- - Deprecated. Prefer to use a regular Occurrence, and populate the - Envelope at the top level of the Occurrence. - id: DSSEAttestationOccurrence + description: Required. Resource URI for the artifact being deployed. type: object - Location: + id: DeploymentNote + DSSEHint: type: object properties: - version: - $ref: '#/components/schemas/Version' - description: Deprecated. The version installed at this location. - cpeUri: + humanReadableName: description: >- - Deprecated. The CPE URI in [CPE - format](https://cpe.mitre.org/specification/) - type: string - path: + Required. The human readable name of this attestation authority, for + example "cloudbuild-prod". type: string - description: >- - The path from which we gathered that this package/version is - installed. - id: 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`. - ComplianceVersion: - id: ComplianceVersion + 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 + 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. properties: - cpeUri: - type: string - description: >- - The CPE URI (https://cpe.mitre.org/specification/) this benchmark is - applicable to. - version: + path: description: >- - The version of the benchmark. This is set to the version of the - OS-specific CIS document the benchmark is defined in. - type: string - benchmarkDocument: + 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: description: >- - The name of the document that defines this benchmark, e.g. "CIS - Container-Optimized OS". - description: >- - Describes the CIS benchmark version that is applicable to a given OS and - os version. - Remediation: - id: Remediation + 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 + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Volume + Detail: + type: object + id: Detail properties: - remediationType: + severityName: + description: The distro assigned severity of this vulnerability. type: string - description: The type of remediation that can be applied. - 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. - details: + fixedPackage: description: >- - Contains a comprehensive human-readable discussion of the - remediation. + 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 - remediationUri: - description: Contains the URL where to obtain the remediation. - $ref: '#/components/schemas/RelatedUrl' - type: object - description: >- - Specifies details on how to handle (and presumably, fix) a - vulnerability. - RepoId: - id: RepoId - description: A unique identifier for a Cloud Repo. - properties: - projectRepoId: - description: A combination of a project ID and a repo name. - $ref: '#/components/schemas/ProjectRepoId' - uid: - description: A server-assigned, globally unique identifier. + description: type: string - type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig: - properties: - approvalRequired: + description: A vendor-specific description of this vulnerability. + isObsolete: 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. + Whether this detail is obsolete. Occurrences are expected not to + point to obsolete details. type: boolean - type: object - description: ApprovalConfig describes configuration for manual approval of a build. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig - Artifact: - id: Artifact - type: object - properties: - names: - type: array + affectedPackage: + description: Required. The package this vulnerability affects. + type: string + affectedCpeUri: + 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. - items: - type: string - checksum: + Required. The [CPE URI](https://cpe.mitre.org/specification/) this + vulnerability affects. + vendor: + description: The name of the vendor of the product. type: string + fixedVersion: description: >- - Hash or checksum value of a binary, or Docker Registry 2.0 digest of - a container. - id: + 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' + fixedCpeUri: type: string - description: >- - Artifact ID, if any; for container images, this will be a URL by - digest like `gcr.io/projectID/imagename@sha256:123456`. - description: Artifact describes a build product. - ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource: - type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource - description: Location of the source in an archive file in Cloud Storage. - properties: - sourceFetcher: - enum: - - SOURCE_FETCHER_UNSPECIFIED - - GSUTIL - - GCS_FETCHER - 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: string - description: >- - Optional. Option to specify the tool to fetch the source file for - the build. - object: - type: string - 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. - bucket: - description: >- - Cloud Storage bucket containing the source (see [Bucket Name - Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). - type: string - generation: - format: int64 - description: >- - Optional. Cloud Storage generation for the object. If the generation - is omitted, the latest generation will be used. - type: string - ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret: - properties: - envMap: - additionalProperties: - format: byte - type: string - type: object - 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. - kmsKeyName: - type: string - description: >- - Resource name of Cloud KMS crypto key to decrypt the encrypted - value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/* - id: ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret - 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. - DSSEHint: - id: DSSEHint - type: object - properties: - humanReadableName: - type: string - description: >- - Required. The human readable name of this attestation authority, for - example "cloudbuild-prod". - 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. - ExportSBOMRequest: - description: >- - The request to generate and export SBOM. Target must be specified for - the request. - type: object - id: ExportSBOMRequest - properties: - cloudStorageLocation: - description: >- - Empty placeholder to denote that this is a Google Cloud Storage - export request. - $ref: '#/components/schemas/CloudStorageLocation' - CloudRepoSourceContext: - description: >- - A CloudRepoSourceContext denotes a particular revision in a Google Cloud - Source Repo. - type: object - id: CloudRepoSourceContext - properties: - aliasContext: - description: An alias, which may be a branch or tag. - $ref: '#/components/schemas/AliasContext' - revisionId: - description: A revision ID. - type: string - repoId: - description: The ID of the repo. - $ref: '#/components/schemas/RepoId' - Volume: - type: object - properties: - name: - description: >- - Name of the volume to mount. Volume names must be unique per build - step and must be valid names for Docker volumes. Each named volume - must be used by at least two build steps. - type: string - path: - 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. - id: Volume - 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 - AttestationNote: - id: AttestationNote - type: object - properties: - hint: - description: Hint hints at the purpose of the attestation authority. - $ref: '#/components/schemas/Hint' - 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. - Detail: - properties: - packageType: - type: string - description: >- - The type of package; whether native or non native (e.g., ruby gems, - node.js packages, etc.). - 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. + sourceUpdateTime: + format: google-datetime type: string - isObsolete: description: >- - Whether this detail is obsolete. Occurrences are expected not to - point to obsolete details. - type: boolean + 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. 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 @@ -3527,39 +2790,8 @@ components: 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' source: - type: string description: The source from which the information in this Detail was obtained. - affectedCpeUri: - type: string - description: >- - Required. The [CPE URI](https://cpe.mitre.org/specification/) this - vulnerability affects. - severityName: - type: string - description: The distro assigned severity of this vulnerability. - description: - type: string - description: A vendor-specific description of this vulnerability. - sourceUpdateTime: - type: string - 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. - 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 - affectedPackage: - type: string - description: Required. The package this vulnerability affects. - vendor: - description: The name of the vendor of the product. type: string affectedVersionEnd: description: >- @@ -3571,1057 +2803,1458 @@ components: provided by a vulnerability database, affected_version_start and affected_version_end will be the same in that Detail. $ref: '#/components/schemas/Version' - fixedVersion: - $ref: '#/components/schemas/Version' + packageType: 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. - type: object + The type of package; whether native or non native (e.g., ruby gems, + node.js packages, etc.). + type: string description: >- A detail for a distro and package affected by this vulnerability and its associated fix (if one is available). - id: Detail - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning: + ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects: properties: - 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 - enum: - - PRIORITY_UNSPECIFIED - - INFO - - WARNING - - ALERT - description: The priority for this warning. - type: string - text: - description: Explanation of the warning generated. + timing: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + readOnly: true + description: >- + Output only. Stores timing information for pushing all artifact + objects. + location: type: string - description: A non-fatal problem encountered during the execution of the build. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning + 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: + type: array + items: + type: string + description: Path globs used to match files in the build's workspace. type: object - GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial: description: >- - The collection of artifacts that influenced the build including sources, - dependencies, build tools, base images, and so on. + Files in the workspace to upload to Cloud Storage upon successful + completion of all build steps. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects + ContaineranalysisGoogleDevtoolsCloudbuildV1Hash: properties: - uri: + value: + description: The hash value. + format: byte type: string - digest: - additionalProperties: - type: string - type: object - type: object - id: GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial - BuildDefinition: - properties: - internalParameters: - additionalProperties: - description: Properties of the object. - type: any - type: object - resolvedDependencies: - items: - $ref: '#/components/schemas/ResourceDescriptor' - type: array - buildType: + type: + enum: + - NONE + - SHA256 + - MD5 + - SHA512 type: string - externalParameters: - type: object - additionalProperties: - description: Properties of the object. - type: any + description: The type of hash that was performed. + enumDescriptions: + - No hash requested. + - Use a sha256 hash. + - Use a md5 hash. + - Use a sha512 hash. + description: Container message for hash values. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Hash type: object - id: BuildDefinition - Jwt: + ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance: properties: - compactJwt: - type: string + resolvedConnectedRepository: 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 - type: object - id: Jwt - ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects: - description: >- - Files in the workspace to upload to Cloud Storage upon successful - completion of all build steps. - properties: - paths: - items: - type: string - description: Path globs used to match files in the build's workspace. - type: array - timing: + Output only. A copy of the build's `source.connected_repository`, if + exists, with any revisions resolved. readOnly: true $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - description: >- - Output only. Stores timing information for pushing all artifact - objects. - location: + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository + resolvedStorageSource: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource 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 - type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects - GetPolicyOptions: - description: Encapsulates settings provided to GetIamPolicy. - type: object - properties: - requestedPolicyVersion: - format: int32 - type: integer + A copy of the build's `source.storage_source`, if exists, with any + generations resolved. + resolvedRepoSource: 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 - SlsaProvenanceV1: - type: object - properties: - buildDefinition: - $ref: '#/components/schemas/BuildDefinition' - runDetails: - $ref: '#/components/schemas/RunDetails' - 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. - ListOccurrencesResponse: - id: ListOccurrencesResponse - description: Response for listing occurrences. - properties: - nextPageToken: - type: string + A copy of the build's `source.repo_source`, if exists, with any + revisions resolved. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource + resolvedGitSource: + readOnly: true + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource 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. - occurrences: - type: array - items: - $ref: '#/components/schemas/Occurrence' - description: The occurrences requested. - type: object - RelatedUrl: - type: object - id: RelatedUrl - description: Metadata for any related URL information. - properties: - url: - type: string - description: Specific URL associated with the resource. - label: - type: string - description: Label to describe usage of the URL. - SlsaProvenance: - properties: - recipe: - $ref: '#/components/schemas/SlsaRecipe' + Output only. A copy of the build's `source.git_source`, if exists, + with any revisions resolved. + resolvedStorageSourceManifest: 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: - $ref: '#/components/schemas/SlsaBuilder' - description: required - metadata: - $ref: '#/components/schemas/SlsaMetadata' - materials: - type: array - items: - $ref: '#/components/schemas/Material' + 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 + fileHashes: + additionalProperties: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes + readOnly: true + type: object 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. + 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. + description: >- + Provenance of the source. Ways to find the original source, or verify + that some source was used for this build. type: object - id: SlsaProvenance - ComplianceNote: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance + ProvenanceBuilder: + id: ProvenanceBuilder type: object properties: - scanInstructions: - type: string - description: Serialized scan instructions with a predefined format. - format: byte - cisBenchmark: - $ref: '#/components/schemas/CisBenchmark' - description: - type: string - description: A description about this compliance check. - title: - type: string - description: The title that identifies this compliance check. - rationale: - type: string - description: A rationale for the existence of this compliance check. - remediation: + id: type: string - description: A description of remediation steps if the compliance check fails. version: - description: The OS and config versions the benchmark applies to. + additionalProperties: + type: string + type: object + builderDependencies: items: - $ref: '#/components/schemas/ComplianceVersion' + $ref: '#/components/schemas/ResourceDescriptor' type: array - impact: - type: string - id: ComplianceNote - 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. - type: object - id: SBOMReferenceOccurrence + ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage: properties: - payloadType: + packagePath: + type: string + description: Path to the package.json. e.g. workspace/path/to/package + repository: 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: - description: The actual payload that contains the SBOM reference data. - $ref: '#/components/schemas/SbomReferenceIntotoPayload' - signatures: - description: The signatures over the payload. - items: - $ref: '#/components/schemas/EnvelopeSignature' - type: array - BuilderConfig: - id: BuilderConfig + 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. + description: >- + Npm package to upload to Artifact Registry upon successful completion of + all build steps. type: object + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage + DiscoveryOccurrence: + id: DiscoveryOccurrence properties: - id: + sbomStatus: + $ref: '#/components/schemas/SBOMStatus' + description: The status of an SBOM generation. + lastScanTime: type: string - ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig: - properties: - gitRepositoryLink: + format: google-datetime + description: The last time this resource was scanned. + cpe: type: string - description: >- - Required. The Developer Connect Git repository link, formatted as - `projects/*/locations/*/connections/*/gitRepositoryLink/*`. - revision: + description: The CPE of the resource being scanned. + analysisStatus: + type: string + description: The status of discovery for the resource. + 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. + enum: + - ANALYSIS_STATUS_UNSPECIFIED + - PENDING + - SCANNING + - FINISHED_SUCCESS + - COMPLETE + - FINISHED_FAILED + - FINISHED_UNSUPPORTED + continuousAnalysis: + enumDescriptions: + - Unknown. + - The resource is continuously analyzed. + - The resource is ignored for continuous analysis. type: string + description: Whether the resource is continuously analyzed. + enum: + - CONTINUOUS_ANALYSIS_UNSPECIFIED + - ACTIVE + - INACTIVE + analysisError: description: >- - Required. The revision to fetch from the Git repository such as a - branch, a tag, a commit SHA, or any Git ref. - dir: + Indicates any errors encountered during analysis of a resource. + There could be 0 or more of these errors. + items: + $ref: '#/components/schemas/Status' + type: array + analysisStatusError: description: >- - Required. Directory, relative to the source root, in which to run - the build. + 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' + archiveTime: + format: google-datetime + readOnly: true + description: >- + Output only. The time occurrences related to this discovery + occurrence were archived. type: string - id: ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig + analysisCompleted: + $ref: '#/components/schemas/AnalysisCompleted' + type: object + description: Provides information about the analysis status of a discovered resource. + VexAssessment: + description: >- + VexAssessment provides all publisher provided Vex information that is + related to this vulnerability. + id: VexAssessment type: object - description: This config defines the location of a source through Developer Connect. - BatchCreateOccurrencesRequest: properties: - occurrences: + remediations: + description: >- + Specifies details on how to handle (and presumably, fix) a + vulnerability. + items: + $ref: '#/components/schemas/Remediation' + type: array + state: + description: Provides the state of this Vulnerability assessment. + 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. + enum: + - STATE_UNSPECIFIED + - AFFECTED + - NOT_AFFECTED + - FIXED + - UNDER_INVESTIGATION + impacts: type: array items: - $ref: '#/components/schemas/Occurrence' - description: Required. The occurrences to create. Max allowed length is 1000. - description: Request to create occurrences in batch. - type: object - id: BatchCreateOccurrencesRequest - ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage: - type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage - properties: - fileHashes: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes - description: Hash types and values of the npm package. - pushTiming: - readOnly: true - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + type: string description: >- - Output only. Stores timing information for pushing the specified - artifact. - uri: - description: URI of the uploaded npm package. + Contains information about the impact of this vulnerability, this + will change with time. + justification: + description: >- + Justification provides the justification when the state of the + assessment if NOT_AFFECTED. + $ref: '#/components/schemas/Justification' + cve: + 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 type: string - description: >- - An npm package uploaded to Artifact Registry using the NpmPackage - directive. - GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation: + vulnerabilityId: + type: string + description: >- + The vulnerability identifier for this Assessment. Will hold one of + common identifiers e.g. CVE, GHSA etc. + 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 + relatedUris: + description: >- + Holds a list of references associated with this vulnerability item + and assessment. + type: array + items: + $ref: '#/components/schemas/RelatedUrl' + ResourceDescriptor: type: object - id: GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation properties: - configSource: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource' - parameters: + annotations: type: object additionalProperties: - description: Properties of the object. type: any - environment: - type: object + uri: + type: string + downloadLocation: + type: string + content: + type: string + format: byte + mediaType: + type: string + digest: additionalProperties: - type: any - description: Properties of the object. - description: Identifies the event that kicked off the build. - ContaineranalysisGoogleDevtoolsCloudbuildV1Source: + type: string + type: object + name: + type: string + id: ResourceDescriptor + ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource: + description: Location of the source in an archive file in Cloud Storage. + type: object properties: - storageSource: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource - description: If provided, get the source from this location in Cloud Storage. - repoSource: + object: description: >- - If provided, get the source from this location in a Cloud Source - Repository. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource - gitSource: - description: If provided, get the source from this Git repository. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource - connectedRepository: + 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 + sourceFetcher: + type: string + 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. description: >- - Optional. If provided, get the source from this 2nd-gen Google Cloud - Build repository resource. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository - developerConnectConfig: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig - description: If provided, get the source from this Developer Connect config. - storageSourceManifest: + Optional. Option to specify the tool to fetch the source file for + the build. + enum: + - SOURCE_FETCHER_UNSPECIFIED + - GSUTIL + - GCS_FETCHER + generation: + type: string + format: int64 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 + Optional. Cloud Storage generation for the object. If the generation + is omitted, the latest generation will be used. + bucket: + description: >- + Cloud Storage bucket containing the source (see [Bucket Name + Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). + type: string + id: ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource + SlsaMetadata: + id: SlsaMetadata type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Source - description: Location of the source in a supported storage service. - CVSSv3: - id: CVSSv3 properties: - baseScore: - format: float - type: number - description: The base score is a function of the base metric scores. - userInteraction: - enum: - - USER_INTERACTION_UNSPECIFIED - - USER_INTERACTION_NONE - - USER_INTERACTION_REQUIRED + buildStartedOn: + format: google-datetime + description: The timestamp of when the build started. type: string - enumDescriptions: - - '' - - '' - - '' - attackComplexity: - enum: - - ATTACK_COMPLEXITY_UNSPECIFIED - - ATTACK_COMPLEXITY_LOW - - ATTACK_COMPLEXITY_HIGH + 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 - enumDescriptions: - - '' - - '' - - '' - integrityImpact: + format: google-datetime + description: The timestamp of when the build completed. + 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 - enum: - - IMPACT_UNSPECIFIED - - IMPACT_HIGH - - IMPACT_LOW - - IMPACT_NONE - enumDescriptions: - - '' - - '' - - '' - - '' - confidentialityImpact: - enumDescriptions: - - '' - - '' - - '' - - '' + completeness: + description: >- + Indicates that the builder claims certain fields in this message to + be complete. + $ref: '#/components/schemas/SlsaCompleteness' + description: Other properties of the build. + Layer: + id: Layer + properties: + directive: + description: >- + Required. The recovered Dockerfile directive used to construct this + layer. See https://docs.docker.com/engine/reference/builder/ for + more information. type: string - enum: - - IMPACT_UNSPECIFIED - - IMPACT_HIGH - - IMPACT_LOW - - IMPACT_NONE - availabilityImpact: - enum: - - IMPACT_UNSPECIFIED - - IMPACT_HIGH - - IMPACT_LOW - - IMPACT_NONE - enumDescriptions: - - '' - - '' - - '' - - '' + arguments: type: string - impactScore: - type: number - format: float - exploitabilityScore: - format: float - type: number - privilegesRequired: + description: The recovered arguments to the Dockerfile directive. + type: object + description: Layer holds metadata specific to a layer of a Docker image. + Command: + description: Command describes a step performed as part of the build pipeline. + properties: + id: + description: >- + Optional unique identifier for this command, used in wait_for to + reference this command as a dependency. type: string - enumDescriptions: - - '' - - '' - - '' - - '' - enum: - - PRIVILEGES_REQUIRED_UNSPECIFIED - - PRIVILEGES_REQUIRED_NONE - - PRIVILEGES_REQUIRED_LOW - - PRIVILEGES_REQUIRED_HIGH - attackVector: + args: + items: + type: string + type: array + description: Command-line arguments used when executing this command. + env: + description: Environment variables set before running this command. + type: array + items: + type: string + waitFor: + items: + type: string + description: The ID(s) of the command(s) that this command depends on. + type: array + dir: description: >- - Base Metrics Represents the intrinsic characteristics of a - vulnerability that are constant over time and across user - environments. - enumDescriptions: - - '' - - '' - - '' - - '' - - '' + Working directory (relative to project source root) used when + running this command. type: string - enum: - - ATTACK_VECTOR_UNSPECIFIED - - ATTACK_VECTOR_NETWORK - - ATTACK_VECTOR_ADJACENT - - ATTACK_VECTOR_LOCAL - - ATTACK_VECTOR_PHYSICAL - scope: + name: type: string - enumDescriptions: - - '' - - '' - - '' - enum: - - SCOPE_UNSPECIFIED - - SCOPE_UNCHANGED - - SCOPE_CHANGED + 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: object - description: >- - Common Vulnerability Scoring System version 3. For details, see - https://www.first.org/cvss/specification-document - VulnerabilityOccurrence: - id: VulnerabilityOccurrence + id: Command + BuildStep: type: object properties: - vexAssessment: - $ref: '#/components/schemas/VexAssessment' - longDescription: - type: string - description: Output only. A detailed description of this vulnerability. - cvssScore: + pullTiming: + $ref: '#/components/schemas/TimeSpan' 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: + Output only. Stores timing information for pulling this build step's + builder image only. + exitCode: + format: int32 + description: Output only. Return code from running the step. + type: integer + allowExitCodes: + type: array + items: + format: int32 + type: integer description: >- - The type of package; whether native or non native (e.g., ruby gems, - node.js packages, etc.). - type: string - cvssv3: - $ref: '#/components/schemas/CVSS' - description: The cvss v3 score for the vulnerability. - extraDetails: - description: Occurrence-specific extra details about the vulnerability. - type: string - severity: - type: string - enumDescriptions: - - Unknown. - - Minimal severity. - - Low severity. - - Medium severity. - - High severity. - - Critical severity. - enum: - - SEVERITY_UNSPECIFIED - - MINIMAL - - LOW - - MEDIUM - - HIGH - - CRITICAL + 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. + volumes: + type: array description: >- - Output only. The note provider assigned severity of this - vulnerability. - fixAvailable: + 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' + env: description: >- - Output only. Whether at least one of the affected packages has a fix - available. + A list of environment variable definitions to be used when running a + step. The elements are of the form "KEY=VALUE" for the environment + variable "KEY" being given the value "VALUE". + items: + type: string + type: array + 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 - cvssV2: - description: The cvss v2 score for the vulnerability. - $ref: '#/components/schemas/CVSS' - effectiveSeverity: + name: 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. + 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 - enum: - - SEVERITY_UNSPECIFIED - - MINIMAL - - LOW - - MEDIUM - - HIGH - - CRITICAL - enumDescriptions: - - Unknown. - - Minimal severity. - - Low severity. - - Medium severity. - - High severity. - - Critical severity. - cvssVersion: + status: type: string enum: - - CVSS_VERSION_UNSPECIFIED - - CVSS_VERSION_2 - - CVSS_VERSION_3 - description: Output only. CVSS version used to populate cvss_score and severity. + - STATUS_UNKNOWN + - PENDING + - QUEUING + - QUEUED + - WORKING + - SUCCESS + - FAILURE + - INTERNAL_ERROR + - TIMEOUT + - CANCELLED + - EXPIRED enumDescriptions: - - '' - - '' - - '' - relatedUrls: - description: Output only. URLs related to this vulnerability. + - 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. + id: + description: >- + Unique identifier for this build step, used in `wait_for` to + reference this build step as a dependency. + type: string + timing: + $ref: '#/components/schemas/TimeSpan' + description: >- + Output only. Stores timing information for executing this build + step. + 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 + waitFor: items: - $ref: '#/components/schemas/RelatedUrl' - type: array - packageIssue: + type: string description: >- - Required. The set of affected locations and their fixes (if - available) within the associated resource. + 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 + secretEnv: type: array items: - $ref: '#/components/schemas/PackageIssue' - shortDescription: + 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`. + args: + 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. + type: array + dir: type: string - description: Output only. A one sentence description of this vulnerability. - description: An occurrence of a severity vulnerability on a resource. - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo: - properties: - detail: + 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. + script: type: string - description: Explains the failure issue in more detail using hard-coded text. - type: - enum: - - FAILURE_TYPE_UNSPECIFIED - - PUSH_FAILED - - PUSH_IMAGE_NOT_FOUND - - PUSH_NOT_AUTHORIZED - - LOGGING_FAILURE - - USER_BUILD_STEP - - FETCH_SOURCE_FAILED + description: >- + A shell script to be executed in the step. When script is provided, + the user cannot specify the entrypoint or args. + entrypoint: type: string - 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. + description: >- + Entrypoint to be used instead of the build step image's default + entrypoint. If unset, the image's default entrypoint is used. + 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. + id: BuildStep + description: 'A step in the build pipeline. Next ID: 21' + ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo - description: A fatal problem encountered during the execution of the build. - Hash: - id: Hash + description: >- + Container message for hashes of byte content of files, used in + SourceProvenance messages to verify integrity of source input to the + build. properties: - value: - type: string - format: byte - description: Required. The hash value. - type: - description: Required. The type of hash that was performed, e.g. "SHA-256". + fileHash: + description: Collection of file hashes. + type: array + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Hash + GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder: + id: GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder + properties: + id: type: string - description: Container message for hash values. - type: object - Expr: type: object - id: Expr + description: >- + Identifies the entity that executed the recipe, which is trusted to have + correctly performed the operation and populated this provenance. + SBOMStatus: + id: SBOMStatus 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. - 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 - expression: + sbomState: + enum: + - SBOM_STATE_UNSPECIFIED + - PENDING + - COMPLETE + enumDescriptions: + - Default unknown state. + - SBOM scanning is pending. + - SBOM scanning has completed. type: string + description: The progress of the SBOM generation. + error: description: >- - Textual representation of an expression in Common Expression - Language syntax. - 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. + If there was an error generating an SBOM, this will indicate what + that error was. 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. - WindowsUpdate: - id: WindowsUpdate type: object + description: The status of an SBOM generation. + GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness: + id: GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness 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. + Indicates that the builder claims certain fields in this message to be + complete. + type: object properties: - description: - description: The localized description of the update. - type: string - title: - description: The localized title of the update. - type: string - supportUrl: - description: The hyperlink to the support information for the update. + parameters: + type: boolean + materials: + type: boolean + environment: + type: boolean + BuildDefinition: + properties: + internalParameters: + additionalProperties: + description: Properties of the object. + type: any + type: object + externalParameters: + additionalProperties: + type: any + description: Properties of the object. + type: object + buildType: type: string - categories: - items: - $ref: '#/components/schemas/Category' - description: The list of categories to which the update belongs. + resolvedDependencies: type: array - identity: - $ref: '#/components/schemas/Identity' - description: Required - The unique identifier for the update. - lastPublishedTimestamp: - description: The last published timestamp of the update. - type: string - format: google-datetime - kbArticleIds: - description: >- - The Microsoft Knowledge Base article IDs that are associated with - the update. items: - type: string - type: array - PackageOccurrence: + $ref: '#/components/schemas/ResourceDescriptor' + type: object + id: BuildDefinition + Remediation: + description: >- + Specifies details on how to handle (and presumably, fix) a + vulnerability. type: object - description: Details on how a particular software package was installed on a system. properties: - packageType: + details: type: string - readOnly: true description: >- - Output only. The type of package; whether native or non native - (e.g., ruby gems, node.js packages, etc.). - version: - description: Output only. The version of the package. - readOnly: true - $ref: '#/components/schemas/Version' - name: - description: Required. Output only. The name of the installed package. - readOnly: true + Contains a comprehensive human-readable discussion of the + remediation. + remediationUri: + $ref: '#/components/schemas/RelatedUrl' + description: Contains the URL where to obtain the remediation. + remediationType: + description: The type of remediation that can be applied. + enum: + - REMEDIATION_TYPE_UNSPECIFIED + - MITIGATION + - NO_FIX_PLANNED + - NONE_AVAILABLE + - VENDOR_FIX + - WORKAROUND type: string - cpeUri: + enumDescriptions: + - No remediation type specified. + - A MITIGATION is available. + - No fix is planned. + - Not available. + - A vendor fix is available. + - A workaround is available. + id: Remediation + ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact: + type: object + description: A Maven artifact uploaded using the MavenArtifact directive. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact + properties: + uri: + description: URI of the uploaded artifact. type: string - 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. + fileHashes: + description: Hash types and values of the Maven Artifact. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes + pushTiming: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan readOnly: true - license: - $ref: '#/components/schemas/License' - description: Licenses that have been declared by the authors of the package. - location: - items: - $ref: '#/components/schemas/Location' description: >- - All of the places within the filesystem versions of this package - have been found. - type: array - architecture: + Output only. Stores timing information for pushing the specified + artifact. + ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage: + properties: + repository: description: >- - 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. - enum: - - ARCHITECTURE_UNSPECIFIED - - X86 - - X64 + 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 - readOnly: true - id: PackageOccurrence - Identity: - description: The unique identifier of the update. + paths: + 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 + items: + type: string + 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 - id: Identity - properties: - revision: - type: integer - format: int32 - description: The revision number of the update. - updateId: - description: The revision independent identifier of the update. - type: string - FileHashes: - id: FileHashes + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage + ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets: 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. properties: - fileHash: + secretManager: items: - $ref: '#/components/schemas/Hash' - description: Required. Collection of file hashes. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret type: array - SlsaRecipe: - id: SlsaRecipe + description: >- + Secrets in Secret Manager and associated secret environment + variable. + inline: + description: >- + Secrets encrypted with KMS key and the associated secret environment + variable. + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret + type: array + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets + description: Secrets and secret environment variables. + SBOMReferenceNote: + type: object properties: - entryPoint: - type: string + version: 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: + The version of the format that the SBOM takes. E.g. if the format is + spdx, the version may be 2.3. + type: string + format: + description: The format that SBOM takes. E.g. may be spdx, cyclonedx, etc... type: string + description: The note representing an SBOM reference. + id: SBOMReferenceNote + ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig: + type: object + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig + description: ApprovalConfig describes configuration for manual approval of a build. + properties: + approvalRequired: 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. + 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 + 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: + version: + $ref: '#/components/schemas/Version' + description: Deprecated. The version installed at this location. + path: + type: string 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. - definedInMaterial: - format: int64 + The path from which we gathered that this package/version is + installed. + cpeUri: 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. - 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. + Deprecated. The CPE URI in [CPE + format](https://cpe.mitre.org/specification/) type: object - description: >- - Steps taken to build the artifact. For a TaskRun, typically each - container corresponds to one step in the recipe. - ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage: - description: An image built by the pipeline. + id: Location + BatchCreateOccurrencesResponse: + id: BatchCreateOccurrencesResponse + description: Response for creating occurrences in batch. + type: object + properties: + occurrences: + type: array + items: + $ref: '#/components/schemas/Occurrence' + description: The occurrences that were created. + Subject: + id: Subject type: object properties: - name: - type: string - description: >- - Name used to push the container image to Google Container Registry, - as presented to `docker push`. - pushTiming: - description: >- - Output only. Stores timing information for pushing the specified - image. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - readOnly: true digest: - description: Docker Registry 2.0 digest. + type: object + 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 + name: type: string - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage - UpgradeNote: + ComplianceOccurrence: + type: object properties: - package: - type: string - description: Required for non-Windows OS. The package this Upgrade is for. - distributions: + nonCompliantFiles: type: array - description: Metadata about the upgrade for each specific operating system. items: - $ref: '#/components/schemas/UpgradeDistribution' - windowsUpdate: - $ref: '#/components/schemas/WindowsUpdate' - description: >- - Required for Windows OS. Represents the metadata about the Windows - update. + $ref: '#/components/schemas/NonCompliantFile' version: - description: >- - Required for non-Windows OS. The version of the package in machine + - human readable form. - $ref: '#/components/schemas/Version' + $ref: '#/components/schemas/ComplianceVersion' + description: The OS and config version the benchmark was run on. + nonComplianceReason: + type: string + id: ComplianceOccurrence + description: >- + An indication that the compliance checks in the associated + ComplianceNote were not satisfied for particular resources or a + specified reason. + ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact type: object 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. - id: UpgradeNote - ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource: + A Maven artifact to upload to Artifact Registry upon successful + completion of all build steps. properties: - branchName: + groupId: + 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 + Maven `groupId` value used when uploading the artifact to Artifact + Registry. + repository: + 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. type: string - repoName: + 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 - description: Required. Name of the Cloud Source Repository. - tagName: + artifactId: 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 - 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. + Maven `artifactId` value used when uploading the artifact to + Artifact Registry. + version: type: string - invertRegex: - type: boolean description: >- - Optional. Only trigger a build if the revision regex does NOT match - the revision regex. - substitutions: - additionalProperties: - type: string - type: object + Maven `version` value used when uploading the artifact to Artifact + Registry. + SlsaCompleteness: + properties: + environment: description: >- - Optional. Substitutions to use in a triggered build. Should only be - used with RunBuildTrigger - projectId: - type: string + If true, the builder claims that recipe.environment is claimed to be + complete. + type: boolean + materials: + type: boolean description: >- - Optional. ID of the project that owns the Cloud Source Repository. - If omitted, the project ID requesting the build is assumed. - commitSha: - description: Explicit commit SHA to build. - type: string - id: ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource + If true, the builder claims that materials are complete, usually + through some controls to prevent network access. Sometimes called + "hermetic". + 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. type: object - description: Location of the source in a Google Cloud Source Repository. - CVSS: + description: >- + Indicates that the builder claims certain fields in this message to be + complete. + id: SlsaCompleteness + SlsaProvenanceV1: type: object + id: SlsaProvenanceV1 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. + 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: - exploitabilityScore: - format: float - type: number - scope: - enumDescriptions: - - '' - - '' - - '' + runDetails: + $ref: '#/components/schemas/RunDetails' + buildDefinition: + $ref: '#/components/schemas/BuildDefinition' + ContaineranalysisGoogleDevtoolsCloudbuildV1Source: + type: object + description: Location of the source in a supported storage service. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Source + properties: + gitSource: + description: If provided, get the source from this Git repository. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource + repoSource: + description: >- + If provided, get the source from this location in a Cloud Source + Repository. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource + 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. + storageSourceManifest: + 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 + developerConnectConfig: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig + description: If provided, get the source from this Developer Connect config. + 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. + id: WindowsUpdate + type: object + 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. + categories: + type: array + description: The list of categories to which the update belongs. + items: + $ref: '#/components/schemas/Category' + description: + description: The localized description of the update. + type: string + supportUrl: + type: string + description: The hyperlink to the support information for the update. + lastPublishedTimestamp: + type: string + description: The last published timestamp of the update. + format: google-datetime + title: + type: string + description: The localized title of the update. + RunDetails: + type: object + id: RunDetails + properties: + byproducts: + items: + $ref: '#/components/schemas/ResourceDescriptor' + type: array + builder: + $ref: '#/components/schemas/ProvenanceBuilder' + metadata: + $ref: '#/components/schemas/BuildMetadata' + License: + properties: + comments: + description: Comments + type: string + expression: + 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". + description: License information. + id: License + type: object + Occurrence: + type: object + properties: + createTime: + format: google-datetime + type: string + description: Output only. The time this occurrence was created. + vulnerability: + $ref: '#/components/schemas/VulnerabilityOccurrence' + description: Describes a security vulnerability. + 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. + remediation: + description: A description of actions that can be taken to remedy the note. + type: string + image: + $ref: '#/components/schemas/ImageOccurrence' + description: >- + Describes how this resource derives from the basis in the associated + note. + discovery: + $ref: '#/components/schemas/DiscoveryOccurrence' + description: Describes when a resource was discovered. + updateTime: + description: Output only. The time this occurrence was last updated. + type: string + format: google-datetime + dsseAttestation: + description: Describes an attestation of an artifact using dsse. + $ref: '#/components/schemas/DSSEAttestationOccurrence' + name: + type: string + description: >- + Output only. The name of the occurrence in the form of + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. + deployment: + $ref: '#/components/schemas/DeploymentOccurrence' + description: Describes the deployment of an artifact on a runtime. + 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 + attestation: + description: Describes an attestation of an artifact. + $ref: '#/components/schemas/AttestationOccurrence' + 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. + 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. + enum: + - NOTE_KIND_UNSPECIFIED + - VULNERABILITY + - BUILD + - IMAGE + - PACKAGE + - DEPLOYMENT + - DISCOVERY + - ATTESTATION + - UPGRADE + - COMPLIANCE + - DSSE_ATTESTATION + - VULNERABILITY_ASSESSMENT + - SBOM_REFERENCE + 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. + build: + $ref: '#/components/schemas/BuildOccurrence' + description: Describes a verifiable build. + envelope: + $ref: '#/components/schemas/Envelope' + description: https://github.com/secure-systems-lab/dsse + sbomReference: + description: Describes a specific SBOM reference occurrences. + $ref: '#/components/schemas/SBOMReferenceOccurrence' + description: An instance of an analysis type that has been found on a resource. + id: Occurrence + ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts + type: object + description: >- + Artifacts produced by a build that should be uploaded upon successful + completion of all build steps. + properties: + pythonPackages: + type: array + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage + 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. + images: + type: array + description: >- + A list of images to be pushed upon the successful completion of all + build steps. The images will be pushed using the builder service + account's credentials. The digests of the pushed images will be + stored in the Build resource's results field. If any of the images + fail to be pushed, the build is marked FAILURE. + items: + type: string + 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 + objects: + 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. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects + mavenArtifacts: + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact + type: array + 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. + GrafeasV1FileLocation: + description: Indicates the location at which a package was found. + type: object + id: GrafeasV1FileLocation + 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. + type: string + CVSSv3: + description: >- + Common Vulnerability Scoring System version 3. For details, see + https://www.first.org/cvss/specification-document + properties: + confidentialityImpact: type: string - enum: - - SCOPE_UNSPECIFIED - - SCOPE_UNCHANGED - - SCOPE_CHANGED - baseScore: - type: number - format: float - description: The base score is a function of the base metric scores. - impactScore: - type: number - format: float - availabilityImpact: enum: - IMPACT_UNSPECIFIED - IMPACT_HIGH - IMPACT_LOW - IMPACT_NONE - - IMPACT_PARTIAL - - IMPACT_COMPLETE - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - authentication: enumDescriptions: - '' - '' - '' - '' - enum: - - AUTHENTICATION_UNSPECIFIED - - AUTHENTICATION_MULTIPLE - - AUTHENTICATION_SINGLE - - AUTHENTICATION_NONE - type: string + exploitabilityScore: + type: number + format: float integrityImpact: - type: string enumDescriptions: - '' - '' - '' - '' - - '' - - '' + type: string enum: - IMPACT_UNSPECIFIED - IMPACT_HIGH - IMPACT_LOW - IMPACT_NONE - - IMPACT_PARTIAL - - IMPACT_COMPLETE - privilegesRequired: + userInteraction: + type: string enum: - - PRIVILEGES_REQUIRED_UNSPECIFIED - - PRIVILEGES_REQUIRED_NONE - - PRIVILEGES_REQUIRED_LOW - - PRIVILEGES_REQUIRED_HIGH + - USER_INTERACTION_UNSPECIFIED + - USER_INTERACTION_NONE + - USER_INTERACTION_REQUIRED enumDescriptions: - '' - '' - '' - - '' + attackComplexity: + enum: + - ATTACK_COMPLEXITY_UNSPECIFIED + - ATTACK_COMPLEXITY_LOW + - ATTACK_COMPLEXITY_HIGH type: string - attackVector: enumDescriptions: - '' - '' - '' - - '' - - '' - enum: - - ATTACK_VECTOR_UNSPECIFIED - - ATTACK_VECTOR_NETWORK - - ATTACK_VECTOR_ADJACENT - - ATTACK_VECTOR_LOCAL - - ATTACK_VECTOR_PHYSICAL - type: string - description: >- - Base Metrics Represents the intrinsic characteristics of a - vulnerability that are constant over time and across user - environments. - confidentialityImpact: + availabilityImpact: enum: - IMPACT_UNSPECIFIED - IMPACT_HIGH - IMPACT_LOW - IMPACT_NONE - - IMPACT_PARTIAL - - IMPACT_COMPLETE enumDescriptions: - '' - '' - '' - '' + type: string + impactScore: + format: float + type: number + privilegesRequired: + enumDescriptions: + - '' + - '' - '' - '' type: string - attackComplexity: - type: string + enum: + - PRIVILEGES_REQUIRED_UNSPECIFIED + - PRIVILEGES_REQUIRED_NONE + - PRIVILEGES_REQUIRED_LOW + - PRIVILEGES_REQUIRED_HIGH + attackVector: enumDescriptions: - '' - '' - '' - '' + - '' + type: string + description: >- + Base Metrics Represents the intrinsic characteristics of a + vulnerability that are constant over time and across user + environments. enum: - - ATTACK_COMPLEXITY_UNSPECIFIED - - ATTACK_COMPLEXITY_LOW - - ATTACK_COMPLEXITY_HIGH - - ATTACK_COMPLEXITY_MEDIUM - userInteraction: + - ATTACK_VECTOR_UNSPECIFIED + - ATTACK_VECTOR_NETWORK + - ATTACK_VECTOR_ADJACENT + - ATTACK_VECTOR_LOCAL + - ATTACK_VECTOR_PHYSICAL + baseScore: + type: number + description: The base score is a function of the base metric scores. + format: float + scope: type: string + enum: + - SCOPE_UNSPECIFIED + - SCOPE_UNCHANGED + - SCOPE_CHANGED enumDescriptions: - '' - '' - '' + type: object + id: CVSSv3 + PackageNote: + properties: + license: + description: Licenses that have been declared by the authors of the package. + $ref: '#/components/schemas/License' + maintainer: + description: A freeform text denoting the maintainer of this package. + type: string + digest: + items: + $ref: '#/components/schemas/Digest' + description: >- + Hash value, typically a file digest, that allows unique + identification a specific package. + type: array + description: + type: string + description: The description of this package. + version: + $ref: '#/components/schemas/Version' + description: The version of the package. + architecture: enum: - - USER_INTERACTION_UNSPECIFIED - - USER_INTERACTION_NONE - - USER_INTERACTION_REQUIRED - id: CVSS - ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource: + - ARCHITECTURE_UNSPECIFIED + - X86 + - X64 + type: string + description: >- + 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. + distribution: + items: + $ref: '#/components/schemas/Distribution' + type: array + description: Deprecated. The various channels by which a package is distributed. + cpeUri: + 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. + name: + type: string + description: Required. Immutable. The name of the package. + packageType: + description: >- + The type of package; whether native or non native (e.g., ruby gems, + node.js packages, etc.). + type: string + url: + description: The homepage for this package. + type: string + id: PackageNote type: object - description: Location of the source in any accessible Git repository. + description: PackageNote represents a particular package version. + Expr: + id: Expr + 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: + 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. + 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 + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval: + description: >- + BuildApproval describes a build's approval configuration, state, and + result. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval + properties: + config: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig + description: Output only. Configuration for manual approval of this build. + readOnly: true + state: + description: Output only. The state of this build's approval. + enum: + - STATE_UNSPECIFIED + - PENDING + - APPROVED + - REJECTED + - CANCELLED + type: string + 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. + result: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult + description: Output only. Result of manual approval for this Build. + readOnly: true + type: object + GitSourceContext: + type: object + properties: + revisionId: + description: Git commit hash. + type: string + url: + type: string + description: Git repository URL. + id: GitSourceContext + description: >- + A GitSourceContext denotes a particular revision in a third party Git + repository (e.g., GitHub). + ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource: properties: dir: description: >- @@ -4630,6 +4263,11 @@ components: specified and is an absolute path, this value is ignored for that step's execution. type: string + url: + 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 revision: type: string description: >- @@ -4640,493 +4278,777 @@ components: 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. + description: Location of the source in any accessible Git repository. + type: object id: ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource - GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata: - description: Other properties of the build. + GoogleDevtoolsContaineranalysisV1alpha1OperationMetadata: type: object + id: GoogleDevtoolsContaineranalysisV1alpha1OperationMetadata + description: >- + Metadata for all operations used and required for all operations that + created by Container Analysis Providers properties: - completeness: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness' - reproducible: - type: boolean - buildStartedOn: - format: google-datetime + createTime: type: string - buildFinishedOn: format: google-datetime + description: Output only. The time this operation was created. + endTime: type: string - buildInvocationId: - type: string - id: GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata - BatchCreateNotesResponse: - description: Response for creating notes in batch. + description: >- + Output only. The time that this operation was marked completed or + failed. + format: google-datetime + Completeness: properties: - notes: + arguments: + description: >- + If true, the builder claims that recipe.arguments is complete, + meaning that all external inputs are properly captured in the + recipe. + 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 + description: >- + If true, the builder claims that recipe.environment is claimed to be + complete. + id: Completeness + description: >- + Indicates that the builder claims certain fields in this message to be + complete. + type: object + ComplianceNote: + type: object + properties: + rationale: + type: string + description: A rationale for the existence of this compliance check. + description: + description: A description about this compliance check. + type: string + cisBenchmark: + $ref: '#/components/schemas/CisBenchmark' + remediation: + description: A description of remediation steps if the compliance check fails. + type: string + scanInstructions: + type: string + description: Serialized scan instructions with a predefined format. + format: byte + title: + type: string + description: The title that identifies this compliance check. + impact: + type: string + version: + description: The OS and config versions the benchmark applies to. items: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/ComplianceVersion' type: array - description: The notes that were created. - id: BatchCreateNotesResponse + id: ComplianceNote + Hint: type: object - SBOMReferenceNote: properties: - version: + humanReadableName: 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 - format: - description: The format that SBOM takes. E.g. may be spdx, cyclonedx, etc... + Required. The human readable name of this attestation authority, for + example "qa". type: string - description: The note representing an SBOM reference. - type: object - id: SBOMReferenceNote - ExportSBOMResponse: + 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 + 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. + ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret: properties: - discoveryOccurrence: + env: + 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. + type: string + versionName: 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. - id: ExportSBOMResponse - description: The response from a call to ExportSBOM. + Resource name of the SecretVersion. In format: + projects/*/secrets/*/versions/* type: object - BuildNote: - id: BuildNote + description: >- + Pairs a secret environment variable with a SecretVersion in Secret + Manager. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret + ListOccurrencesResponse: + description: Response for listing occurrences. + id: ListOccurrencesResponse type: object properties: - builderVersion: + 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 + occurrences: + items: + $ref: '#/components/schemas/Occurrence' + type: array + description: The occurrences requested. + TestIamPermissionsResponse: + properties: + permissions: description: >- - Required. Immutable. Version of the builder which produced this - build. - description: >- - Note holding the version of the provider's builder and the signature of - the provenance message in the build details occurrence. - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions: + A subset of `TestPermissionsRequest.permissions` that the caller is + allowed. + items: + type: string + type: array + description: Response message for `TestIamPermissions` method. type: object + id: TestIamPermissionsResponse + GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource: + id: GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource properties: - machineType: - enum: - - UNSPECIFIED - - N1_HIGHCPU_8 - - N1_HIGHCPU_32 - - E2_HIGHCPU_8 - - E2_HIGHCPU_32 - - E2_MEDIUM - description: Compute Engine machine type on which to run the build. + entryPoint: type: string - 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. - enumDeprecated: - - false - - true - - true - - false - - false - - false - automapSubstitutions: - type: boolean + digest: + type: object + additionalProperties: + 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. + SbomReferenceIntotoPayload: + type: object + id: SbomReferenceIntotoPayload + properties: + predicate: + $ref: '#/components/schemas/SbomReferenceIntotoPredicate' description: >- - Option to include built-in and custom substitutions as env variables - for all build steps. - volumes: + Additional parameters of the Predicate. Includes the actual data + about the SBOM. + subject: type: array 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. + Set of software artifacts that the attestation applies to. Each + element represents a single software artifact. items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Volume - dynamicSubstitutions: + $ref: '#/components/schemas/Subject' + 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. + Artifact: + description: Artifact describes a build product. + id: Artifact + properties: + id: 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 - secretEnv: + Artifact ID, if any; for container images, this will be a URL by + digest like `gcr.io/projectID/imagename@sha256:123456`. + type: string + checksum: + type: string 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 + Hash or checksum value of a binary, or Docker Registry 2.0 digest of + a container. + names: type: array - workerPool: - type: string - description: This field deprecated; please use `pool.name` instead. - deprecated: true - substitutionOption: 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. - 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. - type: string - enum: - - MUST_MATCH - - ALLOW_LOOSE - 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. - description: Option to define build log streaming behavior to Cloud Storage. - enum: - - STREAM_DEFAULT - - STREAM_ON - - STREAM_OFF + 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: object + SbomReferenceIntotoPredicate: + id: SbomReferenceIntotoPredicate + description: A predicate which describes the SBOM being referenced. + type: object + properties: + referrerId: + description: The person or system referring this predicate to the consumer. type: string - defaultLogsBucketBehavior: - description: Optional. Option to specify how default logs buckets are setup. + location: type: string - 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. - diskSizeGb: - 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. + description: The location of the SBOM. + digest: + description: A map of algorithm to digest of the contents of the SBOM. + type: object + additionalProperties: + type: string + mimeType: + description: The mime type of the SBOM. type: string - format: int64 - requestedVerifyOption: - enum: - - NOT_VERIFIED - - VERIFIED + Recipe: + description: >- + Steps taken to build the artifact. For a TaskRun, typically each + container corresponds to one step in the recipe. + type: object + properties: + type: type: string - description: Requested verifiability options. - enumDescriptions: - - Not a verifiable build (the default). - - Build must be verified. - 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. - sourceProvenanceHash: + URI indicating what type of recipe was performed. It determines the + meaning of recipe.entryPoint, recipe.arguments, recipe.environment, + and materials. + environment: items: - enumDescriptions: - - No hash requested. - - Use a sha256 hash. - - Use a md5 hash. - - Use a sha512 hash. - enum: - - NONE - - SHA256 - - MD5 - - SHA512 - type: string - description: Requested hash for SourceProvenance. + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object type: array - 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". + 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". + 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 + 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 + arguments: items: - type: string + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. type: array - logging: - enumDeprecated: - - false - - false - - false - - true - - false - - false description: >- - Option to specify the logging mode, which determines if and where - build logs are stored. + 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". + 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. + id: Recipe + WindowsDetail: + id: WindowsDetail + properties: + description: + type: string + description: The description of this vulnerability. + cpeUri: + type: string + description: >- + Required. The [CPE URI](https://cpe.mitre.org/specification/) this + vulnerability affects. + fixingKbs: + type: array + items: + $ref: '#/components/schemas/KnowledgeBase' + 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. + name: + description: Required. The name of this vulnerability. type: string - enum: - - LOGGING_UNSPECIFIED - - LEGACY - - GCS_ONLY - - STACKDRIVER_ONLY - - CLOUD_LOGGING_ONLY - - NONE - 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. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions - description: Optional arguments to enable specific features of builds. - ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage: + type: object + VulnerabilityAssessmentNote: + description: >- + A single VulnerabilityAssessmentNote represents one particular product's + vulnerability assessment for one CVE. + id: VulnerabilityAssessmentNote type: object properties: - repository: + shortDescription: + description: A one sentence description of this Vex. + type: string + assessment: + description: Represents a vulnerability assessment for the product. + $ref: '#/components/schemas/Assessment' + publisher: + description: Publisher details of this Note. + $ref: '#/components/schemas/Publisher' + product: + description: The product affected by this vex. + $ref: '#/components/schemas/Product' + languageCode: 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. - paths: + Identifies the language used by this document, corresponding to IETF + BCP 47 / RFC 5646. + title: + type: string + description: The title of the note. E.g. `Vex-Debian-11.4` + longDescription: + type: string + description: A detailed description of this Vex. + ContaineranalysisGoogleDevtoolsCloudbuildV1Results: + description: Artifacts created by the build pipeline. + properties: + images: + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage + description: Container images that were built as a part of the build. + type: array + buildStepOutputs: + items: + type: string + format: byte 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. + 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 + artifactTiming: + description: Time to push all non-container artifacts to Cloud Storage. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + numArtifacts: + format: int64 + description: >- + Number of non-container artifacts uploaded to Cloud Storage. Only + populated when artifacts are uploaded to Cloud Storage. + type: string + npmPackages: + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage + description: Npm packages uploaded to Artifact Registry at the end of the build. + type: array + artifactManifest: + 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. + buildStepImages: + description: >- + List of build step digests, in the order corresponding to build step + indices. type: array items: type: string - 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: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage - Justification: + pythonPackages: + type: array + description: >- + Python artifacts uploaded to Artifact Registry at the end of the + build. + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage + mavenArtifacts: + description: >- + Maven artifacts uploaded to Artifact Registry at the end of the + build. + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact + type: array + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Results + type: object + CVSS: + id: CVSS + type: object properties: - details: - description: Additional details on why this justification was chosen. + attackComplexity: + enum: + - ATTACK_COMPLEXITY_UNSPECIFIED + - ATTACK_COMPLEXITY_LOW + - ATTACK_COMPLEXITY_HIGH + - ATTACK_COMPLEXITY_MEDIUM type: string - justificationType: 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. - description: The justification type for this vulnerability. + - '' + - '' + - '' + - '' + scope: 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 + - SCOPE_UNSPECIFIED + - SCOPE_UNCHANGED + - SCOPE_CHANGED type: string - type: object - id: Justification - description: >- - Justification provides the justification when the state of the - assessment if NOT_AFFECTED. - 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". - type: object - id: InTotoStatement - properties: - slsaProvenance: - $ref: '#/components/schemas/SlsaProvenance' - provenance: - $ref: '#/components/schemas/InTotoProvenance' - _type: - description: Always `https://in-toto.io/Statement/v0.1`. + enumDescriptions: + - '' + - '' + - '' + attackVector: + 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 type: string - slsaProvenanceZeroTwo: - $ref: '#/components/schemas/SlsaProvenanceZeroTwo' - predicateType: - description: '`https://slsa.dev/provenance/v0.1` for SlsaProvenance.' + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + impactScore: + format: float + type: number + integrityImpact: + enum: + - IMPACT_UNSPECIFIED + - IMPACT_HIGH + - IMPACT_LOW + - IMPACT_NONE + - IMPACT_PARTIAL + - IMPACT_COMPLETE + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + privilegesRequired: + enum: + - PRIVILEGES_REQUIRED_UNSPECIFIED + - PRIVILEGES_REQUIRED_NONE + - PRIVILEGES_REQUIRED_LOW + - PRIVILEGES_REQUIRED_HIGH + enumDescriptions: + - '' + - '' + - '' + - '' + type: string + availabilityImpact: + enum: + - IMPACT_UNSPECIFIED + - IMPACT_HIGH + - IMPACT_LOW + - IMPACT_NONE + - IMPACT_PARTIAL + - IMPACT_COMPLETE + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + baseScore: + description: The base score is a function of the base metric scores. + format: float + type: number + userInteraction: + enumDescriptions: + - '' + - '' + - '' + type: string + enum: + - USER_INTERACTION_UNSPECIFIED + - USER_INTERACTION_NONE + - USER_INTERACTION_REQUIRED + exploitabilityScore: + format: float + type: number + confidentialityImpact: + enum: + - IMPACT_UNSPECIFIED + - IMPACT_HIGH + - IMPACT_LOW + - IMPACT_NONE + - IMPACT_PARTIAL + - IMPACT_COMPLETE + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + authentication: + enum: + - AUTHENTICATION_UNSPECIFIED + - AUTHENTICATION_MULTIPLE + - AUTHENTICATION_SINGLE + - AUTHENTICATION_NONE type: string - subject: - items: - $ref: '#/components/schemas/Subject' - type: array - Source: - id: Source - description: Source describes the location of the source used for the build. - type: object + enumDescriptions: + - '' + - '' + - '' + - '' + 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. + Signature: 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 - 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' + signature: 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: + 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 type: string + publicKeyId: description: >- - If provided, the input binary artifacts for the build came from this - location. - ListNotesResponse: - id: ListNotesResponse - type: object - properties: - notes: - items: - $ref: '#/components/schemas/Note' - 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. + 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: Response for listing notes. - GetIamPolicyRequest: + id: Signature type: object - id: GetIamPolicyRequest - description: Request message for `GetIamPolicy` method. + 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). + GetIamPolicyRequest: properties: options: description: >- OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. $ref: '#/components/schemas/GetPolicyOptions' - CisBenchmark: - description: A compliance check that is a CIS benchmark. - id: CisBenchmark - properties: - severity: - enumDescriptions: - - Unknown. - - Minimal severity. - - Low severity. - - Medium severity. - - High severity. - - Critical severity. - type: string - enum: - - SEVERITY_UNSPECIFIED - - MINIMAL - - LOW - - MEDIUM - - HIGH - - CRITICAL - profileLevel: - format: int32 - type: integer + id: GetIamPolicyRequest + description: Request message for `GetIamPolicy` method. type: object - SlsaProvenanceZeroTwo: + Binding: type: object - description: See full explanation of fields at slsa.dev/provenance/v0.2. - id: SlsaProvenanceZeroTwo + id: Binding properties: - invocation: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation' - materials: - items: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial' - type: array - buildType: + 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 - buildConfig: - additionalProperties: - type: any - description: Properties of the object. - type: object - metadata: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata' - builder: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder' - ProjectRepoId: + 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 + 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: + 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' + description: Associates `members`, or principals, with a `role`. + UpgradeNote: + 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. properties: - projectId: - description: The ID of the project. - type: string - repoName: + windowsUpdate: + description: >- + Required for Windows OS. Represents the metadata about the Windows + update. + $ref: '#/components/schemas/WindowsUpdate' + version: + description: >- + Required for non-Windows OS. The version of the package in machine + + human readable form. + $ref: '#/components/schemas/Version' + distributions: + type: array + description: Metadata about the upgrade for each specific operating system. + items: + $ref: '#/components/schemas/UpgradeDistribution' + package: type: string - description: The name of the repo. Leave empty for the default repo. - id: ProjectRepoId - type: object - description: >- - Selects a repo using a Google Cloud Platform project ID (e.g., - winged-cargo-31) and a repo name within that project. - VulnerabilityOccurrencesSummary: + description: Required for non-Windows OS. The package this Upgrade is for. type: object - id: VulnerabilityOccurrencesSummary + BuildOccurrence: properties: - counts: - type: array + provenanceBytes: + type: string description: >- - A listing by resource of the number of fixable and total - vulnerabilities. - items: - $ref: '#/components/schemas/FixableTotalByDigest' - description: >- - A summary of how many vulnerability occurrences there are per resource - and severity type. + 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. + provenance: + $ref: '#/components/schemas/BuildProvenance' + description: The actual provenance for the build. + 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' + 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. + $ref: '#/components/schemas/InTotoSlsaProvenanceV1' + description: Details of a build occurrence. + type: object + id: BuildOccurrence DeploymentOccurrence: - description: The period during which some deployable was active in a runtime. id: DeploymentOccurrence properties: + undeployTime: + type: string + description: End of the lifetime of this deployment. + format: google-datetime + deployTime: + format: google-datetime + type: string + description: Required. Beginning of the lifetime of this deployment. + config: + description: Configuration used to create this deployment. + type: string + userEmail: + type: string + description: Identity of the user that triggered this deployment. resourceUri: type: array description: >- @@ -5134,19 +5056,9 @@ components: the deployable field with the same name. items: type: string - userEmail: - type: string - description: Identity of the user that triggered this deployment. - undeployTime: - type: string - format: google-datetime - description: End of the lifetime of this deployment. - address: - type: string - description: Address of the runtime element hosting this deployment. platform: - type: string description: Platform hosting this deployment. + type: string enumDescriptions: - Unknown. - Google Container Engine. @@ -5157,237 +5069,330 @@ components: - GKE - FLEX - CUSTOM - deployTime: - description: Required. Beginning of the lifetime of this deployment. - format: google-datetime - type: string - config: + address: + description: Address of the runtime element hosting this deployment. type: string - description: Configuration used to create this deployment. - type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1Results: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Results + description: The period during which some deployable was active in a runtime. type: object + SBOMReferenceOccurrence: properties: - numArtifacts: - description: >- - Number of non-container artifacts uploaded to Cloud Storage. Only - populated when artifacts are uploaded to Cloud Storage. - format: int64 - type: string - buildStepOutputs: - type: array - 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. - images: - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage - type: array - description: Container images that were built as a part of the build. - buildStepImages: + payload: + $ref: '#/components/schemas/SbomReferenceIntotoPayload' + description: The actual payload that contains the SBOM reference data. + signatures: items: - type: string - description: >- - List of build step digests, in the order corresponding to build step - indices. - type: array - npmPackages: + $ref: '#/components/schemas/EnvelopeSignature' + description: The signatures over the payload. type: array - description: Npm packages uploaded to Artifact Registry at the end of the build. - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage - artifactManifest: + payloadType: description: >- - Path to the artifact manifest for non-container artifacts uploaded - to Cloud Storage. Only populated when artifacts are uploaded to - Cloud Storage. + 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'. type: string - mavenArtifacts: - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact - type: array - description: >- - Maven artifacts 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 - artifactTiming: - description: Time to push all non-container artifacts to Cloud Storage. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - description: Artifacts created by the build pipeline. - Metadata: type: object + id: 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. + GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation: + description: Identifies the event that kicked off the build. properties: - reproducible: - type: boolean - description: >- - If true, the builder claims that running the recipe on materials - will produce bit-for-bit identical output. - 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. - buildFinishedOn: - description: The timestamp of when the build completed. + parameters: + type: object + additionalProperties: + type: any + description: Properties of the object. + configSource: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource' + environment: + type: object + additionalProperties: + description: Properties of the object. + type: any + type: object + id: GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation + BuildProvenance: + id: BuildProvenance + properties: + createTime: format: google-datetime + description: Time at which the build was created. type: string - buildStartedOn: + endTime: type: string - description: The timestamp of when the build started. + description: Time at which execution of the build was finished. + format: google-datetime + startTime: + description: Time at which execution of the build was started. format: google-datetime - completeness: - description: >- - Indicates that the builder claims certain fields in this message to - be complete. - $ref: '#/components/schemas/Completeness' - id: Metadata - description: Other properties of the build. - PackageNote: - properties: - cpeUri: 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. - packageType: - description: >- - The type of package; whether native or non native (e.g., ruby gems, - node.js packages, etc.). + builderVersion: + description: Version string of the builder at the time this build was executed. type: string - license: - $ref: '#/components/schemas/License' - description: Licenses that have been declared by the authors of the package. - name: - description: Required. Immutable. The name of the package. + 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 - url: + projectId: + description: ID of the project. type: string - description: The homepage for this package. - maintainer: + builtArtifacts: + type: array + items: + $ref: '#/components/schemas/Artifact' + description: Output of the build. + id: type: string - description: A freeform text denoting the maintainer of this package. - architecture: + description: Required. Unique identifier of the build. + triggerId: type: string description: >- - The CPU architecture for which packages in this distribution channel - were built. Architecture will be blank for language packages. - enum: - - ARCHITECTURE_UNSPECIFIED - - X86 - - X64 - enumDescriptions: - - Unknown architecture. - - X86 architecture. - - X64 architecture. - digest: + Trigger identifier if the build was triggered automatically; empty + if not. + logsUri: + description: URI where any logs for this provenance were written. + type: string + commands: type: array items: - $ref: '#/components/schemas/Digest' + $ref: '#/components/schemas/Command' + description: Commands requested by the build. + buildOptions: + additionalProperties: + type: string description: >- - Hash value, typically a file digest, that allows unique - identification a specific package. - distribution: + Special options applied to this build. This is a catch-all field + where build providers can enter any desired additional details. + type: object + sourceProvenance: + $ref: '#/components/schemas/Source' + description: Details of the Source input to the build. + type: object + description: >- + Provenance of a build. Contains all information needed to verify the + full details about the build from source to completion. + BatchCreateNotesResponse: + type: object + description: Response for creating notes in batch. + properties: + notes: + description: The notes that were created. type: array items: - $ref: '#/components/schemas/Distribution' - description: Deprecated. The various channels by which a package is distributed. - description: - description: The description of this package. + $ref: '#/components/schemas/Note' + id: BatchCreateNotesResponse + BuilderConfig: + id: BuilderConfig + properties: + id: type: string - version: - description: The version of the package. - $ref: '#/components/schemas/Version' - description: PackageNote represents a particular package version. type: object - id: PackageNote - SlsaBuilder: + Hash: properties: - id: + type: + type: string + description: Required. The type of hash that was performed, e.g. "SHA-256". + value: + description: Required. The hash value. type: string + format: byte + id: Hash type: object - id: SlsaBuilder - Status: - id: Status + description: Container message for hash values. + AnalysisCompleted: + properties: + analysisType: + type: array + items: + type: string + type: object + id: AnalysisCompleted 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). + Indicates which analysis completed successfully. Multiple types of + analysis can be performed on a single resource. + ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage type: object properties: - code: - format: int32 - description: The status code, which should be an enum value of google.rpc.Code. + pushTiming: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + description: >- + Output only. Stores timing information for pushing the specified + image. + readOnly: true + digest: + description: Docker Registry 2.0 digest. + type: string + name: + description: >- + Name used to push the container image to Google Container Registry, + as presented to `docker push`. + type: string + description: An image built by the pipeline. + AttestationNote: + id: 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. + properties: + hint: + description: Hint hints at the purpose of the attestation authority. + $ref: '#/components/schemas/Hint' + type: object + 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 + NonCompliantFile: + properties: + displayCommand: + type: string + description: Command to display the non-compliant files. + path: + description: Empty if `display_command` is set. + type: string + reason: + type: string + description: Explains why a file is non compliant for a CIS check. + 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'. + SetIamPolicyRequest: + type: object + description: Request message for `SetIamPolicy` method. + id: SetIamPolicyRequest + 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/Policy' + Identity: + description: The unique identifier of the update. + properties: + revision: type: integer - details: + description: The revision number of the update. + format: int32 + updateId: + type: string + description: The revision independent identifier of the update. + type: object + id: Identity + Envelope: + description: >- + MUST match + https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. + An authenticated message of arbitrary type. + properties: + signatures: items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object + $ref: '#/components/schemas/EnvelopeSignature' 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: + payload: + format: byte 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. + payloadType: + type: string + id: Envelope + type: object + Justification: + id: Justification + properties: + details: + description: Additional details on why this justification was chosen. + type: string + justificationType: + 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. + type: string + 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 + description: >- + Justification provides the justification when the state of the + assessment if NOT_AFFECTED. + type: object parameters: - 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' 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 - 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 + type: boolean key: description: >- API key. Your API key identifies your project and provides you with API @@ -5397,21 +5402,28 @@ components: name: key 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 + callback: + description: JSONP in: query - name: $.xgafv + name: callback + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt schema: type: string enum: - - '1' - - '2' + - json + - media + - proto quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -5421,68 +5433,85 @@ components: name: quotaUser 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 - 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: + 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: [] + delete: [] occurrences: - id: containeranalysis.occurrences + id: google.containeranalysis.occurrences name: occurrences title: Occurrences methods: - _projects_locations_notes_occurrences_list: + _projects_locations_occurrences_list: operation: &ref_1 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}~1occurrences/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences/get response: &ref_2 mediaType: application/json openAPIDocKey: '200' objectKey: $.occurrences - projects_locations_notes_occurrences_list: + projects_locations_occurrences_list: operation: *ref_1 response: *ref_2 - _projects_locations_occurrences_list: + projects_locations_occurrences_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + _projects_locations_notes_occurrences_list: operation: &ref_3 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}~1occurrences/get response: &ref_4 mediaType: application/json openAPIDocKey: '200' objectKey: $.occurrences - projects_locations_occurrences_list: + projects_locations_notes_occurrences_list: operation: *ref_3 response: *ref_4 - projects_locations_occurrences_get: + projects_occurrences_create: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}/get + $ref: '#/paths/~1v1~1projects~1{projectsId}~1occurrences/post' response: mediaType: application/json openAPIDocKey: '200' - _projects_notes_occurrences_list: + _projects_occurrences_list: operation: &ref_5 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}~1occurrences/get + $ref: '#/paths/~1v1~1projects~1{projectsId}~1occurrences/get' response: &ref_6 mediaType: application/json openAPIDocKey: '200' objectKey: $.occurrences - projects_notes_occurrences_list: + projects_occurrences_list: operation: *ref_5 response: *ref_6 projects_occurrences_patch: @@ -5512,45 +5541,98 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_occurrences_list: + _projects_notes_occurrences_list: operation: &ref_7 - $ref: '#/paths/~1v1~1projects~1{projectsId}~1occurrences/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}~1occurrences/get response: &ref_8 mediaType: application/json openAPIDocKey: '200' objectKey: $.occurrences - projects_occurrences_list: + projects_notes_occurrences_list: operation: *ref_7 response: *ref_8 - projects_occurrences_create: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1occurrences/post' - response: - mediaType: application/json - openAPIDocKey: '200' 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_list - $ref: >- - #/components/x-stackQL-resources/occurrences/methods/projects_locations_occurrences_get + #/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_get - $ref: >- #/components/x-stackQL-resources/occurrences/methods/projects_occurrences_list insert: - $ref: >- #/components/x-stackQL-resources/occurrences/methods/projects_occurrences_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/occurrences/methods/projects_occurrences_patch 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_locations_occurrences_get_vulnerability_summary: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences:vulnerabilitySummary/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_occurrences_get_vulnerability_summary: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~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: [] + delete: [] + occurrences_notes: + id: google.containeranalysis.occurrences_notes + name: occurrences_notes + title: Occurrences_notes + methods: + projects_locations_occurrences_get_notes: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}~1notes/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_occurrences_get_notes: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}~1notes/get + 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: [] + delete: [] notes: - id: containeranalysis.notes + id: google.containeranalysis.notes name: notes title: Notes methods: @@ -5572,15 +5654,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_notes_batch_create: + projects_notes_patch: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes:batchCreate/post' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}/patch' response: mediaType: application/json openAPIDocKey: '200' - projects_notes_create: + projects_notes_delete: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes/post' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_notes_get: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}/get' response: mediaType: application/json openAPIDocKey: '200' @@ -5593,143 +5681,89 @@ components: objectKey: $.notes projects_notes_list: operation: *ref_11 - response: *ref_12 - projects_notes_get: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - projects_notes_delete: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - projects_notes_patch: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/notes/methods/projects_locations_notes_list - - $ref: >- - #/components/x-stackQL-resources/notes/methods/projects_locations_notes_get - - $ref: '#/components/x-stackQL-resources/notes/methods/projects_notes_list' - - $ref: '#/components/x-stackQL-resources/notes/methods/projects_notes_get' - insert: - - $ref: >- - #/components/x-stackQL-resources/notes/methods/projects_notes_create - update: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/notes/methods/projects_notes_delete - occurrences_vulnerability_summary: - id: containeranalysis.occurrences_vulnerability_summary - name: occurrences_vulnerability_summary - title: Occurrences_vulnerability_summary - methods: - projects_locations_occurrences_get_vulnerability_summary: + response: *ref_12 + projects_notes_create: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences:vulnerabilitySummary/get + $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes/post' response: mediaType: application/json openAPIDocKey: '200' - projects_occurrences_get_vulnerability_summary: + projects_notes_batch_create: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences:vulnerabilitySummary/get + $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes:batchCreate/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/occurrences_vulnerability_summary/methods/projects_locations_occurrences_get_vulnerability_summary + #/components/x-stackQL-resources/notes/methods/projects_locations_notes_get - $ref: >- - #/components/x-stackQL-resources/occurrences_vulnerability_summary/methods/projects_occurrences_get_vulnerability_summary - insert: [] - update: [] - delete: [] - occurrences_notes: - id: containeranalysis.occurrences_notes - name: occurrences_notes - title: Occurrences_notes + #/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/notes/methods/projects_notes_create + update: + - $ref: >- + #/components/x-stackQL-resources/notes/methods/projects_notes_patch + delete: + - $ref: >- + #/components/x-stackQL-resources/notes/methods/projects_notes_delete + occurrences_iam_policies: + id: google.containeranalysis.occurrences_iam_policies + name: occurrences_iam_policies + title: Occurrences_iam_policies methods: - projects_locations_occurrences_get_notes: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}~1notes/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_occurrences_get_notes: + projects_occurrences_set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}~1notes/get + #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}:setIamPolicy/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: [] - delete: [] - resources: - id: containeranalysis.resources - name: resources - title: Resources - methods: - projects_locations_resources_export_sbom: + projects_occurrences_test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1resources~1{resourcesId}:exportSBOM/post + #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - projects_resources_export_sbom: - operation: + _projects_occurrences_get_iam_policy: + operation: &ref_13 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1resources~1{resourcesId}:exportSBOM/post - response: + #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}:getIamPolicy/post + response: &ref_14 mediaType: application/json openAPIDocKey: '200' + objectKey: $.bindings + projects_occurrences_get_iam_policy: + operation: *ref_13 + response: *ref_14 sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/occurrences_iam_policies/methods/projects_occurrences_get_iam_policy insert: [] update: [] delete: [] notes_iam_policies: - id: containeranalysis.notes_iam_policies + id: google.containeranalysis.notes_iam_policies name: notes_iam_policies title: Notes_iam_policies methods: - projects_notes_set_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}:setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' _projects_notes_get_iam_policy: - operation: &ref_13 + operation: &ref_15 $ref: >- #/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}:getIamPolicy/post - response: &ref_14 + response: &ref_16 mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings projects_notes_get_iam_policy: - operation: *ref_13 - response: *ref_14 + operation: *ref_15 + response: *ref_16 projects_notes_test_iam_permissions: operation: $ref: >- @@ -5737,116 +5771,42 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/notes_iam_policies/methods/projects_notes_get_iam_policy - insert: [] - update: [] - delete: [] - occurrences_iam_policies: - id: containeranalysis.occurrences_iam_policies - name: occurrences_iam_policies - title: Occurrences_iam_policies - methods: - projects_occurrences_test_iam_permissions: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}:testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_occurrences_set_iam_policy: + projects_notes_set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - _projects_occurrences_get_iam_policy: - operation: &ref_15 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}:getIamPolicy/post - response: &ref_16 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - projects_occurrences_get_iam_policy: - operation: *ref_15 - response: *ref_16 sqlVerbs: select: - $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: [] delete: [] paths: - /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}/occurrences: + /v1/projects/{projectsId}/resources/{resourcesId}:exportSBOM: parameters: &ref_17 - - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/callback' - 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 - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $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 - - 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}/notes: - parameters: *ref_17 - get: - description: Lists notes for the specified project. - operationId: containeranalysis.projects.locations.notes.list + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/fields' + 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 @@ -5858,7 +5818,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListNotesResponse' + $ref: '#/components/schemas/ExportSBOMResponse' parameters: - in: path name: projectsId @@ -5866,28 +5826,20 @@ paths: schema: type: string - in: path - name: locationsId + name: resourcesId 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}/notes/{notesId}: + /v1/projects/{projectsId}/locations/{locationsId}/resources/{resourcesId}:exportSBOM: parameters: *ref_17 - get: - description: Gets the specified note. - operationId: containeranalysis.projects.locations.notes.get + post: + description: Generates an SBOM for the given resource. + operationId: containeranalysis.projects.locations.resources.exportSBOM + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExportSBOMRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5899,7 +5851,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/ExportSBOMResponse' parameters: - in: path name: projectsId @@ -5912,15 +5864,15 @@ paths: schema: type: string - in: path - name: notesId + name: resourcesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/occurrences:vulnerabilitySummary: + /v1/projects/{projectsId}/locations/{locationsId}/occurrences: parameters: *ref_17 get: - description: Gets a summary of the number and severity of occurrences. - operationId: containeranalysis.projects.locations.occurrences.getVulnerabilitySummary + description: Lists occurrences for the specified project. + operationId: containeranalysis.projects.locations.occurrences.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5932,7 +5884,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/VulnerabilityOccurrencesSummary' + $ref: '#/components/schemas/ListOccurrencesResponse' parameters: - in: path name: projectsId @@ -5948,11 +5900,20 @@ paths: name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/occurrences: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/occurrences:vulnerabilitySummary: parameters: *ref_17 - get: - description: Lists occurrences for the specified project. - operationId: containeranalysis.projects.locations.occurrences.list + 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 @@ -5964,7 +5925,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListOccurrencesResponse' + $ref: '#/components/schemas/VulnerabilityOccurrencesSummary' parameters: - in: path name: projectsId @@ -5980,22 +5941,11 @@ 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}/occurrences/{occurrencesId}/notes: + /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}: parameters: *ref_17 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 occurrence. + operationId: containeranalysis.projects.locations.occurrences.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6007,7 +5957,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/Occurrence' parameters: - in: path name: projectsId @@ -6024,11 +5974,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}: + /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}/notes: parameters: *ref_17 get: - description: Gets the specified occurrence. - operationId: containeranalysis.projects.locations.occurrences.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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6040,7 +5992,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Occurrence' + $ref: '#/components/schemas/Note' parameters: - in: path name: projectsId @@ -6057,16 +6009,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/resources/{resourcesId}:exportSBOM: + /v1/projects/{projectsId}/locations/{locationsId}/notes: parameters: *ref_17 - 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 notes for the specified project. + operationId: containeranalysis.projects.locations.notes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6078,7 +6025,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ExportSBOMResponse' + $ref: '#/components/schemas/ListNotesResponse' parameters: - in: path name: projectsId @@ -6090,21 +6037,24 @@ paths: required: true schema: type: string - - in: path - name: resourcesId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/resources/{resourcesId}:exportSBOM: + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}: parameters: *ref_17 - post: - description: Generates an SBOM for the given resource. - operationId: containeranalysis.projects.resources.exportSBOM - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ExportSBOMRequest' + get: + description: Gets the specified note. + operationId: containeranalysis.projects.locations.notes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6116,7 +6066,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ExportSBOMResponse' + $ref: '#/components/schemas/Note' parameters: - in: path name: projectsId @@ -6124,18 +6074,23 @@ paths: schema: type: string - in: path - name: resourcesId + 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}/occurrences: parameters: *ref_17 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 + operationId: containeranalysis.projects.locations.notes.occurrences.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6154,6 +6109,11 @@ paths: required: true schema: type: string + - in: path + name: locationsId + required: true + schema: + type: string - in: path name: notesId required: true @@ -6172,22 +6132,16 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/notes/{notesId}:setIamPolicy: + /v1/projects/{projectsId}/occurrences: parameters: *ref_17 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 + description: Creates a new occurrence. + operationId: containeranalysis.projects.occurrences.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + $ref: '#/components/schemas/Occurrence' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6199,28 +6153,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Occurrence' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: notesId - required: true - schema: - type: string - /v1/projects/{projectsId}/notes:batchCreate: - parameters: *ref_17 - post: - description: Creates new notes in batch. - operationId: containeranalysis.projects.notes.batchCreate - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BatchCreateNotesRequest' + get: + description: Lists occurrences for the specified project. + operationId: containeranalysis.projects.occurrences.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6232,29 +6174,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BatchCreateNotesResponse' + $ref: '#/components/schemas/ListOccurrencesResponse' parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/notes/{notesId}:getIamPolicy: + - 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}/occurrences/{occurrencesId}: parameters: *ref_17 - 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 + 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 @@ -6266,7 +6215,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Occurrence' parameters: - in: path name: projectsId @@ -6274,25 +6223,21 @@ paths: schema: type: string - in: path - name: notesId + name: occurrencesId required: true schema: type: string - /v1/projects/{projectsId}/notes/{notesId}:testIamPermissions: - parameters: *ref_17 - post: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + 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.occurrences.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6304,7 +6249,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -6312,20 +6257,13 @@ paths: schema: type: string - in: path - name: notesId + name: occurrencesId required: true schema: type: string - /v1/projects/{projectsId}/notes: - parameters: *ref_17 - post: - description: Creates a new note. - operationId: containeranalysis.projects.notes.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Note' + get: + description: Gets the specified occurrence. + operationId: containeranalysis.projects.occurrences.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6337,20 +6275,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/Occurrence' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: noteId + - in: path + name: occurrencesId + required: true schema: type: string + /v1/projects/{projectsId}/occurrences/{occurrencesId}/notes: + parameters: *ref_17 get: - description: Lists notes for the specified project. - operationId: containeranalysis.projects.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.occurrences.getNotes security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6362,31 +6305,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListNotesResponse' + $ref: '#/components/schemas/Note' 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: occurrencesId + required: true schema: type: string - /v1/projects/{projectsId}/notes/{notesId}: + /v1/projects/{projectsId}/occurrences:vulnerabilitySummary: parameters: *ref_17 get: - description: Gets the specified note. - operationId: containeranalysis.projects.notes.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 @@ -6398,21 +6333,27 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/VulnerabilityOccurrencesSummary' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: notesId - required: true + - in: query + name: filter schema: type: string - delete: - description: Deletes the specified note. - operationId: containeranalysis.projects.notes.delete + /v1/projects/{projectsId}/occurrences:batchCreate: + parameters: *ref_17 + post: + description: Creates new occurrences in batch. + operationId: containeranalysis.projects.occurrences.batchCreate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BatchCreateOccurrencesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6424,26 +6365,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/BatchCreateOccurrencesResponse' 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 + /v1/projects/{projectsId}/occurrences/{occurrencesId}:setIamPolicy: + parameters: *ref_17 + 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/Note' + $ref: '#/components/schemas/SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6455,7 +6399,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -6463,25 +6407,25 @@ paths: schema: type: string - in: path - name: notesId + name: occurrencesId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/occurrences/{occurrencesId}: + /v1/projects/{projectsId}/occurrences/{occurrencesId}:testIamPermissions: parameters: *ref_17 - patch: - description: Updates the specified occurrence. - operationId: containeranalysis.projects.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 @@ -6493,7 +6437,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Occurrence' + $ref: '#/components/schemas/TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -6505,17 +6449,22 @@ paths: required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: + /v1/projects/{projectsId}/occurrences/{occurrencesId}:getIamPolicy: + parameters: *ref_17 + post: 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 + 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 @@ -6527,7 +6476,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -6539,9 +6488,16 @@ paths: required: true schema: type: string - get: - description: Gets the specified occurrence. - operationId: containeranalysis.projects.occurrences.get + /v1/projects/{projectsId}/notes/{notesId}: + parameters: *ref_17 + patch: + description: Updates the specified note. + operationId: containeranalysis.projects.notes.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Note' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6553,7 +6509,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Occurrence' + $ref: '#/components/schemas/Note' parameters: - in: path name: projectsId @@ -6561,20 +6517,18 @@ paths: schema: type: string - in: path - name: occurrencesId + name: notesId required: true schema: type: string - /v1/projects/{projectsId}/occurrences:batchCreate: - parameters: *ref_17 - post: - description: Creates new occurrences in batch. - operationId: containeranalysis.projects.occurrences.batchCreate - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BatchCreateOccurrencesRequest' + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes the specified note. + operationId: containeranalysis.projects.notes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6586,20 +6540,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BatchCreateOccurrencesResponse' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/occurrences/{occurrencesId}/notes: - parameters: *ref_17 + - in: path + name: notesId + required: true + schema: + type: string 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 + description: Gets the specified note. + operationId: containeranalysis.projects.notes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6619,15 +6574,15 @@ paths: schema: type: string - in: path - name: occurrencesId + name: notesId required: true schema: type: string - /v1/projects/{projectsId}/occurrences: + /v1/projects/{projectsId}/notes: parameters: *ref_17 get: - description: Lists occurrences for the specified project. - operationId: containeranalysis.projects.occurrences.list + description: Lists notes for the specified project. + operationId: containeranalysis.projects.notes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6639,7 +6594,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListOccurrencesResponse' + $ref: '#/components/schemas/ListNotesResponse' parameters: - in: path name: projectsId @@ -6660,13 +6615,13 @@ paths: schema: type: string post: - description: Creates a new occurrence. - operationId: containeranalysis.projects.occurrences.create + description: Creates a new note. + operationId: containeranalysis.projects.notes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/Occurrence' + $ref: '#/components/schemas/Note' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6678,18 +6633,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Occurrence' + $ref: '#/components/schemas/Note' parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/occurrences:vulnerabilitySummary: + - in: query + name: noteId + schema: + type: string + /v1/projects/{projectsId}/notes/{notesId}:getIamPolicy: parameters: *ref_17 - 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.notes.getIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6701,18 +6671,47 @@ 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: notesId + required: true schema: type: string - /v1/projects/{projectsId}/occurrences/{occurrencesId}:testIamPermissions: + /v1/projects/{projectsId}/notes:batchCreate: + parameters: *ref_17 + 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: projectsId + required: true + schema: + type: string + /v1/projects/{projectsId}/notes/{notesId}:testIamPermissions: parameters: *ref_17 post: description: >- @@ -6721,7 +6720,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.occurrences.testIamPermissions + operationId: containeranalysis.projects.notes.testIamPermissions requestBody: content: application/json: @@ -6746,11 +6745,11 @@ paths: schema: type: string - in: path - name: occurrencesId + name: notesId required: true schema: type: string - /v1/projects/{projectsId}/occurrences/{occurrencesId}:setIamPolicy: + /v1/projects/{projectsId}/notes/{notesId}:setIamPolicy: parameters: *ref_17 post: description: >- @@ -6760,7 +6759,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.notes.setIamPolicy requestBody: content: application/json: @@ -6785,26 +6784,18 @@ paths: schema: type: string - in: path - name: occurrencesId + name: notesId required: true schema: type: string - /v1/projects/{projectsId}/occurrences/{occurrencesId}:getIamPolicy: + /v1/projects/{projectsId}/notes/{notesId}/occurrences: parameters: *ref_17 - post: + get: 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' + 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 @@ -6816,7 +6807,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/ListNoteOccurrencesResponse' parameters: - in: path name: projectsId @@ -6824,7 +6815,20 @@ paths: schema: type: string - in: path - name: occurrencesId + name: notesId 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 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 4e0ae7d4..1207d21e 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: '20240506' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/document-warehouse servers: @@ -34,1138 +34,1112 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudContentwarehouseV1SynonymSet: + CloudAiPlatformTenantresourceTenantProjectResource: + id: CloudAiPlatformTenantresourceTenantProjectResource + description: 'The tenant project and tenant resources. Next ID: 10' properties: - name: + tag: + type: string description: >- - The resource name of the SynonymSet This is mandatory for - google.api.resource. Format: - projects/{project_number}/locations/{location}/synonymSets/{context}. + 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. + infraSpannerConfigs: + 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. + 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: type: string - synonyms: - description: List of Synonyms for the context. + format: int64 + description: Output only. The tenant project number that has been created. + cloudSqlInstances: items: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1SynonymSetSynonym + #/components/schemas/CloudAiPlatformTenantresourceCloudSqlInstanceConfig + description: >- + The CloudSQL instances that are provisioned under the tenant + project. type: array - context: + iamPolicyBindings: + 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. + type: array + items: + $ref: '#/components/schemas/CloudAiPlatformTenantresourceIamPolicyBinding' + tenantProjectId: + description: Output only. The tenant project ID that has been created. type: string + tenantServiceAccounts: + items: + $ref: >- + #/components/schemas/CloudAiPlatformTenantresourceTenantServiceAccountIdentity description: >- - This is a freeform field. Example contexts can be "sales," - "engineering," "real estate," "accounting," etc. The context can be - supplied during search requests. - 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 + 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 type: object - id: GoogleCloudContentwarehouseV1SynonymSet - GoogleCloudDocumentaiV1DocumentEntityRelation: - description: Relationship between Entities. - id: GoogleCloudDocumentaiV1DocumentEntityRelation + GoogleCloudDocumentaiV1DocumentPageMatrix: + type: object + id: GoogleCloudDocumentaiV1DocumentPageMatrix properties: - relation: - description: Relationship description. - type: string - objectId: + rows: + format: int32 + description: Number of rows in the matrix. + type: integer + cols: + type: integer + description: Number of columns in the matrix. + format: int32 + data: + description: The matrix data. type: string - description: Object entity id. - subjectId: + format: byte + 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 + description: >- + Representation for transformation matrix, intended to be compatible and + used with OpenCV format for image manipulation. + GoogleApiServiceconsumermanagementV1BillingConfig: + id: GoogleApiServiceconsumermanagementV1BillingConfig + description: Describes the billing configuration for a new tenant project. + properties: + billingAccount: + description: >- + Name of the billing account. For example + `billingAccounts/012345-567890-ABCDEF`. type: string - description: Subject entity id. type: object - GoogleCloudContentwarehouseV1IngestPipelineConfig: + GoogleCloudContentwarehouseV1WeightedSchemaProperty: + description: Specifies the schema property name. properties: - 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. - folder: + documentSchemaName: + description: The document schema name. type: string + propertyNames: + items: + type: string + type: array + description: The property definition names in the schema. + id: GoogleCloudContentwarehouseV1WeightedSchemaProperty + type: object + GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline: + id: GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline + description: >- + The configuration of the Cloud Storage Ingestion with DocAI Processors + pipeline. + properties: + splitClassifyProcessorInfo: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' 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}` - enableDocumentTextExtraction: + The split and classify processor information. The split and classify + result will be used to find a matched extract processor. + skipIngestedDocuments: 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. - cloudFunction: - type: string + 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: 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 - description: The ingestion pipeline config. - type: object - id: GoogleCloudContentwarehouseV1IngestPipelineConfig - GoogleCloudDocumentaiV1DocumentPageSymbol: - properties: - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for Symbol. - detectedLanguages: - description: A list of detected languages together with confidence. + 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/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A detected symbol. - id: GoogleCloudDocumentaiV1DocumentPageSymbol + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' + inputPath: + description: >- + The input Cloud Storage folder. All files under this folder will be + imported to Document Warehouse. Format: `gs:///`. + type: string + processorResultsFolderPath: + type: string + description: >- + The Cloud Storage folder path used to store the raw results from + processors. Format: `gs:///`. + 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 type: object - GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest: - description: Request message for DocumentSchemaService.UpdateDocumentSchema. + GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata: properties: - documentSchema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema' - description: Required. The document schema to update with. - id: GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest - type: object - GoogleCloudDocumentaiV1DocumentTextAnchor: + documents: + description: >- + The input list of all the resource names of the documents to be + processed. + items: + type: string + type: array + processorInfo: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' + description: The DocAI processor to process the documents with. + description: The metadata message for Process-with-DocAi pipeline. + id: >- + GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata type: object - id: GoogleCloudDocumentaiV1DocumentTextAnchor - description: Text reference indexing into the Document.text. + GoogleCloudContentwarehouseV1ListRuleSetsResponse: properties: - content: + nextPageToken: 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: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment - description: The text segments from the Document.text. + 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 - GoogleCloudContentwarehouseV1RunPipelineMetadata: + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' + id: GoogleCloudContentwarehouseV1ListRuleSetsResponse type: object + description: Response message for RuleSetService.ListRuleSets. + 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. properties: - 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. - gcsIngestPipelineMetadata: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata - description: The pipeline metadata for GcsIngest pipeline. - totalFileCount: - format: int32 - description: Number of files that were processed by the pipeline. - type: integer - individualDocumentStatuses: - items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus - type: array - description: The list of response details of each document. - failedFileCount: - description: Number of files that have failed at some point in the pipeline. - format: int32 - type: integer - processWithDocAiPipelineMetadata: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata - description: The pipeline metadata for Process-with-DocAi pipeline. - id: GoogleCloudContentwarehouseV1RunPipelineMetadata - description: Metadata message of RunPipeline method. - GoogleCloudContentwarehouseV1DataValidationAction: - description: Represents the action responsible for data validation operations. - 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 - type: object - id: GoogleCloudContentwarehouseV1DataValidationAction - GoogleCloudContentwarehouseV1InitializeProjectRequest: - description: Request message for projectService.InitializeProject - id: GoogleCloudContentwarehouseV1InitializeProjectRequest - properties: - enableCalUserEmailLogging: - description: Optional. Whether to enable CAL user email logging. - type: boolean - databaseType: - type: string - enum: - - DB_UNKNOWN - - DB_INFRA_SPANNER - - DB_CLOUD_SQL_POSTGRES - enumDescriptions: - - This value is required by protobuf best practices - - Internal Spanner - - Cloud Sql with a Postgres Sql instance - description: Required. The type of database used to store customer data - enumDeprecated: - - false - - false - - true - kmsKey: - type: string + utcOffset: 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: - enum: - - ACL_MODE_UNKNOWN - - ACL_MODE_UNIVERSAL_ACCESS - - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID - - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI - 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. - documentCreatorDefaultRole: - description: Optional. The default role for the person who create a document. - type: string - 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. - enum: - - DOCUMENT_CREATOR_DEFAULT_ROLE_UNSPECIFIED - - DOCUMENT_ADMIN - - DOCUMENT_EDITOR - - DOCUMENT_VIEWER - type: object - GoogleCloudContentwarehouseV1beta1InitializeProjectResponse: - description: Response message for projectService.InitializeProject - id: 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. - type: object - GoogleCloudContentwarehouseV1EnumValue: - type: object - id: GoogleCloudContentwarehouseV1EnumValue - properties: - value: + 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 + format: google-duration + timeZone: + $ref: '#/components/schemas/GoogleTypeTimeZone' + description: Time zone. + year: + type: integer description: >- - String value of the enum field. This must match defined set of enums - in document schema using EnumTypeOptions. - description: Represents the string value of the enum field. - 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: + Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a + datetime without a year. + 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 + 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 - year: + type: integer + nanos: description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. + Optional. Fractions of seconds in nanoseconds. Must be from 0 to + 999,999,999, defaults to 0. type: integer format: int32 + seconds: + type: integer + 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. 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. + Optional. Month of year. Must be from 1 to 12, or 0 if specifying a + datetime without a month. + hours: + type: integer 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. + minutes: + description: >- + Optional. Minutes of hour of day. Must be from 0 to 59, defaults to + 0. type: integer - id: GoogleTypeDate + format: int32 type: object - GoogleCloudContentwarehouseV1CreateDocumentLinkRequest: - id: GoogleCloudContentwarehouseV1CreateDocumentLinkRequest + id: GoogleTypeDateTime + GoogleCloudContentwarehouseV1HistogramQuery: + description: The histogram request. + type: object + id: GoogleCloudContentwarehouseV1HistogramQuery properties: - documentLink: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' + histogramQuery: + type: string description: >- - Required. Document links associated with the source documents - (source_document_id). - requestMetadata: + An expression specifies a histogram request against matching + documents for searches. See SearchDocumentsRequest.histogram_queries + for details about syntax. + filters: 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.CreateDocumentLink. + 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 + requirePreciseResultSize: + 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. + CloudAiPlatformTenantresourceGcsBucketConfig: + id: CloudAiPlatformTenantresourceGcsBucketConfig type: object - 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 - properties: {} - GoogleCloudContentwarehouseV1beta1CreateDocumentMetadata: - description: Metadata object for CreateDocument request (currently empty). - type: object - properties: {} - id: GoogleCloudContentwarehouseV1beta1CreateDocumentMetadata - GoogleCloudContentwarehouseV1FloatArray: - type: object - description: Float values. properties: - values: - description: List of float values. + kmsKeyReference: + 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. + type: string + viewers: type: array + description: Input/Output [Required]. IAM roles (viewer/admin) put on the bucket. items: - type: number - format: float - id: GoogleCloudContentwarehouseV1FloatArray - GoogleCloudDocumentaiV1DocumentPageImageQualityScores: - type: object - properties: - detectedDefects: - type: array - description: A list of detected defects. + type: string + admins: items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect - qualityScore: - type: number - format: float + type: string + type: array + ttlDays: + type: integer description: >- - The overall quality score. Range `[0, 1]` where `1` is perfect - quality. - id: GoogleCloudDocumentaiV1DocumentPageImageQualityScores - description: Image quality scores for the page image. - GoogleCloudContentwarehouseV1PropertyTypeOptions: + Input/Output [Optional]. Only needed when the content in bucket need + to be garbage collected within some amount of days. + format: int32 + 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 + bucketName: + 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. + type: string + description: The identity to configure a GCS bucket. + GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline: properties: - propertyDefinitions: + 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: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1PropertyDefinition + type: string type: array - description: Required. List of property definitions. - id: GoogleCloudContentwarehouseV1PropertyTypeOptions + processorResultsFolderPath: + 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. + exportFolderPath: + description: >- + The Cloud Storage folder path used to store the exported documents + before being sent to CDW. Format: `gs:///`. + type: string + id: GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline type: object - description: Configurations for a nested structured data property. - GoogleCloudContentwarehouseV1GcsIngestPipeline: - id: GoogleCloudContentwarehouseV1GcsIngestPipeline + description: >- + The configuration of processing documents in Document Warehouse with + DocAi processors pipeline. + GoogleCloudContentwarehouseV1MapTypeOptions: type: object + properties: {} + id: GoogleCloudContentwarehouseV1MapTypeOptions + description: Configurations for a Map property. + GoogleCloudContentwarehouseV1EnumTypeOptions: properties: - 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. + validationCheckDisabled: type: boolean - pipelineConfig: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1IngestPipelineConfig 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. - processorType: + 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. + possibleValues: + items: + type: string + description: Required. List of possible enum values. + type: array + description: Configurations for an enum/categorical property. + type: object + id: GoogleCloudContentwarehouseV1EnumTypeOptions + GoogleCloudContentwarehouseV1ListLinkedSourcesRequest: + type: object + description: Response message for DocumentLinkService.ListLinkedSources. + id: GoogleCloudContentwarehouseV1ListLinkedSourcesRequest + properties: + pageToken: type: string description: >- - The Doc AI processor type name. Only used when the format of - ingested files is Doc AI Document proto format. - schemaName: + 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. + pageSize: + type: integer 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 - inputPath: + 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: description: >- - The input Cloud Storage folder. All files under this folder will be - imported to Document Warehouse. Format: `gs:///`. - type: string - description: The configuration of the Cloud Storage Ingestion pipeline. - GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect: + The meta information collected about the document creator, used to + enforce access control for the service. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + GoogleCloudContentwarehouseV1TextTypeOptions: + description: Configurations for a text property. + properties: {} + id: GoogleCloudContentwarehouseV1TextTypeOptions + type: object + GoogleCloudContentwarehouseV1PropertyArray: + id: GoogleCloudContentwarehouseV1PropertyArray + description: Property values. 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` + properties: + type: array + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Property' + description: List of property values. + type: object + GoogleCloudContentwarehouseV1InvalidRule: + type: object + properties: + error: type: string - confidence: - format: float + 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. + GoogleCloudContentwarehouseV1CustomWeightsMetadata: + description: To support the custom weighting across document schemas. + properties: + weightedSchemaProperties: + items: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1WeightedSchemaProperty + type: array description: >- - Confidence of detected defect. Range `[0, 1]` where `1` indicates - strong confidence that the defect exists. - type: number - description: Image Quality Defects + List of schema and property name. Allows a maximum of 10 schemas to + be specified for relevance boosting. type: object - id: GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect + id: GoogleCloudContentwarehouseV1CustomWeightsMetadata GoogleCloudDocumentaiV1DocumentPageTable: + id: GoogleCloudDocumentaiV1DocumentPageTable + type: object + description: A table representation similar to HTML table structure. properties: - provenance: - description: The history of this table. - deprecated: true - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for Table. detectedLanguages: + type: array items: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage description: A list of detected languages together with confidence. - type: array - headerRows: - description: Header rows of the table. + bodyRows: + description: Body rows of the table. type: array items: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow - bodyRows: + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for Table. + provenance: + deprecated: true + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: The history of this table. + headerRows: + type: array items: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow - type: array - description: Body rows of the table. - id: GoogleCloudDocumentaiV1DocumentPageTable - description: A table representation similar to HTML table structure. - type: object - GoogleCloudDocumentaiV1DocumentPageImage: - id: GoogleCloudDocumentaiV1DocumentPageImage + description: Header rows of the table. + CloudAiPlatformTenantresourceTenantServiceAccountIdentity: properties: - height: - format: int32 - type: integer - description: Height of the image in pixels. - content: - description: Raw byte content of the image. - type: string - format: byte - mimeType: + serviceName: type: string description: >- - Encoding [media type (MIME - type)](https://www.iana.org/assignments/media-types/media-types.xhtml) - for the image. - width: - format: int32 - description: Width of the image in pixels. - type: integer + Input/Output [Required]. The service that the service account + belongs to. (e.g. cloudbuild.googleapis.com for GCB service + accounts) + serviceAccountEmail: + description: Output only. The email address of the generated service account. + type: string + id: CloudAiPlatformTenantresourceTenantServiceAccountIdentity + description: >- + The identity of service accounts that have been explicitly created under + tenant projects. type: object - description: Rendered image contents for this page. - GoogleCloudContentwarehouseV1DocumentLink: + GoogleCloudContentwarehouseV1RuleActionsPair: + type: object + id: GoogleCloudContentwarehouseV1RuleActionsPair + description: Represents a rule and outputs of associated actions. 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}. - type: string - targetDocumentReference: - description: Document references of the target document. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentReference' - description: - type: string - description: Description of this document-link. - sourceDocumentReference: - description: Document references of the source document. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentReference' - createTime: - format: google-datetime - description: Output only. The time when the documentLink is created. + rule: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' + description: Represents the rule. + actionOutputs: + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ActionOutput' + description: Outputs of executing the actions associated with the above rule. + type: array + GoogleRpcStatus: + properties: + message: type: string - readOnly: true - state: 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. - enum: - - STATE_UNSPECIFIED - - ACTIVE - - SOFT_DELETED - type: string - 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. - updateTime: - readOnly: true - format: google-datetime - type: string - description: Output only. The time when the documentLink is last updated. - id: GoogleCloudContentwarehouseV1DocumentLink + 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: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + 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. + 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 - description: A document-link between source and target document. - GoogleCloudContentwarehouseV1CreateDocumentResponse: - id: GoogleCloudContentwarehouseV1CreateDocumentResponse + GoogleCloudDocumentaiV1DocumentPageLine: + id: GoogleCloudDocumentaiV1DocumentPageLine type: object properties: - longRunningOperations: - description: post-processing LROs + detectedLanguages: 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 - metadata: - description: >- - Additional information for the API invocation, such as the request - tracking id. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' - document: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' - description: Document created after executing create request. - description: Response message for DocumentService.CreateDocument. - GoogleCloudContentwarehouseV1Document: - type: object + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages together with confidence. + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + deprecated: true + description: The history of this annotation. + layout: + description: Layout for Line. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: >- + A collection of tokens that a human would perceive as a line. Does not + cross column boundaries, can be horizontal, vertical, etc. + GoogleCloudDocumentaiV1DocumentPageDimension: + description: Dimension for the page. properties: - rawDocumentFileType: - 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. - 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 - 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 - type: string - createTime: - type: string - format: google-datetime - description: Output only. The time when the document is created. - readOnly: true - creator: - description: The user who creates the document. - type: string - title: - type: string - description: >- - Title that describes the document. This can be the top heading or - text that describes the document. - referenceId: - description: >- - The reference ID set by customers. Must be unique per project and - location. - type: string - updateTime: - description: Output only. The time when the document is last updated. - readOnly: true + height: + description: Page height. + format: float + type: number + width: + description: Page width. + type: number + format: float + unit: type: string - format: google-datetime - dispositionTime: - format: google-datetime + description: Dimension unit. + id: GoogleCloudDocumentaiV1DocumentPageDimension + type: object + GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter: + properties: + propertyNames: + items: + type: string description: >- - Output only. If linked to a Collection with RetentionPolicy, the - date when the document becomes mutable. - readOnly: true - type: string - textExtractionDisabled: - description: If true, text extraction will not be performed. - type: boolean - deprecated: true - properties: + 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". type: array - description: List of values that are user supplied metadata. + documentSchemas: items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Property' - legalHold: - description: Output only. Indicates if the document has a legal hold on it. - readOnly: true - type: boolean - contentCategory: - enumDescriptions: - - No category is specified. - - Content is of image type. - - Content is of audio type. - - Content is of video type. - enum: - - CONTENT_CATEGORY_UNSPECIFIED - - CONTENT_CATEGORY_IMAGE - - CONTENT_CATEGORY_AUDIO - - CONTENT_CATEGORY_VIDEO + type: string + type: array description: >- - Indicates the category (image, audio, video etc.) of the original - content. + 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}. + yAxis: + description: >- + By default, the y_axis is HISTOGRAM_YAXIS_DOCUMENT if this field is + not set. + enum: + - HISTOGRAM_YAXIS_DOCUMENT + - HISTOGRAM_YAXIS_PROPERTY type: string - displayUri: - type: string - description: Uri to display the document, for example, in the UI. - cloudAiDocument: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' - description: Document AI format to save the structured content, including OCR. - displayName: - 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. - type: string - plainText: - description: Other document format, such as PPTX, XLXS - type: string - updater: - type: string - description: The user who lastly updates the document. - rawDocumentPath: - description: Raw document file in Cloud Storage path. - type: string - textExtractionEnabled: - type: boolean - description: If true, text extraction will be performed. - documentSchemaName: - description: >- - The Document schema name. Format: - projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. - type: string - inlineRawDocument: - type: string - description: Raw document content. - format: byte - 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. - description: Defines the structure for content warehouse document proto. - id: GoogleCloudContentwarehouseV1Document - GoogleCloudContentwarehouseV1ListRuleSetsResponse: - description: Response message for RuleSetService.ListRuleSets. + enumDescriptions: + - Count the documents per property name. + - Count the properties per property name. type: object + id: GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter + GoogleCloudContentwarehouseV1MapProperty: + description: >- + Map property value. Represents a structured entries of key value pairs, + consisting of field names which map to dynamically typed values. 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. - ruleSets: - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' - description: The rule sets from the specified parent. - type: array - id: GoogleCloudContentwarehouseV1ListRuleSetsResponse + fields: + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Value' + description: Unordered map of dynamically typed values. + type: object + id: GoogleCloudContentwarehouseV1MapProperty GoogleCloudContentwarehouseV1ActionExecutorOutput: id: GoogleCloudContentwarehouseV1ActionExecutorOutput type: object properties: ruleActionsPairs: description: List of rule and corresponding actions result. - type: array items: $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleActionsPair' + type: array description: Represents the output of the Action Executor. - GoogleCloudDocumentaiV1DocumentRevisionHumanReview: - type: object + GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo: properties: - stateMessage: + superscript: description: >- - A message providing more details about the current state of - processing. For example, the rejection reason when the state is - `rejected`. - type: string - state: - type: string - description: Human review state. e.g. `requested`, `succeeded`, `rejected`. - description: Human Review information of the document. - id: GoogleCloudDocumentaiV1DocumentRevisionHumanReview - GoogleCloudContentwarehouseV1DataUpdateAction: - properties: - entries: + Whether the text is a superscript. This feature is not supported + yet. + type: boolean + handwritten: + type: boolean + description: Whether the text is handwritten. + fontWeight: + type: integer 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. - type: object - additionalProperties: - type: string - type: object - id: GoogleCloudContentwarehouseV1DataUpdateAction - description: Represents the action responsible for properties update operations. - GoogleCloudDocumentaiV1DocumentPageDetectedBarcode: - description: A detected barcode. - type: object - id: GoogleCloudDocumentaiV1DocumentPageDetectedBarcode - properties: - barcode: - description: Detailed barcode information of the DetectedBarcode. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Barcode' - layout: - description: Layout for DetectedBarcode. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - GoogleCloudContentwarehouseV1DeleteDocumentRequest: - type: object - description: Request message for DocumentService.DeleteDocument. - id: GoogleCloudContentwarehouseV1DeleteDocumentRequest - properties: - requestMetadata: + TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). + Normal is `400`, bold is `700`. + format: int32 + italic: + type: boolean + description: Whether the text is italic. + underlined: + type: boolean + description: Whether the text is underlined. + pixelFontSize: + format: double + type: number description: >- - The meta information collected about the end user, used to enforce - access control for the service. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - GoogleCloudContentwarehouseV1DeleteDocumentAction: - properties: - enableHardDelete: + Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ + `72.0`. + subscript: + type: boolean + description: Whether the text is a subscript. This feature is not supported yet. + fontType: + description: Name or style of the font. + type: string + textColor: + $ref: '#/components/schemas/GoogleTypeColor' + description: Color of the text. + fontSize: + description: Font size in points (`1` point is `¹⁄₇₂` inches). + format: int32 + type: integer + backgroundColor: + $ref: '#/components/schemas/GoogleTypeColor' + description: Color of the background. + bold: type: boolean description: >- - Boolean field to select between hard vs soft delete options. Set - 'true' for 'hard delete' and 'false' for 'soft delete'. - id: GoogleCloudContentwarehouseV1DeleteDocumentAction - description: Represents the action responsible for deleting the document. + Whether the text is bold (equivalent to font_weight is at least + `700`). + strikeout: + type: boolean + description: >- + Whether the text is strikethrough. This feature is not supported + yet. + letterSpacing: + type: number + format: double + description: Letter spacing in points. + smallcaps: + description: >- + Whether the text is in small caps. This feature is not supported + yet. + type: boolean type: object - GoogleCloudContentwarehouseV1RuleEvaluatorOutput: - description: Represents the output of the Rule Evaluator. + id: GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo + description: Font and other text style attributes. + GoogleCloudDocumentaiV1DocumentPageImage: type: object + id: GoogleCloudDocumentaiV1DocumentPageImage properties: - invalidRules: - type: array + mimeType: + type: string description: >- - A subset of triggered rules that failed the validation check(s) - after parsing. + Encoding [media type (MIME + type)](https://www.iana.org/assignments/media-types/media-types.xhtml) + for the image. + height: + format: int32 + type: integer + description: Height of the image in pixels. + width: + description: Width of the image in pixels. + format: int32 + type: integer + content: + type: string + description: Raw byte content of the image. + format: byte + description: Rendered image contents for this page. + GoogleCloudContentwarehouseV1ExportToCdwPipeline: + properties: + documents: items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1InvalidRule' - matchedRules: + type: string description: >- - A subset of triggered rules that are evaluated true for a given - request. - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' + The list of all the resource names of the documents to be processed. + Format: + projects/{project_number}/locations/{location}/documents/{document_id}. type: array - triggeredRules: - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' + exportFolderPath: + type: string description: >- - List of rules fetched from database for the given request trigger - type. - type: array - id: GoogleCloudContentwarehouseV1RuleEvaluatorOutput - GoogleCloudContentwarehouseV1RunPipelineRequest: - id: GoogleCloudContentwarehouseV1RunPipelineRequest - properties: - processWithDocAiPipeline: + The Cloud Storage folder path used to store the exported documents + before being sent to CDW. Format: `gs:///`. + trainingSplitRatio: + format: float + type: number description: >- - Use a DocAI processor to process documents in Document Warehouse, - and re-ingest the updated results into Document Warehouse. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline - gcsIngestWithDocAiProcessorsPipeline: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline + 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. + docAiDataset: description: >- - Use DocAI processors to process documents in Cloud Storage and - ingest them to Document Warehouse. - exportCdwPipeline: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ExportToCdwPipeline - description: >- - Export docuemnts from Document Warehouse to CDW for training - purpose. - gcsIngestPipeline: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1GcsIngestPipeline' - description: Cloud Storage ingestion pipeline. - requestMetadata: - description: >- - The meta information collected about the end user, used to enforce - access control for the service. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - description: Request message for DocumentService.RunPipeline. + 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 + type: string + description: >- + The configuration of exporting documents from the Document Warehouse to + CDW pipeline. + id: GoogleCloudContentwarehouseV1ExportToCdwPipeline type: object - GoogleCloudContentwarehouseV1RuleActionsPair: - properties: - actionOutputs: - description: Outputs of executing the actions associated with the above rule. - type: array - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ActionOutput' - rule: - description: Represents the rule. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' - id: GoogleCloudContentwarehouseV1RuleActionsPair + GoogleCloudDocumentaiV1DocumentPageFormField: + id: GoogleCloudDocumentaiV1DocumentPageFormField + description: A form field detected on the page. type: object - description: Represents a rule and outputs of associated actions. - GoogleCloudContentwarehouseV1FetchAclRequest: properties: - projectOwner: + fieldValue: + description: Layout for the FormField value. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + valueType: 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' + 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 + correctedKeyText: + type: string description: >- - The meta information collected about the end user, used to enforce - access control for the service. - description: Request message for DocumentService.FetchAcl - type: object - id: GoogleCloudContentwarehouseV1FetchAclRequest - GoogleCloudDocumentaiV1DocumentPage: - id: GoogleCloudDocumentaiV1DocumentPage - type: object - description: A page in a Document. - properties: - visualElements: - type: array + 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. + fieldName: description: >- - A list of detected non-text visual elements e.g. checkbox, signature - etc. on the page. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageVisualElement - tokens: - description: A list of visually detected tokens on the page. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageToken' - type: array - detectedLanguages: + Layout for the FormField name. e.g. `Address`, `Email`, `Grand + total`, `Phone number`, etc. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: The history of this annotation. + nameDetectedLanguages: + description: A list of detected languages for name together with confidence. items: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage type: array - description: A list of detected languages together with confidence. - blocks: + correctedValueText: + 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. + type: string + valueDetectedLanguages: type: array items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageBlock' - 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: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages for value together with confidence. + GoogleCloudContentwarehouseV1ListDocumentSchemasResponse: + type: object + description: Response message for DocumentSchemaService.ListDocumentSchemas. + properties: + nextPageToken: + type: string description: >- - Transformation matrices that were applied to the original document - image to produce Page.image. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageMatrix' + 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: + description: The document schemas from the specified parent. type: array - pageNumber: + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema' + id: GoogleCloudContentwarehouseV1ListDocumentSchemasResponse + 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/). + properties: + version: + 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. - format: int32 - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - deprecated: true - description: The history of this page. - paragraphs: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageParagraph' + 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: >- - A list of visually detected text paragraphs on the page. A - collection of lines that a human would perceive as a paragraph. - type: array - formFields: - type: array - description: A list of visually detected form fields on the page. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageFormField' - dimension: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageDimension' - description: Physical dimension of the page. - tables: - description: A list of visually detected tables on the page. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageTable' - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for the page. - lines: + `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: 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. + 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/GoogleCloudDocumentaiV1DocumentPageLine' - symbols: - description: A list of visually detected symbols on the page. - type: array + $ref: '#/components/schemas/GoogleIamV1Binding' + auditConfigs: items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageSymbol' - imageQualityScores: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScores - description: Image quality scores. - detectedBarcodes: + $ref: '#/components/schemas/GoogleIamV1AuditConfig' type: array - description: A list of detected barcodes. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedBarcode - 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. - GoogleCloudContentwarehouseV1DateTimeArray: + description: Specifies cloud audit logging configuration for this policy. + id: GoogleIamV1Policy + type: object + GoogleCloudDocumentaiV1DocumentStyleFontSize: + id: GoogleCloudDocumentaiV1DocumentStyleFontSize type: object + description: Font size with unit. properties: - values: - items: - $ref: '#/components/schemas/GoogleTypeDateTime' - type: array + size: + format: float + type: number + description: Font size for the text. + unit: description: >- - List of datetime values. Both OffsetDateTime and ZonedDateTime are - supported. - description: DateTime values. - id: GoogleCloudContentwarehouseV1DateTimeArray - GoogleCloudDocumentaiV1Document: - id: GoogleCloudDocumentaiV1Document + Unit for the font size. Follows CSS naming (such as `in`, `px`, and + `pt`). + type: string + GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment: 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. + 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 + type: object properties: - 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. + startIndex: type: string - mimeType: - description: >- - An IANA published [media type (MIME - type)](https://www.iana.org/assignments/media-types/media-types.xhtml). + format: int64 + description: TextSegment start UTF-8 char index in the Document.text. + endIndex: + format: int64 + description: TextSegment half open end UTF-8 char index in the Document.text. type: string - entityRelations: - description: Placeholder. Relationship among Document.entities. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntityRelation' - 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' - 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' - textStyles: - description: Styles for the Document.text. - type: array - deprecated: true - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyle' - 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). + id: GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment + GoogleCloudContentwarehouseV1RequestMetadata: + id: GoogleCloudContentwarehouseV1RequestMetadata + type: object + properties: + userInfo: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UserInfo' + description: Provides user unique identification and groups information. + description: Meta information is used to improve the performance of the service. + GoogleCloudDocumentaiV1DocumentEntityRelation: + id: GoogleCloudDocumentaiV1DocumentEntityRelation + type: object + properties: + relation: + description: Relationship description. type: string - pages: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPage' - description: Visual page layout for the Document. - type: array - text: - description: Optional. UTF-8 encoded text in reading order from the document. + objectId: type: string - revisions: - description: Placeholder. Revision history of this document. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentRevision' - type: array - error: - description: Any error that occurred while processing this document. - $ref: '#/components/schemas/GoogleRpcStatus' - 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' - type: object - GoogleCloudContentwarehouseV1Property: + description: Object entity id. + subjectId: + type: string + description: Subject entity id. + description: Relationship between Entities. + GoogleIamV1AuditLogConfig: type: object - id: 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. - propertyValues: - description: Nested structured data property values. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PropertyArray' - name: - description: >- - Required. Must match the name of a PropertyDefinition in the - DocumentSchema. + logType: + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + description: The log type that this config enables. type: string - timestampValues: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampArray' - description: >- - Timestamp property values. It is not supported by CMEK compliant - deployment. - mapProperty: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MapProperty' - description: Map property values. - dateTimeValues: + enumDescriptions: + - Default case. Should never be this. + - 'Admin reads. Example: CloudIAM getIamPolicy' + - 'Data writes. Example: CloudSQL Users create' + - 'Data reads. Example: CloudSQL Users list' + exemptedMembers: + items: + type: string description: >- - Date time property values. It is not supported by CMEK compliant - deployment. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DateTimeArray' - floatValues: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1FloatArray' - description: Float property values. - description: Property of a document. - GoogleCloudContentwarehouseV1ActionOutput: - description: Represents the result of executing an action. - id: GoogleCloudContentwarehouseV1ActionOutput + Specifies the identities that do not cause logging for this type of + permission. Follows the same format of Binding.members. + type: array + 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. + GoogleCloudContentwarehouseV1beta1InitializeProjectResponse: + id: GoogleCloudContentwarehouseV1beta1InitializeProjectResponse type: object + description: Response message for projectService.InitializeProject properties: - actionId: + message: type: string - description: ID of the action. - outputMessage: + description: The message of the project initialization process. + 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. + description: The state of the project initialization process. 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. + - STATE_UNSPECIFIED + - SUCCEEDED + - FAILED + - CANCELLED + - RUNNING + 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 - description: State of an action. - GoogleCloudDocumentaiV1DocumentPageAnchorPageRef: + id: + type: string + description: IANA Time Zone Database time zone, e.g. "America/New_York". type: object + id: GoogleTypeTimeZone + GoogleCloudDocumentaiV1DocumentPageVisualElement: + id: GoogleCloudDocumentaiV1DocumentPageVisualElement properties: - layoutType: - 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. + detectedLanguages: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + type: array + description: A list of detected languages together with confidence. + layout: + description: Layout for VisualElement. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + type: + description: Type of the VisualElement. + type: string + description: >- + Detected non-text visual elements e.g. checkbox, signature etc. on the + page. + 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 + document: + description: Required. The document to create. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + requestMetadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + description: >- + The meta information collected about the end user, used to enforce + access control for the service. + createMask: + 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. + type: string + 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' + description: Request message for DocumentService.CreateDocument. + id: GoogleCloudContentwarehouseV1CreateDocumentRequest + type: object + GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest: + description: Request message for DocumentSchemaService.UpdateDocumentSchema. + type: object + properties: + documentSchema: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema' + description: Required. The document schema to update with. + id: GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest + GoogleCloudContentwarehouseV1HistogramQueryResult: + description: Histogram result that matches HistogramQuery specified in searches. + type: object + id: GoogleCloudContentwarehouseV1HistogramQueryResult + properties: + histogramQuery: type: string + description: Requested histogram expression. + histogram: + additionalProperties: + format: int64 + type: string + type: object + 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. + GoogleCloudDocumentaiV1DocumentPageAnchorPageRef: + properties: confidence: type: number format: float description: >- Optional. Confidence of detected page element, if applicable. Range `[0, 1]`. - layoutId: - deprecated: true - description: Optional. Deprecated. Use PageRef.bounding_poly instead. - type: string page: format: int64 description: >- @@ -1174,1298 +1148,976 @@ components: skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json. type: string + layoutId: + type: string + deprecated: true + 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 + 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 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' + type: object id: GoogleCloudDocumentaiV1DocumentPageAnchorPageRef description: Represents a weak reference to a page element within a document. - GoogleCloudContentwarehouseV1CloudAIDocumentOption: - description: Request Option for processing Cloud AI Document in CW Document. - properties: - customizedEntitiesPropertiesConversions: - type: object - description: If set, only selected entities will be converted to properties. - additionalProperties: - type: string - enableEntitiesConversions: - description: Whether to convert all the entities to properties. - type: boolean - id: GoogleCloudContentwarehouseV1CloudAIDocumentOption - type: object - GoogleCloudContentwarehouseV1RemoveFromFolderAction: - id: GoogleCloudContentwarehouseV1RemoveFromFolderAction - description: >- - Represents the action responsible for remove a document from a specific - folder. + GoogleCloudContentwarehouseV1IngestPipelineConfig: 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 - type: object - CloudAiPlatformTenantresourceTenantProjectResource: - type: object - description: 'The tenant project and tenant resources. Next ID: 10' - id: 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. - tag: + 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}` + cloudFunction: 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. - 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. - cloudSqlInstances: - items: - $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceCloudSqlInstanceConfig + 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 + enableDocumentTextExtraction: description: >- - The CloudSQL instances that are provisioned under the tenant - project. - type: array - tenantProjectNumber: - description: Output only. The tenant project number that has been created. - type: string - format: int64 - gcsBuckets: - description: The GCS buckets that are provisioned under the tenant project. - items: - $ref: '#/components/schemas/CloudAiPlatformTenantresourceGcsBucketConfig' - type: array - infraSpannerConfigs: + The document text extraction enabled flag. If the flag is set to + true, DWH will perform text extraction on the raw document. + type: boolean + documentAclPolicy: + $ref: '#/components/schemas/GoogleIamV1Policy' description: >- - The Infra Spanner databases that are provisioned under the tenant - project. Note: this is an experimental feature. - type: array - items: - $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceInfraSpannerConfig - tenantServiceAccounts: + 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. + description: The ingestion pipeline config. + type: object + id: GoogleCloudContentwarehouseV1IngestPipelineConfig + GoogleCloudDocumentaiV1DocumentPageImageQualityScores: + id: GoogleCloudDocumentaiV1DocumentPageImageQualityScores + properties: + qualityScore: + format: float + description: >- + The overall quality score. Range `[0, 1]` where `1` is perfect + quality. + type: number + detectedDefects: + description: A list of detected defects. type: array items: $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceTenantServiceAccountIdentity - 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). - GoogleCloudDocumentaiV1DocumentProvenanceParent: - description: >- - The parent element the current element is based on. Used for - referencing/aligning, removal and replacement operations. - id: GoogleCloudDocumentaiV1DocumentProvenanceParent + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect + type: object + description: Image quality scores for the page image. + GoogleCloudContentwarehouseV1Property: properties: - index: - type: integer + dateTimeValues: description: >- - The index of the parent item in the corresponding item list (eg. - list of entities, properties within entities, etc.) in the parent - revision. - format: int32 - revision: - format: int32 - type: integer - description: The index of the index into current revision's parent_ids list. - id: - description: The id of the parent provenance. - deprecated: true - format: int32 - type: integer - type: object - GoogleCloudDocumentaiV1BoundingPoly: - properties: - vertices: - description: The bounding polygon vertices. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Vertex' - type: array - normalizedVertices: - description: The bounding polygon normalized vertices. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1NormalizedVertex' - type: array + Date time property values. It is not supported by CMEK compliant + deployment. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DateTimeArray' + floatValues: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1FloatArray' + description: Float property values. + mapProperty: + description: Map property values. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MapProperty' + timestampValues: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampArray' + description: >- + Timestamp property values. It is not supported by CMEK compliant + deployment. + name: + description: >- + Required. Must match the name of a PropertyDefinition in the + DocumentSchema. + type: string + integerValues: + description: Integer property values. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1IntegerArray' + enumValues: + description: Enum property values. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1EnumArray' + propertyValues: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PropertyArray' + description: Nested structured data property values. + textValues: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TextArray' + description: String/text property values. + id: GoogleCloudContentwarehouseV1Property type: object - id: GoogleCloudDocumentaiV1BoundingPoly - description: A bounding polygon for the detected image annotation. - GoogleCloudContentwarehouseV1TimestampValue: - id: GoogleCloudContentwarehouseV1TimestampValue - description: Timestamp value type. + description: Property of a document. + GoogleCloudContentwarehouseV1Value: + id: 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: - textValue: + booleanValue: + description: Represents a boolean value. + type: boolean + datetimeValue: + $ref: '#/components/schemas/GoogleTypeDateTime' + description: Represents a datetime value. + enumValue: + description: Represents an enum value. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1EnumValue' + floatValue: + type: number + description: Represents a float value. + format: float + stringValue: type: string - 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" + description: Represents a string value. timestampValue: - description: Timestamp value - format: google-datetime - type: string + description: Represents a timestamp value. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampValue' + intValue: + type: integer + description: Represents a integer value. + format: int32 type: object - GoogleTypeExpr: + GoogleCloudContentwarehouseV1CloudAIDocumentOption: type: object + description: Request Option for processing Cloud AI Document in CW Document. + id: GoogleCloudContentwarehouseV1CloudAIDocumentOption properties: - expression: + enableEntitiesConversions: + type: boolean + description: Whether to convert all the entities to properties. + customizedEntitiesPropertiesConversions: + additionalProperties: + type: string + description: If set, only selected entities will be converted to properties. + type: object + GoogleCloudContentwarehouseV1Action: + properties: + deleteDocumentAction: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1DeleteDocumentAction + description: Action deleting the document. + publishToPubSub: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PublishAction' + description: Action publish to Pub/Sub operation. + removeFromFolderAction: + description: Action removing a document from a folder. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RemoveFromFolderAction + actionId: type: string + description: ID of the action. Managed internally. + dataValidation: + description: Action triggering data validation operations. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1DataValidationAction + addToFolder: + description: Action triggering create document link operation. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1AddToFolderAction' + accessControl: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1AccessControlAction + description: Action triggering access control operations. + dataUpdate: + description: Action triggering data update operations. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DataUpdateAction' + type: object + description: Represents the action triggered by Rule Engine when the rule is true. + id: GoogleCloudContentwarehouseV1Action + GoogleCloudContentwarehouseV1SearchDocumentsRequest: + properties: + offset: + format: int32 description: >- - Textual representation of an expression in Common Expression - Language syntax. - description: - type: string + 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 + pageToken: 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: + 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. type: string + totalResultSize: + type: string + 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. 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: + Controls if the search document request requires the return of a + total size of matched documents. See + SearchDocumentsResponse.total_size. + enum: + - TOTAL_RESULT_SIZE_UNSPECIFIED + - ESTIMATED_SIZE + - ACTUAL_SIZE + orderBy: 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. - id: GoogleTypeExpr - GoogleCloudContentwarehouseV1ListLinkedTargetsRequest: - id: GoogleCloudContentwarehouseV1ListLinkedTargetsRequest - type: object - properties: + 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. + 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. 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' + qaSizeLimit: description: >- - The meta information collected about the document creator, used to - enforce access control for the service. - description: Request message for DocumentLinkService.ListLinkedTargets. - GoogleCloudContentwarehouseV1SearchDocumentsResponse: - type: object - id: GoogleCloudContentwarehouseV1SearchDocumentsResponse - description: Response message for DocumentService.SearchDocuments. - properties: - metadata: + 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 + pageSize: + type: integer description: >- - Additional information for the API invocation, such as the request - tracking id. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' - histogramQueryResults: - items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1HistogramQueryResult + 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 + histogramQueries: type: array + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1HistogramQuery' description: >- - The histogram results that match with the specified - SearchDocumentsRequest.histogram_queries. - matchingDocuments: - description: >- - The document entities that match the specified - SearchDocumentsRequest. + 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') + documentQuery: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentQuery' + description: Query used to search against documents (keyword, filters, etc.). + id: GoogleCloudContentwarehouseV1SearchDocumentsRequest + description: Request message for DocumentService.SearchDocuments. + type: object + GoogleCloudContentwarehouseV1RunPipelineMetadata: + properties: + exportToCdwPipelineMetadata: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata + description: The pipeline metadata for Export-to-CDW pipeline. + individualDocumentStatuses: + description: The list of response details of each document. type: array items: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument - nextPageToken: - type: string - description: >- - The token that specifies the starting position of the next page of - results. This field is empty if there are no more results. - questionAnswer: - type: string - description: Experimental. Question answer from the query against the document. - totalSize: + #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus + failedFileCount: + description: Number of files that have failed at some point in the pipeline. type: integer - 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". format: int32 - GoogleCloudContentwarehouseV1UpdateRuleSetRequest: - id: GoogleCloudContentwarehouseV1UpdateRuleSetRequest - type: object - description: Request message for RuleSetService.UpdateRuleSet. - properties: - ruleSet: - description: Required. The rule set to update. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' - GoogleCloudContentwarehouseV1IntegerArray: - id: GoogleCloudContentwarehouseV1IntegerArray - description: Integer values. - properties: - values: - items: - format: int32 - type: integer - description: List of integer values. - type: array - type: object - GoogleRpcStatus: - id: GoogleRpcStatus - properties: - code: - description: The status code, which should be an enum value of google.rpc.Code. + userInfo: + description: User unique identification and groups information. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UserInfo' + processWithDocAiPipelineMetadata: + description: The pipeline metadata for Process-with-DocAi pipeline. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata + gcsIngestPipelineMetadata: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata + description: The pipeline metadata for GcsIngest pipeline. + totalFileCount: + description: Number of files that were processed by the pipeline. type: integer format: int32 - 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: >- - 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 + description: Metadata message of RunPipeline method. type: object + id: GoogleCloudContentwarehouseV1RunPipelineMetadata + GoogleCloudContentwarehouseV1RuleEngineOutput: + id: GoogleCloudContentwarehouseV1RuleEngineOutput 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). - GoogleCloudContentwarehouseV1EnumArray: - description: Enum values. - id: GoogleCloudContentwarehouseV1EnumArray - type: object - properties: - values: - type: array - description: List of enum values. - items: - type: string - GoogleCloudContentwarehouseV1SetAclResponse: - description: Response message for DocumentService.SetAcl. - type: object - properties: - metadata: - 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' - id: GoogleCloudContentwarehouseV1SetAclResponse - GoogleCloudDocumentaiV1DocumentEntityNormalizedValue: + Records the output of Rule Engine including rule evaluation and actions + result. type: object - id: GoogleCloudDocumentaiV1DocumentEntityNormalizedValue properties: - floatValue: - type: number - format: float - description: Float value. - 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. + documentName: type: string - addressValue: - description: >- - Postal address. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto - $ref: '#/components/schemas/GoogleTypePostalAddress' - 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 - moneyValue: description: >- - Money value. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/money.proto - $ref: '#/components/schemas/GoogleTypeMoney' - booleanValue: + Name of the document against which the rules and actions were + evaluated. + ruleEvaluatorOutput: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RuleEvaluatorOutput description: >- - Boolean value. Can be used for entities with binary values, or for - checkboxes. - type: boolean - datetimeValue: - $ref: '#/components/schemas/GoogleTypeDateTime' + Output from Rule Evaluator containing matched, unmatched and invalid + rules. + actionExecutorOutput: description: >- - DateTime value. Includes date, time, and timezone. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto - integerValue: - type: integer - description: Integer value. - format: int32 - description: Parsed and normalized entity value. - GoogleApiServiceconsumermanagementV1PolicyBinding: - type: object - id: GoogleApiServiceconsumermanagementV1PolicyBinding - description: Translates to IAM Policy bindings (without auditing at this level) + Output from Action Executor containing rule and corresponding + actions execution result. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1ActionExecutorOutput + GoogleCloudContentwarehouseV1UpdateOptions: properties: - members: - items: - 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}`. - type: array - role: + updateType: + 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 + description: Type for update. 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. + updateMask: + format: google-fieldmask description: >- - Role. (https://cloud.google.com/iam/docs/understanding-roles) For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. - GoogleCloudDocumentaiV1DocumentPageTableTableRow: - properties: - cells: - description: Cells that make up this row. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableCell - type: array + Field mask for merging Document fields. For the `FieldMask` + definition, see + https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + type: string + mergeFieldsOptions: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MergeFieldsOptions' + description: Options for merging. + id: GoogleCloudContentwarehouseV1UpdateOptions + description: Options for Update operations. type: object - id: GoogleCloudDocumentaiV1DocumentPageTableTableRow - description: A row of table cells. - GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata: + GoogleCloudContentwarehouseV1Document: type: object - id: >- - GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata properties: - docAiDataset: - description: The output CDW dataset resource name. + plainText: type: string - documents: - items: - type: string - description: >- - The input list of all the resource names of the documents to be - exported. - type: array - outputPath: + description: Other document format, such as PPTX, XLXS + inlineRawDocument: + description: Raw document content. + format: byte type: string - description: The output Cloud Storage folder in this pipeline. - description: The metadata message for Export-to-CDW pipeline. - GoogleCloudContentwarehouseV1InitializeProjectResponse: - properties: - message: - description: The message of the project initialization process. + rawDocumentPath: + description: Raw document file in Cloud Storage path. type: string - state: + textExtractionEnabled: + type: boolean + description: If true, text extraction will be performed. + updater: + type: string + description: The user who lastly updates the document. + contentCategory: enum: - - STATE_UNSPECIFIED - - SUCCEEDED - - FAILED - - CANCELLED - - RUNNING + - CONTENT_CATEGORY_UNSPECIFIED + - CONTENT_CATEGORY_IMAGE + - CONTENT_CATEGORY_AUDIO + - CONTENT_CATEGORY_VIDEO + type: string 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. + - No category is specified. + - Content is of image type. + - Content is of audio type. + - Content is of video type. + description: >- + Indicates the category (image, audio, video etc.) of the original + content. + cloudAiDocument: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' + description: Document AI format to save the structured content, including OCR. + dispositionTime: + format: google-datetime + description: >- + Output only. If linked to a Collection with RetentionPolicy, the + date when the document becomes mutable. + readOnly: true type: string - description: Response message for projectService.InitializeProject - type: object - id: GoogleCloudContentwarehouseV1InitializeProjectResponse - GoogleCloudContentwarehouseV1FloatTypeOptions: - id: GoogleCloudContentwarehouseV1FloatTypeOptions - type: object - description: Configurations for a float property. - properties: {} - GoogleCloudContentwarehouseV1PublishAction: - id: GoogleCloudContentwarehouseV1PublishAction - type: object - description: >- - Represents the action responsible for publishing messages to a Pub/Sub - topic. - properties: - topicId: + legalHold: + readOnly: true + description: Output only. Indicates if the document has a legal hold on it. + type: boolean + createTime: + description: Output only. The time when the document is created. + format: google-datetime + readOnly: true + type: string + updateTime: + readOnly: true + format: google-datetime + type: string + description: Output only. The time when the document is last updated. + displayName: type: string description: >- - The topic id in the Pub/Sub service for which messages will be - published to. - messages: + 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. + title: + description: >- + Title that describes the document. This can be the top heading or + text that describes the document. + 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. + documentSchemaName: + description: >- + The Document schema name. Format: + projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. + type: string + displayUri: + description: Uri to display the document, for example, in the UI. + type: string + properties: items: - type: string - description: Messages to be published. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Property' type: array - GoogleCloudDocumentaiV1DocumentPageDimension: - description: Dimension for the page. - type: object - id: GoogleCloudDocumentaiV1DocumentPageDimension - properties: - height: - type: number - format: float - description: Page height. - width: - format: float - type: number - description: Page width. - unit: - description: Dimension unit. + description: List of values that are user supplied metadata. + textExtractionDisabled: + deprecated: true + type: boolean + description: If true, text extraction will not be performed. + referenceId: type: string - 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. - type: object - properties: - 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`. + The reference ID set by customers. Must be unique per project and + location. + creator: type: string - redacted: + description: The user who creates the document. + rawDocumentFileType: description: >- - Optional. Whether the entity will be redacted for de-identification - purposes. - type: boolean - mentionId: - type: string - description: Optional. Deprecated. Use `id` field instead. - type: - description: Required. Entity type from a schema e.g. `Address`. + 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 - properties: + 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 + id: GoogleCloudContentwarehouseV1Document + description: Defines the structure for content warehouse document proto. + CloudAiPlatformTenantresourceTenantProjectConfig: + type: object + id: CloudAiPlatformTenantresourceTenantProjectConfig + description: The identity to configure a tenant project. + properties: + policyBindings: + 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. type: array + items: + $ref: >- + #/components/schemas/GoogleApiServiceconsumermanagementV1PolicyBinding + services: description: >- - Optional. Entities can be nested to form a hierarchical data - structure representing the content in the document. + Input/Output [Required]. The API services that are enabled on the + tenant project during creation. + type: array items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: Optional. The history of this annotation. - id: + type: string + folder: type: string description: >- - Optional. Canonical id. This will be a unique value in the entity - list for this document. - textAnchor: + 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}`. + billingConfig: description: >- - Optional. Provenance of the entity. Text anchor indexing into the - Document.text. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' - confidence: - description: Optional. Confidence of detected Schema entity. Range `[0, 1]`. - format: float - type: number - 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. + Input/Output [Required]. The billing account properties to create + the tenant project. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentEntityNormalizedValue - id: GoogleCloudDocumentaiV1DocumentEntity - GoogleCloudContentwarehouseV1TextTypeOptions: - type: object - id: GoogleCloudContentwarehouseV1TextTypeOptions - properties: {} - description: Configurations for a text property. - GoogleCloudContentwarehouseV1UpdateOptions: - type: object - properties: - updateType: - 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 - description: Type for update. - 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. - updateMask: - description: >- - Field mask for merging Document fields. For the `FieldMask` - definition, see - https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - type: string - format: google-fieldmask - mergeFieldsOptions: - description: Options for merging. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MergeFieldsOptions' - description: Options for Update operations. - id: GoogleCloudContentwarehouseV1UpdateOptions - GoogleCloudContentwarehouseV1Value: - type: object - id: GoogleCloudContentwarehouseV1Value + #/components/schemas/GoogleApiServiceconsumermanagementV1BillingConfig + GoogleLongrunningOperation: + id: GoogleLongrunningOperation properties: - booleanValue: - description: Represents a boolean value. + done: type: boolean - datetimeValue: - $ref: '#/components/schemas/GoogleTypeDateTime' - description: Represents a datetime value. - enumValue: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1EnumValue' - description: Represents an enum value. - stringValue: + 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/GoogleRpcStatus' + 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: type: string - description: Represents a string value. - floatValue: - format: float - type: number - description: Represents a float value. - timestampValue: - description: Represents a timestamp value. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampValue' - intValue: - format: int32 - description: Represents a integer value. - type: integer - 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. - GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata: - properties: - documents: - items: - type: string - type: array description: >- - The input list of all the resource names of the documents to be - processed. - processorInfo: - description: The DocAI processor to process the documents with. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' + 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. + description: >- + This resource represents a long-running operation that is the result of + a network API call. type: object - id: >- - GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata - description: The metadata message for Process-with-DocAi pipeline. - GoogleCloudContentwarehouseV1ExportToCdwPipeline: + GoogleCloudDocumentaiV1DocumentPage: type: object - id: GoogleCloudContentwarehouseV1ExportToCdwPipeline - description: >- - The configuration of exporting documents from the Document Warehouse to - CDW pipeline. + description: A page in a Document. properties: - docAiDataset: - 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 - type: string - exportFolderPath: - type: string + detectedBarcodes: + description: A list of detected barcodes. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedBarcode + tables: + type: array + description: A list of visually detected tables on the page. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageTable' + visualElements: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageVisualElement description: >- - The Cloud Storage folder path used to store the exported documents - before being sent to CDW. Format: `gs:///`. - trainingSplitRatio: + A list of detected non-text visual elements e.g. checkbox, signature + etc. on the page. + pageNumber: + type: integer + format: int32 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 - format: float - documents: + 1-based index for current Page in a parent Document. Useful when a + page is taken out of a Document for individual processing. + detectedLanguages: items: - type: string + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages together with confidence. 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}. - CloudAiPlatformTenantresourceTenantProjectConfig: - id: CloudAiPlatformTenantresourceTenantProjectConfig - description: The identity to configure a tenant project. - type: object - properties: - services: + symbols: + type: array + description: A list of visually detected symbols on the page. items: - type: string - description: >- - Input/Output [Required]. The API services that are enabled on the - tenant project during creation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageSymbol' + blocks: type: array - policyBindings: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageBlock' 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. + formFields: type: array items: - $ref: >- - #/components/schemas/GoogleApiServiceconsumermanagementV1PolicyBinding - folder: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageFormField' + description: A list of visually detected form fields on the page. + image: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageImage' 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 - billingConfig: + 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. + lines: + type: array description: >- - Input/Output [Required]. The billing account properties to create - the tenant project. + 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' + imageQualityScores: $ref: >- - #/components/schemas/GoogleApiServiceconsumermanagementV1BillingConfig - GoogleCloudContentwarehouseV1TimeFilter: - properties: - timeField: - enum: - - TIME_FIELD_UNSPECIFIED - - CREATE_TIME - - UPDATE_TIME - - DISPOSITION_TIME - type: string + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScores + description: Image quality scores. + transforms: + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageMatrix' description: >- - Specifies which time field to filter documents on. Defaults to - TimeField.UPLOAD_TIME. - enumDescriptions: - - Default value. - - Earliest document create time. - - Latest document update time. - - Time when document becomes mutable again. - timeRange: - $ref: '#/components/schemas/GoogleTypeInterval' - description: Filter on create timestamp or update timestamp of documents. - id: GoogleCloudContentwarehouseV1TimeFilter - type: object - GoogleCloudContentwarehouseV1SearchDocumentsRequest: - type: object - description: Request message for DocumentService.SearchDocuments. - id: GoogleCloudContentwarehouseV1SearchDocumentsRequest - properties: - pageToken: - type: string + Transformation matrices that were applied to the original document + image to produce Page.image. + tokens: + description: A list of visually detected tokens on the page. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageToken' + paragraphs: + type: array 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. - orderBy: + 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' + dimension: + description: Physical dimension of the page. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageDimension' + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for the page. + provenance: + description: The history of this page. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + deprecated: true + id: GoogleCloudDocumentaiV1DocumentPage + GoogleCloudContentwarehouseV1RuleSet: + properties: + name: 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. + 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 - 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. - qaSizeLimit: - 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: integer - format: int32 - pageSize: - 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. - type: integer - 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 - 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. - totalResultSize: + rules: + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' + type: array + description: List of rules given by the customer. + description: + description: Short description of the rule-set. + type: string + source: + description: Source of the rules i.e., customer name. + type: string + description: Represents a set of rules from a single customer. + type: object + id: GoogleCloudContentwarehouseV1RuleSet + GoogleCloudContentwarehouseV1FileTypeFilter: + properties: + fileType: 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. + - 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 - description: >- - Controls if the search document request requires the return of a - total size of matched documents. See - SearchDocumentsResponse.total_size. enum: - - TOTAL_RESULT_SIZE_UNSPECIFIED - - ESTIMATED_SIZE - - ACTUAL_SIZE - documentQuery: - description: Query used to search against documents (keyword, filters, etc.). - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentQuery' - histogramQueries: - 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') - CloudAiPlatformTenantresourceGcsBucketConfig: - id: CloudAiPlatformTenantresourceGcsBucketConfig + - FILE_TYPE_UNSPECIFIED + - ALL + - FOLDER + - DOCUMENT + - ROOT_FOLDER + description: The type of files to return. + id: GoogleCloudContentwarehouseV1FileTypeFilter + description: Filter for the specific types of documents returned. type: object - description: The identity to configure a GCS bucket. + CloudAiPlatformTenantresourceInfraSpannerConfig: + type: object + id: CloudAiPlatformTenantresourceInfraSpannerConfig properties: - kmsKeyReference: + spannerBorgServiceAccount: 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: + 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. + spannerLocalNamePrefix: type: string + createDatabaseOptions: + $ref: >- + #/components/schemas/CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions 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. - ttlDays: + 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 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 - admins: - items: - type: string - type: array - entityName: + 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. + kmsKeyReference: 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. - viewers: - description: Input/Output [Required]. IAM roles (viewer/admin) put on the bucket. - type: array - items: - type: string - GoogleCloudDocumentaiV1DocumentPageToken: - type: object - id: GoogleCloudDocumentaiV1DocumentPageToken + 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 + description: 'The configuration for a spanner database provisioning. Next ID: 8' + GoogleCloudContentwarehouseV1UpdateDocumentResponse: properties: - detectedBreak: - description: Detected break at the end of a Token. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak - detectedLanguages: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - provenance: - description: The history of this annotation. - deprecated: true - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for Token. - styleInfo: - description: Text style attributes. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo - description: A detected token. - GoogleTypeMoney: - id: GoogleTypeMoney - description: Represents an amount of money with its currency type. - properties: - 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 - 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 - 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 - type: object - GoogleCloudDocumentaiV1DocumentPageVisualElement: - description: >- - Detected non-text visual elements e.g. checkbox, signature etc. on the - page. - type: object - id: GoogleCloudDocumentaiV1DocumentPageVisualElement - properties: - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for VisualElement. - type: - type: string - description: Type of the VisualElement. - detectedLanguages: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - GoogleCloudContentwarehouseV1RequestMetadata: - properties: - userInfo: - description: Provides user unique identification and groups information. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UserInfo' - description: Meta information is used to improve the performance of the service. - id: GoogleCloudContentwarehouseV1RequestMetadata - type: object - GoogleCloudContentwarehouseV1DocumentReference: - type: object - properties: - updateTime: - readOnly: true - type: string - description: Output only. The time when the document is last updated. - format: google-datetime - documentIsRetentionFolder: - description: Document is a folder with retention policy. - 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: - type: string - description: Output only. The time when the document is created. - format: google-datetime - readOnly: true - documentIsFolder: - description: The document type of the document being referenced. - type: boolean - documentIsLegalHoldFolder: - description: Document is a folder with legal hold. - type: boolean - deleteTime: - description: Output only. The time when the document is deleted. - readOnly: true - format: google-datetime - type: string - displayName: - 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. - id: GoogleCloudContentwarehouseV1DocumentReference - description: References to the documents. - GoogleCloudContentwarehouseV1HistogramQueryResult: - id: GoogleCloudContentwarehouseV1HistogramQueryResult - type: object - description: Histogram result that matches HistogramQuery specified in searches. - properties: - histogramQuery: - description: Requested histogram expression. - type: string - histogram: - type: object - 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. - GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus: - description: The status of processing a document. - id: GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus - properties: - documentId: - type: string - description: Document identifier of an existing document. - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status processing the document. - type: object - CloudAiPlatformTenantresourceTenantServiceAccountIdentity: - type: object - id: CloudAiPlatformTenantresourceTenantServiceAccountIdentity - properties: - serviceName: - type: string - description: >- - Input/Output [Required]. The service that the service account - belongs to. (e.g. cloudbuild.googleapis.com for GCB service - accounts) - serviceAccountEmail: - type: string - description: Output only. The email address of the generated service account. - description: >- - The identity of service accounts that have been explicitly created under - tenant projects. - CloudAiPlatformTenantresourceCloudSqlInstanceConfig: - id: CloudAiPlatformTenantresourceCloudSqlInstanceConfig - description: >- - The identity to configure a CloudSQL instance provisioned via SLM - Terraform. - properties: - slmInstanceName: - description: Output only. The SLM instance's full resource name. - type: string - kmsKeyReference: - 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. - type: string - cloudSqlInstanceConnectionName: - type: string - description: Output only. The CloudSQL instance connection name. - slmInstanceType: - type: string - description: Input [Required]. The SLM instance type to provision CloudSQL. - slmInstanceTemplate: - type: string - description: Input [Required]. The SLM instance template to provision CloudSQL. - mdbRolesForCorpAccess: - type: array - description: Input [Optional]. MDB roles for corp access to CloudSQL instance. - items: - type: string - 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 - type: object - GoogleCloudDocumentaiV1DocumentPageAnchor: - properties: - pageRefs: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchorPageRef - description: One or more references to visual page elements - type: array - id: 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. - GoogleCloudContentwarehouseV1LockDocumentRequest: - description: Request message for DocumentService.LockDocument. - id: GoogleCloudContentwarehouseV1LockDocumentRequest - type: object - properties: - lockingUser: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UserInfo' - description: The user information who locks the document. - collectionId: - type: string - description: The collection the document connects to. - GoogleCloudContentwarehouseV1PropertyFilter: - id: GoogleCloudContentwarehouseV1PropertyFilter - type: object - properties: - condition: - type: string + metadata: 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. - documentSchemaName: - type: string + Additional information for the API invocation, such as the request + tracking id. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' + ruleEngineOutput: description: >- - The Document schema name Document.document_schema_name. Format: - projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. - GoogleCloudDocumentaiV1DocumentProvenance: - id: GoogleCloudDocumentaiV1DocumentProvenance - description: >- - Structure to identify provenance relationships between annotations in - different revisions. + 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' + document: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + description: Updated document after executing update request. + description: Response message for DocumentService.UpdateDocument. type: object + id: GoogleCloudContentwarehouseV1UpdateDocumentResponse + GoogleCloudDocumentaiV1Document: properties: - revision: - description: The index of the revision that produced this element. - deprecated: true - type: integer - format: int32 - id: - deprecated: true - description: >- - The Id of this operation. Needs to be unique within the scope of the - revision. - type: integer - format: int32 - type: - description: The type of provenance operation. - enumDeprecated: - - false - - false - - false - - false - - false - - true - - true - - true - 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. - enum: - - OPERATION_TYPE_UNSPECIFIED - - ADD - - REMOVE - - UPDATE - - REPLACE - - EVAL_REQUESTED - - EVAL_APPROVED - - EVAL_SKIPPED - parents: + revisions: + description: Placeholder. Revision history of this document. items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentProvenanceParent - type: array - description: References to the original elements that are replaced. - 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/). - id: GoogleIamV1Policy - properties: - 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: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentRevision' + type: array + error: + description: Any error that occurred while processing this document. + $ref: '#/components/schemas/GoogleRpcStatus' + text: type: string + description: Optional. UTF-8 encoded text in reading order from the document. + pages: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPage' + type: array + description: Visual page layout for the Document. + textChanges: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextChange' 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. + 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 + 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. + content: + type: string format: byte - bindings: + 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. + entityRelations: type: array + description: Placeholder. Relationship among Document.entities. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntityRelation' + uri: + 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`. + 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). + textStyles: items: - $ref: '#/components/schemas/GoogleIamV1Binding' - auditConfigs: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyle' + description: Styles for the Document.text. type: array + deprecated: true + mimeType: + type: string + description: >- + An IANA published [media type (MIME + type)](https://www.iana.org/assignments/media-types/media-types.xhtml). + 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 + 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. + GoogleCloudContentwarehouseV1FetchAclRequest: + type: object + 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. + description: Request message for DocumentService.FetchAcl + id: GoogleCloudContentwarehouseV1FetchAclRequest + 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: + 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: + 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 + 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 + GoogleCloudDocumentaiV1DocumentPageSymbol: + id: GoogleCloudDocumentaiV1DocumentPageSymbol + properties: + layout: + description: Layout for Symbol. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + detectedLanguages: items: - $ref: '#/components/schemas/GoogleIamV1AuditConfig' - description: Specifies cloud audit logging configuration for this policy. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + type: array + description: A list of detected languages together with confidence. type: object - GoogleCloudDocumentaiV1DocumentPageBlock: + description: A detected symbol. + GoogleCloudDocumentaiV1DocumentPageParagraph: + type: object + id: GoogleCloudDocumentaiV1DocumentPageParagraph properties: detectedLanguages: items: @@ -2474,2388 +2126,2733 @@ components: description: A list of detected languages together with confidence. type: array layout: - description: Layout for Block. + description: Layout for Paragraph. $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' provenance: + description: The history of this annotation. $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 - GoogleCloudDocumentaiV1DocumentStyleFontSize: - description: Font size with unit. - id: GoogleCloudDocumentaiV1DocumentStyleFontSize + description: A collection of lines that a human would perceive as a paragraph. + GoogleCloudContentwarehouseV1PublishAction: type: object properties: - unit: + messages: + type: array + items: + type: string + description: Messages to be published. + topicId: type: string description: >- - Unit for the font size. Follows CSS naming (such as `in`, `px`, and - `pt`). - size: - format: float - type: number - description: Font size for the text. - GoogleCloudDocumentaiV1DocumentPageLine: + 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. + id: GoogleCloudContentwarehouseV1PublishAction + GoogleCloudDocumentaiV1DocumentTextChange: + id: GoogleCloudDocumentaiV1DocumentTextChange properties: - detectedLanguages: + 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. + changedText: + description: The text that replaces the text identified in the `text_anchor`. + type: string + provenance: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: The history of this annotation. + deprecated: true type: array + description: This message is used for text changes aka. OCR corrections. + type: object + GoogleCloudContentwarehouseV1QAResult: + description: Additional result info for the question-answering feature. + properties: + confidenceScore: + format: float + 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. + highlights: + description: Highlighted sections in the snippet. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - provenance: - deprecated: true - description: The history of this annotation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for Line. - id: GoogleCloudDocumentaiV1DocumentPageLine - description: >- - A collection of tokens that a human would perceive as a line. Does not - cross column boundaries, can be horizontal, vertical, etc. + #/components/schemas/GoogleCloudContentwarehouseV1QAResultHighlight + type: array + type: object + id: GoogleCloudContentwarehouseV1QAResult + GoogleCloudContentwarehouseV1RuleEvaluatorOutput: type: object + id: GoogleCloudContentwarehouseV1RuleEvaluatorOutput + properties: + matchedRules: + type: array + description: >- + A subset of triggered rules that are evaluated true for a given + request. + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' + invalidRules: + type: array + description: >- + A subset of triggered rules that failed the validation check(s) + after parsing. + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1InvalidRule' + triggeredRules: + type: array + description: >- + List of rules fetched from database for the given request trigger + type. + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' + description: Represents the output of the Rule Evaluator. GoogleCloudDocumentaiV1DocumentRevision: - description: Contains past or forward revisions of this document. type: object - id: GoogleCloudDocumentaiV1DocumentRevision + description: Contains past or forward revisions of this document. properties: - processor: - description: >- - If the annotation was made by processor identify the processor by - its resource name. - type: string parent: + items: + type: integer + format: int32 + type: array + deprecated: true 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 + parentIds: type: array - deprecated: true + 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 + agent: + type: string + description: >- + If the change was made by a person specify the name or id of that + person. createTime: + type: string description: >- The time that the revision was created, internally generated by doc proto storage at the time of create. format: google-datetime + id: + description: >- + Id of the revision, internally generated by doc proto storage. + Unique within the context of the document. type: string humanReview: description: Human Review information of this revision. $ref: >- #/components/schemas/GoogleCloudDocumentaiV1DocumentRevisionHumanReview - agent: + processor: description: >- - If the change was made by a person specify the name or id of that - person. + If the annotation was made by processor identify the processor by + its resource name. type: string - id: + id: GoogleCloudDocumentaiV1DocumentRevision + GoogleCloudContentwarehouseV1CreateDocumentMetadata: + type: object + description: Metadata object for CreateDocument request (currently empty). + properties: {} + id: GoogleCloudContentwarehouseV1CreateDocumentMetadata + 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 + GoogleCloudContentwarehouseV1DateTimeTypeOptions: + type: object + id: GoogleCloudContentwarehouseV1DateTimeTypeOptions + description: Configurations for a date time property. + properties: {} + GoogleCloudDocumentaiV1NormalizedVertex: + 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. + id: GoogleCloudDocumentaiV1NormalizedVertex + properties: + x: + type: number + description: X coordinate. + format: float + 'y': + type: number + description: Y coordinate (starts from the top of the image). + format: float + GoogleCloudContentwarehouseV1SearchDocumentsResponse: + type: object + id: GoogleCloudContentwarehouseV1SearchDocumentsResponse + properties: + matchingDocuments: + items: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument description: >- - Id of the revision, internally generated by doc proto storage. - Unique within the context of the document. - type: string - parentIds: + The document entities that match the specified + SearchDocumentsRequest. + type: array + histogramQueryResults: 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. + The histogram results that match with the specified + SearchDocumentsRequest.histogram_queries. + items: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1HistogramQueryResult type: array + totalSize: + type: integer + 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". + format: int32 + metadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' + description: >- + Additional information for the API invocation, such as the request + tracking id. + questionAnswer: + type: string + description: Experimental. Question answer from the query against the document. + nextPageToken: + type: string + description: >- + The token that specifies the starting position of the next page of + results. This field is empty if there are no more results. + description: Response message for DocumentService.SearchDocuments. + GoogleCloudDocumentaiV1DocumentPageTableTableCell: + type: object + description: A cell representation inside the table. + properties: + colSpan: + type: integer + description: How many columns this cell spans. + format: int32 + rowSpan: + format: int32 + type: integer + description: How many rows this cell spans. + detectedLanguages: items: - type: string - 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. - id: GoogleCloudDocumentaiV1DocumentShardInfo + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages together with confidence. + type: array + layout: + description: Layout for TableCell. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + id: GoogleCloudDocumentaiV1DocumentPageTableTableCell + GoogleTypeColor: 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(''); }; // ... properties: - shardCount: - format: int64 - description: Total number of shards. - type: string - shardIndex: - format: int64 - description: The 0-based index of this shard. + red: + format: float + type: number + description: The amount of red in the color as a value in the interval [0, 1]. + 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: + description: The amount of green in the color as a value in the interval [0, 1]. + type: number + format: float + blue: + description: The amount of blue in the color as a value in the interval [0, 1]. + format: float + type: number + GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus: + properties: + documentId: type: string - textOffset: + description: Document identifier of an existing document. + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status processing the document. + description: The status of processing a document. + id: GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus + type: object + GoogleIamV1AuditConfig: + properties: + auditLogConfigs: + items: + $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' + type: array + description: The configuration for logging of each type of permission. + service: type: string - format: int64 description: >- - The index of the first character in Document.text in the overall - document global text. - GoogleIamV1AuditLogConfig: - type: object + 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: >- - 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 + 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 + GoogleCloudContentwarehouseV1ListLinkedTargetsResponse: + type: object + description: Response message for DocumentLinkService.ListLinkedTargets. 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: + documentLinks: type: array + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' + description: Target document-links. + nextPageToken: description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. + 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: GoogleCloudContentwarehouseV1ListLinkedTargetsResponse + GoogleCloudContentwarehouseV1ListSynonymSetsResponse: + properties: + nextPageToken: + type: string + description: >- + A page token, received from a previous `ListSynonymSets` call. + Provide this to retrieve the subsequent page. + synonymSets: items: - type: string - GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + type: array + description: The synonymSets from the specified parent. + id: GoogleCloudContentwarehouseV1ListSynonymSetsResponse type: object - description: >- - The configuration of processing documents in Document Warehouse with - DocAi processors pipeline. + description: Response message for SynonymSetService.ListSynonymSets. + CloudAiPlatformTenantresourceIamPolicyBinding: properties: - exportFolderPath: - type: string + resource: 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. - documents: + 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 + members: 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}. - processorResultsFolderPath: + Input/Output [Required]. The member service accounts with the roles + above. Note: placeholders are same as the resource above. + role: + description: Input/Output [Required]. The role for members below. + type: string + resourceType: + enum: + - RESOURCE_TYPE_UNSPECIFIED + - PROJECT + - SERVICE_ACCOUNT + - GCS_BUCKET + - SERVICE_CONSUMER + - AR_REPO type: string description: >- - The Cloud Storage folder path used to store the raw results from - processors. Format: `gs:///`. - id: GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline - GoogleCloudContentwarehouseV1AccessControlAction: - type: object - properties: - operationType: + Input/Output [Required]. Specifies the type of resource that will be + accessed by members. 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 - description: Identifies the type of operation. - enum: - - UNKNOWN - - ADD_POLICY_BINDING - - REMOVE_POLICY_BINDING - - REPLACE_POLICY_BINDING - type: string - 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. - id: GoogleCloudContentwarehouseV1AccessControlAction + 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: >- - Represents the action responsible for access control list management - operations. - GoogleCloudContentwarehouseV1FileTypeFilter: - description: Filter for the specific types of documents returned. + The dynamic IAM bindings to be granted after tenant projects are + created. type: object - id: GoogleCloudContentwarehouseV1FileTypeFilter - properties: - fileType: - description: The type of files to return. - 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 - type: string - GoogleCloudContentwarehouseV1PropertyDefinition: + GoogleCloudContentwarehouseV1CreateDocumentLinkRequest: + description: Request message for DocumentLinkService.CreateDocumentLink. + type: object + id: GoogleCloudContentwarehouseV1CreateDocumentLinkRequest properties: - isFilterable: - description: >- - Whether the property can be filtered. If this is a sub-property, all - the parent properties must be marked filterable. - type: boolean - retrievalImportance: - description: The retrieval importance of the property during search. - 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 - type: string - isSearchable: - type: boolean - description: Indicates that the property should be included in a global search. - floatTypeOptions: - description: Float property. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1FloatTypeOptions' - propertyTypeOptions: - description: Nested structured data property. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1PropertyTypeOptions - schemaSources: - items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource - type: array + documentLink: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' description: >- - The mapping information between this property to another schema - source. - dateTimeTypeOptions: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DateTimeTypeOptions + Required. Document links associated with the source documents + (source_document_id). + requestMetadata: description: >- - Date time property. It is not supported by CMEK compliant - deployment. - integerTypeOptions: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1IntegerTypeOptions' - description: Integer property. - textTypeOptions: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TextTypeOptions' - description: Text/string property. + The meta information collected about the document creator, used to + enforce access control for the service. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + GoogleCloudContentwarehouseV1SynonymSet: + type: object + properties: + synonyms: + description: List of Synonyms for the context. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1SynonymSetSynonym name: 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 . + The resource name of the SynonymSet This is mandatory for + google.api.resource. Format: + projects/{project_number}/locations/{location}/synonymSets/{context}. type: string - displayName: - description: The display-name for the property, used for front-end. + 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. + type: string + id: 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 + GoogleCloudContentwarehouseV1GcsIngestPipeline: + type: object + properties: + processorType: type: string - isRepeatable: - type: boolean - description: Whether the property can have multiple values. - 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. - enumTypeOptions: - description: Enum/categorical property. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1EnumTypeOptions' - timestampTypeOptions: + The Doc AI processor type name. Only used when the format of + ingested files is Doc AI Document proto format. + pipelineConfig: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1TimestampTypeOptions + #/components/schemas/GoogleCloudContentwarehouseV1IngestPipelineConfig description: >- - Timestamp property. It is not supported by CMEK compliant - deployment. - isMetadata: + 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. + skipIngestedDocuments: type: boolean 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. - mapTypeOptions: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MapTypeOptions' - description: Map property. - id: GoogleCloudContentwarehouseV1PropertyDefinition - type: object - description: Defines the metadata for a schema property. - GoogleIamV1Binding: - description: Associates `members`, or principals, with a `role`. - properties: - 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' - 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: - type: array + 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. + schemaName: 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 - id: GoogleIamV1Binding - type: object - GoogleCloudContentwarehouseV1WeightedSchemaProperty: - type: object - description: Specifies the schema property name. - id: GoogleCloudContentwarehouseV1WeightedSchemaProperty - properties: - propertyNames: - items: - type: string - description: The property definition names in the schema. - type: array - documentSchemaName: + 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 - description: The document schema name. - GoogleCloudDocumentaiV1DocumentTextChange: - id: GoogleCloudDocumentaiV1DocumentTextChange - properties: - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + inputPath: 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: + The input Cloud Storage folder. All files under this folder will be + imported to Document Warehouse. Format: `gs:///`. type: string - description: The text that replaces the text identified in the `text_anchor`. - provenance: - deprecated: true - description: The history of this annotation. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - type: array - type: object - description: This message is used for text changes aka. OCR corrections. - GoogleCloudContentwarehouseV1beta1UpdateDocumentMetadata: - properties: {} - id: GoogleCloudContentwarehouseV1beta1UpdateDocumentMetadata + description: The configuration of the Cloud Storage Ingestion pipeline. + id: GoogleCloudContentwarehouseV1GcsIngestPipeline + GoogleCloudContentwarehouseV1UpdateDocumentMetadata: type: object description: Metadata object for UpdateDocument request (currently empty). - GoogleCloudContentwarehouseV1Action: - id: GoogleCloudContentwarehouseV1Action + properties: {} + id: GoogleCloudContentwarehouseV1UpdateDocumentMetadata + GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak: + id: GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak properties: - addToFolder: - description: Action triggering create document link operation. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1AddToFolderAction' - accessControl: - description: Action triggering access control operations. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1AccessControlAction - removeFromFolderAction: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RemoveFromFolderAction - description: Action removing a document from a folder. - actionId: + type: type: string - description: ID of the action. Managed internally. - deleteDocumentAction: - description: Action deleting the document. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DeleteDocumentAction - publishToPubSub: - description: Action publish to Pub/Sub operation. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PublishAction' - dataUpdate: - description: Action triggering data update operations. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DataUpdateAction' - dataValidation: - description: Action triggering data validation operations. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DataValidationAction - description: Represents the action triggered by Rule Engine when the rule is true. + 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 + description: Detected break at the end of a Token. + type: object + GoogleCloudContentwarehouseV1TextArray: + id: GoogleCloudContentwarehouseV1TextArray + description: String/text values. + type: object + properties: + values: + description: List of text values. + items: + type: string + type: array + GoogleCloudDocumentaiV1DocumentStyle: type: object - GoogleCloudDocumentaiV1DocumentStyle: - description: >- - Annotation for common text style attributes. This adheres to CSS - conventions as much as possible. properties: + fontWeight: + type: string + description: >- + [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). + Possible values are `normal`, `bold`, `bolder`, and `lighter`. + fontFamily: + description: >- + Font family such as `Arial`, `Times New Roman`. + https://www.w3schools.com/cssref/pr_font_font-family.asp + type: string + backgroundColor: + $ref: '#/components/schemas/GoogleTypeColor' + description: Text background color. fontSize: $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyleFontSize' description: Font size. - backgroundColor: - description: Text background color. - $ref: '#/components/schemas/GoogleTypeColor' - textAnchor: - description: Text anchor indexing into the Document.text. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' textDecoration: + type: string description: >- [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. - type: string + textAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + description: Text anchor indexing into the Document.text. color: - $ref: '#/components/schemas/GoogleTypeColor' description: Text color. - fontFamily: - type: string - description: >- - Font family such as `Arial`, `Times New Roman`. - https://www.w3schools.com/cssref/pr_font_font-family.asp + $ref: '#/components/schemas/GoogleTypeColor' textStyle: + type: string description: >- [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`. + description: >- + Annotation for common text style attributes. This adheres to CSS + conventions as much as possible. + id: GoogleCloudDocumentaiV1DocumentStyle + GoogleCloudContentwarehouseV1FloatArray: + description: Float values. + id: GoogleCloudContentwarehouseV1FloatArray + type: object + properties: + values: + type: array + items: + type: number + format: float + description: List of float values. + GoogleTypeMoney: + properties: + units: + description: >- + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. type: string - fontWeight: + format: int64 + currencyCode: type: string + description: The three-letter currency code defined in ISO 4217. + nanos: description: >- - [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). - Possible values are `normal`, `bold`, `bolder`, and `lighter`. - id: GoogleCloudDocumentaiV1DocumentStyle + 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 type: object - GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo: - description: Font and other text style attributes. + description: Represents an amount of money with its currency type. + CloudAiPlatformTenantresourceCloudSqlInstanceConfig: + description: >- + The identity to configure a CloudSQL instance provisioned via SLM + Terraform. type: object - id: GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo + id: CloudAiPlatformTenantresourceCloudSqlInstanceConfig properties: - letterSpacing: - description: Letter spacing in points. - format: double - type: number - underlined: - type: boolean - description: Whether the text is underlined. - fontType: - description: Name or style of the font. + cloudSqlInstanceConnectionName: + description: Output only. The CloudSQL instance connection name. type: string - handwritten: + slmInstanceType: + description: Input [Required]. The SLM instance type to provision CloudSQL. + type: string + cloudSqlInstanceName: + 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. + slmInstanceName: + type: string + description: Output only. The SLM instance's full resource name. + mdbRolesForCorpAccess: + type: array + description: Input [Optional]. MDB roles for corp access to CloudSQL instance. + items: + type: string + slmInstanceTemplate: + description: Input [Required]. The SLM instance template to provision CloudSQL. + type: string + kmsKeyReference: + 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. + type: string + GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata: + description: The metadata message for Export-to-CDW pipeline. + properties: + documents: + description: >- + The input list of all the resource names of the documents to be + exported. + type: array + items: + type: string + docAiDataset: + description: The output CDW dataset resource name. + type: string + outputPath: + type: string + description: The output Cloud Storage folder in this pipeline. + type: object + id: >- + GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata + GoogleCloudContentwarehouseV1ProcessorInfo: + id: GoogleCloudContentwarehouseV1ProcessorInfo + properties: + documentType: + type: string + description: The processor will process the documents with this document type. + processorName: + description: >- + The processor resource name. Format is + `projects/{project}/locations/{location}/processors/{processor}`, or + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` + type: string + schemaName: + 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}. + type: string + type: object + description: The DocAI processor information. + GoogleCloudContentwarehouseV1TimestampArray: + type: object + description: Timestamp values. + properties: + values: + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampValue' + description: List of timestamp values. + type: array + id: GoogleCloudContentwarehouseV1TimestampArray + GoogleCloudContentwarehouseV1PropertyDefinition: + id: GoogleCloudContentwarehouseV1PropertyDefinition + type: object + description: Defines the metadata for a schema property. + properties: + schemaSources: + items: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource + type: array + description: >- + The mapping information between this property to another schema + source. + mapTypeOptions: + description: Map property. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MapTypeOptions' + textTypeOptions: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TextTypeOptions' + description: Text/string property. + propertyTypeOptions: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1PropertyTypeOptions + description: Nested structured data property. + 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 - description: Whether the text is handwritten. - bold: + retrievalImportance: + enum: + - RETRIEVAL_IMPORTANCE_UNSPECIFIED + - HIGHEST + - HIGHER + - HIGH + - MEDIUM + - LOW + - LOWEST + type: string + description: The retrieval importance of the property during search. + enumDescriptions: + - No importance specified. Default medium importance. + - Highest importance. + - Higher importance. + - High importance. + - Medium importance. + - Low importance (negative). + - Lowest importance (negative). + isRepeatable: type: boolean + description: Whether the property can have multiple values. + dateTimeTypeOptions: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1DateTimeTypeOptions description: >- - Whether the text is bold (equivalent to font_weight is at least - `700`). - backgroundColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Color of the background. - italic: - description: Whether the text is italic. + Date time property. It is not supported by CMEK compliant + deployment. + timestampTypeOptions: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1TimestampTypeOptions + description: >- + Timestamp property. It is not supported by CMEK compliant + deployment. + floatTypeOptions: + description: Float property. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1FloatTypeOptions' + isFilterable: type: boolean - textColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Color of the text. - pixelFontSize: - type: number description: >- - Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ - `72.0`. - format: double - strikeout: + Whether the property can be filtered. If this is a sub-property, all + the parent properties must be marked filterable. + isSearchable: type: boolean + description: Indicates that the property should be included in a global search. + name: + type: string description: >- - Whether the text is strikethrough. This feature is not supported - yet. - superscript: + 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 . + displayName: + type: string + description: The display-name for the property, used for front-end. + enumTypeOptions: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1EnumTypeOptions' + description: Enum/categorical property. + integerTypeOptions: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1IntegerTypeOptions' + description: Integer property. + isRequired: type: boolean description: >- - Whether the text is a superscript. This feature is not supported - yet. - smallcaps: + 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. + GoogleCloudContentwarehouseV1FetchAclResponse: + description: Response message for DocumentService.FetchAcl. + type: object + properties: + policy: + $ref: '#/components/schemas/GoogleIamV1Policy' + description: The IAM policy. + metadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' description: >- - Whether the text is in small caps. This feature is not supported - yet. - type: boolean - fontWeight: - format: int32 + Additional information for the API invocation, such as the request + tracking id. + id: GoogleCloudContentwarehouseV1FetchAclResponse + GoogleCloudDocumentaiV1DocumentProvenance: + type: object + description: >- + Structure to identify provenance relationships between annotations in + different revisions. + id: GoogleCloudDocumentaiV1DocumentProvenance + properties: + 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 + type: string + enum: + - OPERATION_TYPE_UNSPECIFIED + - ADD + - REMOVE + - UPDATE + - REPLACE + - EVAL_REQUESTED + - EVAL_APPROVED + - EVAL_SKIPPED + description: The type of provenance operation. + id: + deprecated: true type: integer + format: int32 description: >- - TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). - Normal is `400`, bold is `700`. - subscript: - type: boolean - description: Whether the text is a subscript. This feature is not supported yet. - fontSize: + The Id of this operation. Needs to be unique within the scope of the + revision. + parents: + description: References to the original elements that are replaced. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentProvenanceParent + type: array + revision: format: int32 - description: Font size in points (`1` point is `¹⁄₇₂` inches). + deprecated: true type: integer - GoogleCloudContentwarehouseV1PropertyArray: - description: Property values. - id: GoogleCloudContentwarehouseV1PropertyArray + description: The index of the revision that produced this element. + GoogleCloudContentwarehouseV1FloatTypeOptions: + description: Configurations for a float property. + properties: {} type: object - properties: - properties: - type: array - description: List of property values. - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Property' - GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument: - id: GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument - description: Document entry with metadata inside SearchDocumentsResponse + id: GoogleCloudContentwarehouseV1FloatTypeOptions + GoogleCloudDocumentaiV1DocumentPageTableTableRow: type: object + id: GoogleCloudDocumentaiV1DocumentPageTableTableRow + description: A row of table cells. properties: - matchedTokenPageIndices: - description: >- - Return the 1-based page indices where those pages have one or more - matched tokens. + cells: items: - type: string - format: int64 + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableCell + description: Cells that make up this row. type: array - 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 - qaResult: - description: >- - Experimental. Additional result info if the question-answering - feature is enabled. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1QAResult' - document: - description: >- - Document that matches the specified SearchDocumentsRequest. This - document only contains indexed metadata information. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' - GoogleLongrunningOperation: + GoogleCloudContentwarehouseV1QAResultHighlight: + description: >- + A text span in the search text snippet that represents a highlighted + section (answer context, highly relevant sentence, etc.). type: object - id: GoogleLongrunningOperation + properties: + endIndex: + description: End index of the highlight, exclusive. + type: integer + format: int32 + startIndex: + description: Start index of the highlight. + format: int32 + type: integer + id: GoogleCloudContentwarehouseV1QAResultHighlight + GoogleCloudContentwarehouseV1UpdateRuleSetRequest: + properties: + ruleSet: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' + description: Required. The rule set to update. + description: Request message for RuleSetService.UpdateRuleSet. + type: object + id: GoogleCloudContentwarehouseV1UpdateRuleSetRequest + GoogleCloudDocumentaiV1DocumentPageBlock: + properties: + detectedLanguages: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages together with confidence. + layout: + description: Layout for Block. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + deprecated: true + description: The history of this annotation. description: >- - This resource represents a long-running operation that is the result of - a network API call. + A block has a set of lines (collected into paragraphs) that have a + common line-spacing and orientation. + type: object + id: GoogleCloudDocumentaiV1DocumentPageBlock + GoogleCloudContentwarehouseV1EnumArray: 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 - 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. - 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 - 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 - GoogleCloudContentwarehouseV1CustomWeightsMetadata: - id: GoogleCloudContentwarehouseV1CustomWeightsMetadata - description: To support the custom weighting across document schemas. + values: + type: array + description: List of enum values. + items: + type: string + description: Enum values. + id: GoogleCloudContentwarehouseV1EnumArray + type: object + GoogleCloudDocumentaiV1DocumentPageToken: type: object properties: - weightedSchemaProperties: + provenance: + deprecated: true + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: The history of this annotation. + styleInfo: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo + description: Text style attributes. + detectedLanguages: + description: A list of detected languages together with confidence. items: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1WeightedSchemaProperty + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage type: array - description: >- - List of schema and property name. Allows a maximum of 10 schemas to - be specified for relevance boosting. - GoogleCloudContentwarehouseV1TimestampArray: + layout: + description: Layout for Token. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + detectedBreak: + description: Detected break at the end of a Token. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak + id: GoogleCloudDocumentaiV1DocumentPageToken + description: A detected token. + 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 - id: GoogleCloudContentwarehouseV1TimestampArray - description: Timestamp values. - properties: - values: - description: List of timestamp values. - type: array - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampValue' - GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource: - id: GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource properties: - processorType: + cmekCloudResourceType: + description: >- + The cloud resource type for the CMEK encryption. For example, + contentwarehouse.googleapis.com/Location type: string - description: The Doc AI processor type name. - name: + cmekServiceName: + description: >- + The service name for the CMEK encryption. For example, + contentwarehouse.googleapis.com type: string - description: The schema name in the source. - type: object - description: The schema source information. - GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak: - id: GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak - type: object - properties: - type: + cmekCloudResourceName: type: string - description: Detected break type. - enumDescriptions: - - Unspecified break type. - - A single whitespace. - - A wider whitespace. - - A hyphen that indicates that a token has been split across lines. - enum: - - TYPE_UNSPECIFIED - - SPACE - - WIDE_SPACE - - HYPHEN - description: Detected break at the end of a Token. - GoogleCloudContentwarehouseV1DateTimeTypeOptions: - description: Configurations for a date time property. - id: GoogleCloudContentwarehouseV1DateTimeTypeOptions - type: object - properties: {} - GoogleApiServiceconsumermanagementV1BillingConfig: - description: Describes the billing configuration for a new tenant project. + description: >- + The cloud resource name for the CMEK encryption. For example, + projects//locations/ + id: CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions + 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: - billingAccount: + location: + description: >- + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. type: string + title: description: >- - Name of the billing account. For example - `billingAccounts/012345-567890-ABCDEF`. + 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. + id: GoogleTypeExpr type: object - id: GoogleApiServiceconsumermanagementV1BillingConfig - GoogleCloudContentwarehouseV1QAResult: - id: GoogleCloudContentwarehouseV1QAResult + GoogleCloudContentwarehouseV1CreateDocumentResponse: properties: - highlights: - items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1QAResultHighlight - description: Highlighted sections in the snippet. + 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 + longRunningOperations: type: array - confidenceScore: - type: number + description: post-processing LROs + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' + document: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + description: Document created after executing create request. + metadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' 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 - description: Additional result info for the question-answering feature. + Additional information for the API invocation, such as the request + tracking id. + id: GoogleCloudContentwarehouseV1CreateDocumentResponse + description: Response message for DocumentService.CreateDocument. type: object - GoogleIamV1AuditConfig: + GoogleCloudContentwarehouseV1GetDocumentRequest: + description: Request message for DocumentService.GetDocument. + type: object + 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' + GoogleCloudContentwarehouseV1ListLinkedTargetsRequest: + properties: + requestMetadata: + description: >- + The meta information collected about the document creator, used to + enforce access control for the service. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + id: GoogleCloudContentwarehouseV1ListLinkedTargetsRequest type: object + description: Request message for DocumentLinkService.ListLinkedTargets. + GoogleTypePostalAddress: 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 + 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: - service: + 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". + 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 + sublocality: + description: >- + Optional. Sublocality of the address. For example, this can be + neighborhoods, boroughs, districts. + type: string + 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. + 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). + postalCode: + 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. + 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.). + 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 + regionCode: type: string - auditLogConfigs: + 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. + addressLines: type: array - description: The configuration for logging of each type of permission. items: - $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' - GoogleCloudContentwarehouseV1SetAclRequest: - properties: - 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: + type: string description: >- - The meta information collected about the end user, used to enforce - access control for the service. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - projectOwner: - type: boolean + 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). + revision: + type: integer description: >- - For Set Project ACL only. Authorization check for end user will be - ignored when project_owner=true. - id: GoogleCloudContentwarehouseV1SetAclRequest + 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 + organization: + description: Optional. The name of the organization at the address. + type: string + id: GoogleTypePostalAddress + GoogleCloudDocumentaiV1BoundingPoly: + properties: + normalizedVertices: + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1NormalizedVertex' + description: The bounding polygon normalized vertices. + vertices: + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Vertex' + description: The bounding polygon vertices. + description: A bounding polygon for the detected image annotation. type: object - description: Request message for DocumentService.SetAcl. + id: GoogleCloudDocumentaiV1BoundingPoly GoogleCloudContentwarehouseV1DocumentSchema: + id: GoogleCloudContentwarehouseV1DocumentSchema + description: A document schema used to define document structure. type: object properties: - createTime: - readOnly: true - format: google-datetime - type: string - description: Output only. The time when the document schema is created. - name: - type: string + displayName: 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. + Required. Name of the schema given by the user. Must be unique per + project. + type: string documentIsFolder: type: boolean description: >- Document Type, true refers the document is a folder, otherwise it is a typical document. - displayName: - description: >- - Required. Name of the schema given by the user. Must be unique per - project. + description: type: string - updateTime: - format: google-datetime - readOnly: true + description: Schema description. + createTime: + description: Output only. The time when the document schema is created. type: string - description: Output only. The time when the document schema is last updated. + readOnly: true + format: google-datetime propertyDefinitions: items: $ref: >- #/components/schemas/GoogleCloudContentwarehouseV1PropertyDefinition description: Document details. type: array - description: - type: string - description: Schema description. - description: A document schema used to define document structure. - id: GoogleCloudContentwarehouseV1DocumentSchema - GoogleCloudContentwarehouseV1MergeFieldsOptions: - id: GoogleCloudContentwarehouseV1MergeFieldsOptions - properties: - 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. - replaceRepeatedFields: + name: 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 - type: object - description: Options for merging updated fields. - GoogleCloudContentwarehouseV1DocumentQuery: - id: GoogleCloudContentwarehouseV1DocumentQuery + 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 + updateTime: + type: string + readOnly: true + description: Output only. The time when the document schema is last updated. + format: google-datetime + GoogleCloudDocumentaiV1DocumentTextAnchor: properties: - customWeightsMetadata: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1CustomWeightsMetadata - 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. - documentNameFilter: + content: + type: string description: >- - Search the documents in the list. Format: - projects/{project_number}/locations/{location}/documents/{document_id}. + 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: - type: string - type: array - documentSchemaNames: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment 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. - query: + id: GoogleCloudDocumentaiV1DocumentTextAnchor + description: Text reference indexing into the Document.text. + type: object + GoogleCloudDocumentaiV1DocumentEntityNormalizedValue: + type: object + properties: + integerValue: + format: int32 + type: integer + description: Integer value. + dateValue: 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. + Date value. Includes year, month, day. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/date.proto + $ref: '#/components/schemas/GoogleTypeDate' + floatValue: + format: float + type: number + description: Float value. + text: type: string - 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 - isNlQuery: - 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. + datetimeValue: + $ref: '#/components/schemas/GoogleTypeDateTime' 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. - propertyFilter: - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PropertyFilter' - type: array + DateTime value. Includes date, time, and timezone. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto + booleanValue: description: >- - This filter specifies a structured syntax to match against the - PropertyDefinition.is_filterable marked as `true`. The relationship - between the PropertyFilters is OR. - folderNameFilter: + Boolean value. Can be used for entities with binary values, or for + checkboxes. + type: boolean + addressValue: + $ref: '#/components/schemas/GoogleTypePostalAddress' description: >- - Search all the documents under this specified folder. Format: - projects/{project_number}/locations/{location}/documents/{document_id}. - type: string - timeFilters: + Postal address. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto + moneyValue: + $ref: '#/components/schemas/GoogleTypeMoney' description: >- - Documents created/updated within a range specified by this filter - are searched against. - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimeFilter' + Money value. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/money.proto + id: GoogleCloudDocumentaiV1DocumentEntityNormalizedValue + description: Parsed and normalized entity value. + GoogleCloudContentwarehouseV1DeleteDocumentLinkRequest: + id: GoogleCloudContentwarehouseV1DeleteDocumentLinkRequest + type: object + 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. + GoogleCloudContentwarehouseV1IntegerArray: + type: object + description: Integer values. + id: GoogleCloudContentwarehouseV1IntegerArray + properties: + values: type: array - fileTypeFilter: + items: + format: int32 + type: integer + description: List of integer values. + GoogleCloudContentwarehouseV1SetAclRequest: + id: GoogleCloudContentwarehouseV1SetAclRequest + properties: + requestMetadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' 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. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1FileTypeFilter' - customPropertyFilter: - deprecated: true - type: string + The meta information collected about the end user, used to enforce + access control for the service. + projectOwner: + type: boolean 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` - queryContext: - items: - type: string + For Set Project ACL only. Authorization check for end user will be + ignored when project_owner=true. + policy: + $ref: '#/components/schemas/GoogleIamV1Policy' 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. - type: array - type: object - GoogleCloudContentwarehouseV1ProjectStatus: + 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"` + description: Request message for DocumentService.SetAcl. type: object - id: GoogleCloudContentwarehouseV1ProjectStatus + GoogleCloudContentwarehouseV1DocumentReference: properties: - documentCreatorDefaultRole: - description: The default role for the person who create a document. + createTime: + readOnly: true + format: google-datetime + description: Output only. The time when the document is created. type: string - databaseType: - enumDescriptions: - - This value is required by protobuf best practices - - Internal Spanner - - Cloud Sql with a Postgres Sql instance - description: Database type. + 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 - enum: - - DB_UNKNOWN - - DB_INFRA_SPANNER - - DB_CLOUD_SQL_POSTGRES - enumDeprecated: - - false - - false - - true - qaEnabled: - type: boolean - description: If the qa is enabled on this project. - state: - 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 - description: State of the project. - 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. + snippet: type: string - location: - description: The location of the queried project. + description: >- + Stores the subset of the referenced document's content. This is + useful to allow user peek the information of the referenced + document. + deleteTime: + format: google-datetime + description: Output only. The time when the document is deleted. + readOnly: true type: string - accessControlMode: - 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 - description: Access control mode. + documentName: type: string - description: >- - Status of a project, including the project state, dbType, aclMode and - etc. - CloudAiPlatformTenantresourceServiceAccountIdentity: - id: CloudAiPlatformTenantresourceServiceAccountIdentity + description: Required. Name of the referenced document. + updateTime: + description: Output only. The time when the document is last updated. + type: string + readOnly: true + format: google-datetime + documentIsRetentionFolder: + type: boolean + description: Document is a folder with retention policy. + documentIsFolder: + type: boolean + description: The document type of the document being referenced. + documentIsLegalHoldFolder: + description: Document is a folder with legal hold. + type: boolean + description: References to the documents. + type: object + id: GoogleCloudContentwarehouseV1DocumentReference + GoogleCloudContentwarehouseV1TimestampTypeOptions: + type: object + description: Configurations for a timestamp property. + properties: {} + id: GoogleCloudContentwarehouseV1TimestampTypeOptions + GoogleCloudDocumentaiV1DocumentRevisionHumanReview: + id: GoogleCloudDocumentaiV1DocumentRevisionHumanReview + description: Human Review information of the document. + type: object properties: - serviceAccountEmail: - description: Output only. The service account email that has been created. + state: + type: string + description: Human review state. e.g. `requested`, `succeeded`, `rejected`. + stateMessage: type: string - tag: 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 + A message providing more details about the current state of + processing. For example, the rejection reason when the state is + `rejected`. + GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument: + description: Document entry with metadata inside SearchDocumentsResponse type: object - description: The identity to configure a service account. - GoogleCloudContentwarehouseV1CreateDocumentRequest: + id: GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument properties: - requestMetadata: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + document: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' description: >- - The meta information collected about the end user, used to enforce - access control for the service. - cloudAiDocumentOption: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1CloudAIDocumentOption + Document that matches the specified SearchDocumentsRequest. This + document only contains indexed metadata information. + searchTextSnippet: + type: string 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. - policy: + 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. + qaResult: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1QAResult' 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' - createMask: + Experimental. Additional result info if the question-answering + feature is enabled. + matchedTokenPageIndices: 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 - type: string - document: - description: Required. The document to create. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' - type: object - id: GoogleCloudContentwarehouseV1CreateDocumentRequest - description: Request message for DocumentService.CreateDocument. - GoogleCloudContentwarehouseV1FetchAclResponse: - type: object - description: Response message for DocumentService.FetchAcl. - id: GoogleCloudContentwarehouseV1FetchAclResponse + Return the 1-based page indices where those pages have one or more + matched tokens. + type: array + items: + format: int64 + type: string + GoogleCloudContentwarehouseV1AccessControlAction: properties: + operationType: + type: string + description: Identifies the type of operation. + 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 + enum: + - UNKNOWN + - ADD_POLICY_BINDING + - REMOVE_POLICY_BINDING + - REPLACE_POLICY_BINDING 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. - GoogleCloudContentwarehouseV1ListLinkedTargetsResponse: - id: GoogleCloudContentwarehouseV1ListLinkedTargetsResponse + 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. + description: >- + Represents the action responsible for access control list management + operations. type: object + id: GoogleCloudContentwarehouseV1AccessControlAction + CloudAiPlatformTenantresourceTenantResource: 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: + p4ServiceAccounts: items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' + $ref: >- + #/components/schemas/CloudAiPlatformTenantresourceServiceAccountIdentity type: array - description: Target document-links. - description: Response message for DocumentLinkService.ListLinkedTargets. - GoogleCloudContentwarehouseV1RuleSet: + description: A list of P4 service accounts (go/p4sa) to provision or deprovision. + tenantProjectResources: + items: + $ref: >- + #/components/schemas/CloudAiPlatformTenantresourceTenantProjectResource + type: array + description: >- + A list of tenant projects and tenant resources to provision or + deprovision. + description: A collection of tenant resources. + type: object + id: CloudAiPlatformTenantresourceTenantResource + GoogleCloudContentwarehouseV1SynonymSetSynonym: + description: >- + Represents a list of words given by the customer All these words are + synonyms of each other. + id: GoogleCloudContentwarehouseV1SynonymSetSynonym type: object - description: Represents a set of rules from a single customer. properties: - source: - description: Source of the rules i.e., customer name. - type: string - rules: - type: array + words: + description: 'For example: sale, invoice, bill, order' items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' - description: List of rules given by the customer. - description: - description: Short description of the rule-set. - type: string - name: - type: string + type: string + type: array + GoogleCloudContentwarehouseV1DeleteDocumentRequest: + properties: + requestMetadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' 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. - id: GoogleCloudContentwarehouseV1RuleSet - GoogleCloudContentwarehouseV1EnumTypeOptions: - id: GoogleCloudContentwarehouseV1EnumTypeOptions + The meta information collected about the end user, used to enforce + access control for the service. type: object + description: Request message for DocumentService.DeleteDocument. + id: GoogleCloudContentwarehouseV1DeleteDocumentRequest + GoogleCloudContentwarehouseV1PropertyTypeOptions: properties: - 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. - possibleValues: - description: Required. List of possible enum values. + propertyDefinitions: type: array items: - type: string - description: Configurations for an enum/categorical property. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1PropertyDefinition + description: Required. List of property definitions. + description: Configurations for a nested structured data property. + type: object + id: GoogleCloudContentwarehouseV1PropertyTypeOptions GoogleCloudDocumentaiV1Vertex: properties: 'y': - description: Y coordinate (starts from the top of the image). type: integer format: int32 + description: Y coordinate (starts from the top of the image). x: description: X coordinate. format: int32 type: integer - type: object - 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. - GoogleTypeTimeZone: - properties: - id: - type: string - description: IANA Time Zone Database time zone, e.g. "America/New_York". - version: - type: string - description: Optional. IANA Time Zone Database version number, e.g. "2019a". - type: object - description: >- - Represents a time zone from the [IANA Time Zone - Database](https://www.iana.org/time-zones). - id: GoogleTypeTimeZone - GoogleCloudDocumentaiV1NormalizedVertex: - properties: - 'y': - format: float - type: number - description: Y coordinate (starts from the top of the image). - x: - type: number - description: X coordinate. - format: float - type: object - id: 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. - GoogleCloudDocumentaiV1DocumentPageLayout: type: object + id: GoogleCloudDocumentaiV1Vertex + GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource: + id: GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource + description: The schema source information. 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. - 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]`. - type: number - format: float - orientation: - 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. + name: + description: The schema name in the source. + type: string + processorType: + description: The Doc AI processor type name. type: string - description: Detected orientation for the Layout. - description: Visual element describing a layout unit on a page. - id: GoogleCloudDocumentaiV1DocumentPageLayout - GoogleCloudContentwarehouseV1RuleEngineOutput: - id: GoogleCloudContentwarehouseV1RuleEngineOutput - description: >- - Records the output of Rule Engine including rule evaluation and actions - result. + type: object + GoogleCloudContentwarehouseV1DocumentQuery: + id: GoogleCloudContentwarehouseV1DocumentQuery type: object properties: - actionExecutorOutput: - description: >- - Output from Action Executor containing rule and corresponding - actions execution result. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ActionExecutorOutput - ruleEvaluatorOutput: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RuleEvaluatorOutput + queryContext: + type: array description: >- - Output from Rule Evaluator containing matched, unmatched and invalid - rules. - documentName: - type: string + 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 + timeFilters: description: >- - Name of the document against which the rules and actions were - evaluated. - GoogleCloudContentwarehouseV1ListLinkedSourcesResponse: - properties: - documentLinks: + Documents created/updated within a range specified by this filter + are searched against. items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' - description: Source document-links. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimeFilter' type: array - nextPageToken: - type: string + customWeightsMetadata: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1CustomWeightsMetadata 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: GoogleCloudContentwarehouseV1ListLinkedSourcesResponse - type: object - description: Response message for DocumentLinkService.ListLinkedSources. - GoogleCloudContentwarehouseV1Rule: - type: object - id: GoogleCloudContentwarehouseV1Rule - properties: - description: - type: string - description: Short description of the rule and its context. - condition: - type: string + 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: + items: + type: string 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: + 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. + type: array + folderNameFilter: type: string description: >- - ID of the rule. It has to be unique across all the examples. This is - managed internally. - actions: - description: List of actions that are executed when the rule is satisfied. + Search all the documents under this specified folder. Format: + projects/{project_number}/locations/{location}/documents/{document_id}. + propertyFilter: + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PropertyFilter' + 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 + documentNameFilter: + description: >- + Search the documents in the list. Format: + projects/{project_number}/locations/{location}/documents/{document_id}. items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Action' - 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. - description: Identifies the trigger type for running the policy. - enum: - - UNKNOWN - - ON_CREATE - - ON_UPDATE - - ON_CREATE_LINK - - ON_DELETE_LINK - type: string - description: Represents the rule for a content warehouse trigger. - GoogleTypePostalAddress: - properties: - postalCode: - type: string + type: string + type: array + isNlQuery: 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.). - administrativeArea: + 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 + customPropertyFilter: 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. + 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 type: string - addressLines: + documentSchemaNames: 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). + 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 type: array - sortingCode: + query: + 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. + type: string + fileTypeFilter: + 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. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1FileTypeFilter' + GoogleCloudDocumentaiV1DocumentPageAnchor: + type: object + properties: + pageRefs: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchorPageRef + description: One or more references to visual page elements + type: array + 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 + GoogleCloudDocumentaiV1DocumentPageDetectedLanguage: + properties: + 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 + confidence: + format: float + description: Confidence of detected language. Range `[0, 1]`. + type: number + type: object + description: Detected language for a structural component. + id: GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + GoogleCloudContentwarehouseV1TimeFilter: + type: object + id: GoogleCloudContentwarehouseV1TimeFilter + properties: + timeField: 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). - languageCode: + Specifies which time field to filter documents on. Defaults to + TimeField.UPLOAD_TIME. + 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' + description: Filter on create timestamp or update timestamp of documents. + GoogleCloudDocumentaiV1Barcode: + id: GoogleCloudDocumentaiV1Barcode + properties: + valueFormat: + 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 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". - recipients: - type: array - items: - type: string + 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: + 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. - sublocality: + Raw value encoded in the barcode. For example: + `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. + description: Encodes the detailed information of a barcode. + type: object + GoogleCloudContentwarehouseV1EnumValue: + properties: + value: description: >- - Optional. Sublocality of the address. For example, this can be - neighborhoods, boroughs, districts. + String value of the enum field. This must match defined set of enums + in document schema using EnumTypeOptions. type: string - revision: - type: integer + id: GoogleCloudContentwarehouseV1EnumValue + description: Represents the string value of the enum field. + type: object + GoogleCloudContentwarehouseV1DeleteDocumentAction: + description: Represents the action responsible for deleting the document. + id: GoogleCloudContentwarehouseV1DeleteDocumentAction + type: object + properties: + enableHardDelete: + type: boolean 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 - locality: + Boolean field to select between hard vs soft delete options. Set + 'true' for 'hard delete' and 'false' for 'soft delete'. + GoogleTypeInterval: + type: object + id: GoogleTypeInterval + properties: + endTime: 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. - organization: - description: Optional. The name of the organization at the address. + 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 - 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 + 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 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 + 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. + CloudAiPlatformTenantresourceServiceAccountIdentity: + description: The identity to configure a service account. type: object - GoogleCloudDocumentaiV1DocumentPageFormField: - id: GoogleCloudDocumentaiV1DocumentPageFormField properties: - correctedKeyText: + serviceAccountEmail: 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. - correctedValueText: - 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: Output only. The service account email that has been created. + tag: type: string - nameDetectedLanguages: - description: A list of detected languages for name together with confidence. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - type: array - fieldValue: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for the FormField value. - 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: - description: The history of this annotation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - fieldName: + 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. + id: CloudAiPlatformTenantresourceServiceAccountIdentity + GoogleCloudContentwarehouseV1UpdateDocumentRequest: + id: GoogleCloudContentwarehouseV1UpdateDocumentRequest + description: Request message for DocumentService.UpdateDocument. + properties: + updateOptions: + description: Options for the update operation. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UpdateOptions' + requestMetadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' description: >- - Layout for the FormField name. e.g. `Address`, `Email`, `Grand - total`, `Phone number`, etc. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - valueDetectedLanguages: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - type: array - description: A list of detected languages for value together with confidence. - type: object - description: A form field detected on the page. - GoogleCloudContentwarehouseV1UpdateDocumentResponse: - id: GoogleCloudContentwarehouseV1UpdateDocumentResponse + The meta information collected about the end user, used to enforce + access control for the service. + 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. type: object - description: Response message for DocumentService.UpdateDocument. + GoogleCloudContentwarehouseV1Rule: properties: - metadata: + actions: + type: array + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Action' + description: List of actions that are executed when the rule is satisfied. + description: + type: string + description: Short description of the rule and its context. + ruleId: + type: string description: >- - Additional information for the API invocation, such as the request - tracking id. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' - ruleEngineOutput: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleEngineOutput' + ID of the rule. It has to be unique across all the examples. This is + managed internally. + condition: 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. - CloudAiPlatformTenantresourceTenantResource: - description: A collection of tenant resources. + 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 + 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. + enum: + - UNKNOWN + - ON_CREATE + - ON_UPDATE + - ON_CREATE_LINK + - ON_DELETE_LINK + description: Identifies the trigger type for running the policy. + type: string + id: GoogleCloudContentwarehouseV1Rule + type: object + description: Represents the rule for a content warehouse trigger. + GoogleCloudContentwarehouseV1AddToFolderAction: properties: - tenantProjectResources: + folders: items: - $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceTenantProjectResource + type: string type: array description: >- - A list of tenant projects and tenant resources to provision or - deprovision. - p4ServiceAccounts: - description: A list of P4 service accounts (go/p4sa) to provision or deprovision. - type: array - items: - $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceServiceAccountIdentity - id: CloudAiPlatformTenantresourceTenantResource + Names of the folder under which new document is to be added. Format: + projects/{project_number}/locations/{location}/documents/{document_id}. + id: GoogleCloudContentwarehouseV1AddToFolderAction + description: Represents the action responsible for adding document under a folder. type: object - GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter: + GoogleCloudContentwarehouseV1DateTimeArray: + type: object + id: GoogleCloudContentwarehouseV1DateTimeArray + description: DateTime values. properties: - propertyNames: - items: - type: string - 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". - type: array - documentSchemas: + values: 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}. + List of datetime values. Both OffsetDateTime and ZonedDateTime are + supported. items: - type: string + $ref: '#/components/schemas/GoogleTypeDateTime' type: array - yAxis: + GoogleCloudContentwarehouseV1InitializeProjectRequest: + properties: + accessControlMode: enum: - - HISTOGRAM_YAXIS_DOCUMENT - - HISTOGRAM_YAXIS_PROPERTY + - ACL_MODE_UNKNOWN + - ACL_MODE_UNIVERSAL_ACCESS + - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID + - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI enumDescriptions: - - Count the documents per property name. - - Count the properties per property name. - description: >- - By default, the y_axis is HISTOGRAM_YAXIS_DOCUMENT if this field is - not set. + - 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: Required. The access control mode for accessing the customer data type: string - id: GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter - type: object - GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment: - properties: - startIndex: - format: int64 + enableCalUserEmailLogging: + description: Optional. Whether to enable CAL user email logging. + type: boolean + kmsKey: type: string - 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. + 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. + databaseType: + enumDeprecated: + - false + - false + - true + enumDescriptions: + - This value is required by protobuf best practices + - Internal Spanner + - Cloud Sql with a Postgres Sql instance + description: Required. The type of database used to store customer data type: string - format: int64 - 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 + enum: + - DB_UNKNOWN + - DB_INFRA_SPANNER + - DB_CLOUD_SQL_POSTGRES + 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. + 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 + description: Request message for projectService.InitializeProject type: object - GoogleCloudContentwarehouseV1UpdateDocumentRequest: + id: GoogleCloudContentwarehouseV1InitializeProjectRequest + GoogleCloudContentwarehouseV1ListLinkedSourcesResponse: + id: GoogleCloudContentwarehouseV1ListLinkedSourcesResponse properties: - document: - description: Required. The document to update. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' - 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: + nextPageToken: + type: string description: >- - The meta information collected about the end user, used to enforce - access control for the service. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - updateOptions: - description: Options for the update operation. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UpdateOptions' - description: Request message for DocumentService.UpdateDocument. + 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. + description: Response message for DocumentLinkService.ListLinkedSources. type: object - id: GoogleCloudContentwarehouseV1UpdateDocumentRequest - GoogleCloudContentwarehouseV1ResponseMetadata: - description: >- - Additional information returned to client, such as debugging - information. + GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata: type: object + id: >- + GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata properties: - requestId: - description: >- - A unique id associated with this call. This id is logged for - tracking purpose. + inputPath: + description: 'The input Cloud Storage folder in this pipeline. Format: `gs:///`.' type: string - id: GoogleCloudContentwarehouseV1ResponseMetadata - GoogleCloudContentwarehouseV1DeleteDocumentLinkRequest: + description: The metadata message for GcsIngest pipeline. + GoogleCloudContentwarehouseV1SetAclResponse: properties: - requestMetadata: + policy: + description: The policy will be attached to a resource (e.g. projecct, document). + $ref: '#/components/schemas/GoogleIamV1Policy' + metadata: description: >- - The meta information collected about the document creator, used to - enforce access control for the service. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - id: GoogleCloudContentwarehouseV1DeleteDocumentLinkRequest + Additional information for the API invocation, such as the request + tracking id. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' + description: Response message for DocumentService.SetAcl. + id: GoogleCloudContentwarehouseV1SetAclResponse type: object - description: Request message for DocumentLinkService.DeleteDocumentLink. - GoogleCloudContentwarehouseV1CreateDocumentMetadata: - id: GoogleCloudContentwarehouseV1CreateDocumentMetadata + GoogleCloudContentwarehouseV1beta1CreateDocumentMetadata: description: Metadata object for CreateDocument request (currently empty). properties: {} + id: GoogleCloudContentwarehouseV1beta1CreateDocumentMetadata + type: object + GoogleApiServiceconsumermanagementV1PolicyBinding: + id: GoogleApiServiceconsumermanagementV1PolicyBinding type: object - GoogleCloudDocumentaiV1Barcode: - id: GoogleCloudDocumentaiV1Barcode properties: - rawValue: - description: >- - Raw value encoded in the barcode. For example: - `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. - type: string - valueFormat: - type: string + members: + type: array + items: + 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. - format: + Uses the same format as in IAM policy. `member` must include both a + prefix and ID. For example, `user:{emailId}`, + `serviceAccount:{emailId}`, `group:{emailId}`. + role: 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. - type: object - description: Encodes the detailed information of a barcode. - GoogleCloudContentwarehouseV1ProcessorInfo: - properties: - processorName: - description: >- - The processor resource name. Format is - `projects/{project}/locations/{location}/processors/{processor}`, or - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` + 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) + GoogleCloudContentwarehouseV1InitializeProjectResponse: + type: object + id: GoogleCloudContentwarehouseV1InitializeProjectResponse + properties: + message: type: string - schemaName: + description: The message of the project initialization process. + state: + enum: + - STATE_UNSPECIFIED + - SUCCEEDED + - FAILED + - CANCELLED + - RUNNING + 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. + description: Response message for projectService.InitializeProject + GoogleCloudContentwarehouseV1PropertyFilter: + properties: + documentSchemaName: description: >- - The Document schema resource name. All documents processed by this - processor will use this schema. Format: + The Document schema name Document.document_schema_name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. type: string - documentType: - description: The processor will process the documents with this document type. + condition: type: string - id: GoogleCloudContentwarehouseV1ProcessorInfo - description: The DocAI processor information. + 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. + id: GoogleCloudContentwarehouseV1PropertyFilter type: object - GoogleCloudContentwarehouseV1UserInfo: + GoogleIamV1Binding: + description: Associates `members`, or principals, with a `role`. type: object - description: The user information. - id: GoogleCloudContentwarehouseV1UserInfo + id: GoogleIamV1Binding properties: - 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"; + role: type: string - groupIds: - 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). + 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: items: type: string description: >- - The unique group identifications which the user is belong to. The - format is "group:yyyy@example.com"; - GoogleTypeDateTime: + 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 + GoogleCloudContentwarehouseV1TimestampValue: + description: Timestamp value type. properties: - year: - type: integer - format: int32 + textValue: description: >- - Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a - datetime without a year. - utcOffset: + 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 + description: Timestamp value + type: string + id: GoogleCloudContentwarehouseV1TimestampValue + type: object + GoogleCloudDocumentaiV1DocumentPageLayout: + id: GoogleCloudDocumentaiV1DocumentPageLayout + type: object + description: Visual element describing a layout unit on a page. + properties: + confidence: + type: number + format: float 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: - format: int32 - description: >- - Optional. Fractions of seconds in nanoseconds. Must be from 0 to - 999,999,999, defaults to 0. - type: integer - 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 - 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 - 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. - format: int32 - type: integer - timeZone: - description: Time zone. - $ref: '#/components/schemas/GoogleTypeTimeZone' - minutes: - type: integer - format: int32 - description: >- - Optional. Minutes of hour of day. Must be from 0 to 59, defaults to - 0. - day: - 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 - format: int32 + 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]`. + boundingPoly: + description: The bounding polygon for the Layout. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' + textAnchor: + description: Text anchor indexing into the Document.text. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + 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. + enum: + - ORIENTATION_UNSPECIFIED + - PAGE_UP + - PAGE_RIGHT + - PAGE_DOWN + - PAGE_LEFT + description: Detected orientation for the Layout. + type: string + GoogleCloudContentwarehouseV1LockDocumentRequest: type: object - 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 - GoogleCloudContentwarehouseV1TextArray: properties: - values: - items: + lockingUser: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UserInfo' + description: The user information who locks the document. + collectionId: + type: string + description: The collection the document connects to. + id: GoogleCloudContentwarehouseV1LockDocumentRequest + description: Request message for DocumentService.LockDocument. + GoogleCloudContentwarehouseV1DataValidationAction: + id: GoogleCloudContentwarehouseV1DataValidationAction + description: Represents the action responsible for data validation operations. + 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 - type: array - description: List of text values. - description: String/text values. - id: GoogleCloudContentwarehouseV1TextArray - type: object - GoogleTypeInterval: - 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 + GoogleCloudDocumentaiV1DocumentShardInfo: properties: - startTime: - format: google-datetime - 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. - endTime: + textOffset: description: >- - Optional. Exclusive end of the interval. If specified, a Timestamp - matching this interval will have to be before the end. + The index of the first character in Document.text in the overall + document global text. type: string - format: google-datetime - GoogleCloudDocumentaiV1DocumentPageMatrix: - type: object - id: GoogleCloudDocumentaiV1DocumentPageMatrix + format: int64 + shardCount: + type: string + description: Total number of shards. + format: int64 + shardIndex: + format: int64 + description: The 0-based index of this shard. + type: string + id: GoogleCloudDocumentaiV1DocumentShardInfo description: >- - Representation for transformation matrix, intended to be compatible and - used with OpenCV format for image manipulation. + 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 + GoogleCloudDocumentaiV1DocumentProvenanceParent: properties: - type: - format: int32 - 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 - data: - type: string - format: byte - description: The matrix data. - cols: - type: integer - description: Number of columns in the matrix. + revision: + description: The index of the index into current revision's parent_ids list. format: int32 - rows: type: integer - description: Number of rows in the matrix. - format: int32 - GoogleCloudDocumentaiV1DocumentPageTableTableCell: - id: GoogleCloudDocumentaiV1DocumentPageTableTableCell - properties: - colSpan: + id: + deprecated: true format: int32 - description: How many columns this cell spans. + description: The id of the parent provenance. type: integer - detectedLanguages: - description: A list of detected languages together with confidence. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - rowSpan: - description: How many rows this cell spans. + index: type: integer format: int32 - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for TableCell. + description: >- + The index of the parent item in the corresponding item list (eg. + list of entities, properties within entities, etc.) in the parent + revision. + id: GoogleCloudDocumentaiV1DocumentProvenanceParent type: object - description: A cell representation inside the table. - GoogleCloudContentwarehouseV1QAResultHighlight: + description: >- + The parent element the current element is based on. Used for + referencing/aligning, removal and replacement operations. + GoogleCloudContentwarehouseV1MergeFieldsOptions: + id: GoogleCloudContentwarehouseV1MergeFieldsOptions type: object properties: - startIndex: - description: Start index of the highlight. - type: integer - format: int32 - endIndex: - description: End index of the highlight, exclusive. - type: integer - format: int32 - id: GoogleCloudContentwarehouseV1QAResultHighlight - description: >- - A text span in the search text snippet that represents a highlighted - section (answer context, highly relevant sentence, etc.). - GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata: + 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. + description: Options for merging updated fields. + GoogleCloudContentwarehouseV1UserInfo: properties: - inputPath: - description: 'The input Cloud Storage folder in this pipeline. Format: `gs:///`.' + 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 - description: The metadata message for GcsIngest pipeline. - id: >- - GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata - type: object - GoogleCloudContentwarehouseV1SynonymSetSynonym: - description: >- - Represents a list of words given by the customer All these words are - synonyms of each other. - type: object - properties: - words: - description: 'For example: sale, invoice, bill, order' + groupIds: type: array + description: >- + The unique group identifications which the user is belong to. The + format is "group:yyyy@example.com"; items: type: string - id: GoogleCloudContentwarehouseV1SynonymSetSynonym - GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline: - description: >- - The configuration of the Cloud Storage Ingestion with DocAI Processors - pipeline. + description: The user information. + id: GoogleCloudContentwarehouseV1UserInfo type: object - id: GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline + GoogleCloudContentwarehouseV1ActionOutput: + description: Represents the result of executing an action. + type: object + id: GoogleCloudContentwarehouseV1ActionOutput properties: - inputPath: - description: >- - The input Cloud Storage folder. All files under this folder will be - imported to Document Warehouse. Format: `gs:///`. + actionState: type: string - 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' - processorResultsFolderPath: + enumDescriptions: + - The unknown state. + - State indicating action executed successfully. + - State indicating action failed. + - State indicating action timed out. + - State indicating action is pending. + enum: + - UNKNOWN + - ACTION_SUCCEEDED + - ACTION_FAILED + - ACTION_TIMED_OUT + - ACTION_PENDING + description: State of an action. + outputMessage: + description: Action execution output message. + type: string + actionId: + description: ID of the action. + type: string + GoogleCloudContentwarehouseV1RunPipelineRequest: + properties: + processWithDocAiPipeline: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline description: >- - The Cloud Storage folder path used to store the raw results from - processors. Format: `gs:///`. - type: string - splitClassifyProcessorInfo: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' + Use a DocAI processor to process documents in Document Warehouse, + and re-ingest the updated results into Document Warehouse. + exportCdwPipeline: description: >- - The split and classify processor information. The split and classify - result will be used to find a matched extract processor. - pipelineConfig: + Export docuemnts from Document Warehouse to CDW for training + purpose. $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1IngestPipelineConfig - 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. - skipIngestedDocuments: - type: boolean + #/components/schemas/GoogleCloudContentwarehouseV1ExportToCdwPipeline + gcsIngestWithDocAiProcessorsPipeline: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline 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. - GoogleCloudContentwarehouseV1UpdateDocumentMetadata: - type: object - id: GoogleCloudContentwarehouseV1UpdateDocumentMetadata - properties: {} - description: Metadata object for UpdateDocument request (currently empty). - GoogleCloudContentwarehouseV1GetDocumentRequest: - id: GoogleCloudContentwarehouseV1GetDocumentRequest - properties: + Use DocAI processors to process documents in Cloud Storage and + ingest them to Document Warehouse. requestMetadata: description: >- The meta information collected about the end user, used to enforce access control for the service. $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - description: Request message for DocumentService.GetDocument. + gcsIngestPipeline: + description: Cloud Storage ingestion pipeline. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1GcsIngestPipeline' + id: GoogleCloudContentwarehouseV1RunPipelineRequest type: object - GoogleCloudContentwarehouseV1AddToFolderAction: + description: Request message for DocumentService.RunPipeline. + GoogleCloudContentwarehouseV1DataUpdateAction: + description: Represents the action responsible for properties update operations. properties: - folders: - type: array + entries: description: >- - Names of the folder under which new document is to be added. Format: - projects/{project_number}/locations/{location}/documents/{document_id}. - items: + 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 + type: object type: object - id: GoogleCloudContentwarehouseV1AddToFolderAction - description: Represents the action responsible for adding document under a folder. - GoogleCloudContentwarehouseV1MapTypeOptions: - id: GoogleCloudContentwarehouseV1MapTypeOptions - type: object - description: Configurations for a Map property. + id: GoogleCloudContentwarehouseV1DataUpdateAction + GoogleCloudContentwarehouseV1IntegerTypeOptions: + description: Configurations for an integer property. properties: {} - GoogleCloudDocumentaiV1DocumentPageDetectedLanguage: - id: GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - properties: - 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 - description: Confidence of detected language. Range `[0, 1]`. + id: GoogleCloudContentwarehouseV1IntegerTypeOptions type: object - description: Detected language for a structural component. - CloudAiPlatformTenantresourceInfraSpannerConfig: + GoogleCloudContentwarehouseV1DocumentLink: + id: GoogleCloudContentwarehouseV1DocumentLink properties: - spannerBorgServiceAccount: - 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. - type: string - sdlBundlePath: + state: + enum: + - STATE_UNSPECIFIED + - ACTIVE + - SOFT_DELETED type: string - description: Input [Required]. The file path to the spanner SDL bundle. - createDatabaseOptions: - $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions + 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: >- - 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: + 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. + targetDocumentReference: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentReference' + description: Document references of the target document. + description: type: string - description: >- - Input [Required]. Every database in Spanner can be identified by the - following path name: /span//: - spannerLocalNamePrefix: + description: Description of this document-link. + updateTime: + description: Output only. The time when the documentLink is last updated. type: string - kmsKeyReference: - 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/ + readOnly: true + format: google-datetime + name: type: string - spannerNamespace: + 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}. + createTime: type: string - description: 'The configuration for a spanner database provisioning. Next ID: 8' - type: object - id: CloudAiPlatformTenantresourceInfraSpannerConfig - GoogleCloudContentwarehouseV1IntegerTypeOptions: - description: Configurations for an integer property. - id: GoogleCloudContentwarehouseV1IntegerTypeOptions + format: google-datetime + description: Output only. The time when the documentLink is created. + readOnly: true + sourceDocumentReference: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentReference' + description: Document references of the source document. + description: A document-link between source and target document. type: object + GoogleCloudContentwarehouseV1beta1UpdateDocumentMetadata: + id: GoogleCloudContentwarehouseV1beta1UpdateDocumentMetadata + description: Metadata object for UpdateDocument request (currently empty). properties: {} - GoogleCloudContentwarehouseV1TimestampTypeOptions: - description: Configurations for a timestamp property. type: object - properties: {} - id: GoogleCloudContentwarehouseV1TimestampTypeOptions - 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(''); }; // ... + GoogleCloudContentwarehouseV1ProjectStatus: type: object - id: GoogleTypeColor + id: GoogleCloudContentwarehouseV1ProjectStatus + description: >- + Status of a project, including the project state, dbType, aclMode and + etc. + properties: + location: + type: string + description: The location of the queried project. + state: + 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. + description: State of the project. + databaseType: + enumDeprecated: + - false + - false + - true + type: string + enum: + - DB_UNKNOWN + - DB_INFRA_SPANNER + - DB_CLOUD_SQL_POSTGRES + description: Database type. + enumDescriptions: + - This value is required by protobuf best practices + - Internal Spanner + - Cloud Sql with a Postgres Sql instance + documentCreatorDefaultRole: + type: string + description: The default role for the person who create a document. + qaEnabled: + description: If the qa is enabled on this project. + type: boolean + accessControlMode: + enum: + - ACL_MODE_UNKNOWN + - ACL_MODE_UNIVERSAL_ACCESS + - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID + - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI + description: Access control mode. + 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. + GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect: + description: Image Quality Defects + id: GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect properties: - red: - type: number - description: The amount of red in the color as a value in the interval [0, 1]. + confidence: format: float - blue: 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 - green: - description: The amount of green in the color as a value in the interval [0, 1]. - type: number - format: float - GoogleCloudContentwarehouseV1ListSynonymSetsResponse: + Confidence of detected defect. Range `[0, 1]` where `1` indicates + strong confidence that the defect exists. + 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` type: object - description: Response message for SynonymSetService.ListSynonymSets. + GoogleCloudDocumentaiV1DocumentEntity: + id: GoogleCloudDocumentaiV1DocumentEntity properties: - nextPageToken: + confidence: + description: Optional. Confidence of detected Schema entity. Range `[0, 1]`. + type: number + format: float + textAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' description: >- - A page token, received from a previous `ListSynonymSets` call. - Provide this to retrieve the subsequent page. - type: string - synonymSets: - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + Optional. Provenance of the entity. Text anchor indexing into the + Document.text. + properties: type: array - description: The synonymSets from the specified parent. - id: GoogleCloudContentwarehouseV1ListSynonymSetsResponse - CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions: - properties: - cmekServiceName: description: >- - The service name for the CMEK encryption. For example, - contentwarehouse.googleapis.com - type: string - cmekCloudResourceType: + Optional. Entities can be nested to form a hierarchical data + structure representing the content in the document. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' + normalizedValue: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentEntityNormalizedValue description: >- - The cloud resource type for the CMEK encryption. For example, - contentwarehouse.googleapis.com/Location - type: string - cmekCloudResourceName: + 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. + pageAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchor' description: >- - The cloud resource name for the CMEK encryption. For example, - projects//locations/ + 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 - 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 - id: CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions - GoogleCloudDocumentaiV1DocumentPageParagraph: - id: GoogleCloudDocumentaiV1DocumentPageParagraph - properties: - detectedLanguages: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. provenance: - deprecated: true + description: Optional. The history of this annotation. $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this annotation. - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for Paragraph. - type: object - description: A collection of lines that a human would perceive as a paragraph. - GoogleCloudContentwarehouseV1InvalidRule: - properties: - error: - description: Validation error on a parsed expression. - type: string - rule: - description: Triggered rule. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' - id: GoogleCloudContentwarehouseV1InvalidRule - type: object - description: A triggered rule that failed the validation check(s) after parsing. - GoogleCloudContentwarehouseV1HistogramQuery: - description: The histogram request. - type: object - id: GoogleCloudContentwarehouseV1HistogramQuery - properties: - histogramQuery: + id: type: string description: >- - An expression specifies a histogram request against matching - documents for searches. See SearchDocumentsRequest.histogram_queries - for details about syntax. - requirePreciseResultSize: + Optional. Canonical id. This will be a unique value in the entity + list for this document. + redacted: 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. - 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/GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter - GoogleCloudContentwarehouseV1ListLinkedSourcesRequest: - id: GoogleCloudContentwarehouseV1ListLinkedSourcesRequest - properties: - 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. + Optional. Whether the entity will be redacted for de-identification + purposes. + mentionId: + description: Optional. Deprecated. Use `id` field instead. type: string - 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. - requestMetadata: - description: >- - The meta information collected about the document creator, used to - enforce access control for the service. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - type: object - description: Response message for DocumentLinkService.ListLinkedSources. - GoogleCloudContentwarehouseV1MapProperty: - properties: - fields: - type: object - description: Unordered map of dynamically typed values. - additionalProperties: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Value' - id: GoogleCloudContentwarehouseV1MapProperty + type: + type: string + description: Required. Entity type from a schema e.g. `Address`. type: object description: >- - Map property value. Represents a structured entries of key value pairs, - consisting of field names which map to dynamically typed values. - CloudAiPlatformTenantresourceIamPolicyBinding: - properties: - members: - items: - type: string - type: array - description: >- - Input/Output [Required]. The member service accounts with the roles - above. Note: placeholders are same as the resource above. - resourceType: - enum: - - RESOURCE_TYPE_UNSPECIFIED - - PROJECT - - SERVICE_ACCOUNT - - GCS_BUCKET - - SERVICE_CONSUMER - - AR_REPO - 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: /// ///: ///@ - type: string - description: >- - Input/Output [Required]. Specifies the type of resource that will be - accessed by members. - role: + 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. + GoogleCloudContentwarehouseV1RemoveFromFolderAction: + properties: + folder: type: string - description: Input/Output [Required]. The role for members below. - 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. + Name of the folder under which new document is to be added. Format: + projects/{project_number}/locations/{location}/documents/{document_id}. + condition: + description: Condition of the action to be executed. type: string - id: CloudAiPlatformTenantresourceIamPolicyBinding + id: GoogleCloudContentwarehouseV1RemoveFromFolderAction type: object description: >- - The dynamic IAM bindings to be granted after tenant projects are - created. - GoogleCloudContentwarehouseV1ListDocumentSchemasResponse: - description: Response message for DocumentSchemaService.ListDocumentSchemas. - id: GoogleCloudContentwarehouseV1ListDocumentSchemasResponse + Represents the action responsible for remove a document from a specific + folder. + GoogleCloudDocumentaiV1DocumentPageDetectedBarcode: + properties: + barcode: + description: Detailed barcode information of the DetectedBarcode. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Barcode' + layout: + description: Layout for DetectedBarcode. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + id: GoogleCloudDocumentaiV1DocumentPageDetectedBarcode + description: A detected barcode. type: object + GoogleCloudContentwarehouseV1ResponseMetadata: properties: - nextPageToken: + requestId: 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 unique id associated with this call. This id is logged for + tracking purpose. type: string - documentSchemas: - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema' - type: array - description: The document schemas from the specified parent. + id: GoogleCloudContentwarehouseV1ResponseMetadata + description: >- + Additional information returned to client, such as debugging + information. + type: object parameters: - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - callback: - description: JSONP + access_token: + description: OAuth access token. in: query - name: callback + name: access_token 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 - 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: @@ -4868,31 +4865,16 @@ components: - json - media - proto - 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 - 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 - 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. + callback: + description: JSONP in: query - name: key + name: callback schema: type: string quotaUser: @@ -4904,208 +4886,82 @@ components: name: quotaUser 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' - x-stackQL-resources: - acl: - id: contentwarehouse.acl - name: acl - title: Acl - methods: - fetch_acl: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}:fetchAcl/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - projects: - id: 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: [] - delete: [] - locations: - id: 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: [] - delete: [] - status: - id: 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: [] - delete: [] - document_schemas: - id: contentwarehouse.document_schemas - name: document_schemas - title: Document_schemas - methods: - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas~1{documentSchemasId}/get - 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' - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas~1{documentSchemasId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - _list: - operation: &ref_1 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas/get - response: &ref_2 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.documentSchemas - list: - operation: *ref_1 - response: *ref_2 - 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: [] - delete: - - $ref: '#/components/x-stackQL-resources/document_schemas/methods/delete' - operations: - id: contentwarehouse.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' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - insert: [] - update: [] - delete: [] + 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 + 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: reference_id: - id: contentwarehouse.reference_id + id: google.contentwarehouse.reference_id name: reference_id title: Reference_id methods: - delete: + get: 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}:get/post response: mediaType: application/json openAPIDocKey: '200' - get: + patch: 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}/patch response: mediaType: application/json openAPIDocKey: '200' - patch: + delete: 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}:delete/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: [] insert: [] - update: [] + update: + - $ref: '#/components/x-stackQL-resources/reference_id/methods/patch' delete: [] document_links: - id: contentwarehouse.document_links + id: google.contentwarehouse.document_links name: document_links title: Document_links methods: - create: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1documentLinks/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1documentLinks~1{documentLinksId}:delete/post response: mediaType: application/json openAPIDocKey: '200' - delete: + create: 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}~1documents~1{documentsId}~1documentLinks/post response: mediaType: application/json openAPIDocKey: '200' @@ -5116,56 +4972,56 @@ components: update: [] delete: [] documents: - id: contentwarehouse.documents + id: google.contentwarehouse.documents name: documents title: Documents methods: - create: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:delete/post response: mediaType: application/json openAPIDocKey: '200' - linked_sources: + patch: 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}/patch response: mediaType: application/json openAPIDocKey: '200' - lock: + linked_sources: 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}~1linkedSources/post response: mediaType: application/json openAPIDocKey: '200' - set_acl: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:setAcl/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents/post response: mediaType: application/json openAPIDocKey: '200' - patch: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:get/post response: mediaType: application/json openAPIDocKey: '200' - search: + set_acl: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents:search/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:setAcl/post response: mediaType: application/json openAPIDocKey: '200' - get: + search: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:get/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents:search/post response: mediaType: application/json openAPIDocKey: '200' @@ -5176,10 +5032,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete: + lock: 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}:lock/post response: mediaType: application/json openAPIDocKey: '200' @@ -5187,10 +5043,11 @@ components: select: [] insert: - $ref: '#/components/x-stackQL-resources/documents/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/documents/methods/patch' delete: [] documents_acl: - id: contentwarehouse.documents_acl + id: google.contentwarehouse.documents_acl name: documents_acl title: Documents_acl methods: @@ -5207,7 +5064,7 @@ components: update: [] delete: [] synonym_sets: - id: contentwarehouse.synonym_sets + id: google.contentwarehouse.synonym_sets name: synonym_sets title: Synonym_sets methods: @@ -5218,13 +5075,6 @@ components: 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' delete: operation: $ref: >- @@ -5232,59 +5082,100 @@ components: response: mediaType: application/json openAPIDocKey: '200' - 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' _list: - operation: &ref_3 + operation: &ref_1 $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets/get - response: &ref_4 + response: &ref_2 mediaType: application/json openAPIDocKey: '200' objectKey: $.synonymSets list: - operation: *ref_3 - response: *ref_4 + operation: *ref_1 + response: *ref_2 + create: + operation: + $ref: >- + #/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: [] + update: + - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/delete' - rule_sets: - id: contentwarehouse.rule_sets - name: rule_sets - title: Rule_sets + document_schemas: + id: google.contentwarehouse.document_schemas + name: document_schemas + title: Document_schemas methods: - get: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets~1{ruleSetsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas/post + response: + mediaType: application/json + openAPIDocKey: '200' + _list: + operation: &ref_3 + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas/get + response: &ref_4 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.documentSchemas + list: + operation: *ref_3 + response: *ref_4 + 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}~1ruleSets~1{ruleSetsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas~1{documentSchemasId}/delete response: mediaType: application/json openAPIDocKey: '200' - patch: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets~1{ruleSetsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas~1{documentSchemasId}/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' + delete: + - $ref: '#/components/x-stackQL-resources/document_schemas/methods/delete' + rule_sets: + id: google.contentwarehouse.rule_sets + name: rule_sets + title: Rule_sets + methods: create: operation: $ref: >- @@ -5303,41 +5194,152 @@ components: list: operation: *ref_5 response: *ref_6 + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets~1{ruleSetsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/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' + 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' + delete: + - $ref: '#/components/x-stackQL-resources/rule_sets/methods/delete' + operations: + id: google.contentwarehouse.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' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + insert: [] + update: [] + 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: [] + 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: [] + delete: [] + acl: + id: google.contentwarehouse.acl + name: acl + title: Acl + methods: + fetch_acl: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}:fetchAcl/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + 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: - - $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' + select: [] + insert: [] update: [] - delete: - - $ref: '#/components/x-stackQL-resources/rule_sets/methods/delete' + delete: [] paths: - /v1/projects/{projectsId}:fetchAcl: + /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}:get: parameters: &ref_7 - - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/_.xgafv' 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 + 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/GoogleCloudContentwarehouseV1FetchAclRequest + #/components/schemas/GoogleCloudContentwarehouseV1GetDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5349,26 +5351,36 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1FetchAclResponse + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}:setAcl: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: referenceIdId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}: parameters: *ref_7 - post: + patch: description: >- - Sets the access control policy for a resource. Replaces any existing - policy. - operationId: contentwarehouse.projects.setAcl + 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/GoogleCloudContentwarehouseV1SetAclRequest' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5381,26 +5393,34 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1SetAclResponse + #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentResponse parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:initialize: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: referenceIdId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}:delete: parameters: *ref_7 post: - description: >- - Provisions resources for given tenant project. Returns a long running - operation. - operationId: contentwarehouse.projects.locations.initialize + 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/GoogleCloudContentwarehouseV1InitializeProjectRequest + #/components/schemas/GoogleCloudContentwarehouseV1DeleteDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5412,7 +5432,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -5424,11 +5444,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:getStatus: + - in: path + name: referenceIdId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/documentLinks/{documentLinksId}:delete: parameters: *ref_7 - get: - description: Get the project status. - operationId: contentwarehouse.projects.locations.getStatus + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5440,8 +5471,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ProjectStatus + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -5453,17 +5483,27 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:runPipeline: + - in: path + name: documentsId + required: true + schema: + type: string + - in: path + name: documentLinksId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/documentLinks: parameters: *ref_7 post: - description: Run a predefined pipeline. - operationId: contentwarehouse.projects.locations.runPipeline + 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/GoogleCloudContentwarehouseV1RunPipelineRequest + #/components/schemas/GoogleCloudContentwarehouseV1CreateDocumentLinkRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5475,7 +5515,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' parameters: - in: path name: projectsId @@ -5487,13 +5527,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documentSchemas/{documentSchemasId}: + - in: path + name: documentsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:delete: parameters: *ref_7 - get: - description: >- - Gets a document schema. Returns NOT_FOUND if the document schema does - not exist. - operationId: contentwarehouse.projects.locations.documentSchemas.get + post: + 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/GoogleCloudContentwarehouseV1DeleteDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5505,8 +5554,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -5519,25 +5567,23 @@ paths: schema: type: string - in: path - name: documentSchemasId + name: documentsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}: + parameters: *ref_7 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 @@ -5550,7 +5596,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema + #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentResponse parameters: - in: path name: projectsId @@ -5563,16 +5609,21 @@ paths: schema: type: string - in: path - name: documentSchemasId + name: documentsId 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 + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/linkedSources: + parameters: *ref_7 + 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 @@ -5584,7 +5635,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1ListLinkedSourcesResponse parameters: - in: path name: projectsId @@ -5597,15 +5649,21 @@ paths: schema: type: string - in: path - name: documentSchemasId + name: documentsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documentSchemas: + /v1/projects/{projectsId}/locations/{locationsId}/documents: parameters: *ref_7 - get: - description: Lists document schemas. - operationId: contentwarehouse.projects.locations.documentSchemas.list + 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 @@ -5618,7 +5676,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ListDocumentSchemasResponse + #/components/schemas/GoogleCloudContentwarehouseV1CreateDocumentResponse parameters: - in: path name: projectsId @@ -5630,23 +5688,17 @@ 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}/documents/{documentsId}:get: + parameters: *ref_7 post: - description: Creates a document schema. - operationId: contentwarehouse.projects.locations.documentSchemas.create + 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/GoogleCloudContentwarehouseV1DocumentSchema' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1GetDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5658,8 +5710,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' parameters: - in: path name: projectsId @@ -5671,14 +5722,23 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + - in: path + name: documentsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:setAcl: parameters: *ref_7 - 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 @@ -5690,7 +5750,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1SetAclResponse parameters: - in: path name: projectsId @@ -5703,21 +5764,24 @@ paths: schema: type: string - in: path - name: operationsId + name: documentsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}:delete: + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:fetchAcl: parameters: *ref_7 post: - description: Deletes a document. Returns NOT_FOUND if the document does not exist. - operationId: contentwarehouse.projects.locations.documents.referenceId.delete + 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/GoogleCloudContentwarehouseV1DeleteDocumentRequest + #/components/schemas/GoogleCloudContentwarehouseV1FetchAclRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5729,7 +5793,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1FetchAclResponse parameters: - in: path name: projectsId @@ -5742,21 +5807,23 @@ paths: schema: type: string - in: path - name: referenceIdId + name: documentsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}:get: + /v1/projects/{projectsId}/locations/{locationsId}/documents:search: parameters: *ref_7 post: - description: Gets a document. Returns NOT_FOUND if the document does not exist. - operationId: contentwarehouse.projects.locations.documents.referenceId.get + 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/GoogleCloudContentwarehouseV1GetDocumentRequest + #/components/schemas/GoogleCloudContentwarehouseV1SearchDocumentsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5768,7 +5835,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1SearchDocumentsResponse parameters: - in: path name: projectsId @@ -5780,24 +5848,17 @@ paths: required: true schema: type: string - - in: path - name: referenceIdId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}: + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/linkedTargets: parameters: *ref_7 - 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.referenceId.patch + post: + description: Return all target document-links from the document. + operationId: contentwarehouse.projects.locations.documents.linkedTargets requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentRequest + #/components/schemas/GoogleCloudContentwarehouseV1ListLinkedTargetsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5810,7 +5871,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentResponse + #/components/schemas/GoogleCloudContentwarehouseV1ListLinkedTargetsResponse parameters: - in: path name: projectsId @@ -5823,21 +5884,21 @@ paths: schema: type: string - in: path - name: referenceIdId + name: documentsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/documentLinks: + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:lock: parameters: *ref_7 post: - description: Create a link between a source document and a target document. - operationId: contentwarehouse.projects.locations.documents.documentLinks.create + 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/GoogleCloudContentwarehouseV1CreateDocumentLinkRequest + #/components/schemas/GoogleCloudContentwarehouseV1LockDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5849,7 +5910,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' parameters: - in: path name: projectsId @@ -5866,17 +5927,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/documentLinks/{documentLinksId}:delete: + /v1/projects/{projectsId}/locations/{locationsId}/synonymSets/{synonymSetsId}: parameters: *ref_7 - 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: >- + 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 @@ -5888,7 +5945,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' parameters: - in: path name: projectsId @@ -5901,26 +5958,15 @@ paths: schema: type: string - in: path - name: documentsId - required: true - schema: - type: string - - in: path - name: documentLinksId + name: synonymSetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents: - parameters: *ref_7 - 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 @@ -5932,8 +5978,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1CreateDocumentResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -5945,17 +5990,21 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/linkedSources: - parameters: *ref_7 - post: - description: Return all source document-links from the document. - operationId: contentwarehouse.projects.locations.documents.linkedSources + - in: path + name: synonymSetsId + required: true + schema: + type: string + 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/GoogleCloudContentwarehouseV1ListLinkedSourcesRequest + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5967,8 +6016,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ListLinkedSourcesResponse + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' parameters: - in: path name: projectsId @@ -5981,21 +6029,15 @@ paths: schema: type: string - in: path - name: documentsId + name: synonymSetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:lock: + /v1/projects/{projectsId}/locations/{locationsId}/synonymSets: parameters: *ref_7 - 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: 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 @@ -6007,7 +6049,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1ListSynonymSetsResponse parameters: - in: path name: projectsId @@ -6019,23 +6062,25 @@ 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}:setAcl: - parameters: *ref_7 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 @@ -6047,8 +6092,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1SetAclResponse + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' parameters: - in: path name: projectsId @@ -6060,24 +6104,16 @@ paths: required: true schema: type: string - - in: path - name: documentsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}: + /v1/projects/{projectsId}/locations/{locationsId}/documentSchemas: parameters: *ref_7 - 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 + post: + description: Creates a document schema. + operationId: contentwarehouse.projects.locations.documentSchemas.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentRequest + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6090,7 +6126,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentResponse + #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema parameters: - in: path name: projectsId @@ -6102,25 +6138,9 @@ paths: required: true schema: type: string - - in: path - name: documentsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:fetchAcl: - parameters: *ref_7 - 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 + get: + description: Lists document schemas. + operationId: contentwarehouse.projects.locations.documentSchemas.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6133,7 +6153,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1FetchAclResponse + #/components/schemas/GoogleCloudContentwarehouseV1ListDocumentSchemasResponse parameters: - in: path name: projectsId @@ -6145,24 +6165,32 @@ 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:search: + /v1/projects/{projectsId}/locations/{locationsId}/documentSchemas/{documentSchemasId}: parameters: *ref_7 - 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 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/GoogleCloudContentwarehouseV1SearchDocumentsRequest + #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6175,7 +6203,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1SearchDocumentsResponse + #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema parameters: - in: path name: projectsId @@ -6183,21 +6211,21 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:get: - parameters: *ref_7 - 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 + 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 @@ -6209,7 +6237,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6222,21 +6250,15 @@ paths: schema: type: string - in: path - name: documentsId + name: documentSchemasId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/linkedTargets: - parameters: *ref_7 - 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 + 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 @@ -6249,7 +6271,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ListLinkedTargetsResponse + #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema parameters: - in: path name: projectsId @@ -6262,21 +6284,20 @@ paths: schema: type: string - in: path - name: documentsId + name: documentSchemasId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:delete: + /v1/projects/{projectsId}/locations/{locationsId}/ruleSets: parameters: *ref_7 post: - description: Deletes a document. Returns NOT_FOUND if the document does not exist. - operationId: contentwarehouse.projects.locations.documents.delete + description: Creates a ruleset. + operationId: contentwarehouse.projects.locations.ruleSets.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DeleteDocumentRequest + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6288,7 +6309,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' parameters: - in: path name: projectsId @@ -6300,18 +6321,9 @@ paths: required: true schema: type: string - - in: path - name: documentsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/synonymSets/{synonymSetsId}: - parameters: *ref_7 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 + description: Lists rulesets. + operationId: contentwarehouse.projects.locations.ruleSets.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6323,7 +6335,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1ListRuleSetsResponse parameters: - in: path name: projectsId @@ -6335,21 +6348,20 @@ paths: required: true schema: type: string - - in: path - name: synonymSetsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - 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/GoogleCloudContentwarehouseV1SynonymSet' + /v1/projects/{projectsId}/locations/{locationsId}/ruleSets/{ruleSetsId}: + parameters: *ref_7 + 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 @@ -6361,7 +6373,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6374,15 +6386,13 @@ paths: schema: type: string - in: path - name: synonymSetsId + name: ruleSetsId 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 + 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 @@ -6394,7 +6404,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' parameters: - in: path name: projectsId @@ -6407,22 +6417,21 @@ paths: schema: type: string - in: path - name: synonymSetsId + name: ruleSetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/synonymSets: - parameters: *ref_7 - 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 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1UpdateRuleSetRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6434,7 +6443,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' parameters: - in: path name: projectsId @@ -6446,9 +6455,19 @@ paths: required: true schema: type: string + - in: path + name: ruleSetsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_7 get: - description: Returns all SynonymSets (for all contexts) for the specified location. - operationId: contentwarehouse.projects.locations.synonymSets.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: contentwarehouse.projects.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6460,8 +6479,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ListSynonymSetsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6473,20 +6491,16 @@ 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 - /v1/projects/{projectsId}/locations/{locationsId}/ruleSets/{ruleSetsId}: + /v1/projects/{projectsId}/locations/{locationsId}:getStatus: parameters: *ref_7 get: - description: Gets a ruleset. Returns NOT_FOUND if the ruleset does not exist. - operationId: contentwarehouse.projects.locations.ruleSets.get + description: Get the project status. + operationId: contentwarehouse.projects.locations.getStatus security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6498,7 +6512,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1ProjectStatus parameters: - in: path name: projectsId @@ -6510,14 +6525,19 @@ 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}:initialize: + parameters: *ref_7 + 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 @@ -6529,7 +6549,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6541,22 +6561,17 @@ paths: required: true schema: type: string - - in: path - name: ruleSetsId - 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}:runPipeline: + parameters: *ref_7 + post: + description: Run a predefined pipeline. + operationId: contentwarehouse.projects.locations.runPipeline requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1UpdateRuleSetRequest + #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6568,7 +6583,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6580,21 +6595,20 @@ paths: required: true schema: type: string - - in: path - name: ruleSetsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/ruleSets: + /v1/projects/{projectsId}:fetchAcl: parameters: *ref_7 post: - description: Creates a ruleset. - operationId: contentwarehouse.projects.locations.ruleSets.create + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1FetchAclRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6606,21 +6620,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1FetchAclResponse 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 + /v1/projects/{projectsId}:setAcl: + parameters: *ref_7 + post: + description: >- + Sets the access control policy for a resource. Replaces any existing + policy. + operationId: contentwarehouse.projects.setAcl + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SetAclRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6633,24 +6652,10 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ListRuleSetsResponse + #/components/schemas/GoogleCloudContentwarehouseV1SetAclResponse 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 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 de713873..9b0637c7 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: '20240520' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/data-catalog/docs/ servers: @@ -2900,7 +2900,7 @@ components: - '2' x-stackQL-resources: operations: - id: datacatalog.operations + id: google.datacatalog.operations name: operations title: Operations methods: @@ -2938,17 +2938,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list insert: [] update: [] delete: - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_delete entry_groups: - id: datacatalog.entry_groups + id: google.datacatalog.entry_groups name: entry_groups title: Entry_groups methods: @@ -2993,19 +2993,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/entry_groups/methods/projects_locations_entry_groups_list - $ref: >- #/components/x-stackQL-resources/entry_groups/methods/projects_locations_entry_groups_get + - $ref: >- + #/components/x-stackQL-resources/entry_groups/methods/projects_locations_entry_groups_list insert: - $ref: >- #/components/x-stackQL-resources/entry_groups/methods/projects_locations_entry_groups_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/entry_groups/methods/projects_locations_entry_groups_patch delete: - $ref: >- #/components/x-stackQL-resources/entry_groups/methods/projects_locations_entry_groups_delete entry_groups_iam_policies: - id: datacatalog.entry_groups_iam_policies + id: google.datacatalog.entry_groups_iam_policies name: entry_groups_iam_policies title: Entry_groups_iam_policies methods: @@ -3042,7 +3044,7 @@ components: update: [] delete: [] entries: - id: datacatalog.entries + id: google.datacatalog.entries name: entries title: Entries methods: @@ -3128,19 +3130,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/entries/methods/projects_locations_entry_groups_entries_list - $ref: >- #/components/x-stackQL-resources/entries/methods/projects_locations_entry_groups_entries_get + - $ref: >- + #/components/x-stackQL-resources/entries/methods/projects_locations_entry_groups_entries_list insert: - $ref: >- #/components/x-stackQL-resources/entries/methods/projects_locations_entry_groups_entries_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/entries/methods/projects_locations_entry_groups_entries_patch delete: - $ref: >- #/components/x-stackQL-resources/entries/methods/projects_locations_entry_groups_entries_delete entries_iam_policies: - id: datacatalog.entries_iam_policies + id: google.datacatalog.entries_iam_policies name: entries_iam_policies title: Entries_iam_policies methods: @@ -3170,7 +3174,7 @@ components: update: [] delete: [] tags: - id: datacatalog.tags + id: google.datacatalog.tags name: tags title: Tags methods: @@ -3256,14 +3260,18 @@ components: #/components/x-stackQL-resources/tags/methods/projects_locations_entry_groups_entries_tags_create - $ref: >- #/components/x-stackQL-resources/tags/methods/projects_locations_entry_groups_tags_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/tags/methods/projects_locations_entry_groups_entries_tags_patch + - $ref: >- + #/components/x-stackQL-resources/tags/methods/projects_locations_entry_groups_tags_patch delete: - $ref: >- #/components/x-stackQL-resources/tags/methods/projects_locations_entry_groups_entries_tags_delete - $ref: >- #/components/x-stackQL-resources/tags/methods/projects_locations_entry_groups_tags_delete tag_templates: - id: datacatalog.tag_templates + id: google.datacatalog.tag_templates name: tag_templates title: Tag_templates methods: @@ -3302,12 +3310,14 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/tag_templates/methods/projects_locations_tag_templates_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/tag_templates/methods/projects_locations_tag_templates_patch delete: - $ref: >- #/components/x-stackQL-resources/tag_templates/methods/projects_locations_tag_templates_delete tag_templates_iam_policies: - id: datacatalog.tag_templates_iam_policies + id: google.datacatalog.tag_templates_iam_policies name: tag_templates_iam_policies title: Tag_templates_iam_policies methods: @@ -3344,7 +3354,7 @@ components: update: [] delete: [] fields: - id: datacatalog.fields + id: google.datacatalog.fields name: fields title: Fields methods: @@ -3381,12 +3391,14 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/fields/methods/projects_locations_tag_templates_fields_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/fields/methods/projects_locations_tag_templates_fields_patch delete: - $ref: >- #/components/x-stackQL-resources/fields/methods/projects_locations_tag_templates_fields_delete enum_values: - id: datacatalog.enum_values + id: google.datacatalog.enum_values name: enum_values title: Enum_values methods: @@ -3403,7 +3415,7 @@ components: update: [] delete: [] taxonomies: - id: datacatalog.taxonomies + id: google.datacatalog.taxonomies name: taxonomies title: Taxonomies methods: @@ -3469,19 +3481,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/taxonomies/methods/projects_locations_taxonomies_list - $ref: >- #/components/x-stackQL-resources/taxonomies/methods/projects_locations_taxonomies_get + - $ref: >- + #/components/x-stackQL-resources/taxonomies/methods/projects_locations_taxonomies_list insert: - $ref: >- #/components/x-stackQL-resources/taxonomies/methods/projects_locations_taxonomies_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/taxonomies/methods/projects_locations_taxonomies_patch delete: - $ref: >- #/components/x-stackQL-resources/taxonomies/methods/projects_locations_taxonomies_delete taxonomies_iam_policies: - id: datacatalog.taxonomies_iam_policies + id: google.datacatalog.taxonomies_iam_policies name: taxonomies_iam_policies title: Taxonomies_iam_policies methods: @@ -3518,7 +3532,7 @@ components: update: [] delete: [] policy_tags: - id: datacatalog.policy_tags + id: google.datacatalog.policy_tags name: policy_tags title: Policy_tags methods: @@ -3563,19 +3577,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/policy_tags/methods/projects_locations_taxonomies_policy_tags_list - $ref: >- #/components/x-stackQL-resources/policy_tags/methods/projects_locations_taxonomies_policy_tags_get + - $ref: >- + #/components/x-stackQL-resources/policy_tags/methods/projects_locations_taxonomies_policy_tags_list insert: - $ref: >- #/components/x-stackQL-resources/policy_tags/methods/projects_locations_taxonomies_policy_tags_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/policy_tags/methods/projects_locations_taxonomies_policy_tags_patch delete: - $ref: >- #/components/x-stackQL-resources/policy_tags/methods/projects_locations_taxonomies_policy_tags_delete policy_tags_iam_policies: - id: datacatalog.policy_tags_iam_policies + id: google.datacatalog.policy_tags_iam_policies name: policy_tags_iam_policies title: Policy_tags_iam_policies methods: @@ -3612,7 +3628,7 @@ components: update: [] delete: [] catalog: - id: datacatalog.catalog + id: google.datacatalog.catalog name: catalog title: Catalog methods: 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 8ad42630..0a453be4 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: '20240520' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/dataflow servers: @@ -5873,7 +5873,7 @@ components: - '2' x-stackQL-resources: snapshots: - id: dataflow.snapshots + id: google.dataflow.snapshots name: snapshots title: Snapshots methods: @@ -5926,24 +5926,24 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/snapshots/methods/projects_snapshots_list + #/components/x-stackQL-resources/snapshots/methods/projects_locations_snapshots_get - $ref: >- - #/components/x-stackQL-resources/snapshots/methods/projects_snapshots_get + #/components/x-stackQL-resources/snapshots/methods/projects_locations_jobs_snapshots_list - $ref: >- - #/components/x-stackQL-resources/snapshots/methods/projects_locations_snapshots_get + #/components/x-stackQL-resources/snapshots/methods/projects_snapshots_get - $ref: >- #/components/x-stackQL-resources/snapshots/methods/projects_locations_snapshots_list - $ref: >- - #/components/x-stackQL-resources/snapshots/methods/projects_locations_jobs_snapshots_list + #/components/x-stackQL-resources/snapshots/methods/projects_snapshots_list insert: [] update: [] delete: - - $ref: >- - #/components/x-stackQL-resources/snapshots/methods/projects_delete_snapshots - $ref: >- #/components/x-stackQL-resources/snapshots/methods/projects_locations_snapshots_delete + - $ref: >- + #/components/x-stackQL-resources/snapshots/methods/projects_delete_snapshots projects: - id: dataflow.projects + id: google.dataflow.projects name: projects title: Projects methods: @@ -5959,7 +5959,7 @@ components: update: [] delete: [] jobs: - id: dataflow.jobs + id: google.dataflow.jobs name: jobs title: Jobs methods: @@ -6044,20 +6044,23 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/jobs/methods/projects_jobs_list' + - $ref: >- + #/components/x-stackQL-resources/jobs/methods/projects_locations_jobs_get - $ref: '#/components/x-stackQL-resources/jobs/methods/projects_jobs_get' - $ref: >- #/components/x-stackQL-resources/jobs/methods/projects_locations_jobs_list - - $ref: >- - #/components/x-stackQL-resources/jobs/methods/projects_locations_jobs_get + - $ref: '#/components/x-stackQL-resources/jobs/methods/projects_jobs_list' insert: - - $ref: '#/components/x-stackQL-resources/jobs/methods/projects_jobs_create' - $ref: >- #/components/x-stackQL-resources/jobs/methods/projects_locations_jobs_create - update: [] + - $ref: '#/components/x-stackQL-resources/jobs/methods/projects_jobs_create' + update: + - $ref: >- + #/components/x-stackQL-resources/jobs/methods/projects_locations_jobs_update + - $ref: '#/components/x-stackQL-resources/jobs/methods/projects_jobs_update' delete: [] jobs_metrics: - id: dataflow.jobs_metrics + id: google.dataflow.jobs_metrics name: jobs_metrics title: Jobs_metrics methods: @@ -6076,15 +6079,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/jobs_metrics/methods/projects_jobs_get_metrics - $ref: >- #/components/x-stackQL-resources/jobs_metrics/methods/projects_locations_jobs_get_metrics + - $ref: >- + #/components/x-stackQL-resources/jobs_metrics/methods/projects_jobs_get_metrics insert: [] update: [] delete: [] debug_config: - id: dataflow.debug_config + id: google.dataflow.debug_config name: debug_config title: Debug_config methods: @@ -6108,7 +6111,7 @@ components: update: [] delete: [] debug: - id: dataflow.debug + id: google.dataflow.debug name: debug title: Debug methods: @@ -6132,7 +6135,7 @@ components: update: [] delete: [] messages: - id: dataflow.messages + id: google.dataflow.messages name: messages title: Messages methods: @@ -6159,15 +6162,15 @@ components: response: *ref_8 sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/messages/methods/projects_jobs_messages_list - $ref: >- #/components/x-stackQL-resources/messages/methods/projects_locations_jobs_messages_list + - $ref: >- + #/components/x-stackQL-resources/messages/methods/projects_jobs_messages_list insert: [] update: [] delete: [] work_items: - id: dataflow.work_items + id: google.dataflow.work_items name: work_items title: Work_items methods: @@ -6205,7 +6208,7 @@ components: update: [] delete: [] templates: - id: dataflow.templates + id: google.dataflow.templates name: templates title: Templates methods: @@ -6250,19 +6253,19 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/templates/methods/projects_templates_get - $ref: >- #/components/x-stackQL-resources/templates/methods/projects_locations_templates_get - insert: - $ref: >- - #/components/x-stackQL-resources/templates/methods/projects_templates_create + #/components/x-stackQL-resources/templates/methods/projects_templates_get + insert: - $ref: >- #/components/x-stackQL-resources/templates/methods/projects_locations_templates_create + - $ref: >- + #/components/x-stackQL-resources/templates/methods/projects_templates_create update: [] delete: [] locations: - id: dataflow.locations + id: google.dataflow.locations name: locations title: Locations methods: @@ -6279,7 +6282,7 @@ components: update: [] delete: [] jobs_execution_details: - id: dataflow.jobs_execution_details + id: google.dataflow.jobs_execution_details name: jobs_execution_details title: Jobs_execution_details methods: @@ -6302,7 +6305,7 @@ components: update: [] delete: [] stages_execution_details: - id: dataflow.stages_execution_details + id: google.dataflow.stages_execution_details name: stages_execution_details title: Stages_execution_details methods: @@ -6325,7 +6328,7 @@ components: update: [] delete: [] flex_templates: - id: dataflow.flex_templates + id: google.dataflow.flex_templates name: flex_templates title: Flex_templates methods: 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 e527f74f..b1398840 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: '20240504' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/dataform/docs servers: @@ -2093,7 +2093,7 @@ components: - '2' x-stackQL-resources: locations: - id: dataform.locations + id: google.dataform.locations name: locations title: Locations methods: @@ -2116,13 +2116,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] repositories: - id: dataform.repositories + id: google.dataform.repositories name: repositories title: Repositories methods: @@ -2195,15 +2195,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/repositories/methods/list' - $ref: '#/components/x-stackQL-resources/repositories/methods/get' + - $ref: '#/components/x-stackQL-resources/repositories/methods/list' insert: - $ref: '#/components/x-stackQL-resources/repositories/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/repositories/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/repositories/methods/delete' repositories_history: - id: dataform.repositories_history + id: google.dataform.repositories_history name: repositories_history title: Repositories_history methods: @@ -2220,7 +2221,7 @@ components: update: [] delete: [] repositories_remote_branches: - id: dataform.repositories_remote_branches + id: google.dataform.repositories_remote_branches name: repositories_remote_branches title: Repositories_remote_branches methods: @@ -2237,7 +2238,7 @@ components: update: [] delete: [] repositories_iam_policies: - id: dataform.repositories_iam_policies + id: google.dataform.repositories_iam_policies name: repositories_iam_policies title: Repositories_iam_policies methods: @@ -2274,7 +2275,7 @@ components: update: [] delete: [] workspaces: - id: dataform.workspaces + id: google.dataform.workspaces name: workspaces title: Workspaces methods: @@ -2396,15 +2397,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/workspaces/methods/list' - $ref: '#/components/x-stackQL-resources/workspaces/methods/get' + - $ref: '#/components/x-stackQL-resources/workspaces/methods/list' insert: - $ref: '#/components/x-stackQL-resources/workspaces/methods/create' update: [] delete: - $ref: '#/components/x-stackQL-resources/workspaces/methods/delete' workspaces_file_git_statuses: - id: dataform.workspaces_file_git_statuses + id: google.dataform.workspaces_file_git_statuses name: workspaces_file_git_statuses title: Workspaces_file_git_statuses methods: @@ -2421,7 +2422,7 @@ components: update: [] delete: [] workspaces_git_ahead_behind: - id: dataform.workspaces_git_ahead_behind + id: google.dataform.workspaces_git_ahead_behind name: workspaces_git_ahead_behind title: Workspaces_git_ahead_behind methods: @@ -2438,7 +2439,7 @@ components: update: [] delete: [] workspaces_file_diff: - id: dataform.workspaces_file_diff + id: google.dataform.workspaces_file_diff name: workspaces_file_diff title: Workspaces_file_diff methods: @@ -2455,7 +2456,7 @@ components: update: [] delete: [] workspaces_directory: - id: dataform.workspaces_directory + id: google.dataform.workspaces_directory name: workspaces_directory title: Workspaces_directory methods: @@ -2472,7 +2473,7 @@ components: update: [] delete: [] workspaces_file: - id: dataform.workspaces_file + id: google.dataform.workspaces_file name: workspaces_file title: Workspaces_file methods: @@ -2489,7 +2490,7 @@ components: update: [] delete: [] workspaces_iam_policies: - id: dataform.workspaces_iam_policies + id: google.dataform.workspaces_iam_policies name: workspaces_iam_policies title: Workspaces_iam_policies methods: @@ -2526,7 +2527,7 @@ components: update: [] delete: [] release_configs: - id: dataform.release_configs + id: google.dataform.release_configs name: release_configs title: Release_configs methods: @@ -2571,15 +2572,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/release_configs/methods/list' - $ref: '#/components/x-stackQL-resources/release_configs/methods/get' + - $ref: '#/components/x-stackQL-resources/release_configs/methods/list' insert: - $ref: '#/components/x-stackQL-resources/release_configs/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/release_configs/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/release_configs/methods/delete' compilation_results: - id: dataform.compilation_results + id: google.dataform.compilation_results name: compilation_results title: Compilation_results methods: @@ -2617,15 +2619,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/compilation_results/methods/list' - $ref: '#/components/x-stackQL-resources/compilation_results/methods/get' + - $ref: '#/components/x-stackQL-resources/compilation_results/methods/list' insert: - $ref: >- #/components/x-stackQL-resources/compilation_results/methods/create update: [] delete: [] workflow_configs: - id: dataform.workflow_configs + id: google.dataform.workflow_configs name: workflow_configs title: Workflow_configs methods: @@ -2670,15 +2672,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/workflow_configs/methods/list' - $ref: '#/components/x-stackQL-resources/workflow_configs/methods/get' + - $ref: '#/components/x-stackQL-resources/workflow_configs/methods/list' insert: - $ref: '#/components/x-stackQL-resources/workflow_configs/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/workflow_configs/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/workflow_configs/methods/delete' workflow_invocations: - id: dataform.workflow_invocations + id: google.dataform.workflow_invocations name: workflow_invocations title: Workflow_invocations methods: @@ -2730,8 +2733,8 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/workflow_invocations/methods/list' - $ref: '#/components/x-stackQL-resources/workflow_invocations/methods/get' + - $ref: '#/components/x-stackQL-resources/workflow_invocations/methods/list' insert: - $ref: >- #/components/x-stackQL-resources/workflow_invocations/methods/create @@ -2740,7 +2743,7 @@ components: - $ref: >- #/components/x-stackQL-resources/workflow_invocations/methods/delete comment_threads_iam_policies: - id: dataform.comment_threads_iam_policies + id: google.dataform.comment_threads_iam_policies name: comment_threads_iam_policies title: Comment_threads_iam_policies methods: @@ -2770,7 +2773,7 @@ components: update: [] delete: [] collections_iam_policies: - id: dataform.collections_iam_policies + id: google.dataform.collections_iam_policies name: collections_iam_policies title: Collections_iam_policies methods: 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 495e6e64..cd8d4e22 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: '20240111' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/data-fusion/docs servers: @@ -1239,7 +1239,7 @@ components: - '2' x-stackQL-resources: locations: - id: datafusion.locations + id: google.datafusion.locations name: locations title: Locations methods: @@ -1261,13 +1261,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: datafusion.operations + id: google.datafusion.operations name: operations title: Operations methods: @@ -1305,14 +1305,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' versions: - id: datafusion.versions + id: google.datafusion.versions name: versions title: Versions methods: @@ -1334,7 +1334,7 @@ components: update: [] delete: [] instances: - id: datafusion.instances + id: google.datafusion.instances name: instances title: Instances methods: @@ -1386,15 +1386,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/instances/methods/list' - $ref: '#/components/x-stackQL-resources/instances/methods/get' + - $ref: '#/components/x-stackQL-resources/instances/methods/list' insert: - $ref: '#/components/x-stackQL-resources/instances/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/instances/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/instances/methods/delete' instances_iam_policies: - id: datafusion.instances_iam_policies + id: google.datafusion.instances_iam_policies name: instances_iam_policies title: Instances_iam_policies methods: @@ -1431,7 +1432,7 @@ components: update: [] delete: [] dns_peerings: - id: datafusion.dns_peerings + id: google.datafusion.dns_peerings name: dns_peerings title: Dns_peerings methods: 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 2de5869b..ce5ee1be 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: '20240207' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/data-labeling/docs/ servers: @@ -4088,7 +4088,7 @@ components: - '2' x-stackQL-resources: operations: - id: datalabeling.operations + id: google.datalabeling.operations name: operations title: Operations methods: @@ -4125,17 +4125,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_operations_list insert: [] update: [] delete: - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_operations_delete datasets: - id: datalabeling.datasets + id: google.datalabeling.datasets name: datasets title: Datasets methods: @@ -4185,10 +4185,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/datasets/methods/projects_datasets_list - $ref: >- #/components/x-stackQL-resources/datasets/methods/projects_datasets_get + - $ref: >- + #/components/x-stackQL-resources/datasets/methods/projects_datasets_list insert: - $ref: >- #/components/x-stackQL-resources/datasets/methods/projects_datasets_create @@ -4197,7 +4197,7 @@ components: - $ref: >- #/components/x-stackQL-resources/datasets/methods/projects_datasets_delete data_items: - id: datalabeling.data_items + id: google.datalabeling.data_items name: data_items title: Data_items methods: @@ -4239,19 +4239,19 @@ components: response: *ref_8 sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/data_items/methods/projects_datasets_data_items_get - - $ref: >- - #/components/x-stackQL-resources/data_items/methods/projects_datasets_data_items_list - $ref: >- #/components/x-stackQL-resources/data_items/methods/projects_datasets_annotated_datasets_data_items_get + - $ref: >- + #/components/x-stackQL-resources/data_items/methods/projects_datasets_data_items_get - $ref: >- #/components/x-stackQL-resources/data_items/methods/projects_datasets_annotated_datasets_data_items_list + - $ref: >- + #/components/x-stackQL-resources/data_items/methods/projects_datasets_data_items_list insert: [] update: [] delete: [] annotated_datasets: - id: datalabeling.annotated_datasets + id: google.datalabeling.annotated_datasets name: annotated_datasets title: Annotated_datasets methods: @@ -4292,7 +4292,7 @@ components: - $ref: >- #/components/x-stackQL-resources/annotated_datasets/methods/projects_datasets_annotated_datasets_delete examples: - id: datalabeling.examples + id: google.datalabeling.examples name: examples title: Examples methods: @@ -4324,7 +4324,7 @@ components: update: [] delete: [] feedback_threads: - id: datalabeling.feedback_threads + id: google.datalabeling.feedback_threads name: feedback_threads title: Feedback_threads methods: @@ -4365,7 +4365,7 @@ components: - $ref: >- #/components/x-stackQL-resources/feedback_threads/methods/projects_datasets_annotated_datasets_feedback_threads_delete feedback_messages: - id: datalabeling.feedback_messages + id: google.datalabeling.feedback_messages name: feedback_messages title: Feedback_messages methods: @@ -4403,10 +4403,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/feedback_messages/methods/projects_datasets_annotated_datasets_feedback_threads_feedback_messages_list - $ref: >- #/components/x-stackQL-resources/feedback_messages/methods/projects_datasets_annotated_datasets_feedback_threads_feedback_messages_get + - $ref: >- + #/components/x-stackQL-resources/feedback_messages/methods/projects_datasets_annotated_datasets_feedback_threads_feedback_messages_list insert: - $ref: >- #/components/x-stackQL-resources/feedback_messages/methods/projects_datasets_annotated_datasets_feedback_threads_feedback_messages_create @@ -4415,7 +4415,7 @@ components: - $ref: >- #/components/x-stackQL-resources/feedback_messages/methods/projects_datasets_annotated_datasets_feedback_threads_feedback_messages_delete image: - id: datalabeling.image + id: google.datalabeling.image name: image title: Image methods: @@ -4432,7 +4432,7 @@ components: update: [] delete: [] video: - id: datalabeling.video + id: google.datalabeling.video name: video title: Video methods: @@ -4449,7 +4449,7 @@ components: update: [] delete: [] text: - id: datalabeling.text + id: google.datalabeling.text name: text title: Text methods: @@ -4466,7 +4466,7 @@ components: update: [] delete: [] evaluations: - id: datalabeling.evaluations + id: google.datalabeling.evaluations name: evaluations title: Evaluations methods: @@ -4491,7 +4491,7 @@ components: update: [] delete: [] example_comparisons: - id: datalabeling.example_comparisons + id: google.datalabeling.example_comparisons name: example_comparisons title: Example_comparisons methods: @@ -4508,7 +4508,7 @@ components: update: [] delete: [] annotation_spec_sets: - id: datalabeling.annotation_spec_sets + id: google.datalabeling.annotation_spec_sets name: annotation_spec_sets title: Annotation_spec_sets methods: @@ -4544,10 +4544,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/annotation_spec_sets/methods/projects_annotation_spec_sets_list - $ref: >- #/components/x-stackQL-resources/annotation_spec_sets/methods/projects_annotation_spec_sets_get + - $ref: >- + #/components/x-stackQL-resources/annotation_spec_sets/methods/projects_annotation_spec_sets_list insert: - $ref: >- #/components/x-stackQL-resources/annotation_spec_sets/methods/projects_annotation_spec_sets_create @@ -4556,7 +4556,7 @@ components: - $ref: >- #/components/x-stackQL-resources/annotation_spec_sets/methods/projects_annotation_spec_sets_delete instructions: - id: datalabeling.instructions + id: google.datalabeling.instructions name: instructions title: Instructions methods: @@ -4592,10 +4592,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/instructions/methods/projects_instructions_list - $ref: >- #/components/x-stackQL-resources/instructions/methods/projects_instructions_get + - $ref: >- + #/components/x-stackQL-resources/instructions/methods/projects_instructions_list insert: - $ref: >- #/components/x-stackQL-resources/instructions/methods/projects_instructions_create @@ -4604,7 +4604,7 @@ components: - $ref: >- #/components/x-stackQL-resources/instructions/methods/projects_instructions_delete evaluation_jobs: - id: datalabeling.evaluation_jobs + id: google.datalabeling.evaluation_jobs name: evaluation_jobs title: Evaluation_jobs methods: @@ -4661,14 +4661,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/evaluation_jobs/methods/projects_evaluation_jobs_list - $ref: >- #/components/x-stackQL-resources/evaluation_jobs/methods/projects_evaluation_jobs_get + - $ref: >- + #/components/x-stackQL-resources/evaluation_jobs/methods/projects_evaluation_jobs_list insert: - $ref: >- #/components/x-stackQL-resources/evaluation_jobs/methods/projects_evaluation_jobs_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/evaluation_jobs/methods/projects_evaluation_jobs_patch delete: - $ref: >- #/components/x-stackQL-resources/evaluation_jobs/methods/projects_evaluation_jobs_delete 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 98a38145..2aefa751 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/datalineage.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/datalineage.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1 x-discovery-doc-revision: '20240517' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/data-catalog servers: @@ -35,33 +35,8 @@ components: scopes: *ref_0 schemas: GoogleCloudDatacatalogLineageV1LineageEvent: - type: object 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. properties: - links: - type: array - description: >- - Optional. List of source-target pairs. Can't contain more than 100 - tuples. - items: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EventLink' - startTime: - 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 - format: google-datetime - 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 name: type: string description: >- @@ -70,117 +45,68 @@ components: 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_-:.` - GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse: - type: object - id: GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse - description: Response message for BatchSearchLinkProcesses. - properties: - 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. - processLinks: + links: items: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1ProcessLinks' - description: An array of processes associated with the specified links. + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EventLink' type: array - GoogleCloudDatacatalogLineageV1OperationMetadata: - description: Metadata describing the operation. - type: object - id: GoogleCloudDatacatalogLineageV1OperationMetadata - properties: + description: >- + Optional. List of source-target pairs. Can't contain more than 100 + tuples. endTime: - format: google-datetime - readOnly: true type: string description: >- - Output only. The timestamp of the operation termination, regardless - of its success. This field is unset if the operation is still - ongoing. - createTime: + 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. format: google-datetime - description: >- - Output only. The timestamp of the operation submission to the - server. - type: string - readOnly: true - resourceUuid: + startTime: type: string - description: Output only. The UUID of the resource being operated on. - readOnly: true - resource: + format: google-datetime 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: - enum: - - TYPE_UNSPECIFIED - - DELETE - - CREATE - readOnly: true - enumDescriptions: - - Unused. - - The resource deletion operation. - - The resource creation operation. - description: Output only. The type of the operation being performed. - type: string - state: - type: string - readOnly: true - description: Output only. The current operation state. - enum: - - STATE_UNSPECIFIED - - PENDING - - RUNNING - - SUCCEEDED - - FAILED - 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. - GoogleCloudDatacatalogLineageV1ProcessLinks: + 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. + 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 + GoogleLongrunningCancelOperationRequest: + id: GoogleLongrunningCancelOperationRequest + type: object + description: The request message for Operations.CancelOperation. + properties: {} + GoogleCloudDatacatalogLineageV1SearchLinksRequest: type: object + id: GoogleCloudDatacatalogLineageV1SearchLinksRequest + description: Request message for SearchLinks. properties: - process: - type: string + source: description: >- - The process name in the format of - `projects/{project}/locations/{location}/processes/{process}`. - links: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1ProcessLinkInfo + 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' + pageSize: 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. - description: Links associated with a specific process. - id: GoogleCloudDatacatalogLineageV1ProcessLinks - GoogleCloudDatacatalogLineageV1ListProcessesResponse: - type: object - id: GoogleCloudDatacatalogLineageV1ListProcessesResponse - properties: - nextPageToken: + 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 + target: 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. + 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' + 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. type: string - processes: - items: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' - type: array - description: The processes from the specified project and location. - description: Response message for ListProcesses. GoogleCloudDatacatalogLineageV1Process: - id: GoogleCloudDatacatalogLineageV1Process properties: name: description: >- @@ -194,6 +120,12 @@ components: description: >- Optional. The origin of this process and its runs and lineage events. + 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 attributes: type: object additionalProperties: @@ -202,121 +134,183 @@ components: 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. - 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: object description: A process is the definition of a data transformation operation. + id: GoogleCloudDatacatalogLineageV1Process + GoogleCloudDatacatalogLineageV1ProcessLinks: + description: Links associated with a specific process. type: object - GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse: + id: GoogleCloudDatacatalogLineageV1ProcessLinks properties: - process: - description: >- - Created process name. Format: - `projects/{project}/locations/{location}/processes/{process}`. - type: string - lineageEvents: + links: items: - type: string + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1ProcessLinkInfo type: array description: >- - Created lineage event names. Format: - `projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}`. - run: + 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. + process: type: string description: >- - Created run name. Format: - `projects/{project}/locations/{location}/processes/{process}/runs/{run}`. - id: GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse - type: object - description: Response message for ProcessOpenLineageRunEvent. - GoogleCloudDatacatalogLineageV1SearchLinksResponse: + The process name in the format of + `projects/{project}/locations/{location}/processes/{process}`. + GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse: + id: GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse properties: + processLinks: + type: array + items: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1ProcessLinks' + description: An array of processes associated with the specified links. 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. - type: string - 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 - description: Response message for SearchLinks. - id: GoogleCloudDatacatalogLineageV1SearchLinksResponse - type: object - GoogleLongrunningCancelOperationRequest: - properties: {} - id: GoogleLongrunningCancelOperationRequest - description: The request message for Operations.CancelOperation. - type: object - GoogleCloudDatacatalogLineageV1Run: type: object - id: GoogleCloudDatacatalogLineageV1Run + description: Response message for BatchSearchLinkProcesses. + GoogleCloudDatacatalogLineageV1Origin: properties: - state: + sourceType: + type: string + 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: - - UNKNOWN - - STARTED - - COMPLETED - - FAILED - - ABORTED - description: Required. The state of the run. - 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. + - SOURCE_TYPE_UNSPECIFIED + - CUSTOM + - BIGQUERY + - DATA_FUSION + - COMPOSER + - LOOKER_STUDIO + - DATAPROC + enumDescriptions: + - Source is Unspecified + - A custom source + - BigQuery + - Data Fusion + - Composer + - Looker Studio + - Dataproc + name: type: string - 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 - displayName: + 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: object + description: Origin of a process. + id: GoogleCloudDatacatalogLineageV1Origin + GoogleCloudDatacatalogLineageV1ListLineageEventsResponse: + properties: + lineageEvents: + description: Lineage events from the specified project and location. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1LineageEvent' + nextPageToken: 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: + 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. + id: GoogleCloudDatacatalogLineageV1ListLineageEventsResponse + description: Response message for ListLineageEvents. + type: object + GoogleCloudDatacatalogLineageV1EventLink: + description: A lineage between source and target entities. + properties: + target: + description: Required. Reference to the target entity + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' + source: + description: Required. Reference to the source entity + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' + id: GoogleCloudDatacatalogLineageV1EventLink + type: object + GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse: + type: object + id: GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse + properties: + run: type: string - format: google-datetime - description: Optional. The timestamp of the end of the run. - name: description: >- - Immutable. The resource name of the run. Format: + Created run name. 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_-:.` + lineageEvents: + type: array + items: + type: string + description: >- + Created lineage event names. Format: + `projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}`. + process: + description: >- + Created process name. Format: + `projects/{project}/locations/{location}/processes/{process}`. + type: string + description: Response message for ProcessOpenLineageRunEvent. + 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 + 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 + GoogleCloudDatacatalogLineageV1ProcessLinkInfo: + properties: startTime: + type: string + description: The start of the first event establishing this link-process tuple. format: google-datetime + link: type: string - description: Required. The timestamp of the start of the run. - description: >- - A lineage run represents an execution of a process that creates lineage - events. - 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 name of the link in the format of + `projects/{project}/locations/{location}/links/{link}`. + endTime: + type: string + format: google-datetime + description: The end of the last event establishing this link-process tuple. + description: Link details. + id: GoogleCloudDatacatalogLineageV1ProcessLinkInfo type: object - id: GoogleProtobufEmpty - properties: {} GoogleCloudDatacatalogLineageV1EntityReference: + id: GoogleCloudDatacatalogLineageV1EntityReference + type: object properties: fullyQualifiedName: description: >- @@ -324,138 +318,140 @@ components: (FQN)](https://cloud.google.com/data-catalog/docs/fully-qualified-names) of the entity. type: string - type: object - id: GoogleCloudDatacatalogLineageV1EntityReference description: The soft reference to everything you can attach a lineage event to. - GoogleCloudDatacatalogLineageV1ListRunsResponse: - type: object + GoogleCloudDatacatalogLineageV1ListProcessesResponse: properties: - runs: - description: The runs from the specified project and location. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' 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 ListRuns. - id: GoogleCloudDatacatalogLineageV1ListRunsResponse - GoogleCloudDatacatalogLineageV1EventLink: - id: GoogleCloudDatacatalogLineageV1EventLink - properties: - target: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' - description: Required. Reference to the target entity - source: - description: Required. Reference to the source entity - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' + processes: + type: array + description: The processes from the specified project and location. + items: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' + id: GoogleCloudDatacatalogLineageV1ListProcessesResponse + description: Response message for ListProcesses. type: object - description: A lineage between source and target entities. - GoogleCloudDatacatalogLineageV1Link: + GoogleCloudDatacatalogLineageV1OperationMetadata: + description: Metadata describing the operation. properties: - startTime: + resourceUuid: + readOnly: true type: string - format: google-datetime - description: The start of the first event establishing this link. - source: - description: The pointer to the entity that is the **source** of this link. - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' - name: + description: Output only. The UUID of the resource being operated on. + resource: description: >- - Output only. Immutable. The name of the link. Format: - `projects/{project}/locations/{location}/links/{link}`. - type: string + Output only. The [relative name] + (https://cloud.google.com//apis/design/resource_names#relative_resource_name) + of the resource being operated on. readOnly: true - target: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' - description: The pointer to the entity that is the **target** of this link. + type: string endTime: type: string format: google-datetime - description: The end of the last event establishing this link. - 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 - GoogleCloudDatacatalogLineageV1ProcessLinkInfo: - description: Link details. - properties: - link: - type: string + readOnly: true description: >- - The name of the link in the format of - `projects/{project}/locations/{location}/links/{link}`. - endTime: + Output only. The timestamp of the operation termination, regardless + of its success. This field is unset if the operation is still + ongoing. + state: + type: string + readOnly: true + 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. + enum: + - STATE_UNSPECIFIED + - PENDING + - RUNNING + - SUCCEEDED + - FAILED + description: Output only. The current operation state. + createTime: + readOnly: true format: google-datetime + description: >- + Output only. The timestamp of the operation submission to the + server. type: string - description: The end of the last event establishing this link-process tuple. - startTime: - description: The start of the first event establishing this link-process tuple. + operationType: + description: Output only. The type of the operation being performed. type: string - format: google-datetime + enum: + - TYPE_UNSPECIFIED + - DELETE + - CREATE + enumDescriptions: + - Unused. + - The resource deletion operation. + - The resource creation operation. + readOnly: true + type: object + id: GoogleCloudDatacatalogLineageV1OperationMetadata + GoogleLongrunningListOperationsResponse: + id: GoogleLongrunningListOperationsResponse + type: object + description: The response message for Operations.ListOperations. + 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. + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' + type: array + GoogleCloudDatacatalogLineageV1SearchLinksResponse: + description: Response message for SearchLinks. type: object - id: GoogleCloudDatacatalogLineageV1ProcessLinkInfo - GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest: + id: GoogleCloudDatacatalogLineageV1SearchLinksResponse properties: - pageToken: - type: string - 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. 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: - type: string + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Link' type: array + nextPageToken: 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}`. - pageSize: - 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 - type: integer - type: object - id: GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest - description: Request message for BatchSearchLinkProcesses. + 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 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}`. - type: string - 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 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. + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + error: + $ref: '#/components/schemas/GoogleRpcStatus' + 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 @@ -466,175 +462,164 @@ 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. - error: + type: any + type: object + done: + type: boolean description: >- - The error result of the operation in case of failure or - cancellation. - $ref: '#/components/schemas/GoogleRpcStatus' + 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. - GoogleRpcStatus: - id: GoogleRpcStatus + GoogleCloudDatacatalogLineageV1ListRunsResponse: + description: Response message for ListRuns. properties: - code: - description: The status code, which should be an enum value of google.rpc.Code. - type: integer - format: int32 - message: + nextPageToken: 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. + 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 - details: - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. + runs: items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' + description: The runs from the specified project and location. type: array 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). - GoogleLongrunningListOperationsResponse: + id: GoogleCloudDatacatalogLineageV1ListRunsResponse + GoogleCloudDatacatalogLineageV1Link: type: object - id: GoogleLongrunningListOperationsResponse + 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: - operations: - description: >- - A list of operations that matches the specified filter in the - request. - type: array - items: - $ref: '#/components/schemas/GoogleLongrunningOperation' - nextPageToken: + source: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' + description: The pointer to the entity that is the **source** of this link. + target: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' + description: The pointer to the entity that is the **target** of this link. + startTime: type: string - description: The standard List next-page token. - description: The response message for Operations.ListOperations. - GoogleCloudDatacatalogLineageV1Origin: - id: GoogleCloudDatacatalogLineageV1Origin - properties: + description: The start of the first event establishing this link. + format: google-datetime 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 - 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. - enumDescriptions: - - Source is Unspecified - - A custom source - - BigQuery - - Data Fusion - - Composer - - Looker Studio - - Dataproc + Output only. Immutable. The name of the link. Format: + `projects/{project}/locations/{location}/links/{link}`. + readOnly: true + endTime: type: string - enum: - - SOURCE_TYPE_UNSPECIFIED - - CUSTOM - - BIGQUERY - - DATA_FUSION - - COMPOSER - - LOOKER_STUDIO - - DATAPROC - description: Origin of a process. + format: google-datetime + description: The end of the last event establishing this link. + id: GoogleCloudDatacatalogLineageV1Link + GoogleProtobufEmpty: + id: GoogleProtobufEmpty type: object - GoogleCloudDatacatalogLineageV1SearchLinksRequest: + 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: {} + GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest: type: object - description: Request message for SearchLinks. 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' - 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. - pageToken: - type: string + links: + type: array 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. + 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}`. + items: + type: string pageSize: 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. type: integer + pageToken: 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. - id: GoogleCloudDatacatalogLineageV1SearchLinksRequest - GoogleCloudDatacatalogLineageV1ListLineageEventsResponse: - 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: string + description: Request message for BatchSearchLinkProcesses. + id: GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest + GoogleCloudDatacatalogLineageV1Run: properties: - nextPageToken: + state: + 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 + different state that is not supported here explicitly. + - The run is still executing. + - The run completed. + - The run failed. + - The run aborted. + 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. + type: object + additionalProperties: + type: any + endTime: + type: string + format: google-datetime + description: Optional. The timestamp of the end of the run. + name: 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. + 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 - lineageEvents: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1LineageEvent' - description: Lineage events from the specified project and location. - description: Response message for ListLineageEvents. - id: GoogleCloudDatacatalogLineageV1ListLineageEventsResponse - parameters: - key: + startTime: + description: Required. The timestamp of the start of the run. + type: string + format: google-datetime + displayName: + 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 `_-:&.` + type: string + id: GoogleCloudDatacatalogLineageV1Run 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 + A lineage run represents an execution of a process that creates lineage + events. + type: object + 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"). + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: upload_protocol + name: oauth_token schema: type: string fields: @@ -643,12 +628,6 @@ components: name: fields 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 @@ -665,15 +644,6 @@ components: name: callback schema: type: string - _.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 @@ -683,67 +653,94 @@ components: name: quotaUser schema: type: string - 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. + 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 + 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' x-stackQL-resources: - operations: - id: datalineage.operations - name: operations - title: Operations + locations: + id: google.datalineage.locations + name: locations + title: Locations methods: - _list: - operation: &ref_1 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_2 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations - list: - operation: *ref_1 - response: *ref_2 - delete: + process_open_lineage_run_event: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:processOpenLineageRunEvent/post response: mediaType: application/json openAPIDocKey: '200' - get: + batch_search_link_processes: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:batchSearchLinkProcesses/post response: mediaType: application/json openAPIDocKey: '200' - cancel: + search_links: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:searchLinks/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' + select: [] insert: [] update: [] - delete: - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' + delete: [] processes: - id: datalineage.processes + id: google.datalineage.processes name: processes title: Processes methods: - patch: + _list: + operation: &ref_1 + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes/get + response: &ref_2 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.processes + list: + operation: *ref_1 + response: *ref_2 + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes/post response: mediaType: application/json openAPIDocKey: '200' @@ -754,28 +751,17 @@ 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' - _list: - operation: &ref_3 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes/get - response: &ref_4 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.processes - list: - operation: *ref_3 - response: *ref_4 - create: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}/get response: mediaType: application/json openAPIDocKey: '200' @@ -785,32 +771,22 @@ components: - $ref: '#/components/x-stackQL-resources/processes/methods/list' insert: - $ref: '#/components/x-stackQL-resources/processes/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/processes/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/processes/methods/delete' runs: - id: datalineage.runs + id: google.datalineage.runs name: runs title: Runs methods: - 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' - _list: - operation: &ref_5 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs/get - response: &ref_6 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.runs - list: - operation: *ref_5 - response: *ref_6 get: operation: $ref: >- @@ -818,45 +794,57 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete: + 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' - 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' + _list: + operation: &ref_3 + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs/get + response: &ref_4 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.runs + list: + operation: *ref_3 + response: *ref_4 sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/runs/methods/list' - $ref: '#/components/x-stackQL-resources/runs/methods/get' + - $ref: '#/components/x-stackQL-resources/runs/methods/list' insert: - $ref: '#/components/x-stackQL-resources/runs/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/runs/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/runs/methods/delete' lineage_events: - id: datalineage.lineage_events + id: google.datalineage.lineage_events name: lineage_events title: Lineage_events methods: - delete: + get: 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}~1lineageEvents~1{lineageEventsId}/get response: mediaType: application/json openAPIDocKey: '200' - get: + delete: 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}~1lineageEvents~1{lineageEventsId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -868,16 +856,16 @@ components: mediaType: application/json openAPIDocKey: '200' _list: - operation: &ref_7 + operation: &ref_5 $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}~1lineageEvents/get - response: &ref_8 + response: &ref_6 mediaType: application/json openAPIDocKey: '200' objectKey: $.lineageEvents list: - operation: *ref_7 - response: *ref_8 + operation: *ref_5 + response: *ref_6 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/lineage_events/methods/get' @@ -887,56 +875,72 @@ components: update: [] delete: - $ref: '#/components/x-stackQL-resources/lineage_events/methods/delete' - locations: - id: datalineage.locations - name: locations - title: Locations + operations: + id: google.datalineage.operations + name: operations + title: Operations methods: - search_links: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:searchLinks/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete response: mediaType: application/json openAPIDocKey: '200' - process_open_lineage_run_event: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:processOpenLineageRunEvent/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - batch_search_link_processes: + _list: + operation: &ref_7 + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get + response: &ref_8 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + list: + operation: *ref_7 + response: *ref_8 + cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:batchSearchLinkProcesses/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post 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: [] - delete: [] + delete: + - $ref: '#/components/x-stackQL-resources/operations/methods/delete' paths: - /v1/projects/{projectsId}/locations/{locationsId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}:processOpenLineageRunEvent: parameters: &ref_9 - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/oauth_token' - get: + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/_.xgafv' + 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 + 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 @@ -948,7 +952,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse parameters: - in: path name: projectsId @@ -961,27 +966,29 @@ paths: schema: type: string - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + name: requestId schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}:batchSearchLinkProcesses: parameters: *ref_9 - 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: datalineage.projects.locations.operations.delete + 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 @@ -993,7 +1000,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse parameters: - in: path name: projectsId @@ -1005,17 +1013,23 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true - schema: - type: string - get: + /v1/projects/{projectsId}/locations/{locationsId}:searchLinks: + parameters: *ref_9 + 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: datalineage.projects.locations.operations.get + 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 @@ -1027,7 +1041,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1SearchLinksResponse parameters: - in: path name: projectsId @@ -1039,30 +1054,13 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/processes: parameters: *ref_9 - 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: datalineage.projects.locations.operations.cancel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningCancelOperationRequest' + 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 @@ -1074,7 +1072,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1ListProcessesResponse parameters: - in: path name: projectsId @@ -1086,16 +1085,18 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}: - parameters: *ref_9 - patch: - description: Updates a process. - operationId: datalineage.projects.locations.processes.patch + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: Creates a new process. + operationId: datalineage.projects.locations.processes.create requestBody: content: application/json: @@ -1124,20 +1125,12 @@ paths: 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 + name: requestId schema: type: string - format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}: + parameters: *ref_9 delete: description: Deletes the process with the specified name. operationId: datalineage.projects.locations.processes.delete @@ -1173,9 +1166,14 @@ paths: name: allowMissing schema: type: boolean - get: - description: Gets the details of the specified process. - operationId: datalineage.projects.locations.processes.get + 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 @@ -1204,91 +1202,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processes: - parameters: *ref_9 - 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 - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1ListProcessesResponse - 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 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 - 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 + name: updateMask schema: type: string + format: google-fieldmask - in: query - name: requestId + name: allowMissing schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs: - parameters: *ref_9 - post: - description: Creates a new run. - operationId: datalineage.projects.locations.processes.runs.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' + type: boolean + get: + description: Gets the details of the specified process. + operationId: datalineage.projects.locations.processes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1300,7 +1225,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' parameters: - in: path name: projectsId @@ -1317,15 +1242,11 @@ paths: required: true schema: type: string - - in: query - name: requestId - schema: - type: string - get: - description: >- - Lists runs in the given project and location. List order is descending - by `start_time`. - operationId: datalineage.projects.locations.processes.runs.list + /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}: + parameters: *ref_9 + 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 @@ -1337,8 +1258,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1ListRunsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -1355,17 +1275,15 @@ paths: required: true schema: type: string - - in: query - name: pageSize + - in: path + name: runsId + required: true schema: - type: integer - format: int32 + type: string - in: query - name: pageToken + name: allowMissing schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}: - parameters: *ref_9 + type: boolean get: description: Gets the details of the specified run. operationId: datalineage.projects.locations.processes.runs.get @@ -1402,9 +1320,14 @@ paths: required: true schema: type: string - delete: - description: Deletes the run with the specified name. - operationId: datalineage.projects.locations.processes.runs.delete + 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 @@ -1416,7 +1339,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' parameters: - in: path name: projectsId @@ -1438,13 +1361,20 @@ paths: required: true schema: type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask - in: query name: allowMissing schema: type: boolean - patch: - description: Updates a run. - operationId: datalineage.projects.locations.processes.runs.patch + /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs: + parameters: *ref_9 + post: + description: Creates a new run. + operationId: datalineage.projects.locations.processes.runs.create requestBody: content: application/json: @@ -1478,25 +1408,58 @@ paths: required: true schema: type: string + - in: query + name: requestId + schema: + type: string + 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 + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1ListRunsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string - in: path - name: runsId + name: locationsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: processesId + required: true schema: type: string - format: google-fieldmask - in: query - name: allowMissing + name: pageSize schema: - type: boolean + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}/lineageEvents/{lineageEventsId}: parameters: *ref_9 - delete: - description: Deletes the lineage event with the specified name. - operationId: datalineage.projects.locations.processes.runs.lineageEvents.delete + 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 @@ -1508,7 +1471,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1LineageEvent parameters: - in: path name: projectsId @@ -1535,13 +1499,9 @@ paths: 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 lineage event with the specified name. + operationId: datalineage.projects.locations.processes.runs.lineageEvents.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1553,8 +1513,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1LineageEvent + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -1581,6 +1540,10 @@ paths: required: true schema: type: string + - in: query + name: allowMissing + schema: + type: boolean /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}/lineageEvents: parameters: *ref_9 post: @@ -1677,23 +1640,15 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:searchLinks: + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: parameters: *ref_9 - post: + delete: 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 + Deletes a long-running operation. This method indicates that the client + is no longer interested 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 @@ -1705,8 +1660,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1SearchLinksResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -1718,15 +1672,52 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:processOpenLineageRunEvent: + - 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: datalineage.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/GoogleLongrunningOperation' + 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: parameters: *ref_9 - post: + get: 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 + 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 @@ -1738,8 +1729,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -1752,29 +1742,37 @@ paths: schema: type: string - in: query - name: requestId + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:batchSearchLinkProcesses: + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: parameters: *ref_9 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 + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is 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/GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest + $ref: '#/components/schemas/GoogleLongrunningCancelOperationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1786,8 +1784,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -1799,3 +1796,8 @@ paths: 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/datamigration.yaml b/providers/src/googleapis.com/v00.00.00000/services/datamigration.yaml index 812a383d..67f61566 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/datamigration.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/datamigration.yaml @@ -7,8 +7,8 @@ info: title: Database Migration API description: Manage Cloud Database Migration Service resources on Google Cloud Platform. version: v1 - x-discovery-doc-revision: '20240515' - x-generated-date: '2024-06-02' + x-discovery-doc-revision: '20240522' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/database-migration/ servers: @@ -536,6 +536,9 @@ components: type: array items: $ref: '#/components/schemas/SqlServerDatabaseBackup' + useDiffBackup: + description: Optional. Enable differential backups. + type: boolean SqlServerDatabaseBackup: id: SqlServerDatabaseBackup description: >- @@ -1236,6 +1239,7 @@ components: - PostgreSQL 13. - PostgreSQL 14. - PostgreSQL 15. + - PostgreSQL 16. enum: - SQL_DATABASE_VERSION_UNSPECIFIED - MYSQL_5_6 @@ -1259,6 +1263,7 @@ components: - POSTGRES_13 - POSTGRES_14 - POSTGRES_15 + - POSTGRES_16 userLabels: description: >- The resource labels for a Cloud SQL instance to use to annotate any @@ -4300,7 +4305,7 @@ components: - '2' x-stackQL-resources: static_ips: - id: datamigration.static_ips + id: google.datamigration.static_ips name: static_ips title: Static_ips methods: @@ -4317,7 +4322,7 @@ components: update: [] delete: [] locations: - id: datamigration.locations + id: google.datamigration.locations name: locations title: Locations methods: @@ -4339,13 +4344,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: datamigration.operations + id: google.datamigration.operations name: operations title: Operations methods: @@ -4383,14 +4388,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' migration_jobs: - id: datamigration.migration_jobs + id: google.datamigration.migration_jobs name: migration_jobs title: Migration_jobs methods: @@ -4498,15 +4503,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/migration_jobs/methods/list' - $ref: '#/components/x-stackQL-resources/migration_jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/migration_jobs/methods/list' insert: - $ref: '#/components/x-stackQL-resources/migration_jobs/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/migration_jobs/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/migration_jobs/methods/delete' migration_jobs_iam_policies: - id: datamigration.migration_jobs_iam_policies + id: google.datamigration.migration_jobs_iam_policies name: migration_jobs_iam_policies title: Migration_jobs_iam_policies methods: @@ -4543,7 +4549,7 @@ components: update: [] delete: [] connection_profiles: - id: datamigration.connection_profiles + id: google.datamigration.connection_profiles name: connection_profiles title: Connection_profiles methods: @@ -4588,17 +4594,18 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/connection_profiles/methods/list' - $ref: '#/components/x-stackQL-resources/connection_profiles/methods/get' + - $ref: '#/components/x-stackQL-resources/connection_profiles/methods/list' insert: - $ref: >- #/components/x-stackQL-resources/connection_profiles/methods/create - update: [] + update: + - $ref: '#/components/x-stackQL-resources/connection_profiles/methods/patch' delete: - $ref: >- #/components/x-stackQL-resources/connection_profiles/methods/delete connection_profiles_iam_policies: - id: datamigration.connection_profiles_iam_policies + id: google.datamigration.connection_profiles_iam_policies name: connection_profiles_iam_policies title: Connection_profiles_iam_policies methods: @@ -4635,7 +4642,7 @@ components: update: [] delete: [] private_connections: - id: datamigration.private_connections + id: google.datamigration.private_connections name: private_connections title: Private_connections methods: @@ -4673,8 +4680,8 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/private_connections/methods/list' - $ref: '#/components/x-stackQL-resources/private_connections/methods/get' + - $ref: '#/components/x-stackQL-resources/private_connections/methods/list' insert: - $ref: >- #/components/x-stackQL-resources/private_connections/methods/create @@ -4683,7 +4690,7 @@ components: - $ref: >- #/components/x-stackQL-resources/private_connections/methods/delete private_connections_iam_policies: - id: datamigration.private_connections_iam_policies + id: google.datamigration.private_connections_iam_policies name: private_connections_iam_policies title: Private_connections_iam_policies methods: @@ -4720,7 +4727,7 @@ components: update: [] delete: [] conversion_workspaces: - id: datamigration.conversion_workspaces + id: google.datamigration.conversion_workspaces name: conversion_workspaces title: Conversion_workspaces methods: @@ -4827,12 +4834,14 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/conversion_workspaces/methods/create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/conversion_workspaces/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/conversion_workspaces/methods/delete conversion_workspaces_iam_policies: - id: datamigration.conversion_workspaces_iam_policies + id: google.datamigration.conversion_workspaces_iam_policies name: conversion_workspaces_iam_policies title: Conversion_workspaces_iam_policies methods: @@ -4869,7 +4878,7 @@ components: update: [] delete: [] mapping_rules: - id: datamigration.mapping_rules + id: google.datamigration.mapping_rules name: mapping_rules title: Mapping_rules methods: @@ -4914,8 +4923,8 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/mapping_rules/methods/list' - $ref: '#/components/x-stackQL-resources/mapping_rules/methods/get' + - $ref: '#/components/x-stackQL-resources/mapping_rules/methods/list' insert: - $ref: '#/components/x-stackQL-resources/mapping_rules/methods/create' update: [] 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 4e99ddb7..84a0f7f3 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: '20240526' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/dataflow/docs/guides/data-pipelines servers: @@ -36,93 +36,188 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudDatapipelinesV1Pipeline: + GoogleCloudDatapipelinesV1RunPipelineRequest: + description: Request message for RunPipeline + id: GoogleCloudDatapipelinesV1RunPipelineRequest + type: object + properties: {} + GoogleCloudDatapipelinesV1Job: + type: object + id: GoogleCloudDatapipelinesV1Job properties: name: type: string - 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. - 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. + description: Required. The fully qualified resource name for the job. + endTime: type: string - displayName: + format: google-datetime description: >- - Required. The display name of the pipeline. It can contain only - letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores - (_). + Output only. The time of job termination. This is absent if the job + is still running. + readOnly: true + id: type: string - jobCount: - type: integer - description: Output only. Number of jobs. readOnly: true - format: int32 - lastUpdateTime: + description: Output only. The internal ID for the job. + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + Status capturing any error code or message related to job creation + or execution. + state: + 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. + type: string + description: The current state of the job. + enum: + - STATE_UNSPECIFIED + - STATE_PENDING + - STATE_RUNNING + - STATE_DONE + - STATE_FAILED + - STATE_CANCELLED + createTime: readOnly: true type: string format: google-datetime + description: Output only. The time of job creation. + dataflowJobDetails: + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1DataflowJobDetails' + description: All the details that are specific to a Dataflow job. + description: >- + Definition of the job information maintained by the pipeline. Fields in + this entity are retrieved from the executor API (e.g. Dataflow API). + GoogleCloudDatapipelinesV1RunPipelineResponse: + properties: + job: + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Job' + description: Job that was created as part of RunPipeline operation. + description: Response message for RunPipeline + id: GoogleCloudDatapipelinesV1RunPipelineResponse + type: object + GoogleCloudDatapipelinesV1LaunchTemplateParameters: + description: Parameters to provide to the template being launched. + type: object + properties: + jobName: + type: string + description: Required. The job name to use for the created job. + parameters: + additionalProperties: + type: string + type: object + description: The runtime parameters to pass to the job. + transformNameMapping: description: >- - Output only. Immutable. The timestamp when the pipeline was last - modified. Set by the Data Pipelines service. - scheduleInfo: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1ScheduleSpec' + 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. + type: object + additionalProperties: + type: string + update: + type: boolean 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. + 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. + id: GoogleCloudDatapipelinesV1LaunchTemplateParameters + GoogleCloudDatapipelinesV1SdkVersion: + id: GoogleCloudDatapipelinesV1SdkVersion + type: object + properties: + versionDisplayName: + description: A readable string describing the version of the SDK. + type: string + version: + description: The version of the SDK used to run the job. + type: string + 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. + description: The version of the SDK used to run the job. + GoogleCloudDatapipelinesV1StopPipelineRequest: + id: GoogleCloudDatapipelinesV1StopPipelineRequest + description: Request message for StopPipeline. + properties: {} + type: object + GoogleCloudDatapipelinesV1Pipeline: + properties: createTime: - readOnly: true + format: google-datetime type: string description: >- Output only. Immutable. The timestamp when the pipeline was initially created. Set by the Data Pipelines service. - format: google-datetime + readOnly: true + schedulerServiceAccountEmail: + type: string + 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. pipelineSources: + type: object + additionalProperties: + 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. - type: object - additionalProperties: - type: string - type: - 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. - type: string - enum: - - PIPELINE_TYPE_UNSPECIFIED - - PIPELINE_TYPE_BATCH - - PIPELINE_TYPE_STREAMING + jobCount: + type: integer + description: Output only. Number of jobs. + format: int32 + readOnly: true + name: 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. + 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. + type: string state: 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. enumDescriptions: - The pipeline state isn't specified. - >- @@ -148,438 +243,178 @@ 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. workload: - description: Workload information for creating new jobs. $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Workload' - description: >- - The main pipeline entity and all the necessary metadata for launching - and managing linked jobs. - id: GoogleCloudDatapipelinesV1Pipeline - type: object - GoogleCloudDatapipelinesV1RunPipelineResponse: - description: Response message for RunPipeline - type: object - properties: - job: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Job' - description: Job that was created as part of RunPipeline operation. - id: GoogleCloudDatapipelinesV1RunPipelineResponse - GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest: - description: A request to launch a Dataflow job from a Flex Template. - properties: - validateOnly: - type: boolean - description: >- - If true, the request is validated but not actually executed. - Defaults to false. - launchParameter: - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter - description: Required. Parameter to launch a job from a Flex Template. - location: - type: string + description: Workload information for creating new jobs. + scheduleInfo: + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1ScheduleSpec' 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`. - projectId: - description: >- - Required. The ID of the Cloud Platform project that the job belongs - to. - type: string - id: GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest - type: object - GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter: - description: Launch Flex Template parameter. - id: GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter - 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. - environment: - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment - description: The runtime environment for the Flex Template job. - parameters: - type: object - description: 'The parameters for the Flex Template. Example: `{"num_workers":"5"}`' - additionalProperties: - type: string - containerSpecGcsPath: - type: string - description: >- - Cloud Storage path to a file with a JSON-serialized ContainerSpec as - content. - transformNameMappings: - additionalProperties: - type: string - description: >- - Use this to pass transform name mappings for streaming update jobs. - Example: `{"oldTransformName":"newTransformName",...}` - type: object - update: - type: boolean - 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. - launchOptions: - additionalProperties: - 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. - type: object - GoogleCloudDatapipelinesV1ListJobsResponse: - description: Response message for ListJobs - type: object - id: GoogleCloudDatapipelinesV1ListJobsResponse - properties: - jobs: - type: array - description: >- - Results that were accessible to the caller. Results are always in - descending order of job creation date. - items: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Job' - 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. - GoogleCloudDatapipelinesV1RuntimeEnvironment: - type: object - properties: - 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" }. - enableStreamingEngine: - type: boolean - description: Whether to enable Streaming Engine for the job. - 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. - 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. - enum: - - WORKER_IP_UNSPECIFIED - - WORKER_IP_PUBLIC - - WORKER_IP_PRIVATE - tempLocation: - type: string - description: >- - The Cloud Storage path to use for temporary files. Must be a valid - Cloud Storage URL, beginning with `gs://`. - bypassTempDirValidation: - type: boolean - description: >- - Whether to bypass the safety checks for the job's temporary - directory. Use with caution. - numWorkers: - description: The initial number of Compute Engine instances for the job. - type: integer - format: int32 - network: - type: string - description: >- - Network to which VMs will be assigned. If empty or unspecified, the - service will use the network "default". - maxWorkers: - format: int32 - description: >- - The maximum number of Compute Engine instances to be made available - to your pipeline during execution, from 1 to 1000. - type: integer - 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. - serviceAccountEmail: - type: string - description: The email address of the service account to run the job as. - kmsKeyName: - type: string - description: >- - Name for the Cloud KMS key for the job. The key format is: - projects//locations//keyRings//cryptoKeys/ - machineType: - description: >- - The machine type to use for the job. Defaults to the value from the - template if not specified. - 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 - 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. - 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. + 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. + lastUpdateTime: type: string - id: GoogleCloudDatapipelinesV1RuntimeEnvironment - description: The environment values to set at runtime. - GoogleCloudDatapipelinesV1ListPipelinesResponse: - properties: - pipelines: - 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 - nextPageToken: + readOnly: true 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: Response message for ListPipelines. - id: GoogleCloudDatapipelinesV1ListPipelinesResponse - type: object - 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). - id: GoogleCloudDatapipelinesV1Job - type: object - properties: - endTime: + Output only. Immutable. The timestamp when the pipeline was last + modified. Set by the Data Pipelines service. format: google-datetime + displayName: description: >- - Output only. The time of job termination. This is absent if the job - is still running. - type: string - readOnly: true - createTime: - readOnly: true - description: Output only. The time of job creation. - format: google-datetime - type: string - state: - 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. + Required. The display name of the pipeline. It can contain only + letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores + (_). type: string + type: enum: - - STATE_UNSPECIFIED - - STATE_PENDING - - STATE_RUNNING - - STATE_DONE - - STATE_FAILED - - STATE_CANCELLED - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - Status capturing any error code or message related to job creation - or execution. - dataflowJobDetails: - description: All the details that are specific to a Dataflow job. - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1DataflowJobDetails' - id: - readOnly: true - description: Output only. The internal ID for the job. - type: string - name: - type: string - description: Required. The fully qualified resource name for the job. - GoogleCloudDatapipelinesV1LaunchTemplateRequest: - description: A request to launch a template. - type: object - 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. - 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: - description: >- - Required. The ID of the Cloud Platform project that the job belongs - to. - type: string - location: - type: string + - PIPELINE_TYPE_UNSPECIFIED + - PIPELINE_TYPE_BATCH + - PIPELINE_TYPE_STREAMING description: >- - The [regional endpoint] - (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) - to which to direct the request. - id: GoogleCloudDatapipelinesV1LaunchTemplateRequest - GoogleCloudDatapipelinesV1SdkVersion: - properties: - sdkSupportStatus: - type: string + 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: - - 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. + - The pipeline type isn't specified. - >- - This version of the SDK is deprecated and will eventually be - unsupported. + A batch pipeline. It runs jobs on a specific schedule, and each + job will automatically terminate once execution is finished. - >- - Support for this SDK version has ended and it should no longer be - used. - enum: - - UNKNOWN - - SUPPORTED - - STALE - - DEPRECATED - - UNSUPPORTED - description: The support status for this SDK version. - versionDisplayName: - description: A readable string describing the version of the SDK. - type: string - version: + 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. type: string - description: The version of the SDK used to run the job. - id: GoogleCloudDatapipelinesV1SdkVersion - type: object - description: The version of the SDK used to run the job. - GoogleCloudDatapipelinesV1StopPipelineRequest: - type: object - id: GoogleCloudDatapipelinesV1StopPipelineRequest - properties: {} - description: Request message for StopPipeline. - GoogleCloudDatapipelinesV1LaunchTemplateParameters: - id: GoogleCloudDatapipelinesV1LaunchTemplateParameters + description: >- + The main pipeline entity and all the necessary metadata for launching + and managing linked jobs. type: object - description: Parameters to provide to the template being launched. + id: GoogleCloudDatapipelinesV1Pipeline + GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter: + id: GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter + description: Launch Flex Template parameter. properties: + environment: + description: The runtime environment for the Flex Template job. + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment parameters: - description: The runtime parameters to pass to the job. type: object + description: 'The parameters for the Flex Template. Example: `{"num_workers":"5"}`' additionalProperties: type: string - update: + transformNameMappings: description: >- - If set, replace the existing pipeline with the name specified by - jobName with this pipeline, preserving state. + Use this to pass transform name mappings for streaming update jobs. + Example: `{"oldTransformName":"newTransformName",...}` + additionalProperties: + type: string + type: object + update: type: boolean - environment: - description: The runtime environment for the job. - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1RuntimeEnvironment' - jobName: - description: Required. The job name to use for the created job. - type: string - 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. - type: object + 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. + launchOptions: additionalProperties: type: string - GoogleCloudDatapipelinesV1DataflowJobDetails: + type: object + 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. + containerSpecGcsPath: + type: string + description: >- + Cloud Storage path to a file with a JSON-serialized ContainerSpec as + content. + jobName: + 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. + type: string + type: object + GoogleCloudDatapipelinesV1Workload: + properties: + dataflowLaunchTemplateRequest: + description: >- + Template information and additional parameters needed to launch a + Dataflow job using the standard launch API. + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1LaunchTemplateRequest' + dataflowFlexTemplateRequest: + description: >- + Template information and additional parameters needed to launch a + Dataflow job using the flex launch API. + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest + id: GoogleCloudDatapipelinesV1Workload + description: Workload details for creating the pipeline jobs. type: object + GoogleCloudDatapipelinesV1DataflowJobDetails: id: GoogleCloudDatapipelinesV1DataflowJobDetails + type: object properties: sdkVersion: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1SdkVersion' - readOnly: true description: Output only. The SDK version used to run the job. - resourceInfo: - type: object - additionalProperties: - format: double - type: number - 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. + 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. - readOnly: true type: integer + 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. + additionalProperties: + format: double + type: number + 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. - GoogleCloudDatapipelinesV1ScheduleSpec: + GoogleCloudDatapipelinesV1LaunchTemplateRequest: properties: - timeZone: + launchParameters: + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1LaunchTemplateParameters description: >- - Timezone ID. This matches the timezone IDs used by the Cloud - Scheduler API. If empty, UTC time is assumed. - type: string - schedule: + The parameters of the template to launch. This should be part of the + body of the POST request. + location: description: >- - Unix-cron format of the schedule. This information is retrieved from - the linked Cloud Scheduler. + The [regional endpoint] + (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) + to which to direct the request. type: string - nextJobTime: - description: Output only. When the next Scheduler job is going to run. + gcsPath: type: string - format: google-datetime - readOnly: true - description: Details of the schedule the pipeline runs on. + description: >- + A Cloud Storage path to the template from which to create the job. + Must be a valid Cloud Storage URL, beginning with 'gs://'. + projectId: + description: >- + Required. The ID of the Cloud Platform project that the job belongs + to. + type: string + validateOnly: + description: >- + If true, the request is validated but not actually executed. + Defaults to false. + type: boolean + description: A request to launch a template. + id: GoogleCloudDatapipelinesV1LaunchTemplateRequest type: object - id: GoogleCloudDatapipelinesV1ScheduleSpec 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 @@ -588,12 +423,7 @@ 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). - type: object properties: - code: - format: int32 - type: integer - description: The status code, which should be an enum value of google.rpc.Code. message: type: string description: >- @@ -601,6 +431,7 @@ components: 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. @@ -609,21 +440,136 @@ components: 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 + GoogleCloudDatapipelinesV1RuntimeEnvironment: + properties: + additionalExperiments: type: array - GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment: + description: Additional experiment flags for the job. + items: + type: string + serviceAccountEmail: + type: string + description: The email address of the service account to run the job as. + 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 + kmsKeyName: + type: string + description: >- + Name for the Cloud KMS key for the job. The key format is: + projects//locations//keyRings//cryptoKeys/ + 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: + format: int32 + description: >- + The maximum number of Compute Engine instances to be made available + to your pipeline during execution, from 1 to 1000. + type: integer + bypassTempDirValidation: + description: >- + Whether to bypass the safety checks for the job's temporary + directory. Use with caution. + type: boolean + enableStreamingEngine: + type: boolean + description: Whether to enable Streaming Engine for the job. + numWorkers: + type: integer + format: int32 + description: The initial number of Compute Engine instances for the job. + machineType: + type: string + description: >- + The machine type to use for the job. Defaults to the value from the + template if not specified. + 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, default to the control plane's region. + 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 + ipConfiguration: + description: Configuration for VM IPs. + enum: + - WORKER_IP_UNSPECIFIED + - WORKER_IP_PUBLIC + - WORKER_IP_PRIVATE + enumDescriptions: + - The configuration is unknown, or unspecified. + - Workers should have public IP addresses. + - Workers should have private IP addresses. + type: string + network: + description: >- + Network to which VMs will be assigned. If empty or unspecified, the + service will use the network "default". + type: string + 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. + description: The environment values to set at runtime. type: object + id: GoogleCloudDatapipelinesV1RuntimeEnvironment + GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment: id: GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment + type: object + description: The environment values to be set at runtime for a Flex Template. properties: - additionalUserLabels: + enableStreamingEngine: + type: boolean + description: Whether to enable Streaming Engine for the job. + serviceAccountEmail: + type: string + description: The email address of the service account to run the job as. + numWorkers: + description: The initial number of Compute Engine instances for the job. + format: int32 + type: integer + tempLocation: + 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" }`. - additionalProperties: - type: string - type: object + The Cloud Storage path to use for temporary files. Must be a valid + Cloud Storage URL, beginning with `gs://`. subnetwork: type: string description: >- @@ -633,6 +579,19 @@ 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. + flexrsGoal: + description: >- + Set FlexRS goal for the job. + https://cloud.google.com/dataflow/docs/guides/flexrs + enum: + - FLEXRS_UNSPECIFIED + - FLEXRS_SPEED_OPTIMIZED + - FLEXRS_COST_OPTIMIZED + enumDescriptions: + - Run in the default mode. + - Optimize for lower execution time. + - Optimize for lower cost. + type: string zone: type: string description: >- @@ -640,11 +599,28 @@ components: 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. - enableStreamingEngine: - type: boolean - description: Whether to enable Streaming Engine for the job. - workerZone: + ipConfiguration: + enum: + - WORKER_IP_UNSPECIFIED + - WORKER_IP_PUBLIC + - WORKER_IP_PRIVATE + enumDescriptions: + - 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. + kmsKeyName: + description: >- + Name for the Cloud KMS key for the job. Key format is: + projects//locations//keyRings//cryptoKeys/ type: string + machineType: + type: string + description: >- + The machine type to use for the job. Defaults to the value from the + template if not specified. + workerZone: description: >- The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) @@ -653,50 +629,28 @@ components: 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. - 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. - enum: - - WORKER_IP_UNSPECIFIED - - WORKER_IP_PUBLIC - - WORKER_IP_PRIVATE - numWorkers: - format: int32 - description: The initial number of Compute Engine instances for the job. - type: integer + additionalUserLabels: + type: object + 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" }`. + additionalProperties: + type: string maxWorkers: - type: integer 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. - flexrsGoal: - type: string - description: >- - Set FlexRS goal for the job. - https://cloud.google.com/dataflow/docs/guides/flexrs - enum: - - FLEXRS_UNSPECIFIED - - FLEXRS_SPEED_OPTIMIZED - - FLEXRS_COST_OPTIMIZED - enumDescriptions: - - Run in the default mode. - - Optimize for lower execution time. - - Optimize for lower cost. - additionalExperiments: - items: - type: string - type: array - description: Additional experiment flags for the job. - machineType: + network: type: string description: >- - The machine type to use for the job. Defaults to the value from the - template if not specified. + Network to which VMs will be assigned. If empty or unspecified, the + service will use the network "default". workerRegion: type: string description: >- @@ -705,75 +659,127 @@ components: 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. - tempLocation: + additionalExperiments: + description: Additional experiment flags for the job. + items: + type: string + type: array + GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest: + properties: + launchParameter: + description: Required. Parameter to launch a job from a Flex Template. + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter + location: type: string description: >- - The Cloud Storage path to use for temporary files. Must be a valid - Cloud Storage URL, beginning with `gs://`. - serviceAccountEmail: - type: string - description: The email address of the service account to run the job as. - network: + 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`. + validateOnly: description: >- - Network to which VMs will be assigned. If empty or unspecified, the - service will use the network "default". + If true, the request is validated but not actually executed. + Defaults to false. + type: boolean + projectId: + description: >- + Required. The ID of the Cloud Platform project that the job belongs + to. type: string - kmsKeyName: + id: GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest + description: A request to launch a Dataflow job from a Flex Template. + type: object + GoogleCloudDatapipelinesV1ScheduleSpec: + id: GoogleCloudDatapipelinesV1ScheduleSpec + properties: + timeZone: description: >- - Name for the Cloud KMS key for the job. Key format is: - projects//locations//keyRings//cryptoKeys/ + Timezone ID. This matches the timezone IDs used by the Cloud + Scheduler API. If empty, UTC time is assumed. type: string - description: The environment values to be set at runtime for a Flex Template. - GoogleCloudDatapipelinesV1RunPipelineRequest: + nextJobTime: + description: Output only. When the next Scheduler job is going to run. + type: string + format: google-datetime + readOnly: true + schedule: + type: string + description: >- + Unix-cron format of the schedule. This information is retrieved from + the linked Cloud Scheduler. + description: Details of the schedule the pipeline runs on. type: object - id: GoogleCloudDatapipelinesV1RunPipelineRequest - properties: {} - description: Request message for RunPipeline 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); } - id: GoogleProtobufEmpty - properties: {} + GoogleCloudDatapipelinesV1ListPipelinesResponse: type: object - GoogleCloudDatapipelinesV1Workload: - description: Workload details for creating the pipeline jobs. - id: GoogleCloudDatapipelinesV1Workload + id: GoogleCloudDatapipelinesV1ListPipelinesResponse properties: - dataflowLaunchTemplateRequest: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1LaunchTemplateRequest' + nextPageToken: + type: string description: >- - Template information and additional parameters needed to launch a - Dataflow job using the standard launch API. - dataflowFlexTemplateRequest: - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest + 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' + type: array description: >- - Template information and additional parameters needed to launch a - Dataflow job using the flex launch API. + Results that matched the filter criteria and were accessible to the + caller. Results are always in descending order of pipeline creation + date. + description: Response message for ListPipelines. + GoogleCloudDatapipelinesV1ListJobsResponse: + description: Response message for ListJobs + id: GoogleCloudDatapipelinesV1ListJobsResponse + 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: + 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. type: object parameters: - 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 - 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 - 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 + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType schema: type: string oauth_token: @@ -782,30 +788,36 @@ components: name: oauth_token schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. + 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: prettyPrint + name: quotaUser schema: - type: boolean + 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 - 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 @@ -816,41 +828,44 @@ components: - 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 - access, quota, and reports. Required unless you provide an OAuth 2.0 - token. + callback: + description: JSONP in: query - name: key + name: callback schema: type: string x-stackQL-resources: - pipelines: - id: datapipelines.pipelines - name: pipelines - title: Pipelines + jobs: + id: google.datapipelines.jobs + name: jobs + title: Jobs methods: - run: - operation: + _list: + operation: &ref_1 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}:run/post - response: + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}~1jobs/get + response: &ref_2 mediaType: application/json openAPIDocKey: '200' - delete: + objectKey: $.jobs + list: + operation: *ref_1 + response: *ref_2 + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/jobs/methods/list' + insert: [] + update: [] + delete: [] + pipelines: + id: google.datapipelines.pipelines + name: pipelines + title: Pipelines + methods: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -861,17 +876,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - patch: + delete: 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}/delete response: mediaType: application/json openAPIDocKey: '200' - stop: + run: 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}:run/post response: mediaType: application/json openAPIDocKey: '200' @@ -883,76 +898,52 @@ components: mediaType: application/json openAPIDocKey: '200' _list: - operation: &ref_1 + operation: &ref_3 $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines/get - response: &ref_2 + response: &ref_4 mediaType: application/json openAPIDocKey: '200' objectKey: $.pipelines list: - operation: *ref_1 - response: *ref_2 + operation: *ref_3 + response: *ref_4 + stop: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}:stop/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/pipelines/methods/get' - $ref: '#/components/x-stackQL-resources/pipelines/methods/list' insert: - $ref: '#/components/x-stackQL-resources/pipelines/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/pipelines/methods/delete' - jobs: - id: datapipelines.jobs - name: jobs - title: Jobs - methods: - _list: - operation: &ref_3 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}~1jobs/get - response: &ref_4 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.jobs - list: - operation: *ref_3 - response: *ref_4 - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/jobs/methods/list' - insert: [] - update: [] - delete: [] paths: - /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}:run: + /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}/jobs: parameters: &ref_5 - - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/key' - post: + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + 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 + 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 @@ -965,7 +956,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1RunPipelineResponse + #/components/schemas/GoogleCloudDatapipelinesV1ListJobsResponse parameters: - in: path name: projectsId @@ -982,13 +973,29 @@ 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}/pipelines/{pipelinesId}: parameters: *ref_5 - delete: + patch: description: >- - Deletes a pipeline. If a scheduler job is attached to the pipeline, it - will be deleted. - operationId: datapipelines.projects.locations.pipelines.delete + 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 @@ -1000,7 +1007,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' parameters: - in: path name: projectsId @@ -1017,6 +1024,11 @@ paths: required: true schema: type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask get: description: >- Looks up a single pipeline. Returns a "NOT_FOUND" error if no such @@ -1051,18 +1063,11 @@ paths: required: true schema: type: string - patch: + delete: 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' + 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 @@ -1074,7 +1079,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -1091,25 +1096,23 @@ paths: required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}:stop: + /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}:run: parameters: *ref_5 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 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/GoogleCloudDatapipelinesV1StopPipelineRequest + #/components/schemas/GoogleCloudDatapipelinesV1RunPipelineRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1121,7 +1124,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1RunPipelineResponse parameters: - in: path name: projectsId @@ -1204,6 +1208,10 @@ paths: required: true schema: type: string + - in: query + name: pageToken + schema: + type: string - in: query name: filter schema: @@ -1213,17 +1221,20 @@ paths: schema: type: integer format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}/jobs: + /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}:stop: parameters: *ref_5 - 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 @@ -1235,8 +1246,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1ListJobsResponse + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' parameters: - in: path name: projectsId @@ -1253,12 +1263,3 @@ paths: required: true 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/dataplex.yaml b/providers/src/googleapis.com/v00.00.00000/services/dataplex.yaml index b93ed2fc..d9577083 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: '20240523' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/dataplex/docs servers: @@ -5945,7 +5945,7 @@ components: - '2' x-stackQL-resources: locations: - id: dataplex.locations + id: google.dataplex.locations name: locations title: Locations methods: @@ -5981,15 +5981,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/locations/methods/projects_locations_list - $ref: >- #/components/x-stackQL-resources/locations/methods/projects_locations_get + - $ref: >- + #/components/x-stackQL-resources/locations/methods/projects_locations_list insert: [] update: [] delete: [] operations: - id: dataplex.operations + id: google.dataplex.operations name: operations title: Operations methods: @@ -6027,17 +6027,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list insert: [] update: [] delete: - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_delete entry_types: - id: dataplex.entry_types + id: google.dataplex.entry_types name: entry_types title: Entry_types methods: @@ -6082,19 +6082,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/entry_types/methods/projects_locations_entry_types_list - $ref: >- #/components/x-stackQL-resources/entry_types/methods/projects_locations_entry_types_get + - $ref: >- + #/components/x-stackQL-resources/entry_types/methods/projects_locations_entry_types_list insert: - $ref: >- #/components/x-stackQL-resources/entry_types/methods/projects_locations_entry_types_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/entry_types/methods/projects_locations_entry_types_patch delete: - $ref: >- #/components/x-stackQL-resources/entry_types/methods/projects_locations_entry_types_delete entry_types_iam_policies: - id: dataplex.entry_types_iam_policies + id: google.dataplex.entry_types_iam_policies name: entry_types_iam_policies title: Entry_types_iam_policies methods: @@ -6131,7 +6133,7 @@ components: update: [] delete: [] aspect_types: - id: dataplex.aspect_types + id: google.dataplex.aspect_types name: aspect_types title: Aspect_types methods: @@ -6176,19 +6178,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/aspect_types/methods/projects_locations_aspect_types_list - $ref: >- #/components/x-stackQL-resources/aspect_types/methods/projects_locations_aspect_types_get + - $ref: >- + #/components/x-stackQL-resources/aspect_types/methods/projects_locations_aspect_types_list insert: - $ref: >- #/components/x-stackQL-resources/aspect_types/methods/projects_locations_aspect_types_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/aspect_types/methods/projects_locations_aspect_types_patch delete: - $ref: >- #/components/x-stackQL-resources/aspect_types/methods/projects_locations_aspect_types_delete aspect_types_iam_policies: - id: dataplex.aspect_types_iam_policies + id: google.dataplex.aspect_types_iam_policies name: aspect_types_iam_policies title: Aspect_types_iam_policies methods: @@ -6225,7 +6229,7 @@ components: update: [] delete: [] entry_groups: - id: dataplex.entry_groups + id: google.dataplex.entry_groups name: entry_groups title: Entry_groups methods: @@ -6270,19 +6274,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/entry_groups/methods/projects_locations_entry_groups_list - $ref: >- #/components/x-stackQL-resources/entry_groups/methods/projects_locations_entry_groups_get + - $ref: >- + #/components/x-stackQL-resources/entry_groups/methods/projects_locations_entry_groups_list insert: - $ref: >- #/components/x-stackQL-resources/entry_groups/methods/projects_locations_entry_groups_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/entry_groups/methods/projects_locations_entry_groups_patch delete: - $ref: >- #/components/x-stackQL-resources/entry_groups/methods/projects_locations_entry_groups_delete entry_groups_iam_policies: - id: dataplex.entry_groups_iam_policies + id: google.dataplex.entry_groups_iam_policies name: entry_groups_iam_policies title: Entry_groups_iam_policies methods: @@ -6319,7 +6325,7 @@ components: update: [] delete: [] entries: - id: dataplex.entries + id: google.dataplex.entries name: entries title: Entries methods: @@ -6364,19 +6370,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/entries/methods/projects_locations_entry_groups_entries_list - $ref: >- #/components/x-stackQL-resources/entries/methods/projects_locations_entry_groups_entries_get + - $ref: >- + #/components/x-stackQL-resources/entries/methods/projects_locations_entry_groups_entries_list insert: - $ref: >- #/components/x-stackQL-resources/entries/methods/projects_locations_entry_groups_entries_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/entries/methods/projects_locations_entry_groups_entries_patch delete: - $ref: >- #/components/x-stackQL-resources/entries/methods/projects_locations_entry_groups_entries_delete lakes_iam_policies: - id: dataplex.lakes_iam_policies + id: google.dataplex.lakes_iam_policies name: lakes_iam_policies title: Lakes_iam_policies methods: @@ -6413,7 +6421,7 @@ components: update: [] delete: [] lakes: - id: dataplex.lakes + id: google.dataplex.lakes name: lakes title: Lakes methods: @@ -6458,19 +6466,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/lakes/methods/projects_locations_lakes_list - $ref: >- #/components/x-stackQL-resources/lakes/methods/projects_locations_lakes_get + - $ref: >- + #/components/x-stackQL-resources/lakes/methods/projects_locations_lakes_list insert: - $ref: >- #/components/x-stackQL-resources/lakes/methods/projects_locations_lakes_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/lakes/methods/projects_locations_lakes_patch delete: - $ref: >- #/components/x-stackQL-resources/lakes/methods/projects_locations_lakes_delete zones_iam_policies: - id: dataplex.zones_iam_policies + id: google.dataplex.zones_iam_policies name: zones_iam_policies title: Zones_iam_policies methods: @@ -6507,7 +6517,7 @@ components: update: [] delete: [] zones: - id: dataplex.zones + id: google.dataplex.zones name: zones title: Zones methods: @@ -6552,19 +6562,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/zones/methods/projects_locations_lakes_zones_list - $ref: >- #/components/x-stackQL-resources/zones/methods/projects_locations_lakes_zones_get + - $ref: >- + #/components/x-stackQL-resources/zones/methods/projects_locations_lakes_zones_list insert: - $ref: >- #/components/x-stackQL-resources/zones/methods/projects_locations_lakes_zones_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/zones/methods/projects_locations_lakes_zones_patch delete: - $ref: >- #/components/x-stackQL-resources/zones/methods/projects_locations_lakes_zones_delete assets_iam_policies: - id: dataplex.assets_iam_policies + id: google.dataplex.assets_iam_policies name: assets_iam_policies title: Assets_iam_policies methods: @@ -6601,7 +6613,7 @@ components: update: [] delete: [] assets: - id: dataplex.assets + id: google.dataplex.assets name: assets title: Assets methods: @@ -6646,19 +6658,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/assets/methods/projects_locations_lakes_zones_assets_list - $ref: >- #/components/x-stackQL-resources/assets/methods/projects_locations_lakes_zones_assets_get + - $ref: >- + #/components/x-stackQL-resources/assets/methods/projects_locations_lakes_zones_assets_list insert: - $ref: >- #/components/x-stackQL-resources/assets/methods/projects_locations_lakes_zones_assets_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/assets/methods/projects_locations_lakes_zones_assets_patch delete: - $ref: >- #/components/x-stackQL-resources/assets/methods/projects_locations_lakes_zones_assets_delete actions: - id: dataplex.actions + id: google.dataplex.actions name: actions title: Actions methods: @@ -6707,7 +6721,7 @@ components: update: [] delete: [] entities: - id: dataplex.entities + id: google.dataplex.entities name: entities title: Entities methods: @@ -6752,19 +6766,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/entities/methods/projects_locations_lakes_zones_entities_list - $ref: >- #/components/x-stackQL-resources/entities/methods/projects_locations_lakes_zones_entities_get + - $ref: >- + #/components/x-stackQL-resources/entities/methods/projects_locations_lakes_zones_entities_list insert: - $ref: >- #/components/x-stackQL-resources/entities/methods/projects_locations_lakes_zones_entities_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/entities/methods/projects_locations_lakes_zones_entities_update delete: - $ref: >- #/components/x-stackQL-resources/entities/methods/projects_locations_lakes_zones_entities_delete partitions: - id: dataplex.partitions + id: google.dataplex.partitions name: partitions title: Partitions methods: @@ -6802,10 +6818,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/partitions/methods/projects_locations_lakes_zones_entities_partitions_list - $ref: >- #/components/x-stackQL-resources/partitions/methods/projects_locations_lakes_zones_entities_partitions_get + - $ref: >- + #/components/x-stackQL-resources/partitions/methods/projects_locations_lakes_zones_entities_partitions_list insert: - $ref: >- #/components/x-stackQL-resources/partitions/methods/projects_locations_lakes_zones_entities_partitions_create @@ -6814,7 +6830,7 @@ components: - $ref: >- #/components/x-stackQL-resources/partitions/methods/projects_locations_lakes_zones_entities_partitions_delete tasks_iam_policies: - id: dataplex.tasks_iam_policies + id: google.dataplex.tasks_iam_policies name: tasks_iam_policies title: Tasks_iam_policies methods: @@ -6851,7 +6867,7 @@ components: update: [] delete: [] tasks: - id: dataplex.tasks + id: google.dataplex.tasks name: tasks title: Tasks methods: @@ -6903,19 +6919,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/tasks/methods/projects_locations_lakes_tasks_list - $ref: >- #/components/x-stackQL-resources/tasks/methods/projects_locations_lakes_tasks_get + - $ref: >- + #/components/x-stackQL-resources/tasks/methods/projects_locations_lakes_tasks_list insert: - $ref: >- #/components/x-stackQL-resources/tasks/methods/projects_locations_lakes_tasks_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/tasks/methods/projects_locations_lakes_tasks_patch delete: - $ref: >- #/components/x-stackQL-resources/tasks/methods/projects_locations_lakes_tasks_delete jobs: - id: dataplex.jobs + id: google.dataplex.jobs name: jobs title: Jobs methods: @@ -6971,10 +6989,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/jobs/methods/projects_locations_lakes_tasks_jobs_list - $ref: >- #/components/x-stackQL-resources/jobs/methods/projects_locations_lakes_tasks_jobs_get + - $ref: >- + #/components/x-stackQL-resources/jobs/methods/projects_locations_lakes_tasks_jobs_list - $ref: >- #/components/x-stackQL-resources/jobs/methods/projects_locations_data_scans_jobs_get - $ref: >- @@ -6983,7 +7001,7 @@ components: update: [] delete: [] environments_iam_policies: - id: dataplex.environments_iam_policies + id: google.dataplex.environments_iam_policies name: environments_iam_policies title: Environments_iam_policies methods: @@ -7020,7 +7038,7 @@ components: update: [] delete: [] environments: - id: dataplex.environments + id: google.dataplex.environments name: environments title: Environments methods: @@ -7065,19 +7083,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/environments/methods/projects_locations_lakes_environments_list - $ref: >- #/components/x-stackQL-resources/environments/methods/projects_locations_lakes_environments_get + - $ref: >- + #/components/x-stackQL-resources/environments/methods/projects_locations_lakes_environments_list insert: - $ref: >- #/components/x-stackQL-resources/environments/methods/projects_locations_lakes_environments_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/environments/methods/projects_locations_lakes_environments_patch delete: - $ref: >- #/components/x-stackQL-resources/environments/methods/projects_locations_lakes_environments_delete sessions: - id: dataplex.sessions + id: google.dataplex.sessions name: sessions title: Sessions methods: @@ -7100,7 +7120,7 @@ components: update: [] delete: [] contentitems: - id: dataplex.contentitems + id: google.dataplex.contentitems name: contentitems title: Contentitems methods: @@ -7145,19 +7165,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/contentitems/methods/projects_locations_lakes_contentitems_list - $ref: >- #/components/x-stackQL-resources/contentitems/methods/projects_locations_lakes_contentitems_get + - $ref: >- + #/components/x-stackQL-resources/contentitems/methods/projects_locations_lakes_contentitems_list insert: - $ref: >- #/components/x-stackQL-resources/contentitems/methods/projects_locations_lakes_contentitems_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/contentitems/methods/projects_locations_lakes_contentitems_patch delete: - $ref: >- #/components/x-stackQL-resources/contentitems/methods/projects_locations_lakes_contentitems_delete contentitems_iam_policies: - id: dataplex.contentitems_iam_policies + id: google.dataplex.contentitems_iam_policies name: contentitems_iam_policies title: Contentitems_iam_policies methods: @@ -7194,7 +7216,7 @@ components: update: [] delete: [] content: - id: dataplex.content + id: google.dataplex.content name: content title: Content methods: @@ -7239,19 +7261,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/content/methods/projects_locations_lakes_content_list - $ref: >- #/components/x-stackQL-resources/content/methods/projects_locations_lakes_content_get + - $ref: >- + #/components/x-stackQL-resources/content/methods/projects_locations_lakes_content_list insert: - $ref: >- #/components/x-stackQL-resources/content/methods/projects_locations_lakes_content_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/content/methods/projects_locations_lakes_content_patch delete: - $ref: >- #/components/x-stackQL-resources/content/methods/projects_locations_lakes_content_delete content_iam_policies: - id: dataplex.content_iam_policies + id: google.dataplex.content_iam_policies name: content_iam_policies title: Content_iam_policies methods: @@ -7288,7 +7312,7 @@ components: update: [] delete: [] data_scans_iam_policies: - id: dataplex.data_scans_iam_policies + id: google.dataplex.data_scans_iam_policies name: data_scans_iam_policies title: Data_scans_iam_policies methods: @@ -7325,7 +7349,7 @@ components: update: [] delete: [] data_scans: - id: dataplex.data_scans + id: google.dataplex.data_scans name: data_scans title: Data_scans methods: @@ -7384,19 +7408,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/data_scans/methods/projects_locations_data_scans_list - $ref: >- #/components/x-stackQL-resources/data_scans/methods/projects_locations_data_scans_get + - $ref: >- + #/components/x-stackQL-resources/data_scans/methods/projects_locations_data_scans_list insert: - $ref: >- #/components/x-stackQL-resources/data_scans/methods/projects_locations_data_scans_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/data_scans/methods/projects_locations_data_scans_patch delete: - $ref: >- #/components/x-stackQL-resources/data_scans/methods/projects_locations_data_scans_delete data_taxonomies_iam_policies: - id: dataplex.data_taxonomies_iam_policies + id: google.dataplex.data_taxonomies_iam_policies name: data_taxonomies_iam_policies title: Data_taxonomies_iam_policies methods: @@ -7433,7 +7459,7 @@ components: update: [] delete: [] data_taxonomies: - id: dataplex.data_taxonomies + id: google.dataplex.data_taxonomies name: data_taxonomies title: Data_taxonomies methods: @@ -7478,19 +7504,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/data_taxonomies/methods/projects_locations_data_taxonomies_list - $ref: >- #/components/x-stackQL-resources/data_taxonomies/methods/projects_locations_data_taxonomies_get + - $ref: >- + #/components/x-stackQL-resources/data_taxonomies/methods/projects_locations_data_taxonomies_list insert: - $ref: >- #/components/x-stackQL-resources/data_taxonomies/methods/projects_locations_data_taxonomies_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/data_taxonomies/methods/projects_locations_data_taxonomies_patch delete: - $ref: >- #/components/x-stackQL-resources/data_taxonomies/methods/projects_locations_data_taxonomies_delete attributes_iam_policies: - id: dataplex.attributes_iam_policies + id: google.dataplex.attributes_iam_policies name: attributes_iam_policies title: Attributes_iam_policies methods: @@ -7527,7 +7555,7 @@ components: update: [] delete: [] attributes: - id: dataplex.attributes + id: google.dataplex.attributes name: attributes title: Attributes methods: @@ -7572,19 +7600,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/attributes/methods/projects_locations_data_taxonomies_attributes_list - $ref: >- #/components/x-stackQL-resources/attributes/methods/projects_locations_data_taxonomies_attributes_get + - $ref: >- + #/components/x-stackQL-resources/attributes/methods/projects_locations_data_taxonomies_attributes_list insert: - $ref: >- #/components/x-stackQL-resources/attributes/methods/projects_locations_data_taxonomies_attributes_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/attributes/methods/projects_locations_data_taxonomies_attributes_patch delete: - $ref: >- #/components/x-stackQL-resources/attributes/methods/projects_locations_data_taxonomies_attributes_delete data_attribute_bindings_iam_policies: - id: dataplex.data_attribute_bindings_iam_policies + id: google.dataplex.data_attribute_bindings_iam_policies name: data_attribute_bindings_iam_policies title: Data_attribute_bindings_iam_policies methods: @@ -7621,7 +7651,7 @@ components: update: [] delete: [] data_attribute_bindings: - id: dataplex.data_attribute_bindings + id: google.dataplex.data_attribute_bindings name: data_attribute_bindings title: Data_attribute_bindings methods: @@ -7666,19 +7696,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/data_attribute_bindings/methods/projects_locations_data_attribute_bindings_list - $ref: >- #/components/x-stackQL-resources/data_attribute_bindings/methods/projects_locations_data_attribute_bindings_get + - $ref: >- + #/components/x-stackQL-resources/data_attribute_bindings/methods/projects_locations_data_attribute_bindings_list insert: - $ref: >- #/components/x-stackQL-resources/data_attribute_bindings/methods/projects_locations_data_attribute_bindings_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/data_attribute_bindings/methods/projects_locations_data_attribute_bindings_patch delete: - $ref: >- #/components/x-stackQL-resources/data_attribute_bindings/methods/projects_locations_data_attribute_bindings_delete governance_rules_iam_policies: - id: dataplex.governance_rules_iam_policies + id: google.dataplex.governance_rules_iam_policies name: governance_rules_iam_policies title: Governance_rules_iam_policies methods: 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 1d32a01e..b42b6bae 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: '20240525' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/dataproc/ servers: @@ -5235,7 +5235,7 @@ components: - '2' x-stackQL-resources: operations: - id: dataproc.operations + id: google.dataproc.operations name: operations title: Operations methods: @@ -5305,14 +5305,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_regions_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_regions_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_regions_operations_list + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list insert: [] update: [] delete: @@ -5321,7 +5321,7 @@ components: - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_delete operations_iam_policies: - id: dataproc.operations_iam_policies + id: google.dataproc.operations_iam_policies name: operations_iam_policies title: Operations_iam_policies methods: @@ -5358,7 +5358,7 @@ components: update: [] delete: [] autoscaling_policies: - id: dataproc.autoscaling_policies + id: google.dataproc.autoscaling_policies name: autoscaling_policies title: Autoscaling_policies methods: @@ -5442,27 +5442,31 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/autoscaling_policies/methods/projects_regions_autoscaling_policies_list - $ref: >- #/components/x-stackQL-resources/autoscaling_policies/methods/projects_regions_autoscaling_policies_get - - $ref: >- - #/components/x-stackQL-resources/autoscaling_policies/methods/projects_locations_autoscaling_policies_list - $ref: >- #/components/x-stackQL-resources/autoscaling_policies/methods/projects_locations_autoscaling_policies_get + - $ref: >- + #/components/x-stackQL-resources/autoscaling_policies/methods/projects_regions_autoscaling_policies_list + - $ref: >- + #/components/x-stackQL-resources/autoscaling_policies/methods/projects_locations_autoscaling_policies_list insert: - $ref: >- #/components/x-stackQL-resources/autoscaling_policies/methods/projects_regions_autoscaling_policies_create - $ref: >- #/components/x-stackQL-resources/autoscaling_policies/methods/projects_locations_autoscaling_policies_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/autoscaling_policies/methods/projects_regions_autoscaling_policies_update + - $ref: >- + #/components/x-stackQL-resources/autoscaling_policies/methods/projects_locations_autoscaling_policies_update delete: - $ref: >- #/components/x-stackQL-resources/autoscaling_policies/methods/projects_regions_autoscaling_policies_delete - $ref: >- #/components/x-stackQL-resources/autoscaling_policies/methods/projects_locations_autoscaling_policies_delete autoscaling_policies_iam_policies: - id: dataproc.autoscaling_policies_iam_policies + id: google.dataproc.autoscaling_policies_iam_policies name: autoscaling_policies_iam_policies title: Autoscaling_policies_iam_policies methods: @@ -5526,7 +5530,7 @@ components: update: [] delete: [] clusters: - id: dataproc.clusters + id: google.dataproc.clusters name: clusters title: Clusters methods: @@ -5606,19 +5610,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/clusters/methods/projects_regions_clusters_list - $ref: >- #/components/x-stackQL-resources/clusters/methods/projects_regions_clusters_get + - $ref: >- + #/components/x-stackQL-resources/clusters/methods/projects_regions_clusters_list insert: - $ref: >- #/components/x-stackQL-resources/clusters/methods/projects_regions_clusters_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/clusters/methods/projects_regions_clusters_patch delete: - $ref: >- #/components/x-stackQL-resources/clusters/methods/projects_regions_clusters_delete clusters_iam_policies: - id: dataproc.clusters_iam_policies + id: google.dataproc.clusters_iam_policies name: clusters_iam_policies title: Clusters_iam_policies methods: @@ -5655,7 +5661,7 @@ components: update: [] delete: [] node_groups: - id: dataproc.node_groups + id: google.dataproc.node_groups name: node_groups title: Node_groups methods: @@ -5697,7 +5703,7 @@ components: update: [] delete: [] jobs: - id: dataproc.jobs + id: google.dataproc.jobs name: jobs title: Jobs methods: @@ -5760,12 +5766,14 @@ components: - $ref: >- #/components/x-stackQL-resources/jobs/methods/projects_regions_jobs_list insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/jobs/methods/projects_regions_jobs_patch delete: - $ref: >- #/components/x-stackQL-resources/jobs/methods/projects_regions_jobs_delete jobs_iam_policies: - id: dataproc.jobs_iam_policies + id: google.dataproc.jobs_iam_policies name: jobs_iam_policies title: Jobs_iam_policies methods: @@ -5802,7 +5810,7 @@ components: update: [] delete: [] workflow_templates: - id: dataproc.workflow_templates + id: google.dataproc.workflow_templates name: workflow_templates title: Workflow_templates methods: @@ -5914,27 +5922,31 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/workflow_templates/methods/projects_regions_workflow_templates_list - $ref: >- #/components/x-stackQL-resources/workflow_templates/methods/projects_regions_workflow_templates_get - - $ref: >- - #/components/x-stackQL-resources/workflow_templates/methods/projects_locations_workflow_templates_list - $ref: >- #/components/x-stackQL-resources/workflow_templates/methods/projects_locations_workflow_templates_get + - $ref: >- + #/components/x-stackQL-resources/workflow_templates/methods/projects_regions_workflow_templates_list + - $ref: >- + #/components/x-stackQL-resources/workflow_templates/methods/projects_locations_workflow_templates_list insert: - $ref: >- #/components/x-stackQL-resources/workflow_templates/methods/projects_regions_workflow_templates_create - $ref: >- #/components/x-stackQL-resources/workflow_templates/methods/projects_locations_workflow_templates_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/workflow_templates/methods/projects_regions_workflow_templates_update + - $ref: >- + #/components/x-stackQL-resources/workflow_templates/methods/projects_locations_workflow_templates_update delete: - $ref: >- #/components/x-stackQL-resources/workflow_templates/methods/projects_regions_workflow_templates_delete - $ref: >- #/components/x-stackQL-resources/workflow_templates/methods/projects_locations_workflow_templates_delete workflow_templates_iam_policies: - id: dataproc.workflow_templates_iam_policies + id: google.dataproc.workflow_templates_iam_policies name: workflow_templates_iam_policies title: Workflow_templates_iam_policies methods: @@ -5998,7 +6010,7 @@ components: update: [] delete: [] batches: - id: dataproc.batches + id: google.dataproc.batches name: batches title: Batches methods: @@ -6043,10 +6055,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/batches/methods/projects_locations_batches_list - $ref: >- #/components/x-stackQL-resources/batches/methods/projects_locations_batches_get + - $ref: >- + #/components/x-stackQL-resources/batches/methods/projects_locations_batches_list insert: - $ref: >- #/components/x-stackQL-resources/batches/methods/projects_locations_batches_create @@ -6055,7 +6067,7 @@ components: - $ref: >- #/components/x-stackQL-resources/batches/methods/projects_locations_batches_delete sessions: - id: dataproc.sessions + id: google.dataproc.sessions name: sessions title: Sessions methods: @@ -6100,10 +6112,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_sessions_list - $ref: >- #/components/x-stackQL-resources/sessions/methods/projects_locations_sessions_get + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_sessions_list insert: - $ref: >- #/components/x-stackQL-resources/sessions/methods/projects_locations_sessions_create @@ -6112,7 +6124,7 @@ components: - $ref: >- #/components/x-stackQL-resources/sessions/methods/projects_locations_sessions_delete session_templates: - id: dataproc.session_templates + id: google.dataproc.session_templates name: session_templates title: Session_templates methods: @@ -6157,14 +6169,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/session_templates/methods/projects_locations_session_templates_list - $ref: >- #/components/x-stackQL-resources/session_templates/methods/projects_locations_session_templates_get + - $ref: >- + #/components/x-stackQL-resources/session_templates/methods/projects_locations_session_templates_list insert: - $ref: >- #/components/x-stackQL-resources/session_templates/methods/projects_locations_session_templates_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/session_templates/methods/projects_locations_session_templates_patch delete: - $ref: >- #/components/x-stackQL-resources/session_templates/methods/projects_locations_session_templates_delete 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 98d8c6c2..cad6dfef 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/datastore.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/datastore.yaml @@ -10,7 +10,7 @@ info: scalable storage for your application. version: v1 x-discovery-doc-revision: '20240521' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/datastore/ servers: @@ -2243,7 +2243,7 @@ components: - '2' x-stackQL-resources: projects: - id: datastore.projects + id: google.datastore.projects name: projects title: Projects methods: @@ -2313,7 +2313,7 @@ components: update: [] delete: [] operations: - id: datastore.operations + id: google.datastore.operations name: operations title: Operations methods: @@ -2350,14 +2350,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' indexes: - id: datastore.indexes + id: google.datastore.indexes name: indexes title: Indexes methods: @@ -2391,8 +2391,8 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/indexes/methods/list' - $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: [] 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 4463c64b..9c3a6b2c 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: '20240515' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/datastream/ servers: @@ -1934,7 +1934,7 @@ components: - '2' x-stackQL-resources: static_ips: - id: datastream.static_ips + id: google.datastream.static_ips name: static_ips title: Static_ips methods: @@ -1951,7 +1951,7 @@ components: update: [] delete: [] locations: - id: datastream.locations + id: google.datastream.locations name: locations title: Locations methods: @@ -1973,13 +1973,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: datastream.operations + id: google.datastream.operations name: operations title: Operations methods: @@ -2017,14 +2017,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' connection_profiles: - id: datastream.connection_profiles + id: google.datastream.connection_profiles name: connection_profiles title: Connection_profiles methods: @@ -2076,17 +2076,18 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/connection_profiles/methods/list' - $ref: '#/components/x-stackQL-resources/connection_profiles/methods/get' + - $ref: '#/components/x-stackQL-resources/connection_profiles/methods/list' insert: - $ref: >- #/components/x-stackQL-resources/connection_profiles/methods/create - update: [] + update: + - $ref: '#/components/x-stackQL-resources/connection_profiles/methods/patch' delete: - $ref: >- #/components/x-stackQL-resources/connection_profiles/methods/delete streams: - id: datastream.streams + id: google.datastream.streams name: streams title: Streams methods: @@ -2138,15 +2139,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/streams/methods/list' - $ref: '#/components/x-stackQL-resources/streams/methods/get' + - $ref: '#/components/x-stackQL-resources/streams/methods/list' insert: - $ref: '#/components/x-stackQL-resources/streams/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/streams/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/streams/methods/delete' objects: - id: datastream.objects + id: google.datastream.objects name: objects title: Objects methods: @@ -2197,7 +2199,7 @@ components: update: [] delete: [] private_connections: - id: datastream.private_connections + id: google.datastream.private_connections name: private_connections title: Private_connections methods: @@ -2235,8 +2237,8 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/private_connections/methods/list' - $ref: '#/components/x-stackQL-resources/private_connections/methods/get' + - $ref: '#/components/x-stackQL-resources/private_connections/methods/list' insert: - $ref: >- #/components/x-stackQL-resources/private_connections/methods/create @@ -2245,7 +2247,7 @@ components: - $ref: >- #/components/x-stackQL-resources/private_connections/methods/delete routes: - id: datastream.routes + id: google.datastream.routes name: routes title: Routes methods: @@ -2283,8 +2285,8 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/routes/methods/list' - $ref: '#/components/x-stackQL-resources/routes/methods/get' + - $ref: '#/components/x-stackQL-resources/routes/methods/list' insert: - $ref: '#/components/x-stackQL-resources/routes/methods/create' update: [] 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 23142e92..d1b1cf1f 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-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/deployment-manager servers: @@ -1745,7 +1745,7 @@ components: - '2' x-stackQL-resources: deployments: - id: deploymentmanager.deployments + id: google.deploymentmanager.deployments name: deployments title: Deployments methods: @@ -1811,15 +1811,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/deployments/methods/list' - $ref: '#/components/x-stackQL-resources/deployments/methods/get' + - $ref: '#/components/x-stackQL-resources/deployments/methods/list' insert: - $ref: '#/components/x-stackQL-resources/deployments/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/deployments/methods/update' + - $ref: '#/components/x-stackQL-resources/deployments/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/deployments/methods/delete' deployments_iam_policies: - id: deploymentmanager.deployments_iam_policies + id: google.deploymentmanager.deployments_iam_policies name: deployments_iam_policies title: Deployments_iam_policies methods: @@ -1856,7 +1858,7 @@ components: update: [] delete: [] manifests: - id: deploymentmanager.manifests + id: google.deploymentmanager.manifests name: manifests title: Manifests methods: @@ -1886,7 +1888,7 @@ components: update: [] delete: [] operations: - id: deploymentmanager.operations + id: google.deploymentmanager.operations name: operations title: Operations methods: @@ -1916,7 +1918,7 @@ components: update: [] delete: [] resources: - id: deploymentmanager.resources + id: google.deploymentmanager.resources name: resources title: Resources methods: @@ -1946,7 +1948,7 @@ components: update: [] delete: [] types: - id: deploymentmanager.types + id: google.deploymentmanager.types name: types title: Types methods: 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 4f00f053..0c8449b2 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/developerconnect.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/developerconnect.yaml @@ -8,7 +8,7 @@ info: description: Connect third-party source code management to Google version: v1 x-discovery-doc-revision: '20240527' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: http://cloud.google.com/developer-connect/docs/overview servers: @@ -677,7 +677,7 @@ components: - '2' x-stackQL-resources: locations: - id: developerconnect.locations + id: google.developerconnect.locations name: locations title: Locations methods: @@ -699,13 +699,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: developerconnect.operations + id: google.developerconnect.operations name: operations title: Operations methods: @@ -743,14 +743,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' connections: - id: developerconnect.connections + id: google.developerconnect.connections name: connections title: Connections methods: @@ -795,15 +795,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/connections/methods/list' - $ref: '#/components/x-stackQL-resources/connections/methods/get' + - $ref: '#/components/x-stackQL-resources/connections/methods/list' insert: - $ref: '#/components/x-stackQL-resources/connections/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/connections/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/connections/methods/delete' connections_linkable_git_repositories: - id: developerconnect.connections_linkable_git_repositories + id: google.developerconnect.connections_linkable_git_repositories name: connections_linkable_git_repositories title: Connections_linkable_git_repositories methods: @@ -820,7 +821,7 @@ components: update: [] delete: [] connections_github_installations: - id: developerconnect.connections_github_installations + id: google.developerconnect.connections_github_installations name: connections_github_installations title: Connections_github_installations methods: @@ -837,7 +838,7 @@ components: update: [] delete: [] git_repository_links: - id: developerconnect.git_repository_links + id: google.developerconnect.git_repository_links name: git_repository_links title: Git_repository_links methods: @@ -875,8 +876,8 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/git_repository_links/methods/list' - $ref: '#/components/x-stackQL-resources/git_repository_links/methods/get' + - $ref: '#/components/x-stackQL-resources/git_repository_links/methods/list' insert: - $ref: >- #/components/x-stackQL-resources/git_repository_links/methods/create @@ -885,7 +886,7 @@ components: - $ref: >- #/components/x-stackQL-resources/git_repository_links/methods/delete git_repository_links_read_write_token: - id: developerconnect.git_repository_links_read_write_token + id: google.developerconnect.git_repository_links_read_write_token name: git_repository_links_read_write_token title: Git_repository_links_read_write_token methods: @@ -902,7 +903,7 @@ components: update: [] delete: [] git_repository_links_read_token: - id: developerconnect.git_repository_links_read_token + id: google.developerconnect.git_repository_links_read_token name: git_repository_links_read_token title: Git_repository_links_read_token methods: @@ -919,7 +920,7 @@ components: update: [] delete: [] git_repository_links_git_refs: - id: developerconnect.git_repository_links_git_refs + id: google.developerconnect.git_repository_links_git_refs name: git_repository_links_git_refs title: Git_repository_links_git_refs methods: 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 f8b441ab..b35ba09a 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/dialogflow.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/dialogflow.yaml @@ -10,7 +10,7 @@ info: apps and devices). version: v3 x-discovery-doc-revision: '20240523' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/dialogflow/ servers: @@ -14228,7 +14228,7 @@ components: - '2' x-stackQL-resources: operations: - id: dialogflow.operations + id: google.dialogflow.operations name: operations title: Operations methods: @@ -14284,18 +14284,18 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_operations_list + #/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_locations_operations_get + #/components/x-stackQL-resources/operations/methods/projects_operations_list insert: [] update: [] delete: [] locations: - id: dialogflow.locations + id: google.dialogflow.locations name: locations title: Locations methods: @@ -14317,15 +14317,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/locations/methods/projects_locations_list - $ref: >- #/components/x-stackQL-resources/locations/methods/projects_locations_get + - $ref: >- + #/components/x-stackQL-resources/locations/methods/projects_locations_list insert: [] update: [] delete: [] security_settings: - id: dialogflow.security_settings + id: google.dialogflow.security_settings name: security_settings title: Security_settings methods: @@ -14370,19 +14370,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/security_settings/methods/projects_locations_security_settings_list - $ref: >- #/components/x-stackQL-resources/security_settings/methods/projects_locations_security_settings_get + - $ref: >- + #/components/x-stackQL-resources/security_settings/methods/projects_locations_security_settings_list insert: - $ref: >- #/components/x-stackQL-resources/security_settings/methods/projects_locations_security_settings_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/security_settings/methods/projects_locations_security_settings_patch delete: - $ref: >- #/components/x-stackQL-resources/security_settings/methods/projects_locations_security_settings_delete agents: - id: dialogflow.agents + id: google.dialogflow.agents name: agents title: Agents methods: @@ -14448,19 +14450,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/agents/methods/projects_locations_agents_list - $ref: >- #/components/x-stackQL-resources/agents/methods/projects_locations_agents_get + - $ref: >- + #/components/x-stackQL-resources/agents/methods/projects_locations_agents_list insert: - $ref: >- #/components/x-stackQL-resources/agents/methods/projects_locations_agents_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/agents/methods/projects_locations_agents_patch delete: - $ref: >- #/components/x-stackQL-resources/agents/methods/projects_locations_agents_delete agents_validation_result: - id: dialogflow.agents_validation_result + id: google.dialogflow.agents_validation_result name: agents_validation_result title: Agents_validation_result methods: @@ -14479,7 +14483,7 @@ components: update: [] delete: [] agents_generative_settings: - id: dialogflow.agents_generative_settings + id: google.dialogflow.agents_generative_settings name: agents_generative_settings title: Agents_generative_settings methods: @@ -14505,7 +14509,7 @@ components: update: [] delete: [] flows: - id: dialogflow.flows + id: google.dialogflow.flows name: flows title: Flows methods: @@ -14578,19 +14582,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/flows/methods/projects_locations_agents_flows_list - $ref: >- #/components/x-stackQL-resources/flows/methods/projects_locations_agents_flows_get + - $ref: >- + #/components/x-stackQL-resources/flows/methods/projects_locations_agents_flows_list insert: - $ref: >- #/components/x-stackQL-resources/flows/methods/projects_locations_agents_flows_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/flows/methods/projects_locations_agents_flows_patch delete: - $ref: >- #/components/x-stackQL-resources/flows/methods/projects_locations_agents_flows_delete flows_validation_result: - id: dialogflow.flows_validation_result + id: google.dialogflow.flows_validation_result name: flows_validation_result title: Flows_validation_result methods: @@ -14609,7 +14615,7 @@ components: update: [] delete: [] pages: - id: dialogflow.pages + id: google.dialogflow.pages name: pages title: Pages methods: @@ -14654,19 +14660,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/pages/methods/projects_locations_agents_flows_pages_list - $ref: >- #/components/x-stackQL-resources/pages/methods/projects_locations_agents_flows_pages_get + - $ref: >- + #/components/x-stackQL-resources/pages/methods/projects_locations_agents_flows_pages_list insert: - $ref: >- #/components/x-stackQL-resources/pages/methods/projects_locations_agents_flows_pages_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/pages/methods/projects_locations_agents_flows_pages_patch delete: - $ref: >- #/components/x-stackQL-resources/pages/methods/projects_locations_agents_flows_pages_delete transition_route_groups: - id: dialogflow.transition_route_groups + id: google.dialogflow.transition_route_groups name: transition_route_groups title: Transition_route_groups methods: @@ -14750,27 +14758,31 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/transition_route_groups/methods/projects_locations_agents_flows_transition_route_groups_list - $ref: >- #/components/x-stackQL-resources/transition_route_groups/methods/projects_locations_agents_flows_transition_route_groups_get - $ref: >- - #/components/x-stackQL-resources/transition_route_groups/methods/projects_locations_agents_transition_route_groups_list + #/components/x-stackQL-resources/transition_route_groups/methods/projects_locations_agents_flows_transition_route_groups_list - $ref: >- #/components/x-stackQL-resources/transition_route_groups/methods/projects_locations_agents_transition_route_groups_get + - $ref: >- + #/components/x-stackQL-resources/transition_route_groups/methods/projects_locations_agents_transition_route_groups_list insert: - $ref: >- #/components/x-stackQL-resources/transition_route_groups/methods/projects_locations_agents_flows_transition_route_groups_create - $ref: >- #/components/x-stackQL-resources/transition_route_groups/methods/projects_locations_agents_transition_route_groups_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/transition_route_groups/methods/projects_locations_agents_flows_transition_route_groups_patch + - $ref: >- + #/components/x-stackQL-resources/transition_route_groups/methods/projects_locations_agents_transition_route_groups_patch delete: - $ref: >- #/components/x-stackQL-resources/transition_route_groups/methods/projects_locations_agents_flows_transition_route_groups_delete - $ref: >- #/components/x-stackQL-resources/transition_route_groups/methods/projects_locations_agents_transition_route_groups_delete versions: - id: dialogflow.versions + id: google.dialogflow.versions name: versions title: Versions methods: @@ -14829,19 +14841,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_agents_flows_versions_list - $ref: >- #/components/x-stackQL-resources/versions/methods/projects_locations_agents_flows_versions_get + - $ref: >- + #/components/x-stackQL-resources/versions/methods/projects_locations_agents_flows_versions_list insert: - $ref: >- #/components/x-stackQL-resources/versions/methods/projects_locations_agents_flows_versions_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/versions/methods/projects_locations_agents_flows_versions_patch delete: - $ref: >- #/components/x-stackQL-resources/versions/methods/projects_locations_agents_flows_versions_delete changelogs: - id: dialogflow.changelogs + id: google.dialogflow.changelogs name: changelogs title: Changelogs methods: @@ -14865,15 +14879,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/changelogs/methods/projects_locations_agents_changelogs_list - $ref: >- #/components/x-stackQL-resources/changelogs/methods/projects_locations_agents_changelogs_get + - $ref: >- + #/components/x-stackQL-resources/changelogs/methods/projects_locations_agents_changelogs_list insert: [] update: [] delete: [] entity_types: - id: dialogflow.entity_types + id: google.dialogflow.entity_types name: entity_types title: Entity_types methods: @@ -15011,34 +15025,40 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/entity_types/methods/projects_locations_agents_entity_types_get - - $ref: >- - #/components/x-stackQL-resources/entity_types/methods/projects_locations_agents_entity_types_list - - $ref: >- - #/components/x-stackQL-resources/entity_types/methods/projects_locations_agents_sessions_entity_types_list + #/components/x-stackQL-resources/entity_types/methods/projects_locations_agents_environments_sessions_entity_types_get - $ref: >- #/components/x-stackQL-resources/entity_types/methods/projects_locations_agents_sessions_entity_types_get - $ref: >- #/components/x-stackQL-resources/entity_types/methods/projects_locations_agents_environments_sessions_entity_types_list - $ref: >- - #/components/x-stackQL-resources/entity_types/methods/projects_locations_agents_environments_sessions_entity_types_get + #/components/x-stackQL-resources/entity_types/methods/projects_locations_agents_entity_types_get + - $ref: >- + #/components/x-stackQL-resources/entity_types/methods/projects_locations_agents_sessions_entity_types_list + - $ref: >- + #/components/x-stackQL-resources/entity_types/methods/projects_locations_agents_entity_types_list insert: - $ref: >- - #/components/x-stackQL-resources/entity_types/methods/projects_locations_agents_entity_types_create + #/components/x-stackQL-resources/entity_types/methods/projects_locations_agents_environments_sessions_entity_types_create - $ref: >- #/components/x-stackQL-resources/entity_types/methods/projects_locations_agents_sessions_entity_types_create - $ref: >- - #/components/x-stackQL-resources/entity_types/methods/projects_locations_agents_environments_sessions_entity_types_create - update: [] + #/components/x-stackQL-resources/entity_types/methods/projects_locations_agents_entity_types_create + update: + - $ref: >- + #/components/x-stackQL-resources/entity_types/methods/projects_locations_agents_environments_sessions_entity_types_patch + - $ref: >- + #/components/x-stackQL-resources/entity_types/methods/projects_locations_agents_sessions_entity_types_patch + - $ref: >- + #/components/x-stackQL-resources/entity_types/methods/projects_locations_agents_entity_types_patch delete: - $ref: >- - #/components/x-stackQL-resources/entity_types/methods/projects_locations_agents_entity_types_delete + #/components/x-stackQL-resources/entity_types/methods/projects_locations_agents_environments_sessions_entity_types_delete - $ref: >- #/components/x-stackQL-resources/entity_types/methods/projects_locations_agents_sessions_entity_types_delete - $ref: >- - #/components/x-stackQL-resources/entity_types/methods/projects_locations_agents_environments_sessions_entity_types_delete + #/components/x-stackQL-resources/entity_types/methods/projects_locations_agents_entity_types_delete intents: - id: dialogflow.intents + id: google.dialogflow.intents name: intents title: Intents methods: @@ -15097,19 +15117,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/intents/methods/projects_locations_agents_intents_list - $ref: >- #/components/x-stackQL-resources/intents/methods/projects_locations_agents_intents_get + - $ref: >- + #/components/x-stackQL-resources/intents/methods/projects_locations_agents_intents_list insert: - $ref: >- #/components/x-stackQL-resources/intents/methods/projects_locations_agents_intents_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/intents/methods/projects_locations_agents_intents_patch delete: - $ref: >- #/components/x-stackQL-resources/intents/methods/projects_locations_agents_intents_delete sessions: - id: dialogflow.sessions + id: google.dialogflow.sessions name: sessions title: Sessions methods: @@ -15182,7 +15204,7 @@ components: update: [] delete: [] test_cases: - id: dialogflow.test_cases + id: google.dialogflow.test_cases name: test_cases title: Test_cases methods: @@ -15262,17 +15284,19 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/test_cases/methods/projects_locations_agents_test_cases_list - $ref: >- #/components/x-stackQL-resources/test_cases/methods/projects_locations_agents_test_cases_get + - $ref: >- + #/components/x-stackQL-resources/test_cases/methods/projects_locations_agents_test_cases_list insert: - $ref: >- #/components/x-stackQL-resources/test_cases/methods/projects_locations_agents_test_cases_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/test_cases/methods/projects_locations_agents_test_cases_patch delete: [] results: - id: dialogflow.results + id: google.dialogflow.results name: results title: Results methods: @@ -15296,15 +15320,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/results/methods/projects_locations_agents_test_cases_results_list - $ref: >- #/components/x-stackQL-resources/results/methods/projects_locations_agents_test_cases_results_get + - $ref: >- + #/components/x-stackQL-resources/results/methods/projects_locations_agents_test_cases_results_list insert: [] update: [] delete: [] webhooks: - id: dialogflow.webhooks + id: google.dialogflow.webhooks name: webhooks title: Webhooks methods: @@ -15349,19 +15373,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/webhooks/methods/projects_locations_agents_webhooks_list - $ref: >- #/components/x-stackQL-resources/webhooks/methods/projects_locations_agents_webhooks_get + - $ref: >- + #/components/x-stackQL-resources/webhooks/methods/projects_locations_agents_webhooks_list insert: - $ref: >- #/components/x-stackQL-resources/webhooks/methods/projects_locations_agents_webhooks_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/webhooks/methods/projects_locations_agents_webhooks_patch delete: - $ref: >- #/components/x-stackQL-resources/webhooks/methods/projects_locations_agents_webhooks_delete environments: - id: dialogflow.environments + id: google.dialogflow.environments name: environments title: Environments methods: @@ -15427,19 +15453,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/environments/methods/projects_locations_agents_environments_list - $ref: >- #/components/x-stackQL-resources/environments/methods/projects_locations_agents_environments_get + - $ref: >- + #/components/x-stackQL-resources/environments/methods/projects_locations_agents_environments_list insert: - $ref: >- #/components/x-stackQL-resources/environments/methods/projects_locations_agents_environments_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/environments/methods/projects_locations_agents_environments_patch delete: - $ref: >- #/components/x-stackQL-resources/environments/methods/projects_locations_agents_environments_delete deployments: - id: dialogflow.deployments + id: google.dialogflow.deployments name: deployments title: Deployments methods: @@ -15463,15 +15491,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/projects_locations_agents_environments_deployments_list - $ref: >- #/components/x-stackQL-resources/deployments/methods/projects_locations_agents_environments_deployments_get + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/projects_locations_agents_environments_deployments_list insert: [] update: [] delete: [] continuous_test_results: - id: dialogflow.continuous_test_results + id: google.dialogflow.continuous_test_results name: continuous_test_results title: Continuous_test_results methods: @@ -15494,7 +15522,7 @@ components: update: [] delete: [] experiments: - id: dialogflow.experiments + id: google.dialogflow.experiments name: experiments title: Experiments methods: @@ -15553,19 +15581,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/experiments/methods/projects_locations_agents_environments_experiments_list - $ref: >- #/components/x-stackQL-resources/experiments/methods/projects_locations_agents_environments_experiments_get + - $ref: >- + #/components/x-stackQL-resources/experiments/methods/projects_locations_agents_environments_experiments_list insert: - $ref: >- #/components/x-stackQL-resources/experiments/methods/projects_locations_agents_environments_experiments_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/experiments/methods/projects_locations_agents_environments_experiments_patch delete: - $ref: >- #/components/x-stackQL-resources/experiments/methods/projects_locations_agents_environments_experiments_delete generators: - id: dialogflow.generators + id: google.dialogflow.generators name: generators title: Generators methods: @@ -15610,14 +15640,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/generators/methods/projects_locations_agents_generators_list - $ref: >- #/components/x-stackQL-resources/generators/methods/projects_locations_agents_generators_get + - $ref: >- + #/components/x-stackQL-resources/generators/methods/projects_locations_agents_generators_list insert: - $ref: >- #/components/x-stackQL-resources/generators/methods/projects_locations_agents_generators_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/generators/methods/projects_locations_agents_generators_patch delete: - $ref: >- #/components/x-stackQL-resources/generators/methods/projects_locations_agents_generators_delete 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 0b4a83d6..07ab911a 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: '20240526' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/discovery-engine/docs servers: @@ -9457,7 +9457,7 @@ components: - '2' x-stackQL-resources: projects: - id: discoveryengine.projects + id: google.discoveryengine.projects name: projects title: Projects methods: @@ -9473,7 +9473,7 @@ components: update: [] delete: [] operations: - id: discoveryengine.operations + id: google.discoveryengine.operations name: operations title: Operations methods: @@ -9709,56 +9709,56 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_operations_list - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_collections_data_connector_operations_list - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_collections_data_connector_operations_get + #/components/x-stackQL-resources/operations/methods/projects_locations_collections_data_stores_branches_operations_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_collections_operations_list + #/components/x-stackQL-resources/operations/methods/projects_locations_collections_data_stores_models_operations_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_collections_operations_get + #/components/x-stackQL-resources/operations/methods/projects_locations_collections_data_stores_schemas_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_collections_data_stores_branches_operations_list - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_collections_data_stores_branches_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_collections_data_stores_models_operations_list - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_collections_data_stores_models_operations_get + #/components/x-stackQL-resources/operations/methods/projects_locations_collections_data_stores_schemas_operations_list - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_collections_data_stores_operations_list + #/components/x-stackQL-resources/operations/methods/projects_locations_collections_engines_operations_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_collections_data_stores_schemas_operations_list + #/components/x-stackQL-resources/operations/methods/projects_locations_data_stores_branches_operations_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_collections_data_stores_schemas_operations_get + #/components/x-stackQL-resources/operations/methods/projects_locations_data_stores_models_operations_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_collections_engines_operations_list + #/components/x-stackQL-resources/operations/methods/projects_locations_collections_data_connector_operations_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_collections_engines_operations_get + #/components/x-stackQL-resources/operations/methods/projects_locations_collections_operations_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list + #/components/x-stackQL-resources/operations/methods/projects_locations_collections_data_stores_operations_list - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get + #/components/x-stackQL-resources/operations/methods/projects_locations_collections_engines_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_data_stores_branches_operations_list - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_data_stores_branches_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_data_stores_models_operations_list - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_data_stores_models_operations_get + #/components/x-stackQL-resources/operations/methods/projects_locations_data_stores_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_collections_data_connector_operations_list + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_collections_operations_list + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_data_stores_operations_list - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_data_stores_operations_get + #/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_list insert: [] update: [] delete: [] data_stores: - id: discoveryengine.data_stores + id: google.discoveryengine.data_stores name: data_stores title: Data_stores methods: @@ -9856,27 +9856,31 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/data_stores/methods/projects_locations_collections_data_stores_list - $ref: >- #/components/x-stackQL-resources/data_stores/methods/projects_locations_collections_data_stores_get - $ref: >- - #/components/x-stackQL-resources/data_stores/methods/projects_locations_data_stores_list + #/components/x-stackQL-resources/data_stores/methods/projects_locations_collections_data_stores_list - $ref: >- #/components/x-stackQL-resources/data_stores/methods/projects_locations_data_stores_get + - $ref: >- + #/components/x-stackQL-resources/data_stores/methods/projects_locations_data_stores_list insert: - $ref: >- #/components/x-stackQL-resources/data_stores/methods/projects_locations_collections_data_stores_create - $ref: >- #/components/x-stackQL-resources/data_stores/methods/projects_locations_data_stores_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/data_stores/methods/projects_locations_collections_data_stores_patch + - $ref: >- + #/components/x-stackQL-resources/data_stores/methods/projects_locations_data_stores_patch delete: - $ref: >- #/components/x-stackQL-resources/data_stores/methods/projects_locations_collections_data_stores_delete - $ref: >- #/components/x-stackQL-resources/data_stores/methods/projects_locations_data_stores_delete data_stores_site_search_engine: - id: discoveryengine.data_stores_site_search_engine + id: google.discoveryengine.data_stores_site_search_engine name: data_stores_site_search_engine title: Data_stores_site_search_engine methods: @@ -9904,7 +9908,7 @@ components: update: [] delete: [] documents: - id: discoveryengine.documents + id: google.discoveryengine.documents name: documents title: Documents methods: @@ -10029,14 +10033,18 @@ components: #/components/x-stackQL-resources/documents/methods/projects_locations_collections_data_stores_branches_documents_create - $ref: >- #/components/x-stackQL-resources/documents/methods/projects_locations_data_stores_branches_documents_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/documents/methods/projects_locations_collections_data_stores_branches_documents_patch + - $ref: >- + #/components/x-stackQL-resources/documents/methods/projects_locations_data_stores_branches_documents_patch delete: - $ref: >- #/components/x-stackQL-resources/documents/methods/projects_locations_collections_data_stores_branches_documents_delete - $ref: >- #/components/x-stackQL-resources/documents/methods/projects_locations_data_stores_branches_documents_delete data_store_operations: - id: discoveryengine.data_store_operations + id: google.discoveryengine.data_store_operations name: data_store_operations title: Data_store_operations methods: @@ -10055,7 +10063,7 @@ components: update: [] delete: [] suggestion_deny_list_entries: - id: discoveryengine.suggestion_deny_list_entries + id: google.discoveryengine.suggestion_deny_list_entries name: suggestion_deny_list_entries title: Suggestion_deny_list_entries methods: @@ -10093,7 +10101,7 @@ components: update: [] delete: [] controls: - id: discoveryengine.controls + id: google.discoveryengine.controls name: controls title: Controls methods: @@ -10216,18 +10224,18 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/controls/methods/projects_locations_collections_data_stores_controls_list - $ref: >- #/components/x-stackQL-resources/controls/methods/projects_locations_collections_data_stores_controls_get - - $ref: >- - #/components/x-stackQL-resources/controls/methods/projects_locations_collections_engines_controls_list - $ref: >- #/components/x-stackQL-resources/controls/methods/projects_locations_collections_engines_controls_get - $ref: >- - #/components/x-stackQL-resources/controls/methods/projects_locations_data_stores_controls_list + #/components/x-stackQL-resources/controls/methods/projects_locations_collections_data_stores_controls_list + - $ref: >- + #/components/x-stackQL-resources/controls/methods/projects_locations_collections_engines_controls_list - $ref: >- #/components/x-stackQL-resources/controls/methods/projects_locations_data_stores_controls_get + - $ref: >- + #/components/x-stackQL-resources/controls/methods/projects_locations_data_stores_controls_list insert: - $ref: >- #/components/x-stackQL-resources/controls/methods/projects_locations_collections_data_stores_controls_create @@ -10235,7 +10243,13 @@ components: #/components/x-stackQL-resources/controls/methods/projects_locations_collections_engines_controls_create - $ref: >- #/components/x-stackQL-resources/controls/methods/projects_locations_data_stores_controls_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/controls/methods/projects_locations_collections_data_stores_controls_patch + - $ref: >- + #/components/x-stackQL-resources/controls/methods/projects_locations_collections_engines_controls_patch + - $ref: >- + #/components/x-stackQL-resources/controls/methods/projects_locations_data_stores_controls_patch delete: - $ref: >- #/components/x-stackQL-resources/controls/methods/projects_locations_collections_data_stores_controls_delete @@ -10244,7 +10258,7 @@ components: - $ref: >- #/components/x-stackQL-resources/controls/methods/projects_locations_data_stores_controls_delete serving_configs: - id: discoveryengine.serving_configs + id: google.discoveryengine.serving_configs name: serving_configs title: Serving_configs methods: @@ -10317,7 +10331,7 @@ components: update: [] delete: [] conversations: - id: discoveryengine.conversations + id: google.discoveryengine.conversations name: conversations title: Conversations methods: @@ -10461,18 +10475,18 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_data_stores_conversations_list - $ref: >- #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_data_stores_conversations_get - - $ref: >- - #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_engines_conversations_list - $ref: >- #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_engines_conversations_get - $ref: >- - #/components/x-stackQL-resources/conversations/methods/projects_locations_data_stores_conversations_list + #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_data_stores_conversations_list + - $ref: >- + #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_engines_conversations_list - $ref: >- #/components/x-stackQL-resources/conversations/methods/projects_locations_data_stores_conversations_get + - $ref: >- + #/components/x-stackQL-resources/conversations/methods/projects_locations_data_stores_conversations_list insert: - $ref: >- #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_data_stores_conversations_create @@ -10480,7 +10494,13 @@ components: #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_engines_conversations_create - $ref: >- #/components/x-stackQL-resources/conversations/methods/projects_locations_data_stores_conversations_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_data_stores_conversations_patch + - $ref: >- + #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_engines_conversations_patch + - $ref: >- + #/components/x-stackQL-resources/conversations/methods/projects_locations_data_stores_conversations_patch delete: - $ref: >- #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_data_stores_conversations_delete @@ -10489,7 +10509,7 @@ components: - $ref: >- #/components/x-stackQL-resources/conversations/methods/projects_locations_data_stores_conversations_delete sessions: - id: discoveryengine.sessions + id: google.discoveryengine.sessions name: sessions title: Sessions methods: @@ -10612,18 +10632,18 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_data_stores_sessions_list - $ref: >- #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_data_stores_sessions_get - - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_engines_sessions_list - $ref: >- #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_engines_sessions_get - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_data_stores_sessions_list + #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_data_stores_sessions_list + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_engines_sessions_list - $ref: >- #/components/x-stackQL-resources/sessions/methods/projects_locations_data_stores_sessions_get + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_data_stores_sessions_list insert: - $ref: >- #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_data_stores_sessions_create @@ -10631,7 +10651,13 @@ components: #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_engines_sessions_create - $ref: >- #/components/x-stackQL-resources/sessions/methods/projects_locations_data_stores_sessions_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_data_stores_sessions_patch + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_engines_sessions_patch + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_data_stores_sessions_patch delete: - $ref: >- #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_data_stores_sessions_delete @@ -10640,7 +10666,7 @@ components: - $ref: >- #/components/x-stackQL-resources/sessions/methods/projects_locations_data_stores_sessions_delete answers: - id: discoveryengine.answers + id: google.discoveryengine.answers name: answers title: Answers methods: @@ -10677,7 +10703,7 @@ components: update: [] delete: [] schemas: - id: discoveryengine.schemas + id: google.discoveryengine.schemas name: schemas title: Schemas methods: @@ -10774,14 +10800,18 @@ components: #/components/x-stackQL-resources/schemas/methods/projects_locations_collections_data_stores_schemas_create - $ref: >- #/components/x-stackQL-resources/schemas/methods/projects_locations_data_stores_schemas_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/schemas/methods/projects_locations_collections_data_stores_schemas_patch + - $ref: >- + #/components/x-stackQL-resources/schemas/methods/projects_locations_data_stores_schemas_patch delete: - $ref: >- #/components/x-stackQL-resources/schemas/methods/projects_locations_collections_data_stores_schemas_delete - $ref: >- #/components/x-stackQL-resources/schemas/methods/projects_locations_data_stores_schemas_delete site_search_engine: - id: discoveryengine.site_search_engine + id: google.discoveryengine.site_search_engine name: site_search_engine title: Site_search_engine methods: @@ -10840,7 +10870,7 @@ components: update: [] delete: [] site_search_engine_domain_verification_status: - id: discoveryengine.site_search_engine_domain_verification_status + id: google.discoveryengine.site_search_engine_domain_verification_status name: site_search_engine_domain_verification_status title: Site_search_engine_domain_verification_status methods: @@ -10857,7 +10887,7 @@ components: update: [] delete: [] search_engine_operations: - id: discoveryengine.search_engine_operations + id: google.discoveryengine.search_engine_operations name: search_engine_operations title: Search_engine_operations methods: @@ -10881,15 +10911,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/search_engine_operations/methods/projects_locations_collections_data_stores_site_search_engine_operations_list - $ref: >- #/components/x-stackQL-resources/search_engine_operations/methods/projects_locations_collections_data_stores_site_search_engine_operations_get + - $ref: >- + #/components/x-stackQL-resources/search_engine_operations/methods/projects_locations_collections_data_stores_site_search_engine_operations_list insert: [] update: [] delete: [] target_sites: - id: discoveryengine.target_sites + id: google.discoveryengine.target_sites name: target_sites title: Target_sites methods: @@ -10987,27 +11017,31 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/target_sites/methods/projects_locations_collections_data_stores_site_search_engine_target_sites_list - $ref: >- #/components/x-stackQL-resources/target_sites/methods/projects_locations_collections_data_stores_site_search_engine_target_sites_get - $ref: >- - #/components/x-stackQL-resources/target_sites/methods/projects_locations_data_stores_site_search_engine_target_sites_list + #/components/x-stackQL-resources/target_sites/methods/projects_locations_collections_data_stores_site_search_engine_target_sites_list - $ref: >- #/components/x-stackQL-resources/target_sites/methods/projects_locations_data_stores_site_search_engine_target_sites_get + - $ref: >- + #/components/x-stackQL-resources/target_sites/methods/projects_locations_data_stores_site_search_engine_target_sites_list insert: - $ref: >- #/components/x-stackQL-resources/target_sites/methods/projects_locations_collections_data_stores_site_search_engine_target_sites_create - $ref: >- #/components/x-stackQL-resources/target_sites/methods/projects_locations_data_stores_site_search_engine_target_sites_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/target_sites/methods/projects_locations_collections_data_stores_site_search_engine_target_sites_patch + - $ref: >- + #/components/x-stackQL-resources/target_sites/methods/projects_locations_data_stores_site_search_engine_target_sites_patch delete: - $ref: >- #/components/x-stackQL-resources/target_sites/methods/projects_locations_collections_data_stores_site_search_engine_target_sites_delete - $ref: >- #/components/x-stackQL-resources/target_sites/methods/projects_locations_data_stores_site_search_engine_target_sites_delete target_site_operations: - id: discoveryengine.target_site_operations + id: google.discoveryengine.target_site_operations name: target_site_operations title: Target_site_operations methods: @@ -11031,15 +11065,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/target_site_operations/methods/projects_locations_collections_data_stores_site_search_engine_target_sites_operations_list - $ref: >- #/components/x-stackQL-resources/target_site_operations/methods/projects_locations_collections_data_stores_site_search_engine_target_sites_operations_get + - $ref: >- + #/components/x-stackQL-resources/target_site_operations/methods/projects_locations_collections_data_stores_site_search_engine_target_sites_operations_list insert: [] update: [] delete: [] user_events: - id: discoveryengine.user_events + id: google.discoveryengine.user_events name: user_events title: User_events methods: @@ -11098,7 +11132,7 @@ components: update: [] delete: [] engines: - id: discoveryengine.engines + id: google.discoveryengine.engines name: engines title: Engines methods: @@ -11143,19 +11177,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/engines/methods/projects_locations_collections_engines_list - $ref: >- #/components/x-stackQL-resources/engines/methods/projects_locations_collections_engines_get + - $ref: >- + #/components/x-stackQL-resources/engines/methods/projects_locations_collections_engines_list insert: - $ref: >- #/components/x-stackQL-resources/engines/methods/projects_locations_collections_engines_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/engines/methods/projects_locations_collections_engines_patch delete: - $ref: >- #/components/x-stackQL-resources/engines/methods/projects_locations_collections_engines_delete grounding_configs: - id: discoveryengine.grounding_configs + id: google.discoveryengine.grounding_configs name: grounding_configs title: Grounding_configs methods: @@ -11172,7 +11208,7 @@ components: update: [] delete: [] ranking_configs: - id: discoveryengine.ranking_configs + id: google.discoveryengine.ranking_configs name: ranking_configs title: Ranking_configs methods: 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 4e6ac304..7187b6ed 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/dlp.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/dlp.yaml @@ -11,7 +11,7 @@ info: ease. version: v2 x-discovery-doc-revision: '20240526' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/sensitive-data-protection/docs/ servers: @@ -37,101 +37,131 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GooglePrivacyDlpV2CloudSqlDiscoveryTarget: - type: object - description: Target used to match against for discovery with Cloud SQL tables. - properties: - 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: - $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. - id: GooglePrivacyDlpV2CloudSqlDiscoveryTarget - GooglePrivacyDlpV2Connection: + GooglePrivacyDlpV2StoredInfoTypeVersion: + description: >- + Version of a StoredInfoType, including the configuration used to build + it, create timestamp, and current state. + id: GooglePrivacyDlpV2StoredInfoTypeVersion type: object properties: + config: + description: StoredInfoType configuration. + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeConfig' state: - type: string - enum: - - CONNECTION_STATE_UNSPECIFIED - - MISSING_CREDENTIALS - - AVAILABLE - - ERROR - description: Required. The connection's state in its lifecycle. + description: >- + Stored info type version state. Read-only, updated by the system + during dictionary creation. enumDescriptions: - Unused + - StoredInfoType version is being created. + - StoredInfoType version is ready for use. - >- - 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. + StoredInfoType creation failed. All relevant error messages are + returned in the `StoredInfoTypeVersion` message. - >- - 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. - cloudSql: - description: Connect to a Cloud SQL instance. - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlProperties' - name: - readOnly: true + 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 type: string - description: >- - Output only. Name of the connection: - `projects/{project}/locations/{location}/connections/{name}`. errors: - type: array + 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 + stats: + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeStats' + description: Statistics about this storedInfoType version. + createTime: description: >- - Output only. Set if status == ERROR, to provide additional details. - Will store the last 10 errors sorted with the most recent first. - readOnly: true - id: GooglePrivacyDlpV2Connection - description: >- - A data connection to allow DLP to profile data in locations that require - additional configuration. - GooglePrivacyDlpV2ImageTransformations: + Create timestamp of the version. Read-only, determined by the system + when the version is created. + type: string + format: google-datetime + GooglePrivacyDlpV2ProfileStatus: + type: object + description: Success or errors for the profile generation. + id: GooglePrivacyDlpV2ProfileStatus properties: - transforms: - description: List of transforms to make. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ImageTransformation' - id: GooglePrivacyDlpV2ImageTransformations - description: A type of transformation that is applied over images. + status: + description: >- + Profiling status code and optional message. The `status.code` value + is 0 (default value) for OK. + $ref: '#/components/schemas/GoogleRpcStatus' + timestamp: + type: string + format: google-datetime + description: Time when the profile generation status was updated + GooglePrivacyDlpV2HybridFindingDetails: type: object + id: GooglePrivacyDlpV2HybridFindingDetails + properties: + rowOffset: + description: >- + Offset of the row for tables. Populate if the row(s) being scanned + are part of a bigger dataset and you want to keep track of their + absolute position. + format: int64 + type: string + tableOptions: + 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' + fileOffset: + type: string + format: int64 + 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. + containerDetails: + description: >- + Details about the container where the content being inspected is + from. + $ref: '#/components/schemas/GooglePrivacyDlpV2Container' + labels: + 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"` + additionalProperties: + type: string + description: Populate to associate additional data with each finding. GooglePrivacyDlpV2FindingLimits: - type: object - 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. id: GooglePrivacyDlpV2FindingLimits properties: maxFindingsPerRequest: - format: int32 - type: integer description: >- Max number of findings that are returned per request or job. If you set this field in an InspectContentRequest, the resulting maximum @@ -140,13 +170,10 @@ components: inspection ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns can be multiple times higher than this value. - maxFindingsPerInfoType: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeLimit' - type: array - description: Configuration of findings limit given for specified infoTypes. - maxFindingsPerItem: + format: int32 type: integer + maxFindingsPerItem: + format: int32 description: >- Max number of findings that are returned for each item scanned. When set within an InspectContentRequest, this field is ignored. This @@ -154,284 +181,330 @@ components: 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 - GooglePrivacyDlpV2InfoTypeCategory: + type: integer + maxFindingsPerInfoType: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeLimit' + description: Configuration of findings limit given for specified infoTypes. + type: array + 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 + GooglePrivacyDlpV2QuasiIdField: + type: object + id: GooglePrivacyDlpV2QuasiIdField + 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: - 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 + customTag: type: string + description: A auxiliary field. + field: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: Identifies the column. + GooglePrivacyDlpV2RecordCondition: + type: object + properties: + expressions: + $ref: '#/components/schemas/GooglePrivacyDlpV2Expressions' + description: An expression. + description: >- + A condition for determining whether a transformation should be applied + to a field. + id: GooglePrivacyDlpV2RecordCondition + GooglePrivacyDlpV2InfoTypeTransformation: + type: object + properties: + primitiveTransformation: + $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' + description: Required. Primitive transformation to apply to the infoType. + infoTypes: description: >- - The group of relevant businesses where this infoType is commonly - used - locationCategory: - description: >- - The region or country that issued the ID or document represented by - the infoType. - enum: - - LOCATION_UNSPECIFIED - - GLOBAL - - ARGENTINA - - AUSTRALIA - - AZERBAIJAN - - 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 - 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 Australia. - - The infoType is typically used in Azerbaijan. - - 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. + InfoTypes to apply the transformation to. An empty list will cause + this transformation to apply to all findings that correspond to + infoTypes that were requested in `InspectConfig`. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + type: array + description: >- + A transformation to apply to text that is identified as a specific + info_type. + id: GooglePrivacyDlpV2InfoTypeTransformation + GooglePrivacyDlpV2RecordTransformation: + properties: + containerVersion: type: string - typeCategory: - description: The class of identifiers where this infoType belongs - 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: Container version, if available ("generation" for Cloud Storage). + containerTimestamp: + description: Findings container modification timestamp, if applicable. type: string - enum: - - TYPE_UNSPECIFIED - - PII - - SPII - - DEMOGRAPHIC - - CREDENTIAL - - GOVERNMENT_ID - - DOCUMENT - - CONTEXTUAL_INFORMATION + format: google-datetime + fieldId: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: For record transformations, provide a field. type: object - id: GooglePrivacyDlpV2InfoTypeCategory - description: >- - Classification of infoTypes to organize them according to geographic - location, industry, and data type. - GooglePrivacyDlpV2CryptoHashConfig: + id: GooglePrivacyDlpV2RecordTransformation + description: The field in a record to transform. + GooglePrivacyDlpV2HybridOptions: + id: GooglePrivacyDlpV2HybridOptions type: object properties: - cryptoKey: - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' - description: The key used by the hash function. - id: GooglePrivacyDlpV2CryptoHashConfig + description: + description: >- + A short description of where the data is coming from. Will be stored + once in the job. 256 max length. + type: string + requiredFindingLabelKeys: + items: + 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. + type: array + labels: + type: object + 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 + 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' 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. - GooglePrivacyDlpV2UpdateJobTriggerRequest: + Configuration to control jobs where the content being inspected is + outside of Google Cloud Platform. + GooglePrivacyDlpV2LargeCustomDictionaryStats: + description: Summary statistics of a custom dictionary. + id: GooglePrivacyDlpV2LargeCustomDictionaryStats type: object - description: Request message for UpdateJobTrigger. - id: GooglePrivacyDlpV2UpdateJobTriggerRequest properties: - updateMask: + approxNumPhrases: + description: Approximate number of distinct phrases in the dictionary. type: string - description: Mask to control which fields get updated. - format: google-fieldmask - jobTrigger: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' - description: New JobTrigger value. - GooglePrivacyDlpV2SecretsDiscoveryTarget: + format: int64 + GooglePrivacyDlpV2ContentLocation: + id: GooglePrivacyDlpV2ContentLocation 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. - id: GooglePrivacyDlpV2SecretsDiscoveryTarget + Precise location of the finding within a document, record, image, or + metadata container. type: object - properties: {} - GooglePrivacyDlpV2ListInspectTemplatesResponse: properties: - inspectTemplates: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' - type: array + containerName: description: >- - List of inspectTemplates, up to page_size in - ListInspectTemplatesRequest. - nextPageToken: + 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 - description: >- - If the next page is available then the next page token to be used in - the following ListInspectTemplates request. - id: GooglePrivacyDlpV2ListInspectTemplatesResponse - type: object - description: Response message for ListInspectTemplates. - GooglePrivacyDlpV2CustomInfoType: - id: GooglePrivacyDlpV2CustomInfoType + recordLocation: + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordLocation' + description: Location within a row or record of a database table. + imageLocation: + $ref: '#/components/schemas/GooglePrivacyDlpV2ImageLocation' + description: Location within an image's pixels. + documentLocation: + description: Location data for document files. + $ref: '#/components/schemas/GooglePrivacyDlpV2DocumentLocation' + containerVersion: + description: >- + Finding container version, if available ("generation" for Cloud + Storage). + type: string + metadataLocation: + description: Location within the metadata for inspected content. + $ref: '#/components/schemas/GooglePrivacyDlpV2MetadataLocation' + containerTimestamp: + format: google-datetime + type: string + 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. + GooglePrivacyDlpV2InspectContentRequest: + type: object + description: Request to search for potentially sensitive info in a ContentItem. + id: GooglePrivacyDlpV2InspectContentRequest properties: - sensitivityScore: - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + inspectConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' 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. - storedType: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredType' + Configuration for the inspector. What specified here will override + the template referenced by the inspect_template_name argument. + item: + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' + description: The item to inspect. + inspectTemplateName: + type: string description: >- - Load an existing `StoredInfoType` resource for use in - `InspectDataSource`. Not currently supported in `InspectContent`. - infoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + 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. + locationId: + type: string + description: Deprecated. This field has no effect. + GooglePrivacyDlpV2ActivateJobTriggerRequest: + id: GooglePrivacyDlpV2ActivateJobTriggerRequest + properties: {} + type: object + description: Request message for ActivateJobTrigger. + GooglePrivacyDlpV2Color: + description: Represents a color in the RGB color space. + id: GooglePrivacyDlpV2Color + 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 + red: + format: float + description: The amount of red in the color as a value in the interval [0, 1]. + type: number + GooglePrivacyDlpV2RequestedRiskAnalysisOptions: + properties: + jobConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2RiskAnalysisJobConfig' + description: The job config for the risk job. + type: object + description: Risk analysis options. + id: GooglePrivacyDlpV2RequestedRiskAnalysisOptions + GooglePrivacyDlpV2Manual: + description: >- + Job trigger option for hybrid jobs. Jobs must be manually created and + finished. + type: object + properties: {} + id: GooglePrivacyDlpV2Manual + GooglePrivacyDlpV2CategoricalStatsResult: + type: object + properties: + valueFrequencyHistogramBuckets: + type: array + description: Histogram of value frequencies in the column. + items: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CategoricalStatsHistogramBucket + id: GooglePrivacyDlpV2CategoricalStatsResult + description: Result of the categorical stats computation. + GooglePrivacyDlpV2Location: + type: object + description: Specifies the location of the finding. + properties: + byteRange: + $ref: '#/components/schemas/GooglePrivacyDlpV2Range' 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. - dictionary: - description: A list of phrases to detect as a CustomInfoType. - $ref: '#/components/schemas/GooglePrivacyDlpV2Dictionary' - detectionRules: + 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. + container: 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. + Information about the container where this finding occurred, if + available. + $ref: '#/components/schemas/GooglePrivacyDlpV2Container' + contentLocations: + description: >- + List of nested objects pointing to the precise location of the + finding within the file or record. + type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DetectionRule' + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentLocation' + 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. + id: GooglePrivacyDlpV2Location + GooglePrivacyDlpV2BigQueryRegexes: + properties: + patterns: + description: >- + A single BigQuery regular expression pattern to match against one or + more tables, datasets, or projects that contain BigQuery tables. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryRegex' type: array - surrogateType: - $ref: '#/components/schemas/GooglePrivacyDlpV2SurrogateType' + id: GooglePrivacyDlpV2BigQueryRegexes + type: object + description: >- + A collection of regular expressions to determine what tables to match + against. + GooglePrivacyDlpV2DatabaseResourceCollection: + type: object + properties: + includeRegexes: + $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceRegexes' description: >- - Message for detecting output from deidentification transformations - that support reversing. - exclusionType: - type: string - 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 + A collection of regular expressions to match a database resource + against. + description: >- + Match database resources using regex filters. Examples of database + resources are tables, views, and stored procedures. + id: GooglePrivacyDlpV2DatabaseResourceCollection + GooglePrivacyDlpV2DiscoveryGenerationCadence: + properties: + tableModifiedCadence: + description: Governs when to update data profiles when a table is modified. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryTableModifiedCadence' + schemaModifiedCadence: + description: Governs when to update data profiles when a schema is modified. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoverySchemaModifiedCadence + 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 + id: GooglePrivacyDlpV2DiscoveryGenerationCadence + GooglePrivacyDlpV2LikelihoodAdjustment: + type: object + id: GooglePrivacyDlpV2LikelihoodAdjustment + description: >- + Message for specifying an adjustment to the likelihood of a finding as + part of a detection rule. + properties: + relativeLikelihood: 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. - regex: - description: Regular expression based CustomInfoType. - $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' - likelihood: - type: string + 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: enum: - LIKELIHOOD_UNSPECIFIED - VERY_UNLIKELY @@ -439,6 +512,7 @@ components: - POSSIBLE - LIKELY - VERY_LIKELY + type: string enumDescriptions: - Default value; same as POSSIBLE. - Highest chance of a false positive. @@ -446,67 +520,77 @@ components: - Some matching signals. The default value. - Low chance of a false positive. - Confidence level is high. Lowest chance of a false positive. - 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. - description: >- - Custom information type provided by the user. Used to find - domain-specific sensitive information configurable to the data in - question. - type: object + description: Set the likelihood of a finding to a fixed value. GooglePrivacyDlpV2ContentItem: + id: GooglePrivacyDlpV2ContentItem type: object + description: Type of content to inspect. properties: + value: + description: String data to inspect or redact. + type: string + byteItem: + $ref: '#/components/schemas/GooglePrivacyDlpV2ByteContentItem' + description: Content data to inspect or redact. Replaces `type` and `data`. table: description: >- Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more. $ref: '#/components/schemas/GooglePrivacyDlpV2Table' - 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. - description: Type of content to inspect. - id: GooglePrivacyDlpV2ContentItem - GooglePrivacyDlpV2SelectedInfoTypes: - id: GooglePrivacyDlpV2SelectedInfoTypes - type: object - description: Apply transformation to the selected info_types. + GooglePrivacyDlpV2FileSet: + id: GooglePrivacyDlpV2FileSet properties: - infoTypes: + url: + type: string description: >- - Required. InfoTypes to apply the transformation to. Required. - Provided InfoType must be unique within the ImageTransformations - message. + 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. + 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' + type: object + description: Set of files to scan. + GooglePrivacyDlpV2TableOptions: + id: GooglePrivacyDlpV2TableOptions + type: object + properties: + identifyingFields: 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/GooglePrivacyDlpV2InfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: Instructions regarding the table content being inspected. GooglePrivacyDlpV2FieldTransformation: + id: GooglePrivacyDlpV2FieldTransformation type: object - description: The transformation to apply to the field. properties: - infoTypeTransformations: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeTransformations' - description: >- - Treat the contents of the field as free text, and selectively - transform content that matches an `InfoType`. primitiveTransformation: - $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' description: Apply the transformation to the entire field. + $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' fields: - items: - $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 + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' 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 @@ -514,801 +598,616 @@ components: 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 - GooglePrivacyDlpV2UpdateConnectionRequest: + infoTypeTransformations: + description: >- + Treat the contents of the field as free text, and selectively + transform content that matches an `InfoType`. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeTransformations' + description: The transformation to apply to the field. + GooglePrivacyDlpV2DataProfilePubSubMessage: properties: - updateMask: - description: Optional. Mask to control which fields get updated. + event: + description: The event that caused the Pub/Sub message to be sent. + 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 - format: google-fieldmask - connection: - description: Required. The connection with new values for the relevant fields. - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' - id: GooglePrivacyDlpV2UpdateConnectionRequest - type: object - description: Request message for UpdateConnection. - GooglePrivacyDlpV2RedactConfig: - id: GooglePrivacyDlpV2RedactConfig - properties: {} - type: object + enum: + - EVENT_TYPE_UNSPECIFIED + - NEW_PROFILE + - CHANGED_PROFILE + - SCORE_INCREASED + - ERROR_CHANGED + 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. 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 '. - GooglePrivacyDlpV2RequestedRiskAnalysisOptions: - description: Risk analysis options. + 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. + id: GooglePrivacyDlpV2DataProfilePubSubMessage type: object - id: GooglePrivacyDlpV2RequestedRiskAnalysisOptions - properties: - jobConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2RiskAnalysisJobConfig' - description: The job config for the risk job. - GooglePrivacyDlpV2StatisticalTable: - 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). + GooglePrivacyDlpV2EntityId: properties: - quasiIds: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2QuasiIdentifierField' - description: Required. Quasi-identifier columns. - table: - description: Required. Auxiliary table location. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - 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. + field: $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: Composite key indicating which field contains the entity identifier. type: object - id: GooglePrivacyDlpV2StatisticalTable - GooglePrivacyDlpV2HybridFindingDetails: - description: Populate to associate additional data with each finding. + 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 + GooglePrivacyDlpV2Result: + description: >- + All result fields mentioned below are updated while the job is + processing. + id: GooglePrivacyDlpV2Result type: object - id: GooglePrivacyDlpV2HybridFindingDetails properties: - containerDetails: - description: >- - Details about the container where the content being inspected is - from. - $ref: '#/components/schemas/GooglePrivacyDlpV2Container' - 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 - 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. - 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. + processedBytes: + type: string format: int64 + description: Total size in bytes that were processed. + numRowsProcessed: type: string - rowOffset: + 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 scanned after sampling and time filtering (applicable + for row based stores such as BigQuery). + totalEstimatedBytes: type: string + description: Estimate of the number of bytes to process. format: int64 - GooglePrivacyDlpV2KAnonymityHistogramBucket: - description: Histogram of k-anonymity equivalence classes. + infoTypeStats: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeStats' + type: array + description: >- + Statistics of how many instances of each info type were found during + inspect job. + hybridStats: + description: Statistics related to the processing of hybrid inspect. + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridInspectStatistics' + GooglePrivacyDlpV2DiscoveryStartingLocation: + type: object properties: - bucketValueCount: + folderId: type: string - description: Total number of distinct equivalence classes in this bucket. - format: int64 - bucketSize: format: int64 - type: string - description: Total number of equivalence classes in this bucket. - equivalenceClassSizeLowerBound: + description: The ID of the Folder within an organization to scan. + organizationId: format: int64 - description: Lower bound on the size of the equivalence classes in this bucket. - type: string - equivalenceClassSizeUpperBound: + description: The ID of an organization to scan. type: string - description: Upper bound on the size of the equivalence classes in this bucket. - format: int64 - bucketValues: - 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: array - type: object - id: GooglePrivacyDlpV2KAnonymityHistogramBucket - GooglePrivacyDlpV2ListStoredInfoTypesResponse: - id: GooglePrivacyDlpV2ListStoredInfoTypesResponse - description: Response message for ListStoredInfoTypes. + description: >- + The location to begin a discovery scan. Denotes an organization ID or + folder ID within an organization. + id: GooglePrivacyDlpV2DiscoveryStartingLocation + GooglePrivacyDlpV2TransformationResultStatus: + id: GooglePrivacyDlpV2TransformationResultStatus type: object properties: - storedInfoTypes: - description: >- - List of storedInfoTypes, up to page_size in - ListStoredInfoTypesRequest. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' - nextPageToken: - description: >- - If the next page is available then the next page token to be used in - the following ListStoredInfoTypes request. + details: + description: Detailed error codes and messages + $ref: '#/components/schemas/GoogleRpcStatus' + resultStatusType: + enum: + - STATE_TYPE_UNSPECIFIED + - INVALID_TRANSFORM + - BIGQUERY_MAX_ROW_SIZE_EXCEEDED + - METADATA_UNRETRIEVABLE + - SUCCESS type: string - GooglePrivacyDlpV2OrConditions: - id: GooglePrivacyDlpV2OrConditions - type: object - properties: - minRowCount: - format: int32 description: >- - Minimum number of rows that should be present before Cloud DLP - profiles a table + Transformation result status type, this will be either SUCCESS, or + it will be the reason for why the transformation was not completely + successful. + 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: The outcome of a transformation. + GooglePrivacyDlpV2InfoTypeLimit: + description: >- + Max findings configuration per infoType, per content item or long + running DlpJob. + properties: + maxFindings: + description: Max findings limit for the given infoType. type: integer - minAge: - format: google-duration - type: string + format: int32 + infoType: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' description: >- - Minimum age a table must have before Cloud DLP can profile it. Value - must be 1 hour or greater. - description: >- - There is an OR relationship between these attributes. They are used to - determine if a table should be scanned or not in Discovery. - GooglePrivacyDlpV2HybridInspectResponse: - description: Quota exceeded errors will be thrown once quota has been met. - id: GooglePrivacyDlpV2HybridInspectResponse + 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. + id: GooglePrivacyDlpV2InfoTypeLimit type: object - properties: {} - GooglePrivacyDlpV2LeaveUntransformed: - id: GooglePrivacyDlpV2LeaveUntransformed + GooglePrivacyDlpV2Error: 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 - properties: {} - GooglePrivacyDlpV2Expressions: - description: An expression, consisting of an operator and conditions. - type: object - id: GooglePrivacyDlpV2Expressions + Details information about an error encountered during job execution or + the results of an unsuccessful activation of the JobTrigger. properties: - logicalOperator: - enum: - - LOGICAL_OPERATOR_UNSPECIFIED - - AND - enumDescriptions: - - Unused - - Conditional AND - type: string + details: + $ref: '#/components/schemas/GoogleRpcStatus' + description: Detailed error codes and messages. + timestamps: + type: array description: >- - The operator to apply to the result of conditions. Default and - currently only supported value is `AND`. - conditions: - $ref: '#/components/schemas/GooglePrivacyDlpV2Conditions' - description: Conditions to apply to the expression. - GooglePrivacyDlpV2LargeCustomDictionaryConfig: - 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. + The times the error occurred. List includes the oldest timestamp and + the last 9 timestamps. + items: + type: string + format: google-datetime + id: GooglePrivacyDlpV2Error + type: object + GooglePrivacyDlpV2HybridInspectStatistics: + description: Statistics related to processing hybrid inspect requests. + id: GooglePrivacyDlpV2HybridInspectStatistics properties: - outputPath: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStoragePath' - 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: + pendingCount: + type: string + format: int64 description: >- - Field in a BigQuery table where each cell represents a dictionary - phrase. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryField' - cloudStorageFileSet: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageFileSet' + 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. + processedCount: + type: string + description: The number of hybrid inspection requests processed within this job. + format: int64 + abortedCount: description: >- - Set of files containing newline-delimited lists of dictionary - phrases. - type: object - GooglePrivacyDlpV2DatastoreKey: - properties: - entityKey: - $ref: '#/components/schemas/GooglePrivacyDlpV2Key' - description: Datastore entity key. - description: Record key for a finding in Cloud Datastore. - type: object - id: GooglePrivacyDlpV2DatastoreKey - GooglePrivacyDlpV2DiscoveryGenerationCadence: - properties: - schemaModifiedCadence: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DiscoverySchemaModifiedCadence - description: Governs when to update data profiles when a schema is modified. - tableModifiedCadence: - description: Governs when to update data profiles when a table is modified. - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryTableModifiedCadence' + 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 type: object - 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. - GooglePrivacyDlpV2DeltaPresenceEstimationConfig: - id: GooglePrivacyDlpV2DeltaPresenceEstimationConfig + GooglePrivacyDlpV2CloudStorageRegexFileSet: 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. + 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: - regionCode: - type: string + excludeRegex: + items: + 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: + 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: >- - 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' - quasiIds: + bucketName: + description: The name of a Cloud Storage bucket. Required. + type: string + includeRegex: type: array description: >- - Required. Fields considered to be quasi-identifiers. No two fields - can have the same tag. + 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: - $ref: '#/components/schemas/GooglePrivacyDlpV2QuasiId' + type: string + id: GooglePrivacyDlpV2CloudStorageRegexFileSet type: object - GooglePrivacyDlpV2FieldId: + GooglePrivacyDlpV2TransformationDescription: + description: >- + A flattened description of a `PrimitiveTransformation` or + `RecordSuppression`. + type: object + id: GooglePrivacyDlpV2TransformationDescription properties: - name: + condition: type: string - description: Name describing the field. - id: GooglePrivacyDlpV2FieldId - description: General identifier of a data field in a storage service. - type: object - GooglePrivacyDlpV2CategoricalStatsConfig: - description: >- - Compute numerical stats over an individual column, including number of - distinct values and value count distribution. - id: GooglePrivacyDlpV2CategoricalStatsConfig - type: object + 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' + 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 + 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. + 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. + GooglePrivacyDlpV2CloudStorageFileSet: + id: GooglePrivacyDlpV2CloudStorageFileSet + description: Message representing a set of files in Cloud Storage. properties: - field: + url: 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' - GooglePrivacyDlpV2DiscoveryCloudSqlConditions: - id: GooglePrivacyDlpV2DiscoveryCloudSqlConditions + The url, in the format `gs:///`. Trailing wildcard in the path is + allowed. + type: string type: object + GooglePrivacyDlpV2ListColumnDataProfilesResponse: properties: - databaseEngines: - items: - enumDescriptions: - - Unused. - - Include all supported database engines. - - MySQL database. - - PostgreSQL database. - enum: - - DATABASE_ENGINE_UNSPECIFIED - - ALL_SUPPORTED_DATABASE_ENGINES - - MYSQL - - POSTGRES - type: string - type: array - description: >- - Optional. Database engines that should be profiled. Optional. - Defaults to ALL_SUPPORTED_DATABASE_ENGINES if unspecified. - 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]. + nextPageToken: + type: string + description: The next page token. + columnDataProfiles: + description: List of data profiles. type: array 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. - description: >- - Requirements that must be true before a table is profiled for the first - time. - GooglePrivacyDlpV2AllInfoTypes: - description: Apply transformation to all findings. + $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' + description: List of profiles generated for a given organization or project. + id: GooglePrivacyDlpV2ListColumnDataProfilesResponse + type: object + GooglePrivacyDlpV2AllOtherDatabaseResources: + description: Match database resources not covered by any other filter. properties: {} type: object - id: GooglePrivacyDlpV2AllInfoTypes - GooglePrivacyDlpV2ThrowError: + id: GooglePrivacyDlpV2AllOtherDatabaseResources + GooglePrivacyDlpV2DataProfileLocation: + id: GooglePrivacyDlpV2DataProfileLocation + type: object + description: The data that will be profiled. + properties: + organizationId: + description: The ID of an organization to scan. + type: string + format: int64 + folderId: + format: int64 + description: The ID of the Folder within an organization to scan. + type: string + GooglePrivacyDlpV2FinishDlpJobRequest: + description: The request message for finishing a DLP hybrid job. properties: {} - description: Throw an error and fail the request when a transformation error occurs. + id: GooglePrivacyDlpV2FinishDlpJobRequest type: object - id: GooglePrivacyDlpV2ThrowError - GooglePrivacyDlpV2Result: - description: >- - All result fields mentioned below are updated while the job is - processing. + GooglePrivacyDlpV2TableDataProfile: type: object - id: GooglePrivacyDlpV2Result + id: GooglePrivacyDlpV2TableDataProfile + description: The profile for a scanned table. properties: - totalEstimatedBytes: + tableId: + description: If the resource is BigQuery, the BigQuery table ID. + type: string + scannedColumnCount: + type: string format: int64 - description: Estimate of the number of bytes to process. + description: The number of columns profiled in the table. + datasetId: type: string - infoTypeStats: + description: If the resource is BigQuery, the dataset ID. + resourceLabels: + type: object + additionalProperties: + type: string + description: >- + The labels applied to the resource at the time the profile was + generated. + predictedInfoTypes: type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeStats' + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeSummary' + description: The infoTypes predicted from this table's data. + rowCount: description: >- - Statistics of how many instances of each info type were found during - inspect job. - numRowsProcessed: + Number of rows in the table when the profile was generated. This + will not be populated for BigLake tables. type: string - description: >- - Number of rows scanned after sampling and time filtering (applicable - for row based stores such as BigQuery). - format: int64 - processedBytes: format: int64 - description: Total size in bytes that were processed. - type: string - hybridStats: - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridInspectStatistics' - description: Statistics related to the processing of hybrid inspect. - GooglePrivacyDlpV2Value: - id: GooglePrivacyDlpV2Value - 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. - type: object - properties: - timestampValue: - description: timestamp + resourceVisibility: type: string + enum: + - RESOURCE_VISIBILITY_UNSPECIFIED + - RESOURCE_VISIBILITY_PUBLIC + - RESOURCE_VISIBILITY_INCONCLUSIVE + - RESOURCE_VISIBILITY_RESTRICTED + description: How broadly a resource has been shared. + 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. + - Visible only to specific users. + lastModifiedTime: format: google-datetime - timeValue: - $ref: '#/components/schemas/GoogleTypeTimeOfDay' - description: time of day - integerValue: - format: int64 - description: integer + description: The time when this table was last modified type: string - floatValue: - format: double - description: float - type: number - stringValue: - description: string + profileLastGenerated: + description: The last time the profile was generated. type: string - dateValue: - $ref: '#/components/schemas/GoogleTypeDate' - description: date - booleanValue: - type: boolean - description: boolean - dayOfWeekValue: + format: google-datetime + projectDataProfile: + type: string + description: The resource name to the project data profile for this table. + encryptionStatus: + description: How the table is encrypted. + enumDescriptions: + - Unused. + - Google manages server-side encryption keys on your behalf. + - Customer provides the key. 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 + - ENCRYPTION_STATUS_UNSPECIFIED + - ENCRYPTION_GOOGLE_MANAGED + - ENCRYPTION_CUSTOMER_MANAGED type: string - GooglePrivacyDlpV2Bucket: - id: GooglePrivacyDlpV2Bucket - type: object - description: Bucket is represented as a range, along with replacement values. - properties: - min: + datasetProjectId: + type: string + description: The Google Cloud project ID that owns the resource. + name: + description: The name of the profile. + type: string + profileStatus: + $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' description: >- - Lower bound of the range, inclusive. Type should be the same as max - if used. - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - max: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: Upper bound of the range, exclusive; type must match min. - replacementValue: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: Required. Replacement value for this bucket. - GooglePrivacyDlpV2JobNotificationEmails: - properties: {} - 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 - GooglePrivacyDlpV2ListDiscoveryConfigsResponse: - description: Response message for ListDiscoveryConfigs. - type: object - id: GooglePrivacyDlpV2ListDiscoveryConfigsResponse - properties: - nextPageToken: + Success or error status from the most recent profile generation + attempt. May be empty if the profile is still being generated. + failedColumnCount: + format: int64 + description: The number of columns skipped in the table because of an error. + type: string + configSnapshot: + description: The snapshot of the configurations used to generate the profile. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileConfigSnapshot' + sensitivityScore: + description: The sensitivity score of this table. + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + tableSizeBytes: + format: int64 type: string + description: The size of the table when the profile was generated. + fullResource: description: >- - If the next page is available then this value is the next page token - to be used in the following ListDiscoveryConfigs request. - discoveryConfigs: + The resource name of the resource profiled. + https://cloud.google.com/apis/design/resource_names#full_resource_name + type: string + dataSourceType: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataSourceType' + description: The resource type that was profiled. + otherInfoTypes: type: array + description: Other infoTypes found in this table's data. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' - description: List of configs, up to page_size in ListDiscoveryConfigsRequest. - GooglePrivacyDlpV2BigQueryRegex: - type: object - id: GooglePrivacyDlpV2BigQueryRegex - properties: - datasetIdRegex: - type: string - description: If unset, this property matches all datasets. - tableIdRegex: - description: If unset, this property matches all tables. + $ref: '#/components/schemas/GooglePrivacyDlpV2OtherInfoTypeSummary' + expirationTime: + format: google-datetime + description: Optional. The time when this table expires. type: string - projectIdRegex: - description: >- - For organizations, if unset, will match all projects. Has no effect - for data profile configurations created within a project. + createTime: type: string - 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. - GooglePrivacyDlpV2CreateDlpJobRequest: - description: >- - Request message for CreateDlpJobRequest. Used to initiate long running - jobs such as calculating risk metrics or inspecting Google Cloud - Storage. - type: object - id: GooglePrivacyDlpV2CreateDlpJobRequest - properties: - riskJob: - description: >- - A risk analysis job calculates re-identification risk metrics for a - BigQuery table. - $ref: '#/components/schemas/GooglePrivacyDlpV2RiskAnalysisJobConfig' - locationId: - description: Deprecated. This field has no effect. + description: The time at which the table was created. + format: google-datetime + datasetLocation: type: string - jobId: description: >- - The job id can contain uppercase and lowercase letters, numbers, and - hyphens; that is, it must match the regular expression: - `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty - to allow the system to generate one. - type: string - inspectJob: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' - description: An inspection job scans a storage repository for InfoTypes. - GooglePrivacyDlpV2BigQueryOptions: - description: Options defining BigQuery table and row identifiers. - id: GooglePrivacyDlpV2BigQueryOptions - properties: - sampleMethod: + If supported, the location where the dataset's data is stored. See + https://cloud.google.com/bigquery/docs/locations for supported + locations. + dataRiskLevel: + description: The data risk level of this table. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' + state: enumDescriptions: - - No sampling. + - Unused. - >- - 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. + 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: - - SAMPLE_METHOD_UNSPECIFIED - - TOP - - RANDOM_START + - STATE_UNSPECIFIED + - RUNNING + - DONE type: string - description: How to sample the data. - includedFields: - 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 - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - rowsLimitPercent: - type: integer + description: State of a profile. + GooglePrivacyDlpV2OtherInfoTypeSummary: + properties: + estimatedPrevalence: 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. + Approximate percentage of non-null rows that contained data detected + by this infotype. format: int32 - identifyingFields: - type: array - 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/GooglePrivacyDlpV2FieldId' - tableReference: - description: Complete BigQuery table reference. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - 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. - rowsLimit: + type: integer + excludedFromAnalysis: + type: boolean description: >- - Max number of rows to scan. If the table has more rows than this - value, the rest of the rows are omitted. If not set, or if set to 0, - all rows will be scanned. Only one of rows_limit and - rows_limit_percent can be specified. Cannot be used in conjunction - with TimespanConfig. - format: int64 - type: string - type: object - GooglePrivacyDlpV2DatastoreOptions: + Whether this infoType was excluded from sensitivity and risk + analysis due to factors such as low prevalence (subject to change). + infoType: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + description: The other infoType. + id: GooglePrivacyDlpV2OtherInfoTypeSummary + description: Infotype details for other infoTypes found within a column. type: object - properties: - kind: - $ref: '#/components/schemas/GooglePrivacyDlpV2KindExpression' - description: The kind to process. - 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 - description: Options defining a data set within Google Cloud Datastore. - GooglePrivacyDlpV2SearchConnectionsResponse: + GooglePrivacyDlpV2StoredInfoTypeConfig: type: object - description: Response message for SearchConnections. properties: - nextPageToken: + description: + description: Description of the StoredInfoType (max 256 characters). type: string + largeCustomDictionary: description: >- - Token to retrieve the next page of results. An empty value means - there are no more results. - connections: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' - 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. - id: GooglePrivacyDlpV2SearchConnectionsResponse - GooglePrivacyDlpV2ListJobTriggersResponse: - type: object - description: Response message for ListJobTriggers. - id: GooglePrivacyDlpV2ListJobTriggersResponse - properties: - 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. - jobTriggers: - description: List of triggeredJobs, up to page_size in ListJobTriggersRequest. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' - type: array - GooglePrivacyDlpV2OutputStorageConfig: - id: GooglePrivacyDlpV2OutputStorageConfig - type: object - properties: - table: - description: >- - Store findings in an existing table or a new table in an existing - dataset. If table_id is not set a new one will be generated for you - with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. - Pacific 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. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - 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. - 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: - - OUTPUT_SCHEMA_UNSPECIFIED - - BASIC_COLUMNS - - GCS_COLUMNS - - DATASTORE_COLUMNS - - BIG_QUERY_COLUMNS - - ALL_COLUMNS - description: Cloud repository for storing output. - GooglePrivacyDlpV2CloudStoragePath: - description: Message representing a single file or path in Cloud Storage. - properties: - path: - type: string - description: >- - A URL representing a file or path (no wildcards) in Cloud Storage. - Example: `gs://[BUCKET_NAME]/dictionary.txt` - id: GooglePrivacyDlpV2CloudStoragePath - type: object - GooglePrivacyDlpV2LDiversityEquivalenceClass: - properties: - topSensitiveValues: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ValueFrequency' - type: array - description: Estimated frequencies of top sensitive values. - equivalenceClassSize: - format: int64 - type: string - description: Size of the k-anonymity equivalence class. - numDistinctSensitiveValues: - description: Number of distinct sensitive values in this equivalence class. - format: int64 - type: string - quasiIdsValues: - 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 - id: GooglePrivacyDlpV2LDiversityEquivalenceClass - type: object - description: The set of columns' values that share the same ldiversity value. - GooglePrivacyDlpV2MetadataLocation: - id: GooglePrivacyDlpV2MetadataLocation - description: Metadata Location - type: object - properties: - type: - description: Type of metadata containing the finding. - enum: - - METADATATYPE_UNSPECIFIED - - STORAGE_METADATA + StoredInfoType where findings are defined by a dictionary of + phrases. + $ref: '#/components/schemas/GooglePrivacyDlpV2LargeCustomDictionaryConfig' + regex: + description: Store regular expression-based StoredInfoType. + $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' + dictionary: + $ref: '#/components/schemas/GooglePrivacyDlpV2Dictionary' + description: Store dictionary-based CustomInfoType. + displayName: type: string - enumDescriptions: - - Unused - - General file metadata provided by Cloud Storage. - storageLabel: - $ref: '#/components/schemas/GooglePrivacyDlpV2StorageMetadataLabel' - description: Storage metadata. - GooglePrivacyDlpV2UpdateDiscoveryConfigRequest: - id: GooglePrivacyDlpV2UpdateDiscoveryConfigRequest + description: Display name of the StoredInfoType (max 256 characters). + 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. + GooglePrivacyDlpV2UpdateJobTriggerRequest: + id: GooglePrivacyDlpV2UpdateJobTriggerRequest type: object - description: Request message for UpdateDiscoveryConfig. + description: Request message for UpdateJobTrigger. properties: updateMask: description: Mask to control which fields get updated. format: google-fieldmask type: string - discoveryConfig: - description: Required. New DiscoveryConfig value. - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' - GooglePrivacyDlpV2SecretManagerCredential: - 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). - id: GooglePrivacyDlpV2SecretManagerCredential + jobTrigger: + description: New JobTrigger value. + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + GooglePrivacyDlpV2InspectDataSourceDetails: + type: object properties: - passwordSecretVersionName: + result: + $ref: '#/components/schemas/GooglePrivacyDlpV2Result' + description: A summary of the outcome of this inspection job. + requestedOptions: + description: The configuration used for this job. + $ref: '#/components/schemas/GooglePrivacyDlpV2RequestedOptions' + description: The results of an inspect DataSource job. + id: GooglePrivacyDlpV2InspectDataSourceDetails + GooglePrivacyDlpV2ReidentifyContentRequest: + id: GooglePrivacyDlpV2ReidentifyContentRequest + description: Request to re-identify an item. + type: object + properties: + inspectConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + description: Configuration for the inspector. + reidentifyConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' description: >- - Required. The name of the Secret Manager resource that stores the - password, in the form - `projects/project-id/secrets/secret-name/versions/version`. + 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 - username: + 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 - description: Required. The username. - type: object - GooglePrivacyDlpV2DocumentLocation: - description: Location of a finding within a document. - type: object - properties: - fileOffset: - format: int64 + item: + description: The item to re-identify. Will be treated as text. + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' + reidentifyTemplateName: description: >- - Offset of the line, from the beginning of the file, where the - finding is located. + 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 - id: GooglePrivacyDlpV2DocumentLocation - GooglePrivacyDlpV2OrgConfig: + GooglePrivacyDlpV2CancelDlpJobRequest: + properties: {} + id: GooglePrivacyDlpV2CancelDlpJobRequest + description: The request message for canceling a DLP job. type: object - id: GooglePrivacyDlpV2OrgConfig - description: >- - Project and scan location information. Only set when the parent is an - org. + GooglePrivacyDlpV2OrgConfig: properties: projectId: description: >- @@ -1317,1860 +1216,1578 @@ components: are profiled, and the Cloud DLP API must be enabled. type: string location: - description: 'The data to scan: folder, org, or project' $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryStartingLocation' - GooglePrivacyDlpV2SurrogateType: - type: object + description: 'The data to scan: folder, org, or project' + id: GooglePrivacyDlpV2OrgConfig 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 - properties: {} - GooglePrivacyDlpV2LikelihoodAdjustment: + Project and scan location information. Only set when the parent is an + org. type: object - id: GooglePrivacyDlpV2LikelihoodAdjustment - description: >- - Message for specifying an adjustment to the likelihood of a finding as - part of a detection rule. - properties: - fixedLikelihood: - 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 - description: Set the likelihood of a finding to a fixed value. - 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`. - type: integer - format: int32 - GooglePrivacyDlpV2InspectionRuleSet: - id: GooglePrivacyDlpV2InspectionRuleSet + GooglePrivacyDlpV2ListDiscoveryConfigsResponse: 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. + id: GooglePrivacyDlpV2ListDiscoveryConfigsResponse + description: Response message for ListDiscoveryConfigs. properties: - infoTypes: - description: List of infoTypes this rule set is applied to. + discoveryConfigs: + description: List of configs, up to page_size in ListDiscoveryConfigsRequest. type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - rules: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectionRule' - description: >- - Set of rules to be applied to infoTypes. The rules are applied in - order. - type: array - GooglePrivacyDlpV2InfoTypeTransformation: - properties: - infoTypes: - type: array + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + nextPageToken: + type: string description: >- - InfoTypes to apply the transformation to. An empty list will cause - this transformation to apply to all findings that correspond to - infoTypes that were requested in `InspectConfig`. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - primitiveTransformation: - $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' - description: Required. Primitive transformation to apply to the infoType. - type: object + If the next page is available then this value is the next page token + to be used in the following ListDiscoveryConfigs request. + GooglePrivacyDlpV2DiscoveryBigQueryConditions: description: >- - A transformation to apply to text that is identified as a specific - info_type. - id: GooglePrivacyDlpV2InfoTypeTransformation - GooglePrivacyDlpV2ReplaceWithInfoTypeConfig: - type: object - description: Replace each matching finding with the name of the info_type. - properties: {} - id: GooglePrivacyDlpV2ReplaceWithInfoTypeConfig - GooglePrivacyDlpV2QuasiIdentifierField: + 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). + id: GooglePrivacyDlpV2DiscoveryBigQueryConditions properties: - customTag: + types: + description: Restrict discovery to specific table types. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTableTypes' + createdAfter: description: >- - A column can be tagged with a custom tag. In this case, the user - must indicate an auxiliary table that contains statistical - information on the possible values of this column (below). - type: string - field: - $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. - type: object - id: GooglePrivacyDlpV2QuasiIdentifierField - GooglePrivacyDlpV2KmsWrappedCryptoKey: - type: object - id: GooglePrivacyDlpV2KmsWrappedCryptoKey - properties: - cryptoKeyName: + BigQuery table must have been created after this date. Used to avoid + backfilling. + format: google-datetime type: string - description: >- - Required. The resource name of the KMS CryptoKey to use for - unwrapping. - wrappedKey: + typeCollection: + 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. + enum: + - BIG_QUERY_COLLECTION_UNSPECIFIED + - BIG_QUERY_COLLECTION_ALL_TYPES + - BIG_QUERY_COLLECTION_ONLY_SUPPORTED_TYPES type: string - description: Required. The wrapped data crypto key. - format: byte - 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). - GooglePrivacyDlpV2DateShiftConfig: - properties: - cryptoKey: - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' - description: >- - Causes the shift to be computed based on this key and the context. - This results in the same shift for the same context and crypto_key. - If set, must also set context. Can only be applied to table items. - lowerBoundDays: - description: >- - Required. For example, -5 means shift date to at most 5 days back in - the past. - type: integer - format: int32 - 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. - upperBoundDays: - format: int32 - type: integer + description: Restrict discovery to categories of table types. + orConditions: + $ref: '#/components/schemas/GooglePrivacyDlpV2OrConditions' 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. - id: GooglePrivacyDlpV2DateShiftConfig + At least one of the conditions must be true for a table to be + scanned. type: object + GooglePrivacyDlpV2ReplaceDictionaryConfig: 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. - GooglePrivacyDlpV2TableReference: - id: GooglePrivacyDlpV2TableReference + Replace each input value with a value randomly selected from the + dictionary. type: object properties: - tableId: - description: Name of the table. + wordList: + 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. + $ref: '#/components/schemas/GooglePrivacyDlpV2WordList' + id: GooglePrivacyDlpV2ReplaceDictionaryConfig + GooglePrivacyDlpV2PubSubCondition: + properties: + minimumSensitivityScore: + enumDescriptions: + - Unused. + - High risk/sensitivity detected. + - Medium or high risk/sensitivity detected. + enum: + - PROFILE_SCORE_BUCKET_UNSPECIFIED + - HIGH + - MEDIUM_OR_HIGH type: string - datasetId: + description: The minimum sensitivity level that triggers the condition. + minimumRiskScore: + enum: + - PROFILE_SCORE_BUCKET_UNSPECIFIED + - HIGH + - MEDIUM_OR_HIGH + enumDescriptions: + - Unused. + - High risk/sensitivity detected. + - Medium or high risk/sensitivity detected. + description: The minimum data risk score that triggers the condition. type: string - description: Dataset ID of the table. - description: >- - Message defining the location of a BigQuery table with the projectId - inferred from the parent project. - GooglePrivacyDlpV2RequestedDeidentifyOptions: type: object - description: De-identification options. + id: GooglePrivacyDlpV2PubSubCondition + description: A condition consisting of a value. + GooglePrivacyDlpV2DiscoveryConfig: properties: - snapshotDeidentifyTemplate: - description: >- - Snapshot of the state of the `DeidentifyTemplate` from the - Deidentify action at the time this job was run. - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' - snapshotStructuredDeidentifyTemplate: - description: >- - Snapshot of the state of the structured `DeidentifyTemplate` from - the `Deidentify` action at the time this job was run. - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' - snapshotImageRedactTemplate: + orgConfig: + description: Only set when the parent is an org. + $ref: '#/components/schemas/GooglePrivacyDlpV2OrgConfig' + lastRunTime: 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 - GooglePrivacyDlpV2QuasiIdField: - 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: Identifies the column. - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - customTag: - description: A auxiliary field. + Output only. The timestamp of the last time this config was + executed. + readOnly: true type: string - id: GooglePrivacyDlpV2QuasiIdField + format: google-datetime + updateTime: + description: Output only. The last update timestamp of a DiscoveryConfig. + type: string + format: google-datetime + readOnly: true + displayName: + description: Display name (max 100 chars) + type: string + errors: + readOnly: true + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Error' + 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. + actions: + type: array + description: Actions to execute at the completion of scanning. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileAction' + createTime: + format: google-datetime + description: Output only. The creation timestamp of a DiscoveryConfig. + type: string + readOnly: true + status: + enum: + - STATUS_UNSPECIFIED + - RUNNING + - PAUSED + enumDescriptions: + - Unused + - The discovery config is currently active. + - The discovery config is paused temporarily. + type: string + description: Required. A status for this configuration. + targets: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryTarget' + description: >- + Target to match against for determining what to scan and how + frequently. + 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`. + type: string + inspectTemplates: + items: + type: string + 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. + id: GooglePrivacyDlpV2DiscoveryConfig + 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). type: object - GooglePrivacyDlpV2UpdateInspectTemplateRequest: - description: Request message for UpdateInspectTemplate. + GooglePrivacyDlpV2ProjectDataProfile: type: object + description: >- + An aggregated profile for this project, based on the resources profiled + within it. + id: GooglePrivacyDlpV2ProjectDataProfile properties: - inspectTemplate: - description: New InspectTemplate value. - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' - updateMask: - format: google-fieldmask - description: Mask to control which fields get updated. + sensitivityScore: + description: The sensitivity score of this project. + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + name: + description: The resource name of the profile. type: string - id: GooglePrivacyDlpV2UpdateInspectTemplateRequest - GooglePrivacyDlpV2HybridInspectDlpJobRequest: + profileStatus: + description: Success or error status of the last attempt to profile the project. + $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' + dataRiskLevel: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' + description: The data risk level of this project. + profileLastGenerated: + description: The last time the profile was generated. + type: string + format: google-datetime + projectId: + type: string + description: Project ID that was profiled. + 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. type: object - description: Request to search for potentially sensitive info in a custom location. - id: GooglePrivacyDlpV2HybridInspectDlpJobRequest - properties: - hybridItem: - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridContentItem' - description: The item to inspect. - GooglePrivacyDlpV2TimeZone: + properties: {} + id: GooglePrivacyDlpV2LeaveUntransformed + 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: - offsetMinutes: - format: int32 + details: description: >- - Set only if the offset can be determined. Positive for time ahead of - UTC. E.g. For "UTC-9", this value is -540. + 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 + code: + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 type: integer - id: GooglePrivacyDlpV2TimeZone + 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 type: object - description: Time zone of the date time object. - GooglePrivacyDlpV2ExcludeByHotword: + GooglePrivacyDlpV2RedactImageResponse: + type: object + id: GooglePrivacyDlpV2RedactImageResponse properties: - hotwordRegex: - description: Regular expression pattern defining what qualifies as a hotword. - $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' - proximity: + inspectResult: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectResult' 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' - 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 - GooglePrivacyDlpV2DeltaPresenceEstimationResult: + 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: >- + 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. + GooglePrivacyDlpV2RiskAnalysisJobConfig: + id: GooglePrivacyDlpV2RiskAnalysisJobConfig description: >- - Result of the δ-presence computation. Note that these results are an - estimation, not exact values. + Configuration for a risk analysis job. See + https://cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis + to learn more. type: object - id: GooglePrivacyDlpV2DeltaPresenceEstimationResult properties: - deltaPresenceEstimationHistogram: + privacyMetric: + $ref: '#/components/schemas/GooglePrivacyDlpV2PrivacyMetric' + description: Privacy metric to compute. + sourceTable: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + description: Input dataset to compute metrics over. + actions: items: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket + $ref: '#/components/schemas/GooglePrivacyDlpV2Action' 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. + Actions to execute at the completion of the job. Are executed in the + order provided. type: array - GooglePrivacyDlpV2RecordCondition: - description: >- - A condition for determining whether a transformation should be applied - to a field. - id: GooglePrivacyDlpV2RecordCondition + GooglePrivacyDlpV2KmsWrappedCryptoKey: properties: - expressions: - description: An expression. - $ref: '#/components/schemas/GooglePrivacyDlpV2Expressions' - type: object - GooglePrivacyDlpV2CancelDlpJobRequest: - id: GooglePrivacyDlpV2CancelDlpJobRequest - properties: {} - description: The request message for canceling a DLP job. + wrappedKey: + format: byte + type: string + description: Required. The wrapped data crypto key. + cryptoKeyName: + description: >- + Required. The resource name of the KMS CryptoKey to use for + unwrapping. + type: string type: object - GooglePrivacyDlpV2DiscoverySchemaModifiedCadence: - properties: - 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 - type: array - 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. - frequency: - 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. - description: The cadence at which to update data profiles when a schema is modified. - type: object - id: GooglePrivacyDlpV2DiscoverySchemaModifiedCadence - GooglePrivacyDlpV2BoundingBox: - properties: - left: - format: int32 - type: integer - description: Left coordinate of the bounding box. (0,0) is upper left. - top: - format: int32 - description: Top coordinate of the bounding box. (0,0) is upper left. - type: integer - height: - description: Height of the bounding box in pixels. - format: int32 - type: integer - width: - description: Width of the bounding box in pixels. - format: int32 - type: integer - id: GooglePrivacyDlpV2BoundingBox - type: object - description: Bounding box encompassing detected text within an image. - GooglePrivacyDlpV2DataProfileConfigSnapshot: - type: object - description: Snapshot of the configurations used to generate the profile. - id: GooglePrivacyDlpV2DataProfileConfigSnapshot + 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 + GooglePrivacyDlpV2SecretManagerCredential: + 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). + id: GooglePrivacyDlpV2SecretManagerCredential properties: - inspectTemplateModifiedTime: + username: type: string - format: google-datetime - description: Timestamp when the template was modified - dataProfileJob: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileJobConfig' - 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. - 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`. - discoveryConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' - description: A copy of the configuration used to generate this profile. - inspectTemplateName: + description: Required. The username. + passwordSecretVersionName: type: string - description: Name of the inspection template used to generate this profile - GooglePrivacyDlpV2SaveFindings: - properties: - outputConfig: - description: Location to store findings outside of DLP. - $ref: '#/components/schemas/GooglePrivacyDlpV2OutputStorageConfig' + 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: object - 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 GooglePrivacyDlpV2BigQueryTableTypes: id: GooglePrivacyDlpV2BigQueryTableTypes + type: object properties: types: type: array items: + enumDescriptions: + - Unused. + - A normal BigQuery table. + - A table that references data stored in Cloud Storage. type: string 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. description: A set of BigQuery table types. description: The types of BigQuery tables supported by Cloud DLP. + GooglePrivacyDlpV2DateTime: type: object - GooglePrivacyDlpV2AllOtherDatabaseResources: - type: object - description: Match database resources not covered by any other filter. - properties: {} - id: GooglePrivacyDlpV2AllOtherDatabaseResources - GooglePrivacyDlpV2QuasiId: properties: - 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 - customTag: + time: + $ref: '#/components/schemas/GoogleTypeTimeOfDay' + description: Time of day + dayOfWeek: type: string + 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 + date: + $ref: '#/components/schemas/GoogleTypeDate' 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. + One or more of the following must be set. Must be a valid date or + time value. + description: Message for a date time object. e.g. 2018-01-01, 5th August. + id: GooglePrivacyDlpV2DateTime + GooglePrivacyDlpV2ListInspectTemplatesResponse: + id: GooglePrivacyDlpV2ListInspectTemplatesResponse type: object - id: GooglePrivacyDlpV2QuasiId - description: A column with a semantic tag attached. - GooglePrivacyDlpV2ListInfoTypesResponse: properties: - infoTypes: - description: Set of sensitive infoTypes. + inspectTemplates: + description: >- + List of inspectTemplates, up to page_size in + ListInspectTemplatesRequest. type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeDescription' - type: object - id: GooglePrivacyDlpV2ListInfoTypesResponse - description: Response to the ListInfoTypes request. - GooglePrivacyDlpV2Export: - type: object - id: GooglePrivacyDlpV2Export - properties: - profileTable: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + nextPageToken: + type: string 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. - description: >- - If set, the detailed data profiles will be persisted to the location of - your choice whenever updated. - GooglePrivacyDlpV2ContentLocation: - description: >- - Precise location of the finding within a document, record, image, or - metadata container. + If the next page is available then the next page token to be used in + the following ListInspectTemplates request. + description: Response message for ListInspectTemplates. + GooglePrivacyDlpV2CloudStorageOptions: + type: object + description: Options defining a file or a set of files within a Cloud Storage bucket. properties: - containerName: + bytesLimitPerFile: type: string + format: int64 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). - recordLocation: - description: Location within a row or record of a database table. - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordLocation' - metadataLocation: - $ref: '#/components/schemas/GooglePrivacyDlpV2MetadataLocation' - description: Location within the metadata for inspected content. - imageLocation: - $ref: '#/components/schemas/GooglePrivacyDlpV2ImageLocation' - description: Location within an image's pixels. - containerVersion: + 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). + filesLimitPercent: + type: integer description: >- - Finding container version, if available ("generation" for Cloud - Storage). - type: string - documentLocation: - description: Location data for document files. - $ref: '#/components/schemas/GooglePrivacyDlpV2DocumentLocation' - containerTimestamp: + 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 + fileSet: + description: The set of one or more files to scan. + $ref: '#/components/schemas/GooglePrivacyDlpV2FileSet' + bytesLimitPerFilePercent: + format: int32 + type: integer 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 + 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). + fileTypes: + 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 + type: array + 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'. + sampleMethod: + type: string + enum: + - SAMPLE_METHOD_UNSPECIFIED + - TOP + - RANDOM_START + 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: How to sample the data. + id: GooglePrivacyDlpV2CloudStorageOptions + GooglePrivacyDlpV2KindExpression: + properties: + name: + description: The name of the kind. type: string - id: GooglePrivacyDlpV2ContentLocation type: object - GooglePrivacyDlpV2TimespanConfig: + description: A representation of a Datastore kind. + id: GooglePrivacyDlpV2KindExpression + GooglePrivacyDlpV2DeidentifyContentResponse: + description: Results of de-identifying a ContentItem. + id: GooglePrivacyDlpV2DeidentifyContentResponse + 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' type: object - description: >- - Configuration of the timespan of the items to include in scanning. - Currently only supported when inspecting Cloud Storage and BigQuery. - id: GooglePrivacyDlpV2TimespanConfig + GooglePrivacyDlpV2DatabaseResourceRegexes: properties: - endTime: - description: >- - Exclude files, tables, or rows newer than this value. If not set, no - upper time limit is applied. - type: string - format: google-datetime - 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. - enableAutoPopulationOfTimespanConfig: - type: boolean + patterns: 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. - GooglePrivacyDlpV2DiscoveryCloudSqlFilter: + 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. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceRegex' + type: array 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 - properties: - 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. - 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). - collection: - description: A specific set of database resources for this filter to apply to. - $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceCollection' + A collection of regular expressions to determine what database resources + to match against. type: object - GooglePrivacyDlpV2InfoTypeTransformations: - id: GooglePrivacyDlpV2InfoTypeTransformations + id: GooglePrivacyDlpV2DatabaseResourceRegexes + GooglePrivacyDlpV2RecordTransformations: properties: - transformations: + recordSuppressions: type: array description: >- - Required. Transformation for each infoType. Cannot specify more than - one for a given infoType. + Configuration defining which records get suppressed entirely. + Records that match any suppression rule are omitted from the output. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeTransformation' - 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. + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordSuppression' + fieldTransformations: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldTransformation' + description: Transform the record by applying various field transformations. + type: array type: object - GooglePrivacyDlpV2DeidentifyDataSourceDetails: - id: GooglePrivacyDlpV2DeidentifyDataSourceDetails + id: GooglePrivacyDlpV2RecordTransformations + description: >- + A type of transformation that is applied over structured data such as a + table. + GooglePrivacyDlpV2TransformationDetails: + 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. 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. - type: object - description: The results of a Deidentify action from an inspect job. - GooglePrivacyDlpV2DatabaseResourceCollection: - properties: - includeRegexes: - $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceRegexes' + resourceName: + description: The name of the job that completed the transformation. + type: string + transformationLocation: + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationLocation' description: >- - A collection of regular expressions to match a database resource - against. - id: GooglePrivacyDlpV2DatabaseResourceCollection - type: object - description: >- - Match database resources using regex filters. Examples of database - resources are tables, views, and stored procedures. - 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). - id: GooglePrivacyDlpV2DiscoveryBigQueryConditions - properties: - orConditions: - $ref: '#/components/schemas/GooglePrivacyDlpV2OrConditions' + The precise location of the transformed content in the original + container. + statusDetails: description: >- - At least one of the conditions must be true for a table to be - scanned. - types: - description: Restrict discovery to specific table types. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTableTypes' - typeCollection: - 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. - description: Restrict discovery to categories of table types. - type: string - createdAfter: + 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: >- - BigQuery table must have been created after this date. Used to avoid - backfilling. + 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 - format: google-datetime - type: object - GooglePrivacyDlpV2OtherInfoTypeSummary: - properties: - infoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: The other infoType. - estimatedPrevalence: + transformation: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationDescription' + type: array description: >- - Approximate percentage of non-null rows that contained data detected - by this infotype. - type: integer - format: int32 - excludedFromAnalysis: - type: boolean + 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. + containerName: + type: string description: >- - Whether this infoType was excluded from sensitivity and risk - analysis due to factors such as low prevalence (subject to change). - id: GooglePrivacyDlpV2OtherInfoTypeSummary + The top level name of the container where the transformation is + located (this will be the source file name or table name). type: object - description: Infotype details for other infoTypes found within a column. - GooglePrivacyDlpV2ProjectDataProfile: + id: GooglePrivacyDlpV2TransformationDetails + GooglePrivacyDlpV2ListTableDataProfilesResponse: properties: - sensitivityScore: - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - description: The sensitivity score of this project. - dataRiskLevel: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' - description: The data risk level of this project. - projectId: - type: string - description: Project ID that was profiled. - profileStatus: - $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' - description: Success or error status of the last attempt to profile the project. - profileLastGenerated: - type: string - format: google-datetime - description: The last time the profile was generated. - name: + nextPageToken: + description: The next page token. type: string - description: The resource name of the profile. - description: >- - An aggregated profile for this project, based on the resources profiled - within it. - type: object - id: GooglePrivacyDlpV2ProjectDataProfile - GooglePrivacyDlpV2RecordKey: + tableDataProfiles: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' + type: array + description: List of data profiles. + description: List of profiles generated for a given organization or project. type: object + id: GooglePrivacyDlpV2ListTableDataProfilesResponse + GooglePrivacyDlpV2UpdateStoredInfoTypeRequest: + id: GooglePrivacyDlpV2UpdateStoredInfoTypeRequest properties: - datastoreKey: - $ref: '#/components/schemas/GooglePrivacyDlpV2DatastoreKey' - description: BigQuery key - idValues: - type: array + config: description: >- - Values of identifying columns in the given row. Order of values - matches the order of `identifying_fields` specified in the scanning - request. - items: - type: string - bigQueryKey: - description: Datastore key - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryKey' - id: GooglePrivacyDlpV2RecordKey - description: Message for a unique key indicating a record that contains a finding. - GooglePrivacyDlpV2CloudSqlIamCredential: - id: 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: {} + 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: + format: google-fieldmask + type: string + description: Mask to control which fields get updated. + description: Request message for UpdateStoredInfoType. type: object - GooglePrivacyDlpV2KAnonymityResult: + GooglePrivacyDlpV2BigQueryOptions: + description: Options defining BigQuery table and row identifiers. type: object - description: Result of the k-anonymity computation. - id: GooglePrivacyDlpV2KAnonymityResult properties: - equivalenceClassHistogramBuckets: + tableReference: + description: Complete BigQuery table reference. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + rowsLimitPercent: + format: int32 + type: integer + 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. + 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. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityHistogramBucket' - type: array - description: Histogram of k-anonymity equivalence classes. - GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket: - type: object - properties: - minProbability: - description: Between 0 and 1. - format: double - type: number - bucketValues: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' type: array - items: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues - description: >- - Sample of quasi-identifier tuple values in this bucket. The total - number of classes returned per bucket is capped at 20. - maxProbability: - type: number - format: double - description: Always greater than or equal to min_probability. - bucketSize: + rowsLimit: type: string - description: Number of records within these probability bounds. - format: int64 - bucketValueCount: format: int64 description: >- - Total number of distinct quasi-identifier tuple values in this - bucket. - type: string - id: 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. - GooglePrivacyDlpV2DataProfileBigQueryRowSchema: - properties: - tableProfile: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' - description: Table data profile column - columnProfile: - $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' - description: Column data profile column - description: >- - The schema of data to be saved to the BigQuery table when the - `DataProfileAction` is enabled. - type: object - id: GooglePrivacyDlpV2DataProfileBigQueryRowSchema - GooglePrivacyDlpV2CategoricalStatsHistogramBucket: - description: Histogram of value frequencies in the column. - properties: - valueFrequencyLowerBound: - description: Lower bound on the value frequency of the values in this bucket. - type: string - format: int64 - bucketSize: - format: int64 - type: string - description: Total number of values in this bucket. - valueFrequencyUpperBound: - format: int64 - description: Upper bound on the value frequency of the values in this bucket. - type: string - bucketValueCount: - format: int64 + 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. + 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/GooglePrivacyDlpV2FieldId' + type: array + sampleMethod: + 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 type: string - description: Total number of distinct values in this bucket. - bucketValues: + includedFields: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ValueFrequency' + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' description: >- - Sample of value frequencies in this bucket. The total number of - values returned per bucket is capped at 20. + 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 - id: GooglePrivacyDlpV2CategoricalStatsHistogramBucket - type: object - 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. - type: object - id: GooglePrivacyDlpV2CryptoKey - properties: - unwrapped: - description: Unwrapped crypto key - $ref: '#/components/schemas/GooglePrivacyDlpV2UnwrappedCryptoKey' - transient: - description: Transient crypto key - $ref: '#/components/schemas/GooglePrivacyDlpV2TransientCryptoKey' - kmsWrapped: - $ref: '#/components/schemas/GooglePrivacyDlpV2KmsWrappedCryptoKey' - description: Key wrapped using Cloud KMS - GooglePrivacyDlpV2StoredInfoTypeConfig: + id: GooglePrivacyDlpV2BigQueryOptions + GooglePrivacyDlpV2InfoTypeLikelihood: 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. + 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: - dictionary: - $ref: '#/components/schemas/GooglePrivacyDlpV2Dictionary' - description: Store dictionary-based CustomInfoType. - largeCustomDictionary: + minLikelihood: + enum: + - LIKELIHOOD_UNSPECIFIED + - VERY_UNLIKELY + - UNLIKELY + - POSSIBLE + - LIKELY + - VERY_LIKELY description: >- - StoredInfoType where findings are defined by a dictionary of - phrases. - $ref: '#/components/schemas/GooglePrivacyDlpV2LargeCustomDictionaryConfig' - description: - description: Description of the StoredInfoType (max 256 characters). - type: string - regex: - $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' - description: Store regular expression-based StoredInfoType. - displayName: - description: Display name of the StoredInfoType (max 256 characters). + Only returns findings equal to or above this threshold. This field + is required or else the configuration fails. 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. + infoType: + 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. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' type: object - id: GooglePrivacyDlpV2StoredInfoTypeConfig - GooglePrivacyDlpV2StorageConfig: + id: GooglePrivacyDlpV2InfoTypeLikelihood + GooglePrivacyDlpV2HybridInspectDlpJobRequest: + description: Request to search for potentially sensitive info in a custom location. + properties: + hybridItem: + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridContentItem' + description: The item to inspect. + id: GooglePrivacyDlpV2HybridInspectDlpJobRequest type: object - description: Shared message indicating Cloud storage type. - id: GooglePrivacyDlpV2StorageConfig + GooglePrivacyDlpV2StatisticalTable: + 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). + type: object + id: GooglePrivacyDlpV2StatisticalTable properties: - datastoreOptions: - $ref: '#/components/schemas/GooglePrivacyDlpV2DatastoreOptions' - description: Google Cloud Datastore options. - cloudStorageOptions: - description: Cloud Storage options. - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageOptions' - timespanConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2TimespanConfig' - description: Configuration of the timespan of the items to include in scanning. - hybridOptions: - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridOptions' - description: Hybrid inspection options. - bigQueryOptions: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryOptions' - description: BigQuery options. - GooglePrivacyDlpV2StoredInfoTypeStats: + 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: + description: Required. Quasi-identifier columns. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2QuasiIdentifierField' + GooglePrivacyDlpV2DiscoveryTarget: + description: Target used to match against for Discovery. properties: - largeCustomDictionary: - $ref: '#/components/schemas/GooglePrivacyDlpV2LargeCustomDictionaryStats' + cloudSqlTarget: + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlDiscoveryTarget' description: >- - StoredInfoType where findings are defined by a dictionary of - phrases. + Cloud SQL target for Discovery. The first target to match a table + will be the one applied. + 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' + bigQueryTarget: + description: >- + BigQuery target for Discovery. The first target to match a table + will be the one applied. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryDiscoveryTarget' type: object - description: Statistics for a StoredInfoType. - id: GooglePrivacyDlpV2StoredInfoTypeStats - GooglePrivacyDlpV2TransientCryptoKey: - description: >- - Use this to have a random data crypto key generated. It will be - discarded after the request finishes. + id: GooglePrivacyDlpV2DiscoveryTarget + GooglePrivacyDlpV2ByteContentItem: + description: Container for bytes to inspect or redact. + id: GooglePrivacyDlpV2ByteContentItem properties: - name: + type: + 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 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 type of data stored in the bytes string. Default will be + TEXT_UTF8. + type: string + 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 + data: + description: Content data to inspect or redact. + format: byte type: string - id: GooglePrivacyDlpV2TransientCryptoKey type: object - 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. + GooglePrivacyDlpV2TransformationOverview: type: object + id: GooglePrivacyDlpV2TransformationOverview + description: Overview of the modifications that occurred. properties: - jobNotificationEmails: - $ref: '#/components/schemas/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). - deidentify: - $ref: '#/components/schemas/GooglePrivacyDlpV2Deidentify' - description: Create a de-identified copy of the input data. - pubSub: - $ref: '#/components/schemas/GooglePrivacyDlpV2PublishToPubSub' - description: Publish a notification to a Pub/Sub topic. - publishToStackdriver: - description: Enable Stackdriver metric dlp.googleapis.com/finding_count. - $ref: '#/components/schemas/GooglePrivacyDlpV2PublishToStackdriver' - saveFindings: - $ref: '#/components/schemas/GooglePrivacyDlpV2SaveFindings' - description: Save resulting findings in a provided location. - publishSummaryToCscc: - $ref: '#/components/schemas/GooglePrivacyDlpV2PublishSummaryToCscc' - description: Publish summary to Cloud Security Command Center (Alpha). - publishFindingsToCloudDataCatalog: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog - description: Publish findings to Cloud Datahub. - id: GooglePrivacyDlpV2Action - GooglePrivacyDlpV2CharsToIgnore: - id: GooglePrivacyDlpV2CharsToIgnore - type: object - description: >- - Characters to skip when doing deidentification of a value. These will be - left alone and skipped. - properties: - commonCharactersToIgnore: - 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. - type: string - enum: - - COMMON_CHARS_TO_IGNORE_UNSPECIFIED - - NUMERIC - - ALPHA_UPPER_CASE - - ALPHA_LOWER_CASE - - PUNCTUATION - - WHITESPACE - charactersToSkip: - description: Characters to not transform when masking. + transformationSummaries: + description: Transformations applied to the dataset. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationSummary' + type: array + transformedBytes: type: string - GooglePrivacyDlpV2UpdateStoredInfoTypeRequest: + format: int64 + description: Total size in bytes that were transformed in some way. + GooglePrivacyDlpV2CreateInspectTemplateRequest: + description: Request message for CreateInspectTemplate. properties: - updateMask: - format: google-fieldmask + inspectTemplate: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + description: Required. The InspectTemplate to create. + locationId: + type: string + description: Deprecated. This field has no effect. + templateId: type: string - description: Mask to control which fields get updated. - config: 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' - id: GooglePrivacyDlpV2UpdateStoredInfoTypeRequest - description: Request message for UpdateStoredInfoType. + 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: GooglePrivacyDlpV2CreateInspectTemplateRequest + type: object + GooglePrivacyDlpV2LDiversityConfig: + id: GooglePrivacyDlpV2LDiversityConfig + description: l-diversity metric, used for analysis of reidentification risk. type: object - GooglePrivacyDlpV2ValueFrequency: - id: GooglePrivacyDlpV2ValueFrequency - description: A value of a field, including its frequency. properties: - count: - description: How many times the value is contained in the field. - type: string - format: int64 - value: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: A value contained in the field in question. + sensitiveAttribute: + description: Sensitive field for computing the l-value. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + 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 + GooglePrivacyDlpV2RecordKey: + id: GooglePrivacyDlpV2RecordKey type: object + description: Message for a unique key indicating a record that contains a finding. + properties: + bigQueryKey: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryKey' + description: Datastore key + 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 + datastoreKey: + description: BigQuery key + $ref: '#/components/schemas/GooglePrivacyDlpV2DatastoreKey' GooglePrivacyDlpV2ActionDetails: - type: object - id: GooglePrivacyDlpV2ActionDetails description: The results of an Action. + type: object properties: deidentifyDetails: $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyDataSourceDetails' description: Outcome of a de-identification action. - GooglePrivacyDlpV2InspectDataSourceDetails: - type: object + id: GooglePrivacyDlpV2ActionDetails + GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails: + id: GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails properties: + requestedPrivacyMetric: + $ref: '#/components/schemas/GooglePrivacyDlpV2PrivacyMetric' + description: Privacy metric to compute. + categoricalStatsResult: + $ref: '#/components/schemas/GooglePrivacyDlpV2CategoricalStatsResult' + description: Categorical stats result requestedOptions: - $ref: '#/components/schemas/GooglePrivacyDlpV2RequestedOptions' description: The configuration used for this job. - result: - description: A summary of the outcome of this inspection job. - $ref: '#/components/schemas/GooglePrivacyDlpV2Result' - description: The results of an inspect DataSource job. - id: GooglePrivacyDlpV2InspectDataSourceDetails - GoogleTypeDate: + $ref: '#/components/schemas/GooglePrivacyDlpV2RequestedRiskAnalysisOptions' + numericalStatsResult: + $ref: '#/components/schemas/GooglePrivacyDlpV2NumericalStatsResult' + description: Numerical stats result + kMapEstimationResult: + description: K-map result + $ref: '#/components/schemas/GooglePrivacyDlpV2KMapEstimationResult' + deltaPresenceEstimationResult: + description: Delta-presence result + $ref: '#/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationResult' + requestedSourceTable: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + description: Input dataset to compute metrics over. + kAnonymityResult: + description: K-anonymity result + $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityResult' + lDiversityResult: + $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityResult' + description: L-divesity result + description: Result of a risk analysis operation request. type: object + GooglePrivacyDlpV2HybridInspectJobTriggerRequest: + description: Request to search for potentially sensitive info in a custom location. properties: - year: - type: integer + hybridItem: + description: The item to inspect. + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridContentItem' + id: GooglePrivacyDlpV2HybridInspectJobTriggerRequest + type: object + GooglePrivacyDlpV2DateShiftConfig: + type: object + id: GooglePrivacyDlpV2DateShiftConfig + properties: + context: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - format: int32 - day: + 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 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. - month: - type: integer + Required. For example, -5 means shift date to at most 5 days back in + the past. + cryptoKey: + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' + 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 description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. + 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. + 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 - GooglePrivacyDlpV2TransformationResultStatus: + 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. + GooglePrivacyDlpV2Trigger: properties: - resultStatusType: - type: string - enum: - - STATE_TYPE_UNSPECIFIED - - INVALID_TRANSFORM - - BIGQUERY_MAX_ROW_SIZE_EXCEEDED - - METADATA_UNRETRIEVABLE - - SUCCESS - 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. + schedule: + $ref: '#/components/schemas/GooglePrivacyDlpV2Schedule' + description: Create a job on a repeating basis based on the elapse of time. + manual: description: >- - Transformation result status type, this will be either SUCCESS, or - it will be the reason for why the transformation was not completely - successful. - details: - $ref: '#/components/schemas/GoogleRpcStatus' - description: Detailed error codes and messages - description: The outcome of a transformation. + For use with hybrid jobs. Jobs must be manually created and + finished. + $ref: '#/components/schemas/GooglePrivacyDlpV2Manual' + id: GooglePrivacyDlpV2Trigger + description: What event needs to occur for a new job to be started. type: object - id: GooglePrivacyDlpV2TransformationResultStatus - GooglePrivacyDlpV2DateTime: + GooglePrivacyDlpV2PublishSummaryToCscc: + properties: {} + 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 - description: Message for a date time object. e.g. 2018-01-01, 5th August. - id: GooglePrivacyDlpV2DateTime + id: GooglePrivacyDlpV2PublishSummaryToCscc + GooglePrivacyDlpV2BigQueryDiscoveryTarget: + description: Target used to match against for discovery with BigQuery tables properties: - date: + filter: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryBigQueryFilter' description: >- - One or more of the following must be set. Must be a valid date or - time value. - $ref: '#/components/schemas/GoogleTypeDate' - timeZone: - $ref: '#/components/schemas/GooglePrivacyDlpV2TimeZone' - description: Time zone - dayOfWeek: + 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: Tables that match this filter will not have profiles created. + $ref: '#/components/schemas/GooglePrivacyDlpV2Disabled' + 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: + description: >- + In addition to matching the filter, these conditions must be true + before a profile is generated. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryBigQueryConditions' + id: GooglePrivacyDlpV2BigQueryDiscoveryTarget + type: object + GooglePrivacyDlpV2CharsToIgnore: + type: object + properties: + charactersToSkip: + description: Characters to not transform when masking. + type: string + commonCharactersToIgnore: + description: >- + Common characters to not transform when masking. Useful to avoid + removing punctuation. enumDescriptions: - - The day of the week is unspecified. - - Monday - - Tuesday - - Wednesday - - Thursday - - Friday - - Saturday - - Sunday + - Unused. + - 0-9 + - A-Z + - a-z + - US Punctuation, one of !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~ + - Whitespace character, one of [ \t\n\x0B\f\r] type: string - description: Day of week enum: - - DAY_OF_WEEK_UNSPECIFIED - - MONDAY - - TUESDAY - - WEDNESDAY - - THURSDAY - - FRIDAY - - SATURDAY - - SUNDAY - time: - $ref: '#/components/schemas/GoogleTypeTimeOfDay' - description: Time of day - GooglePrivacyDlpV2HybridOptions: + - COMMON_CHARS_TO_IGNORE_UNSPECIFIED + - NUMERIC + - ALPHA_UPPER_CASE + - ALPHA_LOWER_CASE + - PUNCTUATION + - WHITESPACE + description: >- + Characters to skip when doing deidentification of a value. These will be + left alone and skipped. + id: GooglePrivacyDlpV2CharsToIgnore + GooglePrivacyDlpV2Deidentify: type: object properties: - labels: - type: object - additionalProperties: - type: string + cloudStorageOutput: 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"` - requiredFindingLabelKeys: + 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 + transformationDetailsStorageConfig: + 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). + $ref: >- + #/components/schemas/GooglePrivacyDlpV2TransformationDetailsStorageConfig + fileTypesToTransform: type: array items: type: string + enum: + - FILE_TYPE_UNSPECIFIED + - BINARY_FILE + - TEXT_FILE + - IMAGE + - WORD + - PDF + - AVRO + - CSV + - TSV + - POWERPOINT + - EXCEL + 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. 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. - 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. - description: + List of user-specified file type groups to transform. If specified, + only the files with these filetypes 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 + filetypes supported are: IMAGES, TEXT_FILES, CSV, TSV. + transformationConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationConfig' description: >- - A short description of where the data is coming from. Will be stored - once in the job. 256 max length. - type: string + User specified deidentify templates and configs for structured, + unstructured, and image files. + id: GooglePrivacyDlpV2Deidentify description: >- - Configuration to control jobs where the content being inspected is - outside of Google Cloud Platform. - id: GooglePrivacyDlpV2HybridOptions - GooglePrivacyDlpV2ExcludeInfoTypes: - type: object + 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 + GooglePrivacyDlpV2SchemaModifiedCadence: properties: - infoTypes: + types: type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + enum: + - SQL_SCHEMA_MODIFICATION_UNSPECIFIED + - NEW_COLUMNS + - REMOVED_COLUMNS + type: string + enumDescriptions: + - Unused. + - New columns have appeared. + - Columns have been removed from the table. 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. - description: List of excluded infoTypes. - id: GooglePrivacyDlpV2ExcludeInfoTypes - GooglePrivacyDlpV2ReidentifyContentResponse: - 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 - description: Results of re-identifying an item. - type: object - GooglePrivacyDlpV2ListProjectDataProfilesResponse: - properties: - nextPageToken: - description: The next page token. - type: string - projectDataProfiles: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ProjectDataProfile' - description: List of data profiles. - type: object - description: List of profiles generated for a given organization or project. - id: GooglePrivacyDlpV2ListProjectDataProfilesResponse - GooglePrivacyDlpV2RedactImageResponse: - properties: - redactedImage: - description: The redacted image. The type will be the same as the original image. - type: string - format: byte - inspectResult: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectResult' - description: >- - The findings. Populated when include_findings in the request is - true. - extractedText: + The types of schema modifications to consider. Defaults to + NEW_COLUMNS. + frequency: + enum: + - UPDATE_FREQUENCY_UNSPECIFIED + - UPDATE_FREQUENCY_NEVER + - UPDATE_FREQUENCY_DAILY + - UPDATE_FREQUENCY_MONTHLY 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. - id: GooglePrivacyDlpV2RedactImageResponse - description: Results of redacting an image. + 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. + description: >- + How frequently to modify the profile when the table's schema is + modified. type: object - GooglePrivacyDlpV2InspectResult: - description: All the findings for a single scanned item. - id: GooglePrivacyDlpV2InspectResult + id: GooglePrivacyDlpV2SchemaModifiedCadence + 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 type: object properties: - findingsTruncated: + quasiIds: description: >- - If true, then this item might have more findings than were returned, - and the findings returned are an arbitrary subset of all findings. - The findings list might be truncated because the input items were - too large, or because the server reached the maximum amount of - resources allowed for a single API call. For best results, divide - the input into smaller batches. - type: boolean - findings: - description: List of findings for an item. + Required. Fields considered to be quasi-identifiers. No two columns + can have the same tag. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2TaggedField' type: array + 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: - $ref: '#/components/schemas/GooglePrivacyDlpV2Finding' - GooglePrivacyDlpV2Finding: - properties: - triggerName: - type: string - description: Job trigger name, if applicable, for this finding. - quote: + $ref: '#/components/schemas/GooglePrivacyDlpV2AuxiliaryTable' + type: array + regionCode: 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. - 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' - location: - description: Where the content was found. - $ref: '#/components/schemas/GooglePrivacyDlpV2Location' - infoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: >- - The type of content that might have been found. Provided if - `excluded_types` is false. - likelihood: - 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. - description: Confidence of how likely it is that the `info_type` is correct. + 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. + GooglePrivacyDlpV2JobTrigger: + properties: + updateTime: + format: google-datetime type: string - jobName: - description: The job that stored the finding. + readOnly: true + description: Output only. The last update timestamp of a triggeredJob. + triggers: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Trigger' + 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. + lastRunTime: + format: google-datetime + description: Output only. The timestamp of the last time this trigger executed. type: string + readOnly: true + inspectJob: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' + description: For inspect jobs, a snapshot of the configuration. name: type: string description: >- - Resource name in format - projects/{project}/locations/{location}/findings/{finding} Populated - only when viewing persisted findings. - jobCreateTime: + Unique resource name for the triggeredJob, assigned by the service + when the triggeredJob is created, for example + `projects/dlp-test-project/jobTriggers/53234423`. + createTime: + description: Output only. The creation timestamp of a triggeredJob. type: string - description: Time the job started that produced this finding. + readOnly: true format: google-datetime - labels: - type: object - 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"` - additionalProperties: - type: string - resourceName: + status: + enum: + - STATUS_UNSPECIFIED + - HEALTHY + - PAUSED + - CANCELLED + description: Required. A status for this trigger. type: string - description: The job that stored the finding. - findingId: + enumDescriptions: + - Unused. + - Trigger is healthy. + - Trigger is temporarily paused. + - Trigger is cancelled and can not be resumed. + displayName: type: string - description: The unique finding id. - createTime: - description: Timestamp when finding was detected. + description: Display name (max 100 chars) + description: + description: User provided description (max 256 chars) type: string - format: google-datetime - description: Represents a piece of potentially sensitive content. - id: GooglePrivacyDlpV2Finding - type: object - GooglePrivacyDlpV2LDiversityResult: - id: GooglePrivacyDlpV2LDiversityResult - description: Result of the l-diversity computation. - properties: - sensitiveValueFrequencyHistogramBuckets: - type: array - description: >- - Histogram of l-diversity equivalence class sensitive value - frequencies. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityHistogramBucket' - type: object - GooglePrivacyDlpV2ImageLocation: - description: Location of the finding within an image. - type: object - properties: - boundingBoxes: + errors: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2BoundingBox' + $ref: '#/components/schemas/GooglePrivacyDlpV2Error' description: >- - Bounding boxes locating the pixels within the image containing the - finding. + 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 - id: GooglePrivacyDlpV2ImageLocation - GooglePrivacyDlpV2NumericalStatsResult: - id: GooglePrivacyDlpV2NumericalStatsResult - description: Result of the numerical stats computation. + 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. + id: GooglePrivacyDlpV2JobTrigger type: object + GooglePrivacyDlpV2QuasiId: + id: GooglePrivacyDlpV2QuasiId + description: A column with a semantic tag attached. properties: - minValue: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: Minimum value appearing in the column. - quantileValues: - description: >- - List of 99 values that partition the set of field values into 100 - equal sized buckets. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - maxValue: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: Maximum value appearing in the column. - GooglePrivacyDlpV2CloudStorageFileSet: - description: Message representing a set of files in Cloud Storage. - properties: - url: + 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 + inferred: description: >- - The url, in the format `gs:///`. Trailing wildcard in the path is - allowed. - type: object - id: GooglePrivacyDlpV2CloudStorageFileSet - GooglePrivacyDlpV2RecordSuppression: - description: >- - Configuration to suppress records whose suppression conditions evaluate - to true. - id: GooglePrivacyDlpV2RecordSuppression - type: object - properties: - condition: - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordCondition' + If no semantic tag is indicated, we infer the statistical model from + the distribution of values in the input data + $ref: '#/components/schemas/GoogleProtobufEmpty' + infoType: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' description: >- - A condition that when it evaluates to true will result in the record - being evaluated to be suppressed from the transformed content. - GooglePrivacyDlpV2CloudSqlProperties: - id: GooglePrivacyDlpV2CloudSqlProperties + A column can be tagged with a InfoType to use the relevant public + dataset as a statistical model of population, if available. We + currently support US ZIP codes, region codes, ages and genders. To + programmatically obtain the list of supported InfoTypes, use + ListInfoTypes with the supported_by=RISK_ANALYSIS filter. type: object - description: Cloud SQL connection properties. + GooglePrivacyDlpV2VersionDescription: properties: - databaseEngine: - 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. + version: + description: Name of the version type: string - description: >- - Required. The database engine used by the Cloud SQL instance that - this connection configures. - usernamePassword: - $ref: '#/components/schemas/GooglePrivacyDlpV2SecretManagerCredential' - description: A username and password stored in Secret Manager. - maxConnections: - type: integer - description: >- - Required. DLP will limit its connections to max_connections. Must be - 2 or greater. - format: int32 - cloudSqlIam: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlIamCredential' - description: Built-in IAM authentication (must be configured in Cloud SQL). - connectionName: - 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` + description: + description: Description of the version. type: string - GooglePrivacyDlpV2VersionDescription: id: GooglePrivacyDlpV2VersionDescription description: Details about each available version for an infotype. type: object + GooglePrivacyDlpV2TransformationErrorHandling: properties: - version: - type: string - description: Name of the version - description: - type: string - description: Description of the version. - GooglePrivacyDlpV2KMapEstimationConfig: + leaveUntransformed: + description: Ignore errors + $ref: '#/components/schemas/GooglePrivacyDlpV2LeaveUntransformed' + throwError: + description: Throw an error + $ref: '#/components/schemas/GooglePrivacyDlpV2ThrowError' 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`. + GooglePrivacyDlpV2BucketingConfig: + type: object + id: GooglePrivacyDlpV2BucketingConfig properties: - quasiIds: + buckets: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2TaggedField' + $ref: '#/components/schemas/GooglePrivacyDlpV2Bucket' type: array + description: Set of buckets. Ranges must be non-overlapping. + 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. + GooglePrivacyDlpV2DataProfileJobConfig: + type: object + 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 + properties: + location: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileLocation' + description: The data to scan. + projectId: description: >- - Required. Fields considered to be quasi-identifiers. No two columns - can have the same tag. - 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. + 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 - auxiliaryTables: + dataProfileActions: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2AuxiliaryTable' + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileAction' + description: Actions to execute at the completion of the job. type: array + inspectTemplates: + items: + type: string 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. - id: 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. - GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog: + 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. + type: array + GooglePrivacyDlpV2BigQueryTable: + properties: + 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. 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 - properties: {} - id: GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog - type: object - GooglePrivacyDlpV2Color: + 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 + `..`. type: object - description: Represents a color in the RGB color space. - properties: - 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]. - id: GooglePrivacyDlpV2Color - GooglePrivacyDlpV2ExclusionRule: + id: GooglePrivacyDlpV2BigQueryTable + GooglePrivacyDlpV2ListConnectionsResponse: + id: GooglePrivacyDlpV2ListConnectionsResponse type: object properties: - excludeInfoTypes: - $ref: '#/components/schemas/GooglePrivacyDlpV2ExcludeInfoTypes' - description: Set of infoTypes for which findings would affect this rule. - matchingType: - 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 - description: How the rule is applied, see MatchingType documentation for details. - enum: - - MATCHING_TYPE_UNSPECIFIED - - MATCHING_TYPE_FULL_MATCH - - MATCHING_TYPE_PARTIAL_MATCH - - MATCHING_TYPE_INVERSE_MATCH + connections: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + description: List of connections. + type: array + nextPageToken: type: string - regex: - $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' - description: Regular expression which defines the rule. - 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' - dictionary: - $ref: '#/components/schemas/GooglePrivacyDlpV2Dictionary' - description: Dictionary which defines the rule. - description: >- - The rule that specifies conditions when findings of infoTypes specified - in `InspectionRuleSet` are removed from results. - id: GooglePrivacyDlpV2ExclusionRule - GooglePrivacyDlpV2DiscoveryTableModifiedCadence: + Token to retrieve the next page of results. An empty value means + there are no more results. + description: Response message for ListConnections. + GooglePrivacyDlpV2InfoTypeTransformations: + type: object properties: - 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: >- - How frequently data profiles can be updated when tables are - modified. Defaults to never. - enum: - - UPDATE_FREQUENCY_UNSPECIFIED - - UPDATE_FREQUENCY_NEVER - - UPDATE_FREQUENCY_DAILY - - UPDATE_FREQUENCY_MONTHLY - type: string - types: + transformations: type: array 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/GooglePrivacyDlpV2InfoTypeTransformation' 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 - id: GooglePrivacyDlpV2DiscoveryTableModifiedCadence - description: The cadence at which to update data profiles when a table is modified. - GooglePrivacyDlpV2RedactImageRequest: - id: GooglePrivacyDlpV2RedactImageRequest + Required. Transformation for each infoType. Cannot specify more than + one for a given infoType. + 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 + GooglePrivacyDlpV2Export: type: object + id: GooglePrivacyDlpV2Export properties: - locationId: - type: string - description: Deprecated. This field has no effect. - inspectConfig: - description: Configuration for the inspector. - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' - imageRedactionConfigs: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ImageRedactionConfig' - type: array - description: The configuration for specifying what content to redact from images. - includeFindings: - type: boolean + profileTable: 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. + 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. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' description: >- - Request to search for potentially sensitive info in an image and redact - it by covering it with a colored rectangle. - GooglePrivacyDlpV2BigQueryDiscoveryTarget: - description: Target used to match against for discovery with BigQuery tables + If set, the detailed data profiles will be persisted to the location of + your choice whenever updated. + GooglePrivacyDlpV2QuoteInfo: 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/GooglePrivacyDlpV2DiscoveryBigQueryFilter' - conditions: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryBigQueryConditions' - description: >- - In addition to matching the filter, these conditions must be true - before a profile is generated. - disabled: - $ref: '#/components/schemas/GooglePrivacyDlpV2Disabled' - description: Tables that match this filter will not have profiles created. - 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' - id: GooglePrivacyDlpV2BigQueryDiscoveryTarget - type: object - GooglePrivacyDlpV2Container: - description: >- - Represents a container that may contain DLP findings. Examples of a - container include a file, table, or database record. + 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: GooglePrivacyDlpV2Container + GooglePrivacyDlpV2SummaryResult: + id: GooglePrivacyDlpV2SummaryResult properties: - type: - description: Container type, for example BigQuery or Cloud Storage. - type: string - projectId: - description: >- - Project where the finding was found. Can be different from the - project that owns the finding. - type: string - version: - type: string - description: >- - Findings container version, if available ("generation" for Cloud - Storage). - 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 - fullPath: - description: >- - A string representation of the full container name. Examples: - - BigQuery: 'Project:DataSetId.TableId' - Cloud Storage: - 'gs://Bucket/folders/filename.txt' + details: type: string - updateTime: - format: google-datetime 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. + A place for warnings or errors to show up if a transformation didn't + work as expected. + code: + enum: + - TRANSFORMATION_RESULT_CODE_UNSPECIFIED + - SUCCESS + - ERROR + enumDescriptions: + - Unused + - Transformation completed without an error. + - Transformation had an error. type: string - relativePath: + description: Outcome of the transformation. + count: + format: int64 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` - GooglePrivacyDlpV2Disabled: - id: GooglePrivacyDlpV2Disabled - type: object - properties: {} - description: Do not profile the tables. - GooglePrivacyDlpV2DiscoveryTarget: - id: GooglePrivacyDlpV2DiscoveryTarget - description: Target used to match against for Discovery. - properties: - bigQueryTarget: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryDiscoveryTarget' - description: >- - BigQuery target for Discovery. The first target to match a table - will be the one applied. - secretsTarget: - $ref: '#/components/schemas/GooglePrivacyDlpV2SecretsDiscoveryTarget' - 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. - cloudSqlTarget: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlDiscoveryTarget' - description: >- - Cloud SQL target for Discovery. The first target to match a table - will be the one applied. + description: Number of transformations counted by this result. type: object - GooglePrivacyDlpV2WordList: - type: object - id: 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 - description: Message defining a list of words or phrases to search for in the data. - GooglePrivacyDlpV2FileSet: - properties: - 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' - 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 - description: Set of files to scan. - id: GooglePrivacyDlpV2FileSet - type: object - GooglePrivacyDlpV2KMapEstimationHistogramBucket: - type: object - id: GooglePrivacyDlpV2KMapEstimationHistogramBucket - 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: - type: string - format: int64 - description: >- - Total number of distinct quasi-identifier tuple values in this - bucket. - bucketSize: - description: Number of records within these anonymity bounds. - format: int64 - type: string - minAnonymity: - type: string - format: int64 - description: Always positive. - maxAnonymity: - format: int64 - type: string - description: Always greater than or equal to min_anonymity. - 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. - GooglePrivacyDlpV2DataRiskLevel: - properties: - score: - description: The score applied to the resource. - enum: - - RISK_SCORE_UNSPECIFIED - - RISK_LOW - - 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. - - >- - 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. - type: string - type: object - description: >- - Score is a summary of all elements in the data profile. A higher number - means more risk. - id: GooglePrivacyDlpV2DataRiskLevel - GooglePrivacyDlpV2SensitivityScore: - description: >- - Score is calculated from of all elements in the data profile. A higher - level means the data is more sensitive. + description: >- + A collection that informs the user the number of times a particular + `TransformationResultCode` and error details occurred. + GooglePrivacyDlpV2SensitivityScore: + description: >- + Score is calculated from of all elements in the data profile. A higher + level means the data is more sensitive. type: object + id: GooglePrivacyDlpV2SensitivityScore properties: score: + description: The sensitivity score applied to the resource. type: string enumDescriptions: - Unused. @@ -3187,1220 +2804,1355 @@ components: 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: - SENSITIVITY_SCORE_UNSPECIFIED - SENSITIVITY_LOW - SENSITIVITY_MODERATE - SENSITIVITY_HIGH - id: GooglePrivacyDlpV2SensitivityScore - GooglePrivacyDlpV2CategoricalStatsResult: - id: GooglePrivacyDlpV2CategoricalStatsResult - description: Result of the categorical stats computation. + GooglePrivacyDlpV2InspectConfig: properties: - valueFrequencyHistogramBuckets: - type: array - description: Histogram of value frequencies in the column. + minLikelihoodPerInfoType: items: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CategoricalStatsHistogramBucket - type: object - GooglePrivacyDlpV2BigQueryKey: - description: Row key for identifying a record in BigQuery table. - type: object - id: GooglePrivacyDlpV2BigQueryKey - properties: - tableReference: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - description: Complete BigQuery table reference. - rowNumber: - type: string - format: int64 + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeLikelihood' + type: array 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`. - GooglePrivacyDlpV2Key: - id: GooglePrivacyDlpV2Key - properties: - partitionId: + 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. + ruleSet: + type: array description: >- - Entities are partitioned into subsets, currently identified by a - project ID and namespace ID. Queries are scoped to a single - partition. - $ref: '#/components/schemas/GooglePrivacyDlpV2PartitionId' - path: + Set of rules to apply to the findings for this InspectConfig. + Exclusion rules, contained in the set are executed in the end, other + rules are executed in the order they are specified for each info + type. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2PathElement' - 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. - type: array - 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 - GooglePrivacyDlpV2CreateConnectionRequest: - type: object - id: GooglePrivacyDlpV2CreateConnectionRequest - properties: - connection: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' - description: Required. The connection resource. - description: Request message for CreateConnection. - GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues: - id: GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues - type: object - properties: - estimatedProbability: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectionRuleSet' + limits: 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. - type: number - format: double - quasiIdsValues: + 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: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + $ref: '#/components/schemas/GooglePrivacyDlpV2CustomInfoType' type: array - description: The quasi-identifier values. - description: A tuple of values for the quasi-identifier columns. - GooglePrivacyDlpV2Proximity: - description: >- - Message for specifying a window around a finding to apply a detection - rule. - id: GooglePrivacyDlpV2Proximity - properties: - windowAfter: - type: integer - format: int32 - description: Number of characters after the finding to consider. - windowBefore: 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). - type: integer - format: int32 - type: object - GooglePrivacyDlpV2DatabaseResourceRegexes: - type: object - properties: - patterns: + CustomInfoTypes provided by the user. See + https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes + to learn more. + includeQuote: + type: boolean 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. + 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. + contentOptions: + description: Deprecated and unused. + items: + enumDescriptions: + - Includes entire content of a file or a data stream. + - Text content within the data, excluding any metadata. + - Images found in the data. + enum: + - CONTENT_UNSPECIFIED + - CONTENT_TEXT + - CONTENT_IMAGE + type: string + type: array + infoTypes: type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceRegex' - id: GooglePrivacyDlpV2DatabaseResourceRegexes - description: >- - A collection of regular expressions to determine what database resources - to match against. - GooglePrivacyDlpV2SchemaModifiedCadence: - description: >- - How frequently to modify the profile when the table's schema is - modified. - properties: - types: - type: array - items: - enum: - - SQL_SCHEMA_MODIFICATION_UNSPECIFIED - - NEW_COLUMNS - - REMOVED_COLUMNS - type: string - enumDescriptions: - - Unused. - - New columns have appeared. - - Columns have been removed from the table. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' description: >- - The types of schema modifications to consider. Defaults to - NEW_COLUMNS. - frequency: + 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. + excludeInfoTypes: + type: boolean + description: >- + When true, excludes type information of the findings. This is not + used for data profiling. + minLikelihood: 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: >- - Frequency to regenerate data profiles when the schema is modified. - Defaults to monthly. - type: string - enum: - - UPDATE_FREQUENCY_UNSPECIFIED - - UPDATE_FREQUENCY_NEVER - - UPDATE_FREQUENCY_DAILY - - UPDATE_FREQUENCY_MONTHLY - type: object - id: GooglePrivacyDlpV2SchemaModifiedCadence - GooglePrivacyDlpV2PubSubExpressions: - properties: - logicalOperator: + 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). enum: - - LOGICAL_OPERATOR_UNSPECIFIED - - OR - - AND + - LIKELIHOOD_UNSPECIFIED + - VERY_UNLIKELY + - UNLIKELY + - POSSIBLE + - LIKELY + - VERY_LIKELY type: string - description: The operator to apply to the collection of conditions. - enumDescriptions: - - Unused. - - Conditional OR. - - Conditional AND. - conditions: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubCondition' - description: Conditions to apply to the expression. - type: array - description: An expression, consisting of an operator and conditions. - id: GooglePrivacyDlpV2PubSubExpressions + description: >- + Configuration description of the scanning process. When used with + redactContent only info_types and min_likelihood are currently used. type: object - GooglePrivacyDlpV2InfoTypeSummary: + id: GooglePrivacyDlpV2InspectConfig + GooglePrivacyDlpV2InspectTemplate: type: object - description: The infoType details for this column. - id: GooglePrivacyDlpV2InfoTypeSummary + id: GooglePrivacyDlpV2InspectTemplate properties: - estimatedPrevalence: - deprecated: true - format: int32 - description: Not populated for predicted infotypes. - type: integer - infoType: - description: The infoType. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - GooglePrivacyDlpV2Manual: - type: object + displayName: + type: string + description: Display name (max 256 chars). + updateTime: + format: google-datetime + type: string + description: Output only. The last update timestamp of an inspectTemplate. + readOnly: true + description: + type: string + description: Short description (max 256 chars). + inspectConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + description: >- + The core content of the template. Configuration of the scanning + process. + createTime: + type: string + readOnly: true + format: google-datetime + description: Output only. The creation timestamp of an inspectTemplate. + 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: >- - Job trigger option for hybrid jobs. Jobs must be manually created and - finished. - id: GooglePrivacyDlpV2Manual - properties: {} - GooglePrivacyDlpV2DataProfilePubSubMessage: + 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. + GooglePrivacyDlpV2Dictionary: type: object - 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. - id: GooglePrivacyDlpV2DataProfilePubSubMessage + id: GooglePrivacyDlpV2Dictionary properties: - event: - type: string - 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. - profile: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' + cloudStoragePath: + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStoragePath' 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. - GooglePrivacyDlpV2CreateStoredInfoTypeRequest: + Newline-delimited file of words in Cloud Storage. Only a single file + is accepted. + wordList: + $ref: '#/components/schemas/GooglePrivacyDlpV2WordList' + description: List of words or phrases to search for. + 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. + GooglePrivacyDlpV2BigQueryTableCollection: + description: Specifies a collection of BigQuery tables. Used for Discovery. type: object - id: GooglePrivacyDlpV2CreateStoredInfoTypeRequest - description: Request message for CreateStoredInfoType. properties: - locationId: - type: string - description: Deprecated. This field has no effect. - config: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeConfig' - description: Required. Configuration of the storedInfoType to create. - storedInfoTypeId: - type: string + includeRegexes: 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. - GooglePrivacyDlpV2InspectionRule: - properties: - exclusionRule: - $ref: '#/components/schemas/GooglePrivacyDlpV2ExclusionRule' - description: Exclusion rule. - hotwordRule: - $ref: '#/components/schemas/GooglePrivacyDlpV2HotwordRule' - description: Hotword-based detection rule. - type: object + A collection of regular expressions to match a BigQuery table + against. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryRegexes' + id: GooglePrivacyDlpV2BigQueryTableCollection + GooglePrivacyDlpV2TimespanConfig: description: >- - A single inspection rule to be applied to infoTypes, specified in - `InspectionRuleSet`. - id: GooglePrivacyDlpV2InspectionRule - GooglePrivacyDlpV2ListConnectionsResponse: - description: Response message for ListConnections. + Configuration of the timespan of the items to include in scanning. + Currently only supported when inspecting Cloud Storage and BigQuery. + type: object properties: - nextPageToken: + endTime: + format: google-datetime description: >- - Token to retrieve the next page of results. An empty value means - there are no more results. + Exclude files, tables, or rows newer than this value. If not set, no + upper time limit is applied. type: string - connections: - description: List of connections. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' - type: object - id: GooglePrivacyDlpV2ListConnectionsResponse - GooglePrivacyDlpV2StoredInfoTypeVersion: - id: GooglePrivacyDlpV2StoredInfoTypeVersion - properties: - config: - description: StoredInfoType configuration. - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeConfig' - errors: + startTime: + type: string + format: google-datetime 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 - 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 + Exclude files, tables, or rows older than this value. If not set, no + lower time limit is applied. + enableAutoPopulationOfTimespanConfig: description: >- - Stored info type version state. Read-only, updated by the system - during dictionary creation. - type: string - createTime: + 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 + timestampField: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' description: >- - Create timestamp of the version. Read-only, determined by the system - when the version is created. - type: string - format: google-datetime - stats: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeStats' - description: Statistics about this storedInfoType version. - type: object - description: >- - Version of a StoredInfoType, including the configuration used to build - it, create timestamp, and current state. - GooglePrivacyDlpV2ColumnDataProfile: + 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. + id: GooglePrivacyDlpV2TimespanConfig + GooglePrivacyDlpV2InfoTypeCategory: type: object - description: The profile for a scanned column within a table. properties: - estimatedNullPercentage: - description: Approximate percentage of entries being null in the column. - enumDescriptions: - - Unused. - - Very few null entries. - - Some null entries. - - A few null entries. - - A lot of null entries. - enum: - - NULL_PERCENTAGE_LEVEL_UNSPECIFIED - - NULL_PERCENTAGE_VERY_LOW - - NULL_PERCENTAGE_LOW - - NULL_PERCENTAGE_MEDIUM - - NULL_PERCENTAGE_HIGH - type: string - otherMatches: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2OtherInfoTypeSummary' - description: Other types found within this column. List will be unordered. - type: array - 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. - type: number - format: double - profileStatus: - $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' + locationCategory: description: >- - Success or error status from the most recent profile generation - attempt. May be empty if the profile is still being generated. - policyState: + The region or country that issued the ID or document represented by + the infoType. type: string enumDescriptions: - - No policy tags. - - Column has policy tag applied. - enum: - - COLUMN_POLICY_STATE_UNSPECIFIED - - COLUMN_POLICY_TAGGED - description: Indicates if a policy tag has been applied to the column. - tableDataProfile: - description: The resource name of the table data profile. - type: string - datasetId: - description: The BigQuery dataset ID. - type: string - datasetProjectId: - description: The Google Cloud project ID that owns the profiled resource. - type: string - sensitivityScore: - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - description: The sensitivity of this column. - tableFullResource: - description: The resource name of the resource this column is within. - type: string - column: - description: The name of the column. - type: string - dataRiskLevel: - description: The data risk level for this column. - $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' - columnType: - type: string + - 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 Australia. + - The infoType is typically used in Azerbaijan. + - 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: - - 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 - description: The data type of a given column. + - LOCATION_UNSPECIFIED + - GLOBAL + - ARGENTINA + - AUSTRALIA + - AZERBAIJAN + - 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: + description: >- + The group of relevant businesses where this infoType is commonly + used 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.' - profileLastGenerated: - description: The last time the profile was generated. - format: google-datetime - type: string - tableId: - description: The BigQuery table ID. - type: string - name: + - 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 name of the profile. - estimatedUniquenessScore: + enum: + - INDUSTRY_UNSPECIFIED + - FINANCE + - HEALTH + - TELECOMMUNICATIONS + typeCategory: type: string - description: Approximate uniqueness of the column. + description: The class of identifiers where this infoType belongs enum: - - UNIQUENESS_SCORE_LEVEL_UNSPECIFIED - - UNIQUENESS_SCORE_LOW - - UNIQUENESS_SCORE_MEDIUM - - UNIQUENESS_SCORE_HIGH + - TYPE_UNSPECIFIED + - PII + - SPII + - DEMOGRAPHIC + - CREDENTIAL + - GOVERNMENT_ID + - DOCUMENT + - CONTEXTUAL_INFORMATION enumDescriptions: + - Unused type - >- - Some columns do not have estimated uniqueness. Possible reasons - include having too few values. + Personally identifiable information, for example, a name or phone + number - >- - Low uniqueness, possibly a boolean, enum or similiarly typed - column. - - Medium uniqueness. + Personally identifiable information that is especially sensitive, + for example, a passport number. - >- - High uniqueness, possibly a column of free text or unique - identifiers. - 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' - datasetLocation: + 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: >- + Classification of infoTypes to organize them according to geographic + location, industry, and data type. + id: GooglePrivacyDlpV2InfoTypeCategory + GooglePrivacyDlpV2ImageTransformations: + type: object + id: GooglePrivacyDlpV2ImageTransformations + description: A type of transformation that is applied over images. + properties: + transforms: + description: List of transforms to make. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2ImageTransformation' + 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 + id: GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig + properties: + cryptoKey: + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' + description: Required. The key used by the encryption algorithm. + customAlphabet: description: >- - The BigQuery location where the dataset's data is stored. See - https://cloud.google.com/bigquery/docs/locations for supported - locations. + 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 - state: - description: State of a profile. - enum: - - STATE_UNSPECIFIED - - RUNNING - - DONE + 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: + type: integer + format: int32 + description: The native way to select the alphabet. Must be in the range [2, 95]. + surrogateInfoType: + 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' + commonAlphabet: 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. + - '`[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 - id: GooglePrivacyDlpV2ColumnDataProfile - GooglePrivacyDlpV2RecordLocation: - description: Location of a finding within a row or record. + description: Common alphabets. + enum: + - FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED + - NUMERIC + - HEXADECIMAL + - UPPER_CASE_ALPHA_NUMERIC + - ALPHA_NUMERIC + GooglePrivacyDlpV2KMapEstimationResult: + description: >- + Result of the reidentifiability analysis. Note that these results are an + estimation, not exact values. + id: GooglePrivacyDlpV2KMapEstimationResult properties: - fieldId: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: Field id of the field containing the finding. - recordKey: - description: Key of the finding. - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordKey' - tableLocation: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableLocation' - description: Location within a `ContentItem.Table`. - id: GooglePrivacyDlpV2RecordLocation + 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 - GooglePrivacyDlpV2TableOptions: - description: Instructions regarding the table content being inspected. + GooglePrivacyDlpV2DocumentLocation: + id: GooglePrivacyDlpV2DocumentLocation properties: - identifyingFields: + fileOffset: + format: int64 + type: string 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' - type: array - id: GooglePrivacyDlpV2TableOptions + 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 - GooglePrivacyDlpV2ReidentifyContentRequest: + GooglePrivacyDlpV2ReplaceValueConfig: + description: Replace each input value with a given `Value`. + properties: + newValue: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + description: Value to replace it with. type: object - description: Request to re-identify an item. + id: GooglePrivacyDlpV2ReplaceValueConfig + GooglePrivacyDlpV2BigQueryRegex: + id: GooglePrivacyDlpV2BigQueryRegex properties: - locationId: + projectIdRegex: type: string - description: Deprecated. This field has no effect. - reidentifyConfig: - 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` - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' - inspectConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' - description: Configuration for the inspector. - 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. + For organizations, if unset, will match all projects. Has no effect + for data profile configurations created within a project. + datasetIdRegex: type: string - 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. + description: If unset, this property matches all datasets. + tableIdRegex: + description: If unset, this property matches all tables. type: string - item: - description: The item to re-identify. Will be treated as text. - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' - id: GooglePrivacyDlpV2ReidentifyContentRequest - GooglePrivacyDlpV2ListTableDataProfilesResponse: + 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 + GooglePrivacyDlpV2UpdateConnectionRequest: + description: Request message for UpdateConnection. + type: object properties: - nextPageToken: - description: The next page token. + connection: + description: Required. The connection with new values for the relevant fields. + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + updateMask: type: string - tableDataProfiles: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' - type: array - description: List of data profiles. - id: GooglePrivacyDlpV2ListTableDataProfilesResponse + description: Optional. Mask to control which fields get updated. + format: google-fieldmask + id: GooglePrivacyDlpV2UpdateConnectionRequest + GooglePrivacyDlpV2TimePartConfig: + properties: + partToExtract: + enum: + - TIME_PART_UNSPECIFIED + - YEAR + - MONTH + - DAY_OF_MONTH + - DAY_OF_WEEK + - WEEK_OF_YEAR + - HOUR_OF_DAY + enumDescriptions: + - Unused + - '[0-9999]' + - '[1-12]' + - '[1-31]' + - '[1-7]' + - '[1-53]' + - '[0-23]' + type: string + 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. type: object - description: List of profiles generated for a given organization or project. - GooglePrivacyDlpV2DeidentifyContentResponse: - id: GooglePrivacyDlpV2DeidentifyContentResponse - description: Results of de-identifying a ContentItem. + GooglePrivacyDlpV2CryptoKey: + 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. 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`. - GooglePrivacyDlpV2DeidentifyConfig: - type: object - id: GooglePrivacyDlpV2DeidentifyConfig - description: The configuration that controls how the data will change. + unwrapped: + description: Unwrapped crypto key + $ref: '#/components/schemas/GooglePrivacyDlpV2UnwrappedCryptoKey' + kmsWrapped: + $ref: '#/components/schemas/GooglePrivacyDlpV2KmsWrappedCryptoKey' + description: Key wrapped using Cloud KMS + transient: + description: Transient crypto key + $ref: '#/components/schemas/GooglePrivacyDlpV2TransientCryptoKey' + GooglePrivacyDlpV2LargeCustomDictionaryConfig: properties: - infoTypeTransformations: + outputPath: + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStoragePath' description: >- - Treat the dataset as free-form text and apply the same free text - transformation everywhere. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeTransformations' - imageTransformations: - $ref: '#/components/schemas/GooglePrivacyDlpV2ImageTransformations' - description: Treat the dataset as an image and redact. - transformationErrorHandling: - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationErrorHandling' + 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. + cloudStorageFileSet: + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageFileSet' description: >- - Mode for handling transformation errors. If left unspecified, the - default mode is `TransformationErrorHandling.ThrowError`. - recordTransformations: + Set of files containing newline-delimited lists of dictionary + phrases. + bigQueryField: description: >- - Treat the dataset as structured. Transformations can be applied to - specific locations within structured datasets, such as transforming - a column within a table. - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordTransformations' - GooglePrivacyDlpV2HotwordRule: - id: GooglePrivacyDlpV2HotwordRule + Field in a BigQuery table where each cell represents a dictionary + phrase. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryField' + 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 + GooglePrivacyDlpV2InfoTypeStats: + id: GooglePrivacyDlpV2InfoTypeStats + description: Statistics regarding a specific InfoType. + type: object properties: - hotwordRegex: - $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' - description: Regular expression pattern defining what qualifies as a hotword. - likelihoodAdjustment: - description: Likelihood adjustment to apply to all matching findings. - $ref: '#/components/schemas/GooglePrivacyDlpV2LikelihoodAdjustment' - proximity: - 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). - $ref: '#/components/schemas/GooglePrivacyDlpV2Proximity' + infoType: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + description: The type of finding this stat is for. + count: + type: string + description: Number of findings for this infoType. + format: int64 + GooglePrivacyDlpV2InspectionRuleSet: type: object description: >- - The rule that adjusts the likelihood of findings within a certain - proximity of hotwords. - GooglePrivacyDlpV2Deidentify: + 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: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + description: List of infoTypes this rule set is applied to. + rules: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectionRule' + description: >- + Set of rules to be applied to infoTypes. The rules are applied in + order. + type: array + id: GooglePrivacyDlpV2InspectionRuleSet + GooglePrivacyDlpV2RedactConfig: 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 + Redact a given value. For example, if used with an + `InfoTypeTransformation` transforming PHONE_NUMBER, and input 'My phone + number is 206-555-0123', the output would be 'My phone number is '. + id: GooglePrivacyDlpV2RedactConfig + properties: {} + GooglePrivacyDlpV2ImageRedactionConfig: 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 - transformationDetailsStorageConfig: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2TransformationDetailsStorageConfig + redactAllText: + type: boolean 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: - type: string - 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: array + If true, all text found in the image, regardless whether it matches + an info_type, is redacted. Only one should be provided. + redactionColor: description: >- - List of user-specified file type groups to transform. If specified, - only the files with these filetypes 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 - filetypes supported are: IMAGES, TEXT_FILES, CSV, TSV. - transformationConfig: + 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: >- - User specified deidentify templates and configs for structured, - unstructured, and image files. - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationConfig' - id: GooglePrivacyDlpV2Deidentify - GooglePrivacyDlpV2BigQueryTable: - id: GooglePrivacyDlpV2BigQueryTable + 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. type: object + id: GooglePrivacyDlpV2ImageRedactionConfig + description: Configuration for determining how redaction of images should occur. + GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket: + type: object + id: GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket 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 - `..`. + 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. properties: - tableId: - type: string - description: Name of the table. - datasetId: - description: Dataset ID of the table. + minProbability: + description: Between 0 and 1. + format: double + type: number + bucketSize: + description: Number of records within these probability bounds. type: string - projectId: + format: int64 + bucketValueCount: + format: int64 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. - 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); } - GooglePrivacyDlpV2Table: - properties: - rows: - type: array - description: Rows of the table. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Row' - headers: + Total number of distinct quasi-identifier tuple values in this + bucket. + bucketValues: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: Headers of the table. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues + description: >- + Sample of quasi-identifier tuple values in this bucket. The total + number of classes returned per bucket is capped at 20. type: array + maxProbability: + type: number + format: double + description: Always greater than or equal to min_probability. + GooglePrivacyDlpV2DiscoveryCloudSqlFilter: + id: GooglePrivacyDlpV2DiscoveryCloudSqlFilter + properties: + 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. + collection: + $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceCollection' + description: A specific set of database resources for this filter to apply to. + databaseResourceReference: + description: >- + The database resource to scan. Targets including this can only + include one target (the target with this database resource + reference). + $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceReference' type: object 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 + 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. + GooglePrivacyDlpV2CryptoHashConfig: + 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. - id: GooglePrivacyDlpV2Table - GooglePrivacyDlpV2TransformationDetailsStorageConfig: - properties: - table: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - 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. type: object - description: Config for storing transformation details. - id: GooglePrivacyDlpV2TransformationDetailsStorageConfig - 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. properties: - hotwordRule: - $ref: '#/components/schemas/GooglePrivacyDlpV2HotwordRule' - description: Hotword-based detection rule. - id: GooglePrivacyDlpV2DetectionRule - type: object + cryptoKey: + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' + description: The key used by the hash function. GooglePrivacyDlpV2KMapEstimationQuasiIdValues: - id: GooglePrivacyDlpV2KMapEstimationQuasiIdValues properties: estimatedAnonymity: format: int64 - type: string description: The estimated anonymity for these quasi-identifier values. + type: string quasiIdsValues: type: array + description: The quasi-identifier values. items: $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: The quasi-identifier values. - type: object description: A tuple of values for the quasi-identifier columns. - GooglePrivacyDlpV2TransformationLocation: + id: GooglePrivacyDlpV2KMapEstimationQuasiIdValues + type: object + GooglePrivacyDlpV2TimeZone: properties: - recordTransformation: - 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. - enum: - - TRANSFORM_UNKNOWN_CONTAINER - - TRANSFORM_BODY - - TRANSFORM_METADATA - - TRANSFORM_TABLE - enumDescriptions: - - Unused. - - Body of a file. - - Metadata for a file. - - A table. - findingId: + offsetMinutes: + format: int32 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). - type: string - description: Specifies the location of a transformation. + 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 + id: GooglePrivacyDlpV2TimeZone + description: Time zone of the date time object. + GooglePrivacyDlpV2RedactImageRequest: type: object - id: GooglePrivacyDlpV2TransformationLocation - GooglePrivacyDlpV2Regex: properties: - pattern: + byteItem: + $ref: '#/components/schemas/GooglePrivacyDlpV2ByteContentItem' + description: The content must be PNG, JPEG, SVG or BMP. + includeFindings: + type: boolean 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. + Whether the response should include findings along with the redacted + image. + inspectConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + description: Configuration for the inspector. + locationId: type: string - groupIndexes: + description: Deprecated. This field has no effect. + imageRedactionConfigs: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2ImageRedactionConfig' type: array + description: The configuration for specifying what content to redact from images. + id: GooglePrivacyDlpV2RedactImageRequest + description: >- + Request to search for potentially sensitive info in an image and redact + it by covering it with a colored rectangle. + GooglePrivacyDlpV2CategoricalStatsConfig: + type: object + properties: + field: description: >- - The index of the submatch to extract as findings. When not - specified, the entire match is returned. No more than 3 may be - included. - items: - format: int32 - type: integer + 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' + description: >- + Compute numerical stats over an individual column, including number of + distinct values and value count distribution. + id: GooglePrivacyDlpV2CategoricalStatsConfig + GooglePrivacyDlpV2SecretsDiscoveryTarget: + id: GooglePrivacyDlpV2SecretsDiscoveryTarget + type: object + 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. + GooglePrivacyDlpV2KAnonymityConfig: type: object - id: GooglePrivacyDlpV2Regex - description: Message defining a custom regular expression. - GooglePrivacyDlpV2ImageTransformation: - id: GooglePrivacyDlpV2ImageTransformation properties: - redactionColor: + quasiIds: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' description: >- - The color to use when redacting content from an image. If not - specified, the default is black. - $ref: '#/components/schemas/GooglePrivacyDlpV2Color' - allText: - $ref: '#/components/schemas/GooglePrivacyDlpV2AllText' + 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: array + entityId: description: >- - Apply transformation to all text that doesn't match an infoType. - Only one instance is allowed within the ImageTransformations - message. - selectedInfoTypes: - description: Apply transformation to the selected info_types. - $ref: '#/components/schemas/GooglePrivacyDlpV2SelectedInfoTypes' - allInfoTypes: - $ref: '#/components/schemas/GooglePrivacyDlpV2AllInfoTypes' + 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. + $ref: '#/components/schemas/GooglePrivacyDlpV2EntityId' + id: GooglePrivacyDlpV2KAnonymityConfig + description: k-anonymity metric, used for analysis of reidentification risk. + GooglePrivacyDlpV2DeidentifyDataSourceDetails: + description: The results of a Deidentify action from an inspect job. + type: object + id: GooglePrivacyDlpV2DeidentifyDataSourceDetails + properties: + requestedOptions: + $ref: '#/components/schemas/GooglePrivacyDlpV2RequestedDeidentifyOptions' + description: De-identification config used for the request. + deidentifyStats: + description: Stats about the de-identification operation. + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyDataSourceStats' + GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues: + description: A tuple of values for the quasi-identifier columns. + type: object + properties: + estimatedProbability: + type: number + format: double description: >- - Apply transformation to all findings not specified in other - ImageTransformation's selected_info_types. Only one instance is - allowed within the ImageTransformations message. - description: Configuration for determining how redaction of images should occur. + 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: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + description: The quasi-identifier values. + type: array + id: GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues + GooglePrivacyDlpV2DatastoreOptions: + description: Options defining a data set within Google Cloud Datastore. + type: object + id: GooglePrivacyDlpV2DatastoreOptions + properties: + partitionId: + 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' + kind: + description: The kind to process. + $ref: '#/components/schemas/GooglePrivacyDlpV2KindExpression' + GooglePrivacyDlpV2PubSubExpressions: + id: GooglePrivacyDlpV2PubSubExpressions + properties: + conditions: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubCondition' + description: Conditions to apply to the expression. + logicalOperator: + description: The operator to apply to the collection of conditions. + enumDescriptions: + - Unused. + - Conditional OR. + - Conditional AND. + type: string + enum: + - LOGICAL_OPERATOR_UNSPECIFIED + - OR + - AND + description: An expression, consisting of an operator and conditions. + type: object + GooglePrivacyDlpV2LDiversityResult: type: object - GooglePrivacyDlpV2InspectContentResponse: - description: Results of inspecting an item. properties: - result: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectResult' - description: The findings. + sensitiveValueFrequencyHistogramBuckets: + description: >- + Histogram of l-diversity equivalence class sensitive value + frequencies. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityHistogramBucket' + type: array + description: Result of the l-diversity computation. + id: GooglePrivacyDlpV2LDiversityResult + GooglePrivacyDlpV2CloudStoragePath: + properties: + path: + type: string + description: >- + A URL representing a file or path (no wildcards) in Cloud Storage. + Example: `gs://[BUCKET_NAME]/dictionary.txt` type: object - id: GooglePrivacyDlpV2InspectContentResponse - GooglePrivacyDlpV2NumericalStatsConfig: - description: >- - Compute numerical stats over an individual column, including min, max, - and quantiles. + description: Message representing a single file or path in Cloud Storage. + id: GooglePrivacyDlpV2CloudStoragePath + GooglePrivacyDlpV2CloudSqlDiscoveryTarget: type: object + description: Target used to match against for discovery with Cloud SQL tables. properties: - field: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + generationCadence: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence description: >- - Field to compute numerical stats on. Supported types are integer, - float, date, datetime, timestamp, time. - id: GooglePrivacyDlpV2NumericalStatsConfig - GooglePrivacyDlpV2CreateJobTriggerRequest: + 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. + conditions: + description: >- + In addition to matching the filter, these conditions must be true + before a profile is generated. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryCloudSqlConditions' + disabled: + description: Disable profiling for database resources that match this filter. + $ref: '#/components/schemas/GooglePrivacyDlpV2Disabled' + 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' + id: GooglePrivacyDlpV2CloudSqlDiscoveryTarget + GooglePrivacyDlpV2Connection: type: object - id: GooglePrivacyDlpV2CreateJobTriggerRequest properties: - triggerId: + name: + readOnly: true 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. - jobTrigger: - description: Required. The JobTrigger to create. - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' - locationId: + Output only. Name of the connection: + `projects/{project}/locations/{location}/connections/{name}`. + cloudSql: + description: Connect to a Cloud SQL instance. + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlProperties' + state: + enum: + - CONNECTION_STATE_UNSPECIFIED + - MISSING_CREDENTIALS + - AVAILABLE + - ERROR + 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 - description: Deprecated. This field has no effect. - description: Request message for CreateJobTrigger. - GooglePrivacyDlpV2DataProfileJobConfig: - id: GooglePrivacyDlpV2DataProfileJobConfig + description: Required. The connection's state in its lifecycle. + errors: + description: >- + Output only. Set if status == ERROR, to provide additional details. + Will store the last 10 errors sorted with the most recent first. + type: array + readOnly: true + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Error' + id: GooglePrivacyDlpV2Connection 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). + A data connection to allow DLP to profile data in locations that require + additional configuration. + GooglePrivacyDlpV2Row: + description: Values of the row. + properties: + values: + description: Individual cells. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + type: array + id: GooglePrivacyDlpV2Row type: object + GooglePrivacyDlpV2StoredInfoType: properties: - inspectTemplates: + name: + type: string + description: Resource name. + currentVersion: + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeVersion' + description: Current version of the stored info type. + pendingVersions: + description: >- + Pending versions of the stored info type. Empty if no versions are + pending. type: array items: - type: string + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeVersion' + type: object + id: GooglePrivacyDlpV2StoredInfoType + description: >- + StoredInfoType resource message that contains information about the + current version and any pending updates. + GooglePrivacyDlpV2DeltaPresenceEstimationResult: + type: object + properties: + deltaPresenceEstimationHistogram: 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. - dataProfileActions: + The intervals [min_probability, max_probability) do not overlap. If + a value doesn't correspond to any such interval, the associated + frequency is zero. For example, the following records: + {min_probability: 0, max_probability: 0.1, frequency: 17} + {min_probability: 0.2, max_probability: 0.3, frequency: 42} + {min_probability: 0.3, max_probability: 0.4, frequency: 99} mean + that there are no record with an estimated probability in [0.1, 0.2) + nor larger or equal to 0.4. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileAction' - description: Actions to execute at the completion of the job. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket type: array - 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: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileLocation' - description: The data to scan. - GooglePrivacyDlpV2InfoTypeLimit: + description: >- + Result of the δ-presence computation. Note that these results are an + estimation, not exact values. + id: GooglePrivacyDlpV2DeltaPresenceEstimationResult + GooglePrivacyDlpV2Proximity: + description: >- + Message for specifying a window around a finding to apply a detection + rule. + id: GooglePrivacyDlpV2Proximity + type: object properties: - infoType: + windowBefore: 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: - description: Max findings limit for the given infoType. + 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). type: integer format: int32 - description: >- - Max findings configuration per infoType, per content item or long - running DlpJob. - type: object - id: GooglePrivacyDlpV2InfoTypeLimit - GooglePrivacyDlpV2DataSourceType: - description: Message used to identify the type of resource being profiled. + windowAfter: + format: int32 + type: integer + description: Number of characters after the finding to consider. + GooglePrivacyDlpV2Key: properties: - dataSource: - type: string - readOnly: true + path: description: >- - Output only. An identifying string to the type of resource being - profiled. Current values: google/bigquery/table, google/project + The entity path. An entity path consists of one or more elements + composed of a kind and a string or numerical identifier, which + identify entities. The first element identifies a _root entity_, the + second element identifies a _child_ of the root entity, the third + element identifies a child of the second entity, and so forth. The + entities identified by all prefixes of the path are called the + element's _ancestors_. A path can never be empty, and a path can + have at most 100 elements. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2PathElement' + type: array + 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. + id: GooglePrivacyDlpV2Key type: object - id: GooglePrivacyDlpV2DataSourceType - GooglePrivacyDlpV2PubSubCondition: - description: A condition consisting of a value. - id: GooglePrivacyDlpV2PubSubCondition + GooglePrivacyDlpV2DataRiskLevel: properties: - minimumRiskScore: - type: string + score: enumDescriptions: - Unused. - - High risk/sensitivity detected. - - Medium or high risk/sensitivity detected. - description: The minimum data risk score that triggers the condition. - enum: - - PROFILE_SCORE_BUCKET_UNSPECIFIED - - HIGH - - MEDIUM_OR_HIGH - minimumSensitivityScore: - description: The minimum sensitivity level that triggers the condition. + - >- + Low risk - Lower indication of sensitive data that appears to have + additional access restrictions in place or no indication of + sensitive data found. + - >- + 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. type: string - enumDescriptions: - - Unused. - - High risk/sensitivity detected. - - Medium or high risk/sensitivity detected. enum: - - PROFILE_SCORE_BUCKET_UNSPECIFIED - - HIGH - - MEDIUM_OR_HIGH + - RISK_SCORE_UNSPECIFIED + - RISK_LOW + - RISK_MODERATE + - RISK_HIGH + description: The score applied to the resource. + description: >- + Score is a summary of all elements in the data profile. A higher number + means more risk. type: object - GooglePrivacyDlpV2PublishToStackdriver: + id: GooglePrivacyDlpV2DataRiskLevel + GooglePrivacyDlpV2AllOtherBigQueryTables: + id: GooglePrivacyDlpV2AllOtherBigQueryTables + 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. properties: {} type: object - description: >- - Enable Stackdriver metric dlp.googleapis.com/finding_count. This will - publish a metric to stack driver on each infotype requested and how many - findings were found for it. CustomDetectors will be bucketed as 'Custom' - under the Stackdriver label 'info_type'. - id: GooglePrivacyDlpV2PublishToStackdriver - GooglePrivacyDlpV2FixedSizeBucketingConfig: + GooglePrivacyDlpV2DeidentifyDataSourceStats: + properties: + transformationErrorCount: + description: Number of errors encountered while trying to apply transformations. + format: int64 + type: string + transformationCount: + format: int64 + type: string + description: Number of successfully applied transformations. + transformedBytes: + type: string + format: int64 + description: Total size in bytes that were transformed in some way. + id: GooglePrivacyDlpV2DeidentifyDataSourceStats + description: Summary of what was modified during a transformation. + type: object + GooglePrivacyDlpV2ColumnDataProfile: + description: The profile for a scanned column within a table. + id: GooglePrivacyDlpV2ColumnDataProfile type: object - 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. - id: GooglePrivacyDlpV2FixedSizeBucketingConfig properties: - 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+". - lowerBound: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + datasetId: + type: string + description: The BigQuery dataset ID. + estimatedUniquenessScore: + enum: + - UNIQUENESS_SCORE_LEVEL_UNSPECIFIED + - UNIQUENESS_SCORE_LOW + - UNIQUENESS_SCORE_MEDIUM + - UNIQUENESS_SCORE_HIGH + description: Approximate uniqueness of the column. + type: string + 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. + column: + type: string + description: The name of the column. + freeTextScore: 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: + 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. type: number - 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 - GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails: - id: GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails - properties: - deltaPresenceEstimationResult: - description: Delta-presence result - $ref: '#/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationResult' - categoricalStatsResult: - description: Categorical stats result - $ref: '#/components/schemas/GooglePrivacyDlpV2CategoricalStatsResult' - lDiversityResult: - description: L-divesity result - $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityResult' - requestedOptions: - description: The configuration used for this job. - $ref: '#/components/schemas/GooglePrivacyDlpV2RequestedRiskAnalysisOptions' - kMapEstimationResult: - $ref: '#/components/schemas/GooglePrivacyDlpV2KMapEstimationResult' - description: K-map result - requestedPrivacyMetric: - $ref: '#/components/schemas/GooglePrivacyDlpV2PrivacyMetric' - description: Privacy metric to compute. - requestedSourceTable: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - description: Input dataset to compute metrics over. - numericalStatsResult: - description: Numerical stats result - $ref: '#/components/schemas/GooglePrivacyDlpV2NumericalStatsResult' - kAnonymityResult: - $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityResult' - description: K-anonymity result - type: object - description: Result of a risk analysis operation request. - GooglePrivacyDlpV2TableDataProfile: - properties: - 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' - datasetLocation: + policyState: + enumDescriptions: + - No policy tags. + - Column has policy tag applied. + description: Indicates if a policy tag has been applied to the column. + enum: + - COLUMN_POLICY_STATE_UNSPECIFIED + - COLUMN_POLICY_TAGGED type: string + datasetLocation: description: >- - If supported, the location where the dataset's data is stored. See + The BigQuery location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported locations. - lastModifiedTime: - type: string - format: google-datetime - description: The time when this table was last modified - projectDataProfile: - description: The resource name to the project data profile for this table. type: string 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. - scannedColumnCount: - type: string - format: int64 - description: The number of columns profiled in the table. - predictedInfoTypes: + otherMatches: type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeSummary' - description: The infoTypes predicted from this table's data. + $ref: '#/components/schemas/GooglePrivacyDlpV2OtherInfoTypeSummary' + description: Other types found within this column. List will be unordered. datasetProjectId: + description: The Google Cloud project ID that owns the profiled resource. type: string - description: The Google Cloud project ID that owns the resource. - tableId: + profileLastGenerated: + format: google-datetime type: string - description: If the resource is BigQuery, the BigQuery table ID. - createTime: + description: The last time the profile was generated. + tableFullResource: + description: The resource name of the resource this column is within. type: string - description: The time at which the table was created. - format: google-datetime - failedColumnCount: + columnType: type: string - format: int64 - description: The number of columns skipped in the table because of an error. + 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 + sensitivityScore: + description: The sensitivity of this column. + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + dataRiskLevel: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' + description: The data risk level for this column. name: - type: string description: The name of the profile. - 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. + 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. state: + description: State of a profile. enumDescriptions: - Unused. - >- @@ -4409,1654 +4161,1960 @@ components: - >- 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 - profileLastGenerated: - description: The last time the profile was generated. - format: google-datetime - type: string - configSnapshot: - description: The snapshot of the configurations used to generate the profile. - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileConfigSnapshot' - resourceVisibility: - description: How broadly a resource has been shared. - enum: - - RESOURCE_VISIBILITY_UNSPECIFIED - - RESOURCE_VISIBILITY_PUBLIC - - RESOURCE_VISIBILITY_INCONCLUSIVE - - RESOURCE_VISIBILITY_RESTRICTED type: string + estimatedNullPercentage: 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. - - Visible only to specific users. - expirationTime: - format: google-datetime - description: Optional. The time when this table expires. + - 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. + enum: + - NULL_PERCENTAGE_LEVEL_UNSPECIFIED + - NULL_PERCENTAGE_VERY_LOW + - NULL_PERCENTAGE_LOW + - NULL_PERCENTAGE_MEDIUM + - NULL_PERCENTAGE_HIGH type: string - tableSizeBytes: - description: The size of the table when the profile was generated. + tableId: + type: string + description: The BigQuery table ID. + tableDataProfile: + type: string + description: The resource name of the table data profile. + GooglePrivacyDlpV2SurrogateType: + properties: {} + id: GooglePrivacyDlpV2SurrogateType + 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`. + GooglePrivacyDlpV2ListProjectDataProfilesResponse: + description: List of profiles generated for a given organization or project. + type: object + id: GooglePrivacyDlpV2ListProjectDataProfilesResponse + properties: + projectDataProfiles: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2ProjectDataProfile' + description: List of data profiles. + nextPageToken: + type: string + description: The next page token. + GooglePrivacyDlpV2TableLocation: + type: object + id: GooglePrivacyDlpV2TableLocation + description: Location of a finding within a table. + properties: + rowIndex: 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 - datasetId: - description: If the resource is BigQuery, the dataset ID. + GooglePrivacyDlpV2Conditions: + properties: + conditions: + description: A collection of conditions. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Condition' + description: A collection of conditions. + type: object + id: GooglePrivacyDlpV2Conditions + GooglePrivacyDlpV2KAnonymityHistogramBucket: + id: GooglePrivacyDlpV2KAnonymityHistogramBucket + properties: + equivalenceClassSizeLowerBound: type: string - otherInfoTypes: - description: Other infoTypes found in this table's data. + description: Lower bound on the size of the equivalence classes in this bucket. + format: int64 + equivalenceClassSizeUpperBound: + type: string + description: Upper bound on the size of the equivalence classes in this bucket. + format: int64 + bucketValueCount: + format: int64 + type: string + description: Total number of distinct equivalence classes in this bucket. + bucketSize: + description: Total number of equivalence classes in this bucket. + type: string + format: int64 + bucketValues: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityEquivalenceClass' + type: array + 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. + GooglePrivacyDlpV2DataProfileAction: + id: GooglePrivacyDlpV2DataProfileAction + description: A task to execute when a data profile has been generated. + properties: + pubSubNotification: + description: Publish a message into the Pub/Sub topic. + $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubNotification' + exportData: + $ref: '#/components/schemas/GooglePrivacyDlpV2Export' + description: Export data profiles into a provided location. + type: object + GooglePrivacyDlpV2JobNotificationEmails: + id: GooglePrivacyDlpV2JobNotificationEmails + 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). + properties: {} + GooglePrivacyDlpV2ImageLocation: + description: Location of the finding within an image. + properties: + boundingBoxes: type: array + description: >- + Bounding boxes locating the pixels within the image containing the + finding. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2OtherInfoTypeSummary' - resourceLabels: - additionalProperties: - type: string + $ref: '#/components/schemas/GooglePrivacyDlpV2BoundingBox' + id: GooglePrivacyDlpV2ImageLocation + type: object + GooglePrivacyDlpV2NumericalStatsResult: + properties: + quantileValues: + description: >- + List of 99 values that partition the set of field values into 100 + equal sized buckets. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + type: array + maxValue: + description: Maximum value appearing in the column. + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + minValue: + description: Minimum value appearing in the column. + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + id: GooglePrivacyDlpV2NumericalStatsResult + type: object + description: Result of the numerical stats computation. + GooglePrivacyDlpV2TransientCryptoKey: + id: GooglePrivacyDlpV2TransientCryptoKey + type: object + properties: + name: + type: string + 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). + description: >- + Use this to have a random data crypto key generated. It will be + discarded after the request finishes. + GooglePrivacyDlpV2CharacterMaskConfig: + description: >- + Partially mask a string by replacing a given number of characters with a + fixed character. Masking can start from the beginning or end of the + string. This can be used on data of any type (numbers, longs, and so on) + and when de-identifying structured data we'll attempt to preserve the + original data's type. (This allows you to take a long like 123 and + modify it to a string like **3. + id: GooglePrivacyDlpV2CharacterMaskConfig + type: object + properties: + 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 + numberToMask: + type: integer + format: int32 description: >- - The labels applied to the resource at the time the profile was - generated. - type: object - dataSourceType: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataSourceType' - description: The resource type that was profiled. - fullResource: + 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-****-****-****`. + reverseOrder: description: >- - The resource name of the resource profiled. - https://cloud.google.com/apis/design/resource_names#full_resource_name - type: string - rowCount: - type: string - format: int64 + 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 + charactersToIgnore: + type: array description: >- - Number of rows in the table when the profile was generated. This - will not be populated for BigLake tables. - id: GooglePrivacyDlpV2TableDataProfile - type: object - description: The profile for a scanned table. - GooglePrivacyDlpV2BigQueryTableCollection: - id: GooglePrivacyDlpV2BigQueryTableCollection + 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/GooglePrivacyDlpV2CharsToIgnore' + GooglePrivacyDlpV2ImageTransformation: + id: GooglePrivacyDlpV2ImageTransformation properties: - includeRegexes: + selectedInfoTypes: + $ref: '#/components/schemas/GooglePrivacyDlpV2SelectedInfoTypes' + description: Apply transformation to the selected info_types. + allInfoTypes: + $ref: '#/components/schemas/GooglePrivacyDlpV2AllInfoTypes' description: >- - A collection of regular expressions to match a BigQuery table - against. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryRegexes' - description: Specifies a collection of BigQuery tables. Used for Discovery. - type: object - GooglePrivacyDlpV2EntityId: - id: GooglePrivacyDlpV2EntityId + Apply transformation to all findings not specified in other + ImageTransformation's selected_info_types. Only one instance is + allowed within the ImageTransformations message. + 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' + description: Configuration for determining how redaction of images should occur. 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. - properties: - field: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: Composite key indicating which field contains the entity identifier. - GooglePrivacyDlpV2TaggedField: - description: A column with a semantic tag attached. + GooglePrivacyDlpV2InfoType: type: object - id: GooglePrivacyDlpV2TaggedField + description: Type of information detected by the API. 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 - customTag: + version: + description: Optional version name for this InfoType. type: string + sensitivityScore: 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: - description: Required. Identifies the column. - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - infoType: + Optional custom sensitivity for this InfoType. This only applies to + data profiling. + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + name: + type: string 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' - GooglePrivacyDlpV2RequestedOptions: + 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}`. + id: GooglePrivacyDlpV2InfoType + GooglePrivacyDlpV2CategoricalStatsHistogramBucket: properties: - jobConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' - description: Inspect config. - snapshotInspectTemplate: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + bucketValueCount: + type: string + description: Total number of distinct values in this bucket. + format: int64 + valueFrequencyLowerBound: + format: int64 + description: Lower bound on the value frequency of the values in this bucket. + type: string + bucketValues: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2ValueFrequency' description: >- - If run with an InspectTemplate, a snapshot of its state at the time - of this run. + Sample of value frequencies in this bucket. The total number of + values returned per bucket is capped at 20. + type: array + valueFrequencyUpperBound: + description: Upper bound on the value frequency of the values in this bucket. + format: int64 + type: string + bucketSize: + description: Total number of values in this bucket. + format: int64 + type: string + id: GooglePrivacyDlpV2CategoricalStatsHistogramBucket + description: Histogram of value frequencies in the column. type: object - id: GooglePrivacyDlpV2RequestedOptions - description: Snapshot of the inspection configuration. - 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. + GooglePrivacyDlpV2DiscoverySchemaModifiedCadence: + description: The cadence at which to update data profiles when a schema is modified. type: object properties: - buckets: - description: Set of buckets. Ranges must be non-overlapping. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Bucket' - type: array - id: GooglePrivacyDlpV2BucketingConfig - GooglePrivacyDlpV2ListDeidentifyTemplatesResponse: - description: Response message for ListDeidentifyTemplates. - id: GooglePrivacyDlpV2ListDeidentifyTemplatesResponse - properties: - nextPageToken: + 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: >- - If the next page is available then the next page token to be used in - the following ListDeidentifyTemplates request. - deidentifyTemplates: + How frequently profiles may be updated when schemas are modified. + Defaults to monthly. + types: type: array - description: >- - List of deidentify templates, up to page_size in - ListDeidentifyTemplatesRequest. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' - type: object - GooglePrivacyDlpV2TimePartConfig: - type: object - description: >- - For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a - portion of the value. + type: string + enum: + - SCHEMA_MODIFICATION_UNSPECIFIED + - SCHEMA_NEW_COLUMNS + - SCHEMA_REMOVED_COLUMNS + 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. + 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. + id: GooglePrivacyDlpV2DiscoverySchemaModifiedCadence + GooglePrivacyDlpV2Range: properties: - partToExtract: + start: type: string - enum: - - TIME_PART_UNSPECIFIED - - YEAR - - MONTH - - DAY_OF_MONTH - - DAY_OF_WEEK - - WEEK_OF_YEAR - - HOUR_OF_DAY - enumDescriptions: - - Unused - - '[0-9999]' - - '[1-12]' - - '[1-31]' - - '[1-7]' - - '[1-53]' - - '[0-23]' - description: The part of the time to keep. - id: GooglePrivacyDlpV2TimePartConfig - GooglePrivacyDlpV2DeidentifyContentRequest: - description: Request to de-identify a ContentItem. + description: Index of the first character of the range (inclusive). + format: int64 + end: + format: int64 + type: string + description: Index of the last character of the range (exclusive). + id: GooglePrivacyDlpV2Range + description: Generic half-open interval [start, end) type: object - id: GooglePrivacyDlpV2DeidentifyContentRequest + GooglePrivacyDlpV2AllText: + description: Apply to all text. + properties: {} + type: object + id: GooglePrivacyDlpV2AllText + GooglePrivacyDlpV2CloudSqlIamCredential: + type: object + properties: {} + id: 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. + GooglePrivacyDlpV2LDiversityEquivalenceClass: + id: GooglePrivacyDlpV2LDiversityEquivalenceClass + description: The set of columns' values that share the same ldiversity value. properties: - inspectConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' - description: >- - Configuration for the inspector. Items specified here will override - the template referenced by the inspect_template_name argument. - deidentifyTemplateName: - 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. - item: - 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' - locationId: + equivalenceClassSize: + format: int64 type: string - description: Deprecated. This field has no effect. - 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. + description: Size of the k-anonymity equivalence class. + topSensitiveValues: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2ValueFrequency' + description: Estimated frequencies of top sensitive values. + numDistinctSensitiveValues: + description: Number of distinct sensitive values in this equivalence class. + format: int64 type: string - deidentifyConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' + quasiIdsValues: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + type: array description: >- - Configuration for the de-identification of the content item. Items - specified here will override the template referenced by the - deidentify_template_name argument. - GooglePrivacyDlpV2QuoteInfo: - properties: - dateTime: - $ref: '#/components/schemas/GooglePrivacyDlpV2DateTime' - description: The date time indicated by the quote. + Quasi-identifier values defining the k-anonymity equivalence class. + The order is always the same as the original request. type: object - id: GooglePrivacyDlpV2QuoteInfo - description: Message for infoType-dependent details parsed from quote. - GooglePrivacyDlpV2Dictionary: - id: GooglePrivacyDlpV2Dictionary + GooglePrivacyDlpV2RecordSuppression: + description: >- + Configuration to suppress records whose suppression conditions evaluate + to true. properties: - cloudStoragePath: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStoragePath' + condition: 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. + 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' + id: GooglePrivacyDlpV2RecordSuppression type: object - GooglePrivacyDlpV2Location: - id: GooglePrivacyDlpV2Location - description: Specifies the location of the finding. + GooglePrivacyDlpV2LDiversityHistogramBucket: type: object properties: - container: - description: >- - Information about the container where this finding occurred, if - available. - $ref: '#/components/schemas/GooglePrivacyDlpV2Container' - 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' - codepointRange: + bucketValues: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityEquivalenceClass' 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' - contentLocations: + Sample of equivalence classes in this bucket. The total number of + classes returned per bucket is capped at 20. + sensitiveValueFrequencyLowerBound: 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 - GooglePrivacyDlpV2CloudStorageOptions: - description: Options defining a file or a set of files within a Cloud Storage bucket. - properties: - sampleMethod: - enum: - - SAMPLE_METHOD_UNSPECIFIED - - TOP - - RANDOM_START - description: How to sample the data. - 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. + Lower bound on the sensitive value frequencies of the equivalence + classes in this bucket. type: string - fileTypes: - type: array + format: int64 + bucketValueCount: + description: Total number of distinct equivalence classes in this bucket. + format: int64 + type: string + bucketSize: + type: string + description: Total number of equivalence classes in this bucket. + format: int64 + sensitiveValueFrequencyUpperBound: 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'. - 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. - type: string - enum: - - FILE_TYPE_UNSPECIFIED - - BINARY_FILE - - TEXT_FILE - - IMAGE - - WORD - - PDF - - AVRO - - CSV - - TSV - - POWERPOINT - - EXCEL - bytesLimitPerFile: + Upper bound on the sensitive value frequencies of the equivalence + classes in this bucket. + type: string + format: int64 + id: GooglePrivacyDlpV2LDiversityHistogramBucket + description: Histogram of l-diversity equivalence class sensitive value frequencies. + GooglePrivacyDlpV2SelectedInfoTypes: + properties: + infoTypes: + description: >- + Required. InfoTypes to apply the transformation to. Required. + Provided InfoType must be unique within the ImageTransformations + message. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + type: array + description: Apply transformation to the selected info_types. + id: GooglePrivacyDlpV2SelectedInfoTypes + type: object + GooglePrivacyDlpV2TransformationLocation: + properties: + recordTransformation: + description: >- + For record transformations, provide a field and container + information. + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordTransformation' + findingId: type: string 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). - format: int64 - bytesLimitPerFilePercent: - type: integer + 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). + containerType: + type: string + enumDescriptions: + - Unused. + - Body of a file. + - Metadata for a file. + - A table. 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). + Information about the functionality of the container where this + finding occurred, if available. + enum: + - TRANSFORM_UNKNOWN_CONTAINER + - TRANSFORM_BODY + - TRANSFORM_METADATA + - TRANSFORM_TABLE + description: Specifies the location of a transformation. + id: GooglePrivacyDlpV2TransformationLocation + type: object + GooglePrivacyDlpV2DetectionRule: + properties: + hotwordRule: + description: Hotword-based detection rule. + $ref: '#/components/schemas/GooglePrivacyDlpV2HotwordRule' + 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: GooglePrivacyDlpV2DetectionRule + 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 - filesLimitPercent: + 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. format: int32 type: integer + month: 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. - fileSet: - $ref: '#/components/schemas/GooglePrivacyDlpV2FileSet' - description: The set of one or more files to scan. - type: object - id: GooglePrivacyDlpV2CloudStorageOptions - GooglePrivacyDlpV2KMapEstimationResult: - description: >- - Result of the reidentifiability analysis. Note that these results are an - estimation, not exact values. - id: GooglePrivacyDlpV2KMapEstimationResult + 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 + GooglePrivacyDlpV2TransformationDetailsStorageConfig: type: object + description: Config for storing transformation details. + id: GooglePrivacyDlpV2TransformationDetailsStorageConfig properties: - kMapEstimationHistogram: - items: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2KMapEstimationHistogramBucket + table: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' 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 - GooglePrivacyDlpV2PartitionId: - id: GooglePrivacyDlpV2PartitionId + 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. + GooglePrivacyDlpV2DataProfileConfigSnapshot: properties: - namespaceId: + inspectTemplateName: 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. + description: Name of the inspection template used to generate this profile + dataProfileJob: + 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' + deprecated: true + 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. + inspectTemplateModifiedTime: + description: Timestamp when the template was modified + type: string + format: google-datetime + id: GooglePrivacyDlpV2DataProfileConfigSnapshot + description: Snapshot of the configurations used to generate the profile. + type: object + GooglePrivacyDlpV2PubSubNotification: + properties: + topic: + type: string + description: >- + Cloud Pub/Sub topic to send notifications to. Format is + projects/{project}/topics/{topic}. + detailOfMessage: + 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 + type: string + enumDescriptions: + - Unused. + - The full table data profile. + - The name of the profiled resource. + event: type: string + 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. + - 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. + pubsubCondition: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfilePubSubCondition' + description: >- + Conditions (e.g., data risk or sensitivity level) for triggering a + Pub/Sub. + id: GooglePrivacyDlpV2PubSubNotification + type: object 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. + 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`. + GooglePrivacyDlpV2BigQueryField: + id: GooglePrivacyDlpV2BigQueryField + properties: + field: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: Designated field in the BigQuery table. + table: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + description: Source table of the field. + type: object + description: Message defining a field of a BigQuery table. + GooglePrivacyDlpV2ExcludeInfoTypes: + properties: + 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' + id: GooglePrivacyDlpV2ExcludeInfoTypes + description: List of excluded infoTypes. type: object - GooglePrivacyDlpV2HybridContentItem: + GooglePrivacyDlpV2PathElement: description: >- - An individual hybrid item to inspect. Will be stored temporarily during - processing. - type: object - id: GooglePrivacyDlpV2HybridContentItem - properties: - item: - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' - description: The item to inspect. - findingDetails: - description: Supplementary information that will be added to each finding. - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridFindingDetails' - GooglePrivacyDlpV2DlpJob: + 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. properties: - jobTriggerName: - type: string + id: + format: int64 description: >- - If created by a job trigger, the resource name of the trigger that - instantiated the job. - name: - type: string - description: The server-assigned name. - errors: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Error' - description: A stream of errors encountered running the job. - type: array - inspectDetails: - description: Results from inspecting a data source. - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectDataSourceDetails' - endTime: - description: Time when the job finished. - format: google-datetime - type: string - type: - type: string - description: The type of job. - 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 - createTime: - type: string - format: google-datetime - description: Time when the job was created. - riskDetails: - description: Results from analyzing risk of a data source. - $ref: '#/components/schemas/GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails' - startTime: + 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. type: string - format: google-datetime - description: Time when the job started. - actionDetails: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ActionDetails' - type: array - description: Events that should occur after the job has completed. - state: - enum: - - JOB_STATE_UNSPECIFIED - - PENDING - - RUNNING - - DONE - - CANCELED - - FAILED - - ACTIVE + kind: + 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 - description: State of a job. - 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. - lastModified: + name: type: string - format: google-datetime - description: Time when the job was last modified by the system. - id: GooglePrivacyDlpV2DlpJob - description: Combines all of the information about a DLP job. + description: >- + The name of the entity. A name matching regex `__.*__` is + reserved/read-only. A name must not be more than 1500 bytes when + UTF-8 encoded. Cannot be `""`. + type: object + id: GooglePrivacyDlpV2PathElement + GooglePrivacyDlpV2UnwrappedCryptoKey: type: object - GooglePrivacyDlpV2TransformationSummary: properties: - infoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: Set if the transformation was limited to a specific InfoType. - transformedBytes: - format: int64 - description: Total size in bytes that were transformed in some way. + key: type: string - results: + description: Required. A 128/192/256 bit key. + format: byte + id: GooglePrivacyDlpV2UnwrappedCryptoKey + description: >- + Using raw keys is prone to security risks due to accidentally leaking + the key. Choose another type of key if possible. + GooglePrivacyDlpV2CryptoDeterministicConfig: + id: GooglePrivacyDlpV2CryptoDeterministicConfig + 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. + properties: + 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' + 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' + 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. + type: object + GooglePrivacyDlpV2ExcludeByHotword: + id: GooglePrivacyDlpV2ExcludeByHotword + type: object + 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 + 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. + GooglePrivacyDlpV2ListJobTriggersResponse: + description: Response message for ListJobTriggers. + properties: + jobTriggers: type: array - description: Collection of all transformations that took place or had an error. + description: List of triggeredJobs, up to page_size in ListJobTriggersRequest. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2SummaryResult' - recordSuppress: - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordSuppression' - description: The specific suppression option these stats apply to. - fieldTransformations: + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + nextPageToken: + type: string 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. + If the next page is available then this value is the next page token + to be used in the following ListJobTriggers request. + type: object + id: GooglePrivacyDlpV2ListJobTriggersResponse + GooglePrivacyDlpV2ListDlpJobsResponse: + id: GooglePrivacyDlpV2ListDlpJobsResponse + properties: + jobs: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldTransformation' + $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' type: array - transformation: - $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' - description: The specific transformation these stats apply to. - field: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: Set if the transformation was limited to a specific FieldId. - description: >- - Summary of a single transformation. Only one of 'transformation', - 'field_transformation', or 'record_suppress' will be set. - type: object - id: GooglePrivacyDlpV2TransformationSummary - GooglePrivacyDlpV2AllOtherBigQueryTables: + description: A list of DlpJobs that matches the specified filter in the request. + nextPageToken: + type: string + description: The standard List next-page token. + description: The response message for listing DLP jobs. + type: object + GooglePrivacyDlpV2CreateDeidentifyTemplateRequest: + description: Request message for CreateDeidentifyTemplate. + id: GooglePrivacyDlpV2CreateDeidentifyTemplateRequest type: object - 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. - properties: {} - id: GooglePrivacyDlpV2AllOtherBigQueryTables - GooglePrivacyDlpV2CreateInspectTemplateRequest: properties: - locationId: - description: Deprecated. This field has no effect. - type: string - inspectTemplate: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' - description: Required. The InspectTemplate to create. templateId: - type: string 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: GooglePrivacyDlpV2CreateInspectTemplateRequest - type: object - description: Request message for CreateInspectTemplate. - GooglePrivacyDlpV2StoredType: - id: GooglePrivacyDlpV2StoredType - properties: - name: type: string - description: >- - Resource name of the requested `StoredInfoType`, for example - `organizations/433245324/storedInfoTypes/432452342` or - `projects/project-id/storedInfoTypes/432452342`. - createTime: + deidentifyTemplate: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + description: Required. The DeidentifyTemplate to create. + locationId: + description: Deprecated. This field has no effect. type: string + GooglePrivacyDlpV2QuasiIdentifierField: + id: GooglePrivacyDlpV2QuasiIdentifierField + properties: + customTag: description: >- - Timestamp indicating when the version of the `StoredInfoType` used - for inspection was created. Output-only field, populated by the - system. - format: google-datetime - description: A reference to a StoredInfoType to use with scanning. + A column can be tagged with a custom tag. In this case, the user + must indicate an auxiliary table that contains statistical + information on the possible values of this column (below). + type: string + field: + $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. type: object - GooglePrivacyDlpV2TransformationErrorHandling: - id: GooglePrivacyDlpV2TransformationErrorHandling - properties: - leaveUntransformed: - description: Ignore errors - $ref: '#/components/schemas/GooglePrivacyDlpV2LeaveUntransformed' - throwError: - $ref: '#/components/schemas/GooglePrivacyDlpV2ThrowError' - description: Throw an error + GooglePrivacyDlpV2PublishToStackdriver: + id: GooglePrivacyDlpV2PublishToStackdriver type: object 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`. - GooglePrivacyDlpV2InspectTemplate: + 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: {} + GooglePrivacyDlpV2KAnonymityResult: + properties: + equivalenceClassHistogramBuckets: + description: Histogram of k-anonymity equivalence classes. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityHistogramBucket' type: object + id: GooglePrivacyDlpV2KAnonymityResult + description: Result of the k-anonymity computation. + GooglePrivacyDlpV2KMapEstimationHistogramBucket: properties: - description: - description: Short description (max 256 chars). + bucketSize: type: string - inspectConfig: + format: int64 + description: Number of records within these anonymity bounds. + bucketValues: description: >- - The core content of the template. Configuration of the scanning - process. - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' - createTime: - description: Output only. The creation timestamp of an inspectTemplate. + 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' + bucketValueCount: type: string - readOnly: true - format: google-datetime - name: - readOnly: true + format: int64 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`; - type: string - displayName: - description: Display name (max 256 chars). + Total number of distinct quasi-identifier tuple values in this + bucket. + maxAnonymity: + description: Always greater than or equal to min_anonymity. type: string - updateTime: - description: Output only. The last update timestamp of an inspectTemplate. - readOnly: true + format: int64 + minAnonymity: + description: Always positive. type: string - format: google-datetime - 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. - GooglePrivacyDlpV2AllText: - properties: {} - id: GooglePrivacyDlpV2AllText - description: Apply to all text. + format: int64 type: object - GooglePrivacyDlpV2TableLocation: + id: 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. + GooglePrivacyDlpV2InspectJobConfig: 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. - format: int64 + 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. + actions: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Action' + type: array + description: Actions to execute at the completion of the job. + storageConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2StorageConfig' + description: The data to scan. + inspectConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + description: How and what to scan for. + id: GooglePrivacyDlpV2InspectJobConfig type: object - description: Location of a finding within a table. - id: GooglePrivacyDlpV2TableLocation - GooglePrivacyDlpV2DeidentifyDataSourceStats: - description: Summary of what was modified during a transformation. + description: Controls what and how to inspect for findings. + GooglePrivacyDlpV2DiscoveryBigQueryFilter: + properties: + 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' + 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). type: object + id: GooglePrivacyDlpV2DiscoveryBigQueryFilter + 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. + GooglePrivacyDlpV2DatabaseResourceRegex: properties: - transformationCount: + projectIdRegex: type: string - format: int64 - description: Number of successfully applied transformations. - transformationErrorCount: + description: >- + For organizations, if unset, will match all projects. Has no effect + for configurations created within a project. + instanceRegex: + description: >- + Regex to test the instance name against. If empty, all instances + match. type: string - description: Number of errors encountered while trying to apply transformations. - format: int64 - transformedBytes: - description: Total size in bytes that were transformed in some way. - format: int64 + databaseRegex: + description: >- + Regex to test the database name against. If empty, all databases + match. type: string - id: GooglePrivacyDlpV2DeidentifyDataSourceStats - GooglePrivacyDlpV2KindExpression: - description: A representation of a Datastore kind. - type: object - id: GooglePrivacyDlpV2KindExpression - properties: - name: + databaseResourceNameRegex: type: string - description: The name of the kind. - GooglePrivacyDlpV2PrivacyMetric: - id: GooglePrivacyDlpV2PrivacyMetric - description: Privacy metric to compute for reidentification risk analysis. - type: object - properties: - numericalStatsConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2NumericalStatsConfig' - description: Numerical stats - kAnonymityConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityConfig' - description: K-anonymity - categoricalStatsConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2CategoricalStatsConfig' - description: Categorical stats - kMapEstimationConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2KMapEstimationConfig' - description: k-map - lDiversityConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityConfig' - description: l-diversity - deltaPresenceEstimationConfig: - description: delta-presence - $ref: '#/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationConfig' - GooglePrivacyDlpV2UnwrappedCryptoKey: + 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: >- - Using raw keys is prone to security risks due to accidentally leaking - the key. Choose another type of key if possible. + 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. + type: object + id: GooglePrivacyDlpV2DatabaseResourceRegex + GooglePrivacyDlpV2UpdateDiscoveryConfigRequest: + description: Request message for UpdateDiscoveryConfig. type: object + id: GooglePrivacyDlpV2UpdateDiscoveryConfigRequest properties: - key: + discoveryConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + description: Required. New DiscoveryConfig value. + updateMask: + description: Mask to control which fields get updated. type: string - format: byte - description: Required. A 128/192/256 bit key. - id: GooglePrivacyDlpV2UnwrappedCryptoKey - GooglePrivacyDlpV2DiscoveryConfig: + format: google-fieldmask + GooglePrivacyDlpV2CreateDiscoveryConfigRequest: + description: Request message for CreateDiscoveryConfig. + type: object + id: GooglePrivacyDlpV2CreateDiscoveryConfigRequest properties: - displayName: - description: Display name (max 100 chars) + configId: type: string - orgConfig: - description: Only set when the parent is an org. - $ref: '#/components/schemas/GooglePrivacyDlpV2OrgConfig' + 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. + discoveryConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + description: Required. The DiscoveryConfig to create. + GooglePrivacyDlpV2Container: + description: >- + Represents a container that may contain DLP findings. Examples of a + container include a file, table, or database record. + id: GooglePrivacyDlpV2Container + type: object + properties: updateTime: - description: Output only. The last update timestamp of a DiscoveryConfig. format: google-datetime type: string - readOnly: true - targets: description: >- - Target to match against for determining what to scan and how - frequently. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryTarget' - type: array - createTime: + 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: + description: Container type, for example BigQuery or Cloud Storage. type: string - readOnly: true - description: Output only. The creation timestamp of a DiscoveryConfig. - format: google-datetime - 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 - name: + version: type: string 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`. - errors: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Error' - readOnly: true + Findings container version, if available ("generation" for Cloud + Storage). + rootPath: + type: string 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 - lastRunTime: + 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 - readOnly: true - format: google-datetime description: >- - Output only. The timestamp of the last time this config was - executed. - actions: - description: Actions to execute at the completion of scanning. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileAction' - status: + Project where the finding was found. Can be different from the + project that owns the finding. + fullPath: + description: >- + A string representation of the full container name. Examples: - + BigQuery: 'Project:DataSetId.TableId' - Cloud Storage: + 'gs://Bucket/folders/filename.txt' type: string - enumDescriptions: - - Unused - - The discovery config is currently active. - - The discovery config is paused temporarily. - description: Required. A status for this configuration. - enum: - - STATUS_UNSPECIFIED - - RUNNING - - PAUSED - 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). + 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` + GooglePrivacyDlpV2RecordLocation: + id: GooglePrivacyDlpV2RecordLocation + description: Location of a finding within a row or record. + properties: + tableLocation: + $ref: '#/components/schemas/GooglePrivacyDlpV2TableLocation' + description: Location within a `ContentItem.Table`. + fieldId: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: Field id of the field containing the finding. + recordKey: + description: Key of the finding. + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordKey' type: object - id: GooglePrivacyDlpV2DiscoveryConfig - GooglePrivacyDlpV2DataProfileLocation: + GooglePrivacyDlpV2DiscoveryTableModifiedCadence: + id: GooglePrivacyDlpV2DiscoveryTableModifiedCadence type: object - id: GooglePrivacyDlpV2DataProfileLocation + description: The cadence at which to update data profiles when a table is modified. properties: - folderId: + frequency: + 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 - format: int64 - description: The ID of the Folder within an organization to scan. - organizationId: - description: The ID of an organization to scan. + 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 + 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 + 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. + properties: + field: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: >- + Required. Field within the record this condition is evaluated + against. + operator: + description: >- + Required. Operator used to compare the field or infoType to the + value. + enum: + - RELATIONAL_OPERATOR_UNSPECIFIED + - EQUAL_TO + - NOT_EQUAL_TO + - GREATER_THAN + - LESS_THAN + - GREATER_THAN_OR_EQUALS + - LESS_THAN_OR_EQUALS + - EXISTS + 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 type: string - format: int64 - description: The data that will be profiled. - GooglePrivacyDlpV2DiscoveryBigQueryFilter: - id: GooglePrivacyDlpV2DiscoveryBigQueryFilter + value: + description: Value to compare against. [Mandatory, except for `EXISTS` tests.] + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + type: object + id: GooglePrivacyDlpV2Condition + GooglePrivacyDlpV2Action: 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: - 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. - $ref: '#/components/schemas/GooglePrivacyDlpV2AllOtherBigQueryTables' - 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' + jobNotificationEmails: 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. - GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest: - properties: - updateMask: - type: string - format: google-fieldmask - description: Mask to control which fields get updated. - deidentifyTemplate: - description: New DeidentifyTemplate value. - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' - description: Request message for UpdateDeidentifyTemplate. - type: object - id: GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest - GooglePrivacyDlpV2TransformationConfig: + 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). + $ref: '#/components/schemas/GooglePrivacyDlpV2JobNotificationEmails' + saveFindings: + description: Save resulting findings in a provided location. + $ref: '#/components/schemas/GooglePrivacyDlpV2SaveFindings' + deidentify: + $ref: '#/components/schemas/GooglePrivacyDlpV2Deidentify' + description: Create a de-identified copy of the input data. + publishFindingsToCloudDataCatalog: + description: Publish findings to Cloud Datahub. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog + 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' + pubSub: + description: Publish a notification to a Pub/Sub topic. + $ref: '#/components/schemas/GooglePrivacyDlpV2PublishToPubSub' 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. + 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 + GooglePrivacyDlpV2KAnonymityEquivalenceClass: type: object + id: GooglePrivacyDlpV2KAnonymityEquivalenceClass + description: The set of columns' values that share the same ldiversity value properties: - 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. - structuredDeidentifyTemplate: + quasiIdsValues: 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 - deidentifyTemplate: + 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: 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. + Size of the equivalence class, for example number of rows with the + above set of values. + format: int64 type: string - id: GooglePrivacyDlpV2TransformationConfig - GoogleTypeTimeOfDay: + GooglePrivacyDlpV2CreateDlpJobRequest: + id: GooglePrivacyDlpV2CreateDlpJobRequest properties: - nanos: - description: Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - format: int32 - type: integer - seconds: + riskJob: + $ref: '#/components/schemas/GooglePrivacyDlpV2RiskAnalysisJobConfig' 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 - minutes: - format: int32 - description: Minutes of hour of day. Must be from 0 to 59. - type: integer - hours: - format: int32 - type: integer + A risk analysis job calculates re-identification risk metrics for a + BigQuery table. + locationId: + type: string + description: Deprecated. This field has no effect. + inspectJob: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' + description: An inspection job scans a storage repository for InfoTypes. + jobId: + 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. - id: GoogleTypeTimeOfDay + The job id can contain uppercase and lowercase letters, numbers, and + hyphens; that is, it must match the regular expression: + `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty + to allow the system to generate one. + type: object 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`. + Request message for CreateDlpJobRequest. Used to initiate long running + jobs such as calculating risk metrics or inspecting Google Cloud + Storage. + GooglePrivacyDlpV2HybridInspectResponse: + properties: {} type: object - GooglePrivacyDlpV2TransformationOverview: + description: Quota exceeded errors will be thrown once quota has been met. + id: GooglePrivacyDlpV2HybridInspectResponse + GooglePrivacyDlpV2SearchConnectionsResponse: + description: Response message for SearchConnections. + id: GooglePrivacyDlpV2SearchConnectionsResponse type: object - description: Overview of the modifications that occurred. - id: GooglePrivacyDlpV2TransformationOverview properties: - transformedBytes: - description: Total size in bytes that were transformed in some way. - format: int64 + nextPageToken: type: string - transformationSummaries: - type: array + description: >- + Token to retrieve the next page of results. An empty value means + there are no more results. + connections: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationSummary' - description: Transformations applied to the dataset. - GooglePrivacyDlpV2DiscoveryStartingLocation: - type: object - id: GooglePrivacyDlpV2DiscoveryStartingLocation + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + 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 + GooglePrivacyDlpV2PartitionId: properties: - organizationId: + namespaceId: type: string - format: int64 - description: The ID of an organization to scan. - folderId: - description: The ID of the Folder within an organization to scan. + 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 - format: int64 + type: object + id: GooglePrivacyDlpV2PartitionId description: >- - The location to begin a discovery scan. Denotes an organization ID or - folder ID within an organization. - GooglePrivacyDlpV2LDiversityHistogramBucket: + 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. + 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 + GooglePrivacyDlpV2CreateConnectionRequest: + type: object + description: Request message for CreateConnection. + id: GooglePrivacyDlpV2CreateConnectionRequest properties: - bucketValues: - type: array - description: >- - Sample of equivalence classes in this bucket. The total number of - classes returned per bucket is capped at 20. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityEquivalenceClass' - bucketSize: - format: int64 - description: Total number of equivalence classes in this bucket. - type: string - sensitiveValueFrequencyUpperBound: - description: >- - Upper bound on the sensitive value frequencies of the equivalence - classes in this bucket. - type: string - format: int64 - sensitiveValueFrequencyLowerBound: - format: int64 + connection: + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + description: Required. The connection resource. + GooglePrivacyDlpV2UpdateInspectTemplateRequest: + type: object + properties: + inspectTemplate: + description: New InspectTemplate value. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + updateMask: + format: google-fieldmask type: string - description: >- - Lower bound on the sensitive value frequencies of the equivalence - classes in this bucket. - bucketValueCount: + description: Mask to control which fields get updated. + description: Request message for UpdateInspectTemplate. + id: GooglePrivacyDlpV2UpdateInspectTemplateRequest + GooglePrivacyDlpV2ValueFrequency: + id: GooglePrivacyDlpV2ValueFrequency + type: object + properties: + count: + description: How many times the value is contained in the field. type: string format: int64 - description: Total number of distinct equivalence classes in this bucket. + value: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + description: A value contained in the field in question. + description: A value of a field, including its frequency. + GooglePrivacyDlpV2Schedule: type: object - description: Histogram of l-diversity equivalence class sensitive value frequencies. - id: GooglePrivacyDlpV2LDiversityHistogramBucket - GooglePrivacyDlpV2CreateDeidentifyTemplateRequest: + description: Schedule for inspect job triggers. + id: GooglePrivacyDlpV2Schedule properties: - deidentifyTemplate: - description: Required. The DeidentifyTemplate to create. - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' - templateId: + recurrencePeriodDuration: type: string + format: google-duration 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. - locationId: - type: string - description: Deprecated. This field has no effect. - id: GooglePrivacyDlpV2CreateDeidentifyTemplateRequest - description: Request message for CreateDeidentifyTemplate. - type: object - 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 - type: object - properties: {} - id: GooglePrivacyDlpV2PublishSummaryToCscc - GooglePrivacyDlpV2ImageRedactionConfig: + 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. + GooglePrivacyDlpV2InspectionRule: properties: - 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: - 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. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - redactionColor: - description: >- - 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 - type: object - GooglePrivacyDlpV2DatabaseResourceRegex: + exclusionRule: + $ref: '#/components/schemas/GooglePrivacyDlpV2ExclusionRule' + description: Exclusion rule. + hotwordRule: + description: Hotword-based detection rule. + $ref: '#/components/schemas/GooglePrivacyDlpV2HotwordRule' + description: >- + A single inspection rule to be applied to infoTypes, specified in + `InspectionRuleSet`. + id: GooglePrivacyDlpV2InspectionRule type: object - id: GooglePrivacyDlpV2DatabaseResourceRegex + GooglePrivacyDlpV2CreateJobTriggerRequest: properties: - databaseRegex: - type: string - description: >- - Regex to test the database name against. If empty, all databases - match. - databaseResourceNameRegex: - 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. + jobTrigger: + description: Required. The JobTrigger to create. + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + locationId: + description: Deprecated. This field has no effect. type: string - projectIdRegex: + triggerId: type: string description: >- - For organizations, if unset, will match all projects. Has no effect - for configurations created within a project. - instanceRegex: - description: >- - Regex to test the instance name against. If empty, all instances - match. - type: string - 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. - GooglePrivacyDlpV2ReplaceValueConfig: - id: GooglePrivacyDlpV2ReplaceValueConfig - properties: - newValue: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: Value to replace it with. + 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. + description: Request message for CreateJobTrigger. type: object - description: Replace each input value with a given `Value`. - GooglePrivacyDlpV2BigQueryField: + id: GooglePrivacyDlpV2CreateJobTriggerRequest + GooglePrivacyDlpV2SaveFindings: 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. - type: object - id: GooglePrivacyDlpV2BigQueryField - GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig: - id: GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig + outputConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2OutputStorageConfig' + description: Location to store findings outside of DLP. type: object + 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 + GooglePrivacyDlpV2DatabaseResourceReference: + description: Identifies a single database resource, like a table within a database. + id: GooglePrivacyDlpV2DatabaseResourceReference properties: - customAlphabet: + projectId: + type: string 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 - ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + Required. If within a project-level config, then this must match the + config's project ID. + databaseResource: + description: >- + Required. Name of a database resource, for example, a table within + the database. type: string - commonAlphabet: - 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)' + database: + type: string + description: Required. Name of a database within the instance. + instance: type: string - enum: - - FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED - - NUMERIC - - HEXADECIMAL - - UPPER_CASE_ALPHA_NUMERIC - - ALPHA_NUMERIC - description: Common alphabets. - 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' - radix: - type: integer - format: int32 - 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. - 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 - 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. - GooglePrivacyDlpV2LargeCustomDictionaryStats: - id: GooglePrivacyDlpV2LargeCustomDictionaryStats + Required. The instance where this resource is located. For example: + Cloud SQL instance ID. type: object + GooglePrivacyDlpV2TaggedField: properties: - approxNumPhrases: - format: int64 - type: string - description: Approximate number of distinct phrases in the dictionary. - description: Summary statistics of a custom dictionary. - GooglePrivacyDlpV2LDiversityConfig: - properties: - 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' - sensitiveAttribute: + field: + description: Required. Identifies the column. $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: Sensitive field for computing the l-value. - description: l-diversity metric, used for analysis of reidentification risk. + 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). + 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. + 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 + description: A column with a semantic tag attached. + id: GooglePrivacyDlpV2TaggedField type: object - id: GooglePrivacyDlpV2LDiversityConfig - GooglePrivacyDlpV2InfoTypeDescription: - id: GooglePrivacyDlpV2InfoTypeDescription - description: InfoType description. + GooglePrivacyDlpV2Finding: type: object + id: GooglePrivacyDlpV2Finding + description: Represents a piece of potentially sensitive content. properties: - versions: - description: A list of available versions for the infotype. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2VersionDescription' - type: array - sensitivityScore: - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - 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 - description: Which parts of the API supports this InfoType. - type: array + resourceName: + type: string + description: The job that stored the finding. + location: + description: Where the content was found. + $ref: '#/components/schemas/GooglePrivacyDlpV2Location' + likelihood: + enum: + - LIKELIHOOD_UNSPECIFIED + - VERY_UNLIKELY + - UNLIKELY + - POSSIBLE + - LIKELY + - VERY_LIKELY + description: Confidence of how likely it is that the `info_type` is correct. + 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. + jobName: + description: The job that stored the finding. + type: string + triggerName: + type: string + description: Job trigger name, if applicable, for this finding. + findingId: + type: string + description: The unique finding id. + quoteInfo: + $ref: '#/components/schemas/GooglePrivacyDlpV2QuoteInfo' + 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. name: type: string - description: Internal name of the infoType. - categories: - description: The category of the infoType. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeCategory' - description: + description: >- + Resource name in format + projects/{project}/locations/{location}/findings/{finding} Populated + only when viewing persisted findings. + infoType: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + description: >- + The type of content that might have been found. Provided if + `excluded_types` is false. + createTime: type: string + format: google-datetime + description: Timestamp when finding was detected. + labels: description: >- - Description of the infotype. Translated when language is provided in - the request. - displayName: - description: Human readable form of the infoType name. + 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: + format: google-datetime type: string - GooglePrivacyDlpV2FinishDlpJobRequest: - description: The request message for finishing a DLP hybrid job. - id: GooglePrivacyDlpV2FinishDlpJobRequest + description: Time the job started that produced this finding. + 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 + GooglePrivacyDlpV2ReplaceWithInfoTypeConfig: + description: Replace each matching finding with the name of the info_type. + type: object + id: GooglePrivacyDlpV2ReplaceWithInfoTypeConfig properties: {} + GooglePrivacyDlpV2Regex: + description: Message defining a custom regular expression. + id: GooglePrivacyDlpV2Regex + properties: + 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 + items: + format: int32 + type: integer + 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. type: object - GooglePrivacyDlpV2Trigger: - id: GooglePrivacyDlpV2Trigger + GooglePrivacyDlpV2AllInfoTypes: + id: GooglePrivacyDlpV2AllInfoTypes + properties: {} type: object + description: Apply transformation to all findings. + GooglePrivacyDlpV2DataSourceType: + id: GooglePrivacyDlpV2DataSourceType properties: - manual: + dataSource: + type: string description: >- - For use with hybrid jobs. Jobs must be manually created and - finished. - $ref: '#/components/schemas/GooglePrivacyDlpV2Manual' - schedule: - $ref: '#/components/schemas/GooglePrivacyDlpV2Schedule' - description: Create a job on a repeating basis based on the elapse of time. - description: What event needs to occur for a new job to be started. - GooglePrivacyDlpV2Conditions: + Output only. An identifying string to the type of resource being + profiled. Current values: google/bigquery/table, google/project + readOnly: true type: object - id: GooglePrivacyDlpV2Conditions + description: Message used to identify the type of resource being profiled. + GooglePrivacyDlpV2HybridContentItem: properties: - conditions: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Condition' - description: A collection of conditions. - description: A collection of conditions. - GooglePrivacyDlpV2CharacterMaskConfig: + 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' + description: >- + An individual hybrid item to inspect. Will be stored temporarily during + processing. + type: object + id: GooglePrivacyDlpV2HybridContentItem + GooglePrivacyDlpV2PrimitiveTransformation: + properties: + cryptoDeterministicConfig: + description: Deterministic Crypto + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoDeterministicConfig' + bucketingConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2BucketingConfig' + description: Bucketing + fixedSizeBucketingConfig: + description: Fixed size bucketing + $ref: '#/components/schemas/GooglePrivacyDlpV2FixedSizeBucketingConfig' + cryptoReplaceFfxFpeConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig' + description: Ffx-Fpe + characterMaskConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2CharacterMaskConfig' + description: Mask + cryptoHashConfig: + description: Crypto + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoHashConfig' + replaceDictionaryConfig: + description: >- + Replace with a value randomly drawn (with replacement) from a + dictionary. + $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceDictionaryConfig' + replaceConfig: + description: Replace with a specified value. + $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceValueConfig' + timePartConfig: + description: Time extraction + $ref: '#/components/schemas/GooglePrivacyDlpV2TimePartConfig' + redactConfig: + description: Redact + $ref: '#/components/schemas/GooglePrivacyDlpV2RedactConfig' + dateShiftConfig: + description: Date Shift + $ref: '#/components/schemas/GooglePrivacyDlpV2DateShiftConfig' + replaceWithInfoTypeConfig: + description: Replace with infotype + $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceWithInfoTypeConfig' + description: A rule for transforming a value. + type: object + id: GooglePrivacyDlpV2PrimitiveTransformation + GooglePrivacyDlpV2DeidentifyContentRequest: + type: object + id: GooglePrivacyDlpV2DeidentifyContentRequest properties: - reverseOrder: - type: boolean + inspectTemplateName: + 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***`. - charactersToIgnore: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2CharsToIgnore' - type: array + 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. + item: + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' 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`. - maskingCharacter: + 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: 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. + 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 - numberToMask: - type: integer - format: int32 + deidentifyConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' 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-****-****-****`. - id: GooglePrivacyDlpV2CharacterMaskConfig - type: object - 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. - GooglePrivacyDlpV2RecordTransformation: - properties: - fieldId: - description: For record transformations, provide a field. - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - containerTimestamp: - format: google-datetime - type: string - description: Findings container modification timestamp, if applicable. - containerVersion: + Configuration for the de-identification of the content item. Items + specified here will override the template referenced by the + deidentify_template_name argument. + inspectConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + description: >- + Configuration for the inspector. Items specified here will override + the template referenced by the inspect_template_name argument. + locationId: type: string - description: Container version, if available ("generation" for Cloud Storage). - description: The field in a record to transform. + description: Deprecated. This field has no effect. + description: Request to de-identify a ContentItem. + GooglePrivacyDlpV2InspectContentResponse: + properties: + result: + description: The findings. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectResult' + id: GooglePrivacyDlpV2InspectContentResponse + description: Results of inspecting an item. type: object - id: GooglePrivacyDlpV2RecordTransformation - GooglePrivacyDlpV2InfoTypeStats: - id: GooglePrivacyDlpV2InfoTypeStats - description: Statistics regarding a specific InfoType. + GooglePrivacyDlpV2StoredType: type: object + description: A reference to a StoredInfoType to use with scanning. + id: GooglePrivacyDlpV2StoredType properties: - infoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: The type of finding this stat is for. - count: + createTime: + description: >- + Timestamp indicating when the version of the `StoredInfoType` used + for inspection was created. Output-only field, populated by the + system. + format: google-datetime type: string - format: int64 - description: Number of findings for this infoType. - GooglePrivacyDlpV2JobTrigger: + name: + description: >- + Resource name of the requested `StoredInfoType`, for example + `organizations/433245324/storedInfoTypes/432452342` or + `projects/project-id/storedInfoTypes/432452342`. + type: string + GooglePrivacyDlpV2DeidentifyTemplate: type: object - id: 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. + id: GooglePrivacyDlpV2DeidentifyTemplate properties: + deidentifyConfig: + description: The core content of the template. + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' displayName: - description: Display name (max 100 chars) type: string - status: - enumDescriptions: - - Unused. - - Trigger is healthy. - - Trigger is temporarily paused. - - Trigger is cancelled and can not be resumed. + description: Display name (max 256 chars). + description: + type: string + description: Short description (max 256 chars). + createTime: + description: Output only. The creation timestamp of an inspectTemplate. type: string - enum: - - STATUS_UNSPECIFIED - - HEALTHY - - PAUSED - - CANCELLED - description: Required. A status for this trigger. - 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. - errors: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Error' readOnly: true + format: google-datetime + name: 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. - 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 - description: User provided description (max 256 chars) - inspectJob: - description: For inspect jobs, a snapshot of the configuration. - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' - createTime: readOnly: true + updateTime: + readOnly: true + type: string format: google-datetime - description: Output only. The creation timestamp of a triggeredJob. + description: Output only. The last update timestamp of an inspectTemplate. + description: >- + DeidentifyTemplates contains instructions on how to de-identify content. + See + https://cloud.google.com/sensitive-data-protection/docs/concepts-templates + to learn more. + GooglePrivacyDlpV2OutputStorageConfig: + description: Cloud repository for storing output. + type: object + properties: + outputSchema: + description: >- + Schema used for writing the findings for Inspect jobs. This field is + only used for Inspect and must be unspecified for Risk jobs. Columns + are derived from the `Finding` object. If appending to an existing + table, any columns from the predefined schema that are missing will + be added. No columns in the existing table will be deleted. If + unspecified, then all available columns will be used for a new table + or an (existing) table with no schema, and no changes will be made + to an existing table that has a schema. Only for use with external + storage. + enum: + - OUTPUT_SCHEMA_UNSPECIFIED + - BASIC_COLUMNS + - GCS_COLUMNS + - DATASTORE_COLUMNS + - BIG_QUERY_COLUMNS + - ALL_COLUMNS + 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. type: string - name: + 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 + GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest: + description: Request message for UpdateDeidentifyTemplate. + id: GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest + properties: + deidentifyTemplate: + description: New DeidentifyTemplate value. + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + updateMask: + format: google-fieldmask + description: Mask to control which fields get updated. + type: string + type: object + 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. + id: GooglePrivacyDlpV2TransformationConfig + type: object + properties: + imageRedactTemplate: 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`. - updateTime: - format: google-datetime - readOnly: true - description: Output only. The last update timestamp of a triggeredJob. + 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. + deidentifyTemplate: type: string - lastRunTime: - readOnly: true - format: google-datetime - description: Output only. The timestamp of the last time this trigger executed. + 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: + 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 - GooglePrivacyDlpV2DataProfilePubSubCondition: - properties: - expressions: - description: An expression. - $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubExpressions' - id: GooglePrivacyDlpV2DataProfilePubSubCondition + GooglePrivacyDlpV2TransformationSummary: type: object - description: A condition for determining whether a Pub/Sub should be triggered. - 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 + Summary of a single transformation. Only one of 'transformation', + 'field_transformation', or 'record_suppress' will be set. properties: - field: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: >- - Required. Field within the record this condition is evaluated - against. - operator: + transformedBytes: type: string + description: Total size in bytes that were transformed in some way. + format: int64 + transformation: + description: The specific transformation these stats apply to. + $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' + recordSuppress: + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordSuppression' + description: The specific suppression option these stats apply to. + fieldTransformations: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldTransformation' description: >- - Required. Operator used to compare the field or infoType to the - value. + 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. + infoType: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + description: Set if the transformation was limited to a specific InfoType. + field: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: Set if the transformation was limited to a specific FieldId. + results: + description: Collection of all transformations that took place or had an error. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2SummaryResult' + id: GooglePrivacyDlpV2TransformationSummary + GooglePrivacyDlpV2MetadataLocation: + properties: + type: + description: Type of metadata containing the finding. 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 + - General file metadata provided by Cloud Storage. + type: string enum: - - RELATIONAL_OPERATOR_UNSPECIFIED - - EQUAL_TO - - NOT_EQUAL_TO - - 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' - GooglePrivacyDlpV2HybridInspectJobTriggerRequest: + - METADATATYPE_UNSPECIFIED + - STORAGE_METADATA + storageLabel: + description: Storage metadata. + $ref: '#/components/schemas/GooglePrivacyDlpV2StorageMetadataLabel' + description: Metadata Location + id: GooglePrivacyDlpV2MetadataLocation type: object - description: Request to search for potentially sensitive info in a custom location. - id: GooglePrivacyDlpV2HybridInspectJobTriggerRequest - properties: - hybridItem: - description: The item to inspect. - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridContentItem' - GooglePrivacyDlpV2Row: - description: Values of the row. + GooglePrivacyDlpV2ListDeidentifyTemplatesResponse: properties: - values: + nextPageToken: + type: string + description: >- + If the next page is available then the next page token to be used in + the following ListDeidentifyTemplates request. + deidentifyTemplates: + description: >- + List of deidentify templates, up to page_size in + ListDeidentifyTemplatesRequest. type: array - description: Individual cells. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - id: GooglePrivacyDlpV2Row + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' type: object - GooglePrivacyDlpV2DatabaseResourceReference: + description: Response message for ListDeidentifyTemplates. + id: GooglePrivacyDlpV2ListDeidentifyTemplatesResponse + GooglePrivacyDlpV2ExclusionRule: properties: - database: - type: string - description: Required. Name of a database within the instance. - databaseResource: - type: string - description: >- - Required. Name of a database resource, for example, a table within - the database. - instance: - type: string + regex: + description: Regular expression which defines the rule. + $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' + excludeByHotword: + $ref: '#/components/schemas/GooglePrivacyDlpV2ExcludeByHotword' description: >- - Required. The instance where this resource is located. For example: - Cloud SQL instance ID. - projectId: + 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' + matchingType: + 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 + description: How the rule is applied, see MatchingType documentation for details. + enum: + - MATCHING_TYPE_UNSPECIFIED + - MATCHING_TYPE_FULL_MATCH + - MATCHING_TYPE_PARTIAL_MATCH + - MATCHING_TYPE_INVERSE_MATCH type: string - description: >- - Required. If within a project-level config, then this must match the - config's project ID. - description: Identifies a single database resource, like a table within a database. + excludeInfoTypes: + description: Set of infoTypes for which findings would affect this rule. + $ref: '#/components/schemas/GooglePrivacyDlpV2ExcludeInfoTypes' type: object - id: GooglePrivacyDlpV2DatabaseResourceReference - GooglePrivacyDlpV2DeidentifyTemplate: - id: GooglePrivacyDlpV2DeidentifyTemplate + id: GooglePrivacyDlpV2ExclusionRule description: >- - DeidentifyTemplates contains instructions on how to de-identify content. - See - https://cloud.google.com/sensitive-data-protection/docs/concepts-templates - to learn more. - type: object - properties: - deidentifyConfig: - description: The core content of the template. - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' - name: - type: string - description: >- - Output only. The template name. The template will have one of the - following formats: - `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR - `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` - readOnly: true - description: - type: string - description: Short description (max 256 chars). - updateTime: - type: string - description: Output only. The last update timestamp of an inspectTemplate. - readOnly: true - format: google-datetime - displayName: - type: string - description: Display name (max 256 chars). - createTime: - description: Output only. The creation timestamp of an inspectTemplate. - type: string - format: google-datetime - readOnly: true - GooglePrivacyDlpV2InfoType: - description: Type of information detected by the API. + The rule that specifies conditions when findings of infoTypes specified + in `InspectionRuleSet` are removed from results. + GooglePrivacyDlpV2FixedSizeBucketingConfig: type: object - id: GooglePrivacyDlpV2InfoType + 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: - sensitivityScore: - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + lowerBound: description: >- - Optional custom sensitivity for this InfoType. This only applies to - data profiling. - version: - description: Optional version name for this InfoType. - type: string - name: - type: string + 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' + bucketSize: + type: number + format: double 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}`. - GooglePrivacyDlpV2CreateDiscoveryConfigRequest: - description: Request message for CreateDiscoveryConfig. - properties: - configId: - type: string + 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. + upperBound: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' 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. - discoveryConfig: - description: Required. The DiscoveryConfig to create. - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + 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+". + id: GooglePrivacyDlpV2FixedSizeBucketingConfig + GooglePrivacyDlpV2StorageConfig: type: object - id: GooglePrivacyDlpV2CreateDiscoveryConfigRequest + id: GooglePrivacyDlpV2StorageConfig + description: Shared message indicating Cloud storage type. + properties: + cloudStorageOptions: + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageOptions' + description: Cloud Storage options. + hybridOptions: + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridOptions' + description: Hybrid inspection options. + datastoreOptions: + $ref: '#/components/schemas/GooglePrivacyDlpV2DatastoreOptions' + description: Google Cloud Datastore options. + bigQueryOptions: + description: BigQuery options. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryOptions' + timespanConfig: + description: Configuration of the timespan of the items to include in scanning. + $ref: '#/components/schemas/GooglePrivacyDlpV2TimespanConfig' GooglePrivacyDlpV2AuxiliaryTable: + type: object + id: GooglePrivacyDlpV2AuxiliaryTable description: >- An auxiliary table contains statistical information on the relative frequency of different quasi-identifiers values. It has one or several @@ -6066,1012 +6124,954 @@ components: frequency is assumed to be zero (and thus, the tuple is highly reidentifiable). properties: - table: - $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' + table: + description: Required. Auxiliary table location. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' quasiIds: - description: Required. Quasi-identifier columns. type: array + description: Required. Quasi-identifier columns. items: $ref: '#/components/schemas/GooglePrivacyDlpV2QuasiIdField' - id: GooglePrivacyDlpV2AuxiliaryTable - type: object - GooglePrivacyDlpV2StoredInfoType: - type: object - properties: - currentVersion: - description: Current version of the stored info type. - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeVersion' - pendingVersions: - description: >- - Pending versions of the stored info type. Empty if no versions are - pending. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeVersion' - type: array - name: - type: string - description: Resource name. - description: >- - StoredInfoType resource message that contains information about the - current version and any pending updates. - id: GooglePrivacyDlpV2StoredInfoType - GooglePrivacyDlpV2PathElement: - type: object - properties: - id: - 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. - type: string - kind: - type: string - 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 `""`. - name: - description: >- - The name of the entity. A name matching regex `__.*__` is - reserved/read-only. A name must not be more than 1500 bytes when - UTF-8 encoded. Cannot be `""`. - type: string - id: GooglePrivacyDlpV2PathElement - 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. - GooglePrivacyDlpV2BigQueryRegexes: - id: GooglePrivacyDlpV2BigQueryRegexes - properties: - patterns: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryRegex' - description: >- - A single BigQuery regular expression pattern to match against one or - more tables, datasets, or projects that contain BigQuery tables. - type: array - type: object - description: >- - A collection of regular expressions to determine what tables to match - against. - GooglePrivacyDlpV2ProfileStatus: + GooglePrivacyDlpV2PrivacyMetric: type: object - id: GooglePrivacyDlpV2ProfileStatus properties: - status: - 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: Success or errors for the profile generation. - GooglePrivacyDlpV2SummaryResult: + kMapEstimationConfig: + description: k-map + $ref: '#/components/schemas/GooglePrivacyDlpV2KMapEstimationConfig' + kAnonymityConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityConfig' + description: K-anonymity + categoricalStatsConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2CategoricalStatsConfig' + description: Categorical stats + deltaPresenceEstimationConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationConfig' + description: delta-presence + numericalStatsConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2NumericalStatsConfig' + description: Numerical stats + lDiversityConfig: + description: l-diversity + $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityConfig' + description: Privacy metric to compute for reidentification risk analysis. + id: GooglePrivacyDlpV2PrivacyMetric + GooglePrivacyDlpV2NumericalStatsConfig: description: >- - A collection that informs the user the number of times a particular - `TransformationResultCode` and error details occurred. - properties: - details: - description: >- - A place for warnings or errors to show up if a transformation didn't - work as expected. - type: string - count: - format: int64 - type: string - description: Number of transformations counted by this result. - code: - type: string - enum: - - TRANSFORMATION_RESULT_CODE_UNSPECIFIED - - SUCCESS - - ERROR - description: Outcome of the transformation. - enumDescriptions: - - Unused - - Transformation completed without an error. - - Transformation had an error. - id: GooglePrivacyDlpV2SummaryResult + Compute numerical stats over an individual column, including min, max, + and quantiles. type: object - GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence: properties: - refreshFrequency: - 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. + field: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' 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. - schemaModifiedCadence: - $ref: '#/components/schemas/GooglePrivacyDlpV2SchemaModifiedCadence' - description: When to reprofile if the schema has changed. - description: >- - How often existing tables should have their profiles refreshed. New - tables are scanned as quickly as possible depending on system capacity. - id: GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence - type: object - GooglePrivacyDlpV2Range: - properties: - start: - description: Index of the first character of the range (inclusive). - type: string - format: int64 - end: - type: string - format: int64 - description: Index of the last character of the range (exclusive). - type: object - description: Generic half-open interval [start, end) - id: GooglePrivacyDlpV2Range - GooglePrivacyDlpV2InspectJobConfig: - description: Controls what and how to inspect for findings. - type: object + Field to compute numerical stats on. Supported types are integer, + float, date, datetime, timestamp, time. + id: GooglePrivacyDlpV2NumericalStatsConfig + GooglePrivacyDlpV2CloudSqlProperties: properties: - inspectConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' - description: How and what to scan for. - inspectTemplateName: + databaseEngine: type: string + enumDescriptions: + - >- + An engine that is not currently supported by Sensitive Data + Protection. + - Cloud SQL for MySQL instance. + - Cloud SQL for PostgreSQL instance. 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: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Action' - description: Actions to execute at the completion of the job. - type: array - storageConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2StorageConfig' - description: The data to scan. - id: GooglePrivacyDlpV2InspectJobConfig - GooglePrivacyDlpV2Schedule: + Required. The database engine used by the Cloud SQL instance that + this connection configures. + enum: + - DATABASE_ENGINE_UNKNOWN + - DATABASE_ENGINE_MYSQL + - DATABASE_ENGINE_POSTGRES + usernamePassword: + description: A username and password stored in Secret Manager. + $ref: '#/components/schemas/GooglePrivacyDlpV2SecretManagerCredential' + connectionName: + type: string + 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` + cloudSqlIam: + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlIamCredential' + description: Built-in IAM authentication (must be configured in Cloud SQL). + maxConnections: + type: integer + description: >- + Required. DLP will limit its connections to max_connections. Must be + 2 or greater. + format: int32 + id: GooglePrivacyDlpV2CloudSqlProperties + type: object + description: Cloud SQL connection properties. + GooglePrivacyDlpV2InfoTypeSummary: type: object + description: The infoType details for this column. properties: - recurrencePeriodDuration: - type: string + infoType: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + description: The infoType. + estimatedPrevalence: + type: integer + format: int32 + description: Not populated for predicted infotypes. + deprecated: true + id: GooglePrivacyDlpV2InfoTypeSummary + GooglePrivacyDlpV2OrConditions: + properties: + minRowCount: 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. + Minimum number of rows that should be present before Cloud DLP + profiles a table + format: int32 + type: integer + minAge: + description: >- + Minimum age a table must have before Cloud DLP can profile it. Value + must be 1 hour or greater. + type: string format: google-duration - id: GooglePrivacyDlpV2Schedule - description: Schedule for inspect job triggers. - GooglePrivacyDlpV2RecordTransformations: - id: GooglePrivacyDlpV2RecordTransformations + id: GooglePrivacyDlpV2OrConditions description: >- - A type of transformation that is applied over structured data such as a - table. + There is an OR relationship between these attributes. They are used to + determine if a table should be scanned or not in Discovery. + type: object + GooglePrivacyDlpV2DatastoreKey: + id: GooglePrivacyDlpV2DatastoreKey type: object properties: - recordSuppressions: - type: array - description: >- - Configuration defining which records get suppressed entirely. - Records that match any suppression rule are omitted from the output. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordSuppression' - fieldTransformations: - type: array - description: Transform the record by applying various field transformations. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldTransformation' - GooglePrivacyDlpV2ByteContentItem: - description: Container for bytes to inspect or redact. + entityKey: + $ref: '#/components/schemas/GooglePrivacyDlpV2Key' + description: Datastore entity key. + description: Record key for a finding in Cloud Datastore. + 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 type: object - id: GooglePrivacyDlpV2ByteContentItem + id: GooglePrivacyDlpV2PublishToPubSub properties: - data: + topic: type: string - format: byte - description: Content data to inspect or redact. - type: - 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 description: >- - The type of data stored in the bytes string. Default will be - TEXT_UTF8. - 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 - type: string - GooglePrivacyDlpV2InfoTypeLikelihood: - id: GooglePrivacyDlpV2InfoTypeLikelihood + 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}. + GoogleTypeTimeOfDay: + type: object + 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`. properties: - minLikelihood: - enum: - - LIKELIHOOD_UNSPECIFIED - - VERY_UNLIKELY - - UNLIKELY - - POSSIBLE - - LIKELY - - VERY_LIKELY + hours: + format: int32 description: >- - Only returns findings equal to or above this threshold. This field - is required or else the configuration fails. - 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. - infoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + 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: >- - 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 + 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: + format: int32 + description: Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + type: integer + GooglePrivacyDlpV2HotwordRule: + id: GooglePrivacyDlpV2HotwordRule + properties: + likelihoodAdjustment: + description: Likelihood adjustment to apply to all matching findings. + $ref: '#/components/schemas/GooglePrivacyDlpV2LikelihoodAdjustment' + hotwordRegex: + description: Regular expression pattern defining what qualifies as a hotword. + $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' + proximity: + 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). + $ref: '#/components/schemas/GooglePrivacyDlpV2Proximity' 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. - GooglePrivacyDlpV2CryptoDeterministicConfig: + The rule that adjusts the likelihood of findings within a certain + proximity of hotwords. + type: object + GooglePrivacyDlpV2RequestedOptions: type: object + id: GooglePrivacyDlpV2RequestedOptions properties: - surrogateInfoType: + jobConfig: + description: Inspect config. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' + snapshotInspectTemplate: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' 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' - cryptoKey: + If run with an InspectTemplate, a snapshot of its state at the time + of this run. + description: Snapshot of the inspection configuration. + GooglePrivacyDlpV2DeidentifyConfig: + properties: + recordTransformations: + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordTransformations' 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. - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' - context: + 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: >- - 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' - description: >- - Pseudonymization method that generates deterministic encryption for the - given input. Outputs a base64 encoded representation of the encrypted - output. Uses AES-SIV based on the RFC - https://tools.ietf.org/html/rfc5297. - id: GooglePrivacyDlpV2CryptoDeterministicConfig - GooglePrivacyDlpV2PubSubNotification: - id: GooglePrivacyDlpV2PubSubNotification + Treat the dataset as free-form text and apply the same free text + transformation everywhere. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeTransformations' + transformationErrorHandling: + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationErrorHandling' + description: >- + Mode for handling transformation errors. If left unspecified, the + default mode is `TransformationErrorHandling.ThrowError`. + imageTransformations: + $ref: '#/components/schemas/GooglePrivacyDlpV2ImageTransformations' + description: Treat the dataset as an image and redact. + id: GooglePrivacyDlpV2DeidentifyConfig type: object + description: The configuration that controls how the data will change. + GooglePrivacyDlpV2ListStoredInfoTypesResponse: + description: Response message for ListStoredInfoTypes. + id: GooglePrivacyDlpV2ListStoredInfoTypesResponse properties: - detailOfMessage: - enumDescriptions: - - Unused. - - The full table data profile. - - The name of the profiled resource. - enum: - - DETAIL_LEVEL_UNSPECIFIED - - TABLE_PROFILE - - RESOURCE_NAME - 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). - topic: - description: >- - Cloud Pub/Sub topic to send notifications to. Format is - projects/{project}/topics/{topic}. + nextPageToken: type: string - pubsubCondition: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfilePubSubCondition' description: >- - Conditions (e.g., data risk or sensitivity level) for triggering a - Pub/Sub. - event: + If the next page is available then the next page token to be used in + the following ListStoredInfoTypes request. + storedInfoTypes: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + type: array description: >- - The type of event that triggers a Pub/Sub. At most one - `PubSubNotification` per EventType is permitted. - 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. - 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`. - GooglePrivacyDlpV2KAnonymityEquivalenceClass: - description: The set of columns' values that share the same ldiversity value + List of storedInfoTypes, up to page_size in + ListStoredInfoTypesRequest. type: object - id: GooglePrivacyDlpV2KAnonymityEquivalenceClass + GooglePrivacyDlpV2DataProfilePubSubCondition: + id: GooglePrivacyDlpV2DataProfilePubSubCondition + description: A condition for determining whether a Pub/Sub should be triggered. properties: - equivalenceClassSize: - type: string + expressions: + $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubExpressions' + description: An expression. + type: object + GooglePrivacyDlpV2DiscoveryCloudSqlConditions: + type: object + id: GooglePrivacyDlpV2DiscoveryCloudSqlConditions + properties: + databaseEngines: description: >- - Size of the equivalence class, for example number of rows with the - above set of values. - format: int64 - quasiIdsValues: + Optional. Database engines that should be profiled. Optional. + Defaults to ALL_SUPPORTED_DATABASE_ENGINES if unspecified. + type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + enum: + - DATABASE_ENGINE_UNSPECIFIED + - ALL_SUPPORTED_DATABASE_ENGINES + - MYSQL + - POSTGRES + enumDescriptions: + - Unused. + - Include all supported database engines. + - MySQL database. + - PostgreSQL database. + type: string + types: + items: + 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. + type: string 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. + 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]. type: array - GooglePrivacyDlpV2PrimitiveTransformation: - id: GooglePrivacyDlpV2PrimitiveTransformation - description: A rule for transforming a value. + description: >- + Requirements that must be true before a table is profiled for the first + time. + GooglePrivacyDlpV2Bucket: + id: GooglePrivacyDlpV2Bucket + description: Bucket is represented as a range, along with replacement values. properties: - dateShiftConfig: - description: Date Shift - $ref: '#/components/schemas/GooglePrivacyDlpV2DateShiftConfig' - timePartConfig: - description: Time extraction - $ref: '#/components/schemas/GooglePrivacyDlpV2TimePartConfig' - fixedSizeBucketingConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2FixedSizeBucketingConfig' - description: Fixed size bucketing - replaceDictionaryConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceDictionaryConfig' + max: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + description: Upper bound of the range, exclusive; type must match min. + replacementValue: + description: Required. Replacement value for this bucket. + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + min: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' description: >- - Replace with a value randomly drawn (with replacement) from a - dictionary. - replaceWithInfoTypeConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceWithInfoTypeConfig' - description: Replace with infotype - bucketingConfig: - description: Bucketing - $ref: '#/components/schemas/GooglePrivacyDlpV2BucketingConfig' - cryptoDeterministicConfig: - description: Deterministic Crypto - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoDeterministicConfig' - replaceConfig: - description: Replace with a specified value. - $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceValueConfig' - cryptoReplaceFfxFpeConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig' - description: Ffx-Fpe - characterMaskConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2CharacterMaskConfig' - description: Mask - redactConfig: - description: Redact - $ref: '#/components/schemas/GooglePrivacyDlpV2RedactConfig' - cryptoHashConfig: - description: Crypto - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoHashConfig' - type: object - GooglePrivacyDlpV2StorageMetadataLabel: + Lower bound of the range, inclusive. Type should be the same as max + if used. type: object - description: >- - Storage metadata label to indicate which metadata entry contains - findings. + GooglePrivacyDlpV2DeltaPresenceEstimationConfig: properties: - key: - description: Label name. + quasiIds: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2QuasiId' + description: >- + Required. Fields considered to be quasi-identifiers. No two fields + can have the same tag. + 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 - id: GooglePrivacyDlpV2StorageMetadataLabel - GooglePrivacyDlpV2ListDlpJobsResponse: + auxiliaryTables: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2StatisticalTable' + 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. + 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 + type: object + GooglePrivacyDlpV2BigQueryKey: + description: Row key for identifying a record in BigQuery table. + id: GooglePrivacyDlpV2BigQueryKey type: object - id: GooglePrivacyDlpV2ListDlpJobsResponse properties: - nextPageToken: + tableReference: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + description: Complete BigQuery table reference. + 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 - description: The standard List next-page token. - jobs: - type: array - description: A list of DlpJobs that matches the specified filter in the request. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' - description: The response message for listing DLP jobs. - GooglePrivacyDlpV2ListColumnDataProfilesResponse: + GooglePrivacyDlpV2StoredInfoTypeStats: + description: Statistics for a StoredInfoType. + properties: + largeCustomDictionary: + $ref: '#/components/schemas/GooglePrivacyDlpV2LargeCustomDictionaryStats' + description: >- + StoredInfoType where findings are defined by a dictionary of + phrases. + id: GooglePrivacyDlpV2StoredInfoTypeStats type: object - description: List of profiles generated for a given organization or project. - id: GooglePrivacyDlpV2ListColumnDataProfilesResponse + GooglePrivacyDlpV2CreateStoredInfoTypeRequest: + description: Request message for CreateStoredInfoType. + type: object + id: GooglePrivacyDlpV2CreateStoredInfoTypeRequest properties: - columnDataProfiles: - description: List of data profiles. + locationId: + description: Deprecated. This field has no effect. + type: string + config: + description: Required. Configuration of the storedInfoType to create. + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeConfig' + 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 + GooglePrivacyDlpV2Table: + properties: + rows: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Row' + description: Rows of the table. + type: array + headers: type: array + description: Headers of the table. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' - nextPageToken: - type: string - description: The next page token. - GooglePrivacyDlpV2RiskAnalysisJobConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' description: >- - Configuration for a risk analysis job. See - https://cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis + 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 + GooglePrivacyDlpV2CustomInfoType: + type: object properties: - sourceTable: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - description: Input dataset to compute metrics over. - actions: + surrogateType: + $ref: '#/components/schemas/GooglePrivacyDlpV2SurrogateType' description: >- - Actions to execute at the completion of the job. Are executed in the - order provided. + Message for detecting output from deidentification transformations + that support reversing. + exclusionType: + type: string + 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. + storedType: + description: >- + Load an existing `StoredInfoType` resource for use in + `InspectDataSource`. Not currently supported in `InspectContent`. + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredType' + 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: + description: Regular expression based CustomInfoType. + $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' + detectionRules: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Action' + $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. type: array - privacyMetric: - description: Privacy metric to compute. - $ref: '#/components/schemas/GooglePrivacyDlpV2PrivacyMetric' - id: GooglePrivacyDlpV2RiskAnalysisJobConfig - type: object - GooglePrivacyDlpV2CloudStorageRegexFileSet: - type: object + dictionary: + $ref: '#/components/schemas/GooglePrivacyDlpV2Dictionary' + description: A list of phrases to detect as a CustomInfoType. + 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' + likelihood: + 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 + 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. + id: GooglePrivacyDlpV2CustomInfoType 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 + Custom information type provided by the user. Used to find + domain-specific sensitive information configurable to the data in + question. + GooglePrivacyDlpV2StorageMetadataLabel: + type: object properties: - includeRegex: - 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 - excludeRegex: + key: + type: string + description: Label name. + description: >- + Storage metadata label to indicate which metadata entry contains + findings. + id: GooglePrivacyDlpV2StorageMetadataLabel + GooglePrivacyDlpV2ThrowError: + type: object + id: GooglePrivacyDlpV2ThrowError + properties: {} + description: Throw an error and fail the request when a transformation error occurs. + GooglePrivacyDlpV2WordList: + id: GooglePrivacyDlpV2WordList + properties: + words: 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. + 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] type: array - bucketName: - type: string - description: The name of a Cloud Storage bucket. Required. - 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 - properties: - topic: - type: string - 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}. - id: GooglePrivacyDlpV2PublishToPubSub type: object - GooglePrivacyDlpV2TransformationDetails: - id: GooglePrivacyDlpV2TransformationDetails + description: Message defining a list of words or phrases to search for in the data. + GooglePrivacyDlpV2DlpJob: + id: GooglePrivacyDlpV2DlpJob + description: Combines all of the information about a DLP job. type: object properties: - 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 - transformedBytes: + inspectDetails: + description: Results from inspecting a data source. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectDataSourceDetails' + startTime: + description: Time when the job started. + format: google-datetime type: string - 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. - format: int64 - 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. + actionDetails: + description: Events that should occur after the job has completed. type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationDescription' - statusDetails: - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationResultStatus' - 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. - resourceName: + $ref: '#/components/schemas/GooglePrivacyDlpV2ActionDetails' + riskDetails: + description: Results from analyzing risk of a data source. + $ref: '#/components/schemas/GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails' + createTime: type: string - description: The name of the job that completed the transformation. - 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. - GooglePrivacyDlpV2DataProfileAction: - description: A task to execute when a data profile has been generated. - id: GooglePrivacyDlpV2DataProfileAction - properties: - exportData: - $ref: '#/components/schemas/GooglePrivacyDlpV2Export' - description: Export data profiles into a provided location. - pubSubNotification: - description: Publish a message into the Pub/Sub topic. - $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubNotification' - type: object - GooglePrivacyDlpV2HybridInspectStatistics: - description: Statistics related to processing hybrid inspect requests. - properties: - processedCount: + description: Time when the job was created. + format: google-datetime + state: type: string - format: int64 - description: The number of hybrid inspection requests processed within this job. - pendingCount: + 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. + enum: + - JOB_STATE_UNSPECIFIED + - PENDING + - RUNNING + - DONE + - CANCELED + - FAILED + - ACTIVE + description: State of a job. + name: type: string - format: int64 - 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. - abortedCount: + description: The server-assigned name. + type: + enum: + - DLP_JOB_TYPE_UNSPECIFIED + - INSPECT_JOB + - RISK_ANALYSIS_JOB + description: The type of job. + enumDescriptions: + - Defaults to INSPECT_JOB. + - The job inspected Google Cloud for sensitive data. + - The job executed a Risk Analysis computation. type: string - format: int64 - description: >- - The number of hybrid inspection requests aborted because the job ran - out of quota or was ended before they could be processed. - type: object - id: GooglePrivacyDlpV2HybridInspectStatistics - GooglePrivacyDlpV2Error: - type: object - description: >- - Details information about an error encountered during job execution or - the results of an unsuccessful activation of the JobTrigger. - id: GooglePrivacyDlpV2Error - properties: - details: - description: Detailed error codes and messages. - $ref: '#/components/schemas/GoogleRpcStatus' - timestamps: + errors: + description: A stream of errors encountered running the job. type: array - description: >- - The times the error occurred. List includes the oldest timestamp and - the last 9 timestamps. items: - format: google-datetime - type: string - GooglePrivacyDlpV2ReplaceDictionaryConfig: - id: GooglePrivacyDlpV2ReplaceDictionaryConfig - properties: - wordList: + $ref: '#/components/schemas/GooglePrivacyDlpV2Error' + lastModified: + format: google-datetime + type: string + description: Time when the job was last modified by the system. + jobTriggerName: + type: string 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. - $ref: '#/components/schemas/GooglePrivacyDlpV2WordList' + If created by a job trigger, the resource name of the trigger that + instantiated the job. + endTime: + type: string + description: Time when the job finished. + format: google-datetime + GooglePrivacyDlpV2DataProfileBigQueryRowSchema: + id: GooglePrivacyDlpV2DataProfileBigQueryRowSchema + properties: + columnProfile: + $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' + description: Column data profile column + tableProfile: + $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' + description: Table data profile column type: object description: >- - Replace each input value with a value randomly selected from the - dictionary. - GooglePrivacyDlpV2TransformationDescription: + The schema of data to be saved to the BigQuery table when the + `DataProfileAction` is enabled. + GooglePrivacyDlpV2TableReference: description: >- - A flattened description of a `PrimitiveTransformation` or - `RecordSuppression`. + Message defining the location of a BigQuery table with the projectId + inferred from the parent project. type: object - id: GooglePrivacyDlpV2TransformationDescription + id: GooglePrivacyDlpV2TableReference properties: - 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 + datasetId: + description: Dataset ID of the table. type: string - description: The transformation type. + tableId: + type: string + description: Name of the table. + GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence: + type: object + 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: + schemaModifiedCadence: + $ref: '#/components/schemas/GooglePrivacyDlpV2SchemaModifiedCadence' + description: When to reprofile if the schema has changed. + 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: - - 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 + - UPDATE_FREQUENCY_UNSPECIFIED + - UPDATE_FREQUENCY_NEVER + - UPDATE_FREQUENCY_DAILY + - UPDATE_FREQUENCY_MONTHLY + type: string + 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. + GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog: + type: object + id: GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog + 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 + GooglePrivacyDlpV2InfoTypeDescription: + properties: description: 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. + Description of the infotype. Translated when language is provided in + the request. type: string - condition: + name: + description: Internal name of the infoType. 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' - GooglePrivacyDlpV2InspectConfig: - id: GooglePrivacyDlpV2InspectConfig - properties: - contentOptions: + categories: type: array - description: Deprecated and unused. + description: The category of the infoType. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeCategory' + versions: + description: A list of available versions for the infotype. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2VersionDescription' + type: array + supportedBy: + type: array + description: Which parts of the API supports this InfoType. items: - enumDescriptions: - - Includes entire content of a file or a data stream. - - Text content within the data, excluding any metadata. - - Images found in the data. enum: - - CONTENT_UNSPECIFIED - - CONTENT_TEXT - - CONTENT_IMAGE + - ENUM_TYPE_UNSPECIFIED + - INSPECT + - RISK_ANALYSIS + enumDescriptions: + - Unused. + - Supported by the inspect operations. + - Supported by the risk analysis operations. type: string - 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' - 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. - enum: - - LIKELIHOOD_UNSPECIFIED - - VERY_UNLIKELY - - UNLIKELY - - POSSIBLE - - LIKELY - - VERY_LIKELY + sensitivityScore: + description: The default sensitivity of the infoType. + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + displayName: type: string + description: Human readable form of the infoType name. + type: object + id: GooglePrivacyDlpV2InfoTypeDescription + description: InfoType description. + GooglePrivacyDlpV2InspectResult: + description: All the findings for a single scanned item. + type: object + id: GooglePrivacyDlpV2InspectResult + properties: + findingsTruncated: 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). - infoTypes: - type: array - 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' - excludeInfoTypes: + 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 - description: >- - When true, excludes type information of the findings. This is not - used for data profiling. - customInfoTypes: + findings: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2CustomInfoType' - description: >- - CustomInfoTypes provided by the user. See - https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes - to learn more. + $ref: '#/components/schemas/GooglePrivacyDlpV2Finding' type: array - ruleSet: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectionRuleSet' + description: List of findings for an item. + GooglePrivacyDlpV2Expressions: + description: An expression, consisting of an operator and conditions. + id: GooglePrivacyDlpV2Expressions + properties: + conditions: + description: Conditions to apply to the expression. + $ref: '#/components/schemas/GooglePrivacyDlpV2Conditions' + logicalOperator: + enumDescriptions: + - Unused + - Conditional AND 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. + The operator to apply to the result of conditions. Default and + currently only supported value is `AND`. + type: string + enum: + - LOGICAL_OPERATOR_UNSPECIFIED + - AND + type: object + GooglePrivacyDlpV2ListInfoTypesResponse: + description: Response to the ListInfoTypes request. + id: GooglePrivacyDlpV2ListInfoTypesResponse + properties: + infoTypes: type: array - minLikelihoodPerInfoType: - 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: Set of sensitive infoTypes. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeLikelihood' - type: array - 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. - description: >- - Configuration description of the scanning process. When used with - redactContent only info_types and min_likelihood are currently used. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeDescription' type: object - GoogleRpcStatus: - id: GoogleRpcStatus + GooglePrivacyDlpV2Disabled: + properties: {} type: object + id: GooglePrivacyDlpV2Disabled + description: Do not profile the tables. + GooglePrivacyDlpV2BoundingBox: + type: object + description: Bounding box encompassing detected text within an image. + id: GooglePrivacyDlpV2BoundingBox 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 - 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: + width: format: int32 - description: The status code, which should be an enum value of google.rpc.Code. type: integer + description: Width of the bounding box in pixels. + height: + description: Height of the bounding box in pixels. + type: integer + format: int32 + top: + description: Top coordinate of the bounding box. (0,0) is upper left. + type: integer + format: int32 + left: + format: int32 + description: Left coordinate of the bounding box. (0,0) is upper left. + type: integer + GooglePrivacyDlpV2Value: 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). - GooglePrivacyDlpV2KAnonymityConfig: + 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 + type: object properties: - 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. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - type: array - 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. - id: GooglePrivacyDlpV2KAnonymityConfig + timeValue: + description: time of day + $ref: '#/components/schemas/GoogleTypeTimeOfDay' + booleanValue: + type: boolean + description: boolean + dateValue: + $ref: '#/components/schemas/GoogleTypeDate' + description: date + timestampValue: + format: google-datetime + description: timestamp + type: string + stringValue: + type: string + description: string + 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 + integerValue: + format: int64 + description: integer + type: string + floatValue: + description: float + type: number + format: double + GooglePrivacyDlpV2ReidentifyContentResponse: + description: Results of re-identifying an item. type: object - description: k-anonymity metric, used for analysis of reidentification risk. - GooglePrivacyDlpV2InspectContentRequest: - description: Request to search for potentially sensitive info in a ContentItem. + properties: + 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' + id: GooglePrivacyDlpV2ReidentifyContentResponse + GooglePrivacyDlpV2RequestedDeidentifyOptions: + description: De-identification options. + id: GooglePrivacyDlpV2RequestedDeidentifyOptions type: object - id: GooglePrivacyDlpV2InspectContentRequest properties: - inspectConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + snapshotStructuredDeidentifyTemplate: description: >- - Configuration for the inspector. What specified here will override - the template referenced by the inspect_template_name argument. - inspectTemplateName: - type: string + Snapshot of the state of the structured `DeidentifyTemplate` from + the `Deidentify` action at the time this job was run. + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + snapshotDeidentifyTemplate: 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. - item: - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' - description: The item to inspect. - locationId: - type: string - description: Deprecated. This field has no effect. - GooglePrivacyDlpV2ActivateJobTriggerRequest: + Snapshot of the state of the `DeidentifyTemplate` from the + Deidentify action at the time this job was run. + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + 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' + GooglePrivacyDlpV2FieldId: + description: General identifier of a data field in a storage service. type: object - description: Request message for ActivateJobTrigger. - properties: {} - id: GooglePrivacyDlpV2ActivateJobTriggerRequest + id: GooglePrivacyDlpV2FieldId + properties: + name: + type: string + description: Name describing the field. parameters: - 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 - enum: - - json - - media - - proto 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. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: key + 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 - 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 - 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 _.xgafv: description: V1 error format. in: query @@ -7081,1501 +7081,1426 @@ 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 - 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 - 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: boolean + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType schema: type: string x-stackQL-resources: info_types: - id: dlp.info_types + id: google.dlp.info_types name: info_types title: Info_types methods: - info_types_list: + 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: [] + delete: [] + content: + id: google.dlp.content + name: content + title: Content + methods: + projects_content_inspect: operation: - $ref: '#/paths/~1v2~1infoTypes/get' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1content:inspect/post' response: mediaType: application/json openAPIDocKey: '200' - locations_info_types_list: + projects_content_reidentify: operation: - $ref: '#/paths/~1v2~1locations~1{locationsId}~1infoTypes/get' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1content:reidentify/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' + 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: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1content:deidentify/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_content_reidentify: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1content:reidentify/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/info_types/methods/info_types_list - - $ref: >- - #/components/x-stackQL-resources/info_types/methods/locations_info_types_list + select: [] insert: [] update: [] delete: [] - stored_info_types: - id: dlp.stored_info_types - name: stored_info_types - title: Stored_info_types + dlp_jobs: + id: google.dlp.dlp_jobs + name: dlp_jobs + title: Dlp_jobs methods: - _organizations_stored_info_types_list: + 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' + _projects_dlp_jobs_list: operation: &ref_1 - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes/get + $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs/get' response: &ref_2 mediaType: application/json openAPIDocKey: '200' - objectKey: $.storedInfoTypes - organizations_stored_info_types_list: + objectKey: $.jobs + projects_dlp_jobs_list: operation: *ref_1 response: *ref_2 - organizations_stored_info_types_create: + projects_dlp_jobs_create: operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes/post + $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_stored_info_types_get: + projects_dlp_jobs_cancel: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/get + #/paths/~1v2~1projects~1{projectsId}~1dlpJobs~1{dlpJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' - organizations_stored_info_types_delete: + projects_locations_dlp_jobs_hybrid_inspect: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}:hybridInspect/post response: mediaType: application/json openAPIDocKey: '200' - organizations_stored_info_types_patch: + projects_locations_dlp_jobs_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_stored_info_types_get: + projects_locations_dlp_jobs_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_stored_info_types_patch: + projects_locations_dlp_jobs_finish: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}:finish/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_stored_info_types_delete: + projects_locations_dlp_jobs_create: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs/post response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_stored_info_types_list: + _projects_locations_dlp_jobs_list: operation: &ref_3 $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs/get response: &ref_4 mediaType: application/json openAPIDocKey: '200' - objectKey: $.storedInfoTypes - organizations_locations_stored_info_types_list: + objectKey: $.jobs + projects_locations_dlp_jobs_list: operation: *ref_3 response: *ref_4 - organizations_locations_stored_info_types_create: + projects_locations_dlp_jobs_cancel: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' - _projects_stored_info_types_list: + _organizations_locations_dlp_jobs_list: operation: &ref_5 - $ref: '#/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes/get' + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1dlpJobs/get response: &ref_6 mediaType: application/json openAPIDocKey: '200' - objectKey: $.storedInfoTypes - projects_stored_info_types_list: + objectKey: $.jobs + organizations_locations_dlp_jobs_list: operation: *ref_5 response: *ref_6 - projects_stored_info_types_create: - operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes/post' - response: - mediaType: application/json - openAPIDocKey: '200' - projects_stored_info_types_get: - operation: + 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 + - $ref: >- + #/components/x-stackQL-resources/dlp_jobs/methods/projects_dlp_jobs_create + update: [] + 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 + project_data_profiles: + id: google.dlp.project_data_profiles + name: project_data_profiles + title: Project_data_profiles + methods: + _projects_locations_project_data_profiles_list: + operation: &ref_7 $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes~1{storedInfoTypesId}/get - response: + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1projectDataProfiles/get + response: &ref_8 mediaType: application/json openAPIDocKey: '200' - projects_stored_info_types_delete: + objectKey: $.projectDataProfiles + projects_locations_project_data_profiles_list: + operation: *ref_7 + response: *ref_8 + projects_locations_project_data_profiles_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes~1{storedInfoTypesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1projectDataProfiles~1{projectDataProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_stored_info_types_patch: + organizations_locations_project_data_profiles_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes~1{storedInfoTypesId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1projectDataProfiles~1{projectDataProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_stored_info_types_list: - operation: &ref_7 + _organizations_locations_project_data_profiles_list: + operation: &ref_9 $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes/get - response: &ref_8 + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1projectDataProfiles/get + response: &ref_10 mediaType: application/json openAPIDocKey: '200' - objectKey: $.storedInfoTypes - projects_locations_stored_info_types_list: - operation: *ref_7 - response: *ref_8 - projects_locations_stored_info_types_create: + objectKey: $.projectDataProfiles + organizations_locations_project_data_profiles_list: + operation: *ref_9 + response: *ref_10 + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/project_data_profiles/methods/projects_locations_project_data_profiles_get + - $ref: >- + #/components/x-stackQL-resources/project_data_profiles/methods/organizations_locations_project_data_profiles_get + - $ref: >- + #/components/x-stackQL-resources/project_data_profiles/methods/projects_locations_project_data_profiles_list + - $ref: >- + #/components/x-stackQL-resources/project_data_profiles/methods/organizations_locations_project_data_profiles_list + insert: [] + update: [] + delete: [] + table_data_profiles: + id: google.dlp.table_data_profiles + name: table_data_profiles + title: Table_data_profiles + methods: + projects_locations_table_data_profiles_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_stored_info_types_delete: + projects_locations_table_data_profiles_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_stored_info_types_get: + _projects_locations_table_data_profiles_list: + operation: &ref_11 + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles/get + response: &ref_12 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.tableDataProfiles + projects_locations_table_data_profiles_list: + operation: *ref_11 + response: *ref_12 + organizations_locations_table_data_profiles_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_stored_info_types_patch: + organizations_locations_table_data_profiles_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_list - - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_get - - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_get - - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_list - - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_list - - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_get - - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_list - - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_get - insert: + _organizations_locations_table_data_profiles_list: + operation: &ref_13 + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles/get + response: &ref_14 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.tableDataProfiles + organizations_locations_table_data_profiles_list: + operation: *ref_13 + response: *ref_14 + sqlVerbs: + select: - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_create + #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_get - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_create + #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_get - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_create + #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_list - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_create + #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_list + insert: [] update: [] delete: - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_delete - - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_delete - - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_delete + #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_delete - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_delete - inspect_templates: - id: dlp.inspect_templates - name: inspect_templates - title: Inspect_templates + #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_delete + deidentify_templates: + id: google.dlp.deidentify_templates + name: deidentify_templates + title: Deidentify_templates methods: - organizations_inspect_templates_patch: + projects_locations_deidentify_templates_create: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates/post response: mediaType: application/json openAPIDocKey: '200' - organizations_inspect_templates_get: - operation: + _projects_locations_deidentify_templates_list: + operation: &ref_15 $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/get - response: + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates/get + response: &ref_16 mediaType: application/json openAPIDocKey: '200' - organizations_inspect_templates_delete: + objectKey: $.deidentifyTemplates + projects_locations_deidentify_templates_list: + operation: *ref_15 + response: *ref_16 + projects_locations_deidentify_templates_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_inspect_templates_create: + projects_locations_deidentify_templates_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - _organizations_inspect_templates_list: - operation: &ref_9 - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates/get - response: &ref_10 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.inspectTemplates - organizations_inspect_templates_list: - operation: *ref_9 - response: *ref_10 - organizations_locations_inspect_templates_get: + projects_locations_deidentify_templates_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_inspect_templates_patch: + projects_deidentify_templates_create: operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/patch + $ref: '#/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_inspect_templates_delete: + _projects_deidentify_templates_list: + operation: &ref_17 + $ref: '#/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates/get' + response: &ref_18 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.deidentifyTemplates + projects_deidentify_templates_list: + operation: *ref_17 + response: *ref_18 + projects_deidentify_templates_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_inspect_templates_create: + projects_deidentify_templates_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates/post + #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_inspect_templates_list: - operation: &ref_11 + projects_deidentify_templates_patch: + operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates/get - response: &ref_12 + #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.inspectTemplates - organizations_locations_inspect_templates_list: - operation: *ref_11 - response: *ref_12 - projects_inspect_templates_patch: + organizations_locations_deidentify_templates_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1inspectTemplates~1{inspectTemplatesId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_inspect_templates_get: + organizations_locations_deidentify_templates_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1inspectTemplates~1{inspectTemplatesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_inspect_templates_delete: + organizations_locations_deidentify_templates_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1inspectTemplates~1{inspectTemplatesId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_inspect_templates_create: + organizations_locations_deidentify_templates_create: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1inspectTemplates/post' + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates/post response: mediaType: application/json openAPIDocKey: '200' - _projects_inspect_templates_list: - operation: &ref_13 - $ref: '#/paths/~1v2~1projects~1{projectsId}~1inspectTemplates/get' - response: &ref_14 + _organizations_locations_deidentify_templates_list: + operation: &ref_19 + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates/get + response: &ref_20 mediaType: application/json openAPIDocKey: '200' - objectKey: $.inspectTemplates - projects_inspect_templates_list: - operation: *ref_13 - response: *ref_14 - projects_locations_inspect_templates_patch: + objectKey: $.deidentifyTemplates + organizations_locations_deidentify_templates_list: + operation: *ref_19 + response: *ref_20 + organizations_deidentify_templates_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_inspect_templates_delete: - operation: + _organizations_deidentify_templates_list: + operation: &ref_21 $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/delete - response: + #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates/get + response: &ref_22 mediaType: application/json openAPIDocKey: '200' - projects_locations_inspect_templates_get: + objectKey: $.deidentifyTemplates + organizations_deidentify_templates_list: + operation: *ref_21 + response: *ref_22 + organizations_deidentify_templates_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_inspect_templates_list: - operation: &ref_15 + organizations_deidentify_templates_delete: + operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates/get - response: &ref_16 + #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.inspectTemplates - projects_locations_inspect_templates_list: - operation: *ref_15 - response: *ref_16 - projects_locations_inspect_templates_create: + organizations_deidentify_templates_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates/post + #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_get + #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_get - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_list + #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_get - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_get + #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_list - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_list + #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_get - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_get + #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_list - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_list + #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_get - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_get + #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_list - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_list + #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_list insert: - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_create + #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_create - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_create + #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_create - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_create + #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_create - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_create - update: [] + #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_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 + - $ref: >- + #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_patch + - $ref: >- + #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_patch delete: - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_delete + #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_delete - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_delete + #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_delete - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_delete + #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_delete - $ref: >- - #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_delete - deidentify_templates: - id: dlp.deidentify_templates - name: deidentify_templates - title: Deidentify_templates + #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_delete + inspect_templates: + id: google.dlp.inspect_templates + name: inspect_templates + title: Inspect_templates methods: - organizations_deidentify_templates_delete: - operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_deidentify_templates_patch: - operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_deidentify_templates_get: - operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_deidentify_templates_create: + projects_locations_inspect_templates_create: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates/post response: mediaType: application/json openAPIDocKey: '200' - _organizations_deidentify_templates_list: - operation: &ref_17 + _projects_locations_inspect_templates_list: + operation: &ref_23 $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates/get - response: &ref_18 + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates/get + response: &ref_24 mediaType: application/json openAPIDocKey: '200' - objectKey: $.deidentifyTemplates - organizations_deidentify_templates_list: - operation: *ref_17 - response: *ref_18 - organizations_locations_deidentify_templates_create: + objectKey: $.inspectTemplates + projects_locations_inspect_templates_list: + operation: *ref_23 + response: *ref_24 + projects_locations_inspect_templates_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_deidentify_templates_list: - operation: &ref_19 + projects_locations_inspect_templates_patch: + operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates/get - response: &ref_20 + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/patch + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deidentifyTemplates - organizations_locations_deidentify_templates_list: - operation: *ref_19 - response: *ref_20 - organizations_locations_deidentify_templates_patch: + projects_locations_inspect_templates_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_deidentify_templates_get: + projects_inspect_templates_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get + #/paths/~1v2~1projects~1{projectsId}~1inspectTemplates~1{inspectTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_deidentify_templates_delete: + projects_inspect_templates_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1inspectTemplates~1{inspectTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - _projects_deidentify_templates_list: - operation: &ref_21 - $ref: '#/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates/get' - response: &ref_22 + projects_inspect_templates_get: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1inspectTemplates~1{inspectTemplatesId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deidentifyTemplates - projects_deidentify_templates_list: - operation: *ref_21 - response: *ref_22 - projects_deidentify_templates_create: + projects_inspect_templates_create: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates/post' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1inspectTemplates/post' response: mediaType: application/json openAPIDocKey: '200' - projects_deidentify_templates_get: + _projects_inspect_templates_list: + operation: &ref_25 + $ref: '#/paths/~1v2~1projects~1{projectsId}~1inspectTemplates/get' + response: &ref_26 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.inspectTemplates + projects_inspect_templates_list: + operation: *ref_25 + response: *ref_26 + _organizations_locations_inspect_templates_list: + operation: &ref_27 + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates/get + response: &ref_28 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.inspectTemplates + organizations_locations_inspect_templates_list: + operation: *ref_27 + response: *ref_28 + organizations_locations_inspect_templates_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates/post response: mediaType: application/json openAPIDocKey: '200' - projects_deidentify_templates_delete: + organizations_locations_inspect_templates_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_deidentify_templates_patch: + organizations_locations_inspect_templates_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_deidentify_templates_delete: + organizations_locations_inspect_templates_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_deidentify_templates_patch: + organizations_inspect_templates_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_deidentify_templates_get: + organizations_inspect_templates_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_deidentify_templates_list: - operation: &ref_23 + organizations_inspect_templates_delete: + operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates/get - response: &ref_24 + #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/delete + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deidentifyTemplates - projects_locations_deidentify_templates_list: - operation: *ref_23 - response: *ref_24 - projects_locations_deidentify_templates_create: + organizations_inspect_templates_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates/post + #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates/post response: mediaType: application/json openAPIDocKey: '200' + _organizations_inspect_templates_list: + operation: &ref_29 + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates/get + response: &ref_30 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.inspectTemplates + organizations_inspect_templates_list: + operation: *ref_29 + response: *ref_30 sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_get + #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_get - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_list + #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_get - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_list + #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_list - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_get + #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_get - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_list + #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_list - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_get + #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_get - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_get + #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_list - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_list + #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_list insert: - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_create + #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_create - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_create + #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_create - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_create + #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_create - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_create - update: [] + #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_create + update: + - $ref: >- + #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_patch + - $ref: >- + #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_patch + - $ref: >- + #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_patch + - $ref: >- + #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_patch delete: - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_delete + #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_delete - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/organizations_locations_deidentify_templates_delete + #/components/x-stackQL-resources/inspect_templates/methods/organizations_locations_inspect_templates_delete - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_delete + #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_delete - $ref: >- - #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_delete - table_data_profiles: - id: dlp.table_data_profiles - name: table_data_profiles - title: Table_data_profiles + #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_delete + connections: + id: google.dlp.connections + name: connections + title: Connections methods: - _organizations_locations_table_data_profiles_list: - operation: &ref_25 + projects_locations_connections_create: + operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles/get - response: &ref_26 + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.tableDataProfiles - organizations_locations_table_data_profiles_list: - operation: *ref_25 - response: *ref_26 - organizations_locations_table_data_profiles_get: + _projects_locations_connections_list: + operation: &ref_31 + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get + response: &ref_32 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.connections + projects_locations_connections_list: + operation: *ref_31 + response: *ref_32 + projects_locations_connections_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_table_data_profiles_delete: + projects_locations_connections_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_table_data_profiles_list: - operation: &ref_27 + projects_locations_connections_get: + operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles/get - response: &ref_28 + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.tableDataProfiles - projects_locations_table_data_profiles_list: - operation: *ref_27 - response: *ref_28 - projects_locations_table_data_profiles_delete: + projects_locations_connections_search: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections:search/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_table_data_profiles_get: + organizations_locations_connections_search: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections:search/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_list + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_get - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_get + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_list + insert: - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_list + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_create + update: - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_get - insert: [] - update: [] + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_patch delete: - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_delete - - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_delete - job_triggers: - id: dlp.job_triggers - name: job_triggers - title: Job_triggers + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_delete + image: + id: google.dlp.image + name: image + title: Image methods: - _organizations_locations_job_triggers_list: - operation: &ref_29 - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers/get - response: &ref_30 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.jobTriggers - organizations_locations_job_triggers_list: - operation: *ref_29 - response: *ref_30 - organizations_locations_job_triggers_create: - operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_locations_job_triggers_patch: + projects_locations_image_redact: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1image:redact/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_job_triggers_delete: + projects_image_redact: operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/delete + $ref: '#/paths/~1v2~1projects~1{projectsId}~1image:redact/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_job_triggers_get: - operation: + sqlVerbs: + select: [] + insert: [] + update: [] + 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_33 $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/get - response: + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1columnDataProfiles/get + response: &ref_34 mediaType: application/json openAPIDocKey: '200' - projects_locations_job_triggers_delete: + objectKey: $.columnDataProfiles + projects_locations_column_data_profiles_list: + operation: *ref_33 + response: *ref_34 + projects_locations_column_data_profiles_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1columnDataProfiles~1{columnDataProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_job_triggers_get: + organizations_locations_column_data_profiles_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1columnDataProfiles~1{columnDataProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_job_triggers_patch: + _organizations_locations_column_data_profiles_list: + operation: &ref_35 + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1columnDataProfiles/get + response: &ref_36 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.columnDataProfiles + organizations_locations_column_data_profiles_list: + operation: *ref_35 + response: *ref_36 + 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: [] + delete: [] + stored_info_types: + id: google.dlp.stored_info_types + name: stored_info_types + title: Stored_info_types + methods: + projects_locations_stored_info_types_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes/post response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_job_triggers_list: - operation: &ref_31 + _projects_locations_stored_info_types_list: + operation: &ref_37 $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers/get - response: &ref_32 + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes/get + response: &ref_38 mediaType: application/json openAPIDocKey: '200' - objectKey: $.jobTriggers - projects_locations_job_triggers_list: - operation: *ref_31 - response: *ref_32 - projects_locations_job_triggers_create: + objectKey: $.storedInfoTypes + projects_locations_stored_info_types_list: + operation: *ref_37 + response: *ref_38 + projects_locations_stored_info_types_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_job_triggers_activate: + projects_locations_stored_info_types_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}:activate/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_job_triggers_hybrid_inspect: + projects_locations_stored_info_types_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}:hybridInspect/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_job_triggers_create: + projects_stored_info_types_create: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1jobTriggers/post' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes/post' response: mediaType: application/json openAPIDocKey: '200' - _projects_job_triggers_list: - operation: &ref_33 - $ref: '#/paths/~1v2~1projects~1{projectsId}~1jobTriggers/get' - response: &ref_34 + _projects_stored_info_types_list: + operation: &ref_39 + $ref: '#/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes/get' + response: &ref_40 mediaType: application/json openAPIDocKey: '200' - objectKey: $.jobTriggers - projects_job_triggers_list: - operation: *ref_33 - response: *ref_34 - projects_job_triggers_get: + objectKey: $.storedInfoTypes + projects_stored_info_types_list: + operation: *ref_39 + response: *ref_40 + projects_stored_info_types_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/get + #/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes~1{storedInfoTypesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_job_triggers_delete: + projects_stored_info_types_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/delete + #/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes~1{storedInfoTypesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_job_triggers_patch: + projects_stored_info_types_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/patch + #/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes~1{storedInfoTypesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_job_triggers_activate: + organizations_locations_stored_info_types_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}:activate/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_list - - $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_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_list - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_get - insert: - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_create - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_create - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_create - update: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_delete - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_delete - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_delete - discovery_configs: - id: dlp.discovery_configs - name: discovery_configs - title: Discovery_configs - methods: - organizations_locations_discovery_configs_delete: - operation: + _organizations_locations_stored_info_types_list: + operation: &ref_41 $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/delete - response: + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes/get + response: &ref_42 mediaType: application/json openAPIDocKey: '200' - organizations_locations_discovery_configs_patch: + objectKey: $.storedInfoTypes + organizations_locations_stored_info_types_list: + operation: *ref_41 + response: *ref_42 + organizations_locations_stored_info_types_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_discovery_configs_get: + organizations_locations_stored_info_types_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/get response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_discovery_configs_list: - operation: &ref_35 - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs/get - response: &ref_36 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.discoveryConfigs - organizations_locations_discovery_configs_list: - operation: *ref_35 - response: *ref_36 - organizations_locations_discovery_configs_create: + organizations_locations_stored_info_types_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_discovery_configs_patch: + organizations_stored_info_types_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_discovery_configs_get: + organizations_stored_info_types_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_discovery_configs_delete: + organizations_stored_info_types_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/get response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_discovery_configs_list: - operation: &ref_37 + _organizations_stored_info_types_list: + operation: &ref_43 $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs/get - response: &ref_38 + #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes/get + response: &ref_44 mediaType: application/json openAPIDocKey: '200' - objectKey: $.discoveryConfigs - projects_locations_discovery_configs_list: - operation: *ref_37 - response: *ref_38 - projects_locations_discovery_configs_create: + objectKey: $.storedInfoTypes + organizations_stored_info_types_list: + operation: *ref_43 + response: *ref_44 + organizations_stored_info_types_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs/post + #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_get + #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_get - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_list + #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_get - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_get + #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_list + - $ref: >- + #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_get + - $ref: >- + #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_list + - $ref: >- + #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_get + - $ref: >- + #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_list + - $ref: >- + #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_list + insert: + - $ref: >- + #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_create + - $ref: >- + #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_create + - $ref: >- + #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_create + - $ref: >- + #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_create + update: + - $ref: >- + #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_patch - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_list - insert: + #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_patch - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_create + #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_patch - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_create - update: [] + #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_patch delete: - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_delete + #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_delete - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_delete - project_data_profiles: - id: dlp.project_data_profiles - name: project_data_profiles - title: Project_data_profiles + #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_delete + - $ref: >- + #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_delete + - $ref: >- + #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_delete + discovery_configs: + id: google.dlp.discovery_configs + name: discovery_configs + title: Discovery_configs methods: - organizations_locations_project_data_profiles_get: + projects_locations_discovery_configs_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1projectDataProfiles~1{projectDataProfilesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/get response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_project_data_profiles_list: - operation: &ref_39 - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1projectDataProfiles/get - response: &ref_40 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.projectDataProfiles - organizations_locations_project_data_profiles_list: - operation: *ref_39 - response: *ref_40 - projects_locations_project_data_profiles_get: + projects_locations_discovery_configs_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1projectDataProfiles~1{projectDataProfilesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/delete response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_project_data_profiles_list: - operation: &ref_41 - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1projectDataProfiles/get - response: &ref_42 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.projectDataProfiles - projects_locations_project_data_profiles_list: - operation: *ref_41 - response: *ref_42 - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/project_data_profiles/methods/organizations_locations_project_data_profiles_get - - $ref: >- - #/components/x-stackQL-resources/project_data_profiles/methods/organizations_locations_project_data_profiles_list - - $ref: >- - #/components/x-stackQL-resources/project_data_profiles/methods/projects_locations_project_data_profiles_get - - $ref: >- - #/components/x-stackQL-resources/project_data_profiles/methods/projects_locations_project_data_profiles_list - insert: [] - update: [] - delete: [] - column_data_profiles: - id: dlp.column_data_profiles - name: column_data_profiles - title: Column_data_profiles - methods: - organizations_locations_column_data_profiles_get: + projects_locations_discovery_configs_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1columnDataProfiles~1{columnDataProfilesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/patch response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_column_data_profiles_list: - operation: &ref_43 - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1columnDataProfiles/get - response: &ref_44 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.columnDataProfiles - organizations_locations_column_data_profiles_list: - operation: *ref_43 - response: *ref_44 - _projects_locations_column_data_profiles_list: + _projects_locations_discovery_configs_list: operation: &ref_45 $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1columnDataProfiles/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs/get response: &ref_46 mediaType: application/json openAPIDocKey: '200' - objectKey: $.columnDataProfiles - projects_locations_column_data_profiles_list: + objectKey: $.discoveryConfigs + projects_locations_discovery_configs_list: operation: *ref_45 response: *ref_46 - 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' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/column_data_profiles/methods/organizations_locations_column_data_profiles_get - - $ref: >- - #/components/x-stackQL-resources/column_data_profiles/methods/organizations_locations_column_data_profiles_list - - $ref: >- - #/components/x-stackQL-resources/column_data_profiles/methods/projects_locations_column_data_profiles_list - - $ref: >- - #/components/x-stackQL-resources/column_data_profiles/methods/projects_locations_column_data_profiles_get - insert: [] - update: [] - delete: [] - connections: - id: dlp.connections - name: connections - title: Connections - methods: - organizations_locations_connections_search: + projects_locations_discovery_configs_create: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections:search/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_get: + organizations_locations_discovery_configs_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_delete: + organizations_locations_discovery_configs_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_patch: + organizations_locations_discovery_configs_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_create: + organizations_locations_discovery_configs_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs/post response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_connections_list: + _organizations_locations_discovery_configs_list: operation: &ref_47 $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs/get response: &ref_48 mediaType: application/json openAPIDocKey: '200' - objectKey: $.connections - projects_locations_connections_list: + objectKey: $.discoveryConfigs + organizations_locations_discovery_configs_list: operation: *ref_47 response: *ref_48 - projects_locations_connections_search: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~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 + #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_get - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_list + #/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/connections/methods/projects_locations_connections_create - update: [] + #/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 delete: - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_delete - dlp_jobs: - id: dlp.dlp_jobs - name: dlp_jobs - title: Dlp_jobs + #/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 + job_triggers: + id: google.dlp.job_triggers + name: job_triggers + title: Job_triggers methods: - _organizations_locations_dlp_jobs_list: - operation: &ref_49 - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1dlpJobs/get - response: &ref_50 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.jobs - organizations_locations_dlp_jobs_list: - operation: *ref_49 - response: *ref_50 - 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: + projects_locations_job_triggers_patch: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs~1{dlpJobsId}/get' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_dlp_jobs_create: + projects_locations_job_triggers_get: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs/post' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/get response: mediaType: application/json openAPIDocKey: '200' - _projects_dlp_jobs_list: - operation: &ref_51 - $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs/get' - response: &ref_52 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.jobs - projects_dlp_jobs_list: - operation: *ref_51 - response: *ref_52 - projects_dlp_jobs_cancel: + projects_locations_job_triggers_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1dlpJobs~1{dlpJobsId}:cancel/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_dlp_jobs_hybrid_inspect: + projects_locations_job_triggers_activate: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}:hybridInspect/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}:activate/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_dlp_jobs_delete: + projects_locations_job_triggers_hybrid_inspect: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}:hybridInspect/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_dlp_jobs_get: - operation: + _projects_locations_job_triggers_list: + operation: &ref_49 $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}/get - response: + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers/get + response: &ref_50 mediaType: application/json openAPIDocKey: '200' - projects_locations_dlp_jobs_finish: + objectKey: $.jobTriggers + projects_locations_job_triggers_list: + operation: *ref_49 + response: *ref_50 + projects_locations_job_triggers_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}:finish/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_dlp_jobs_create: + projects_job_triggers_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs/post + #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/delete response: - mediaType: application/json - openAPIDocKey: '200' - _projects_locations_dlp_jobs_list: - operation: &ref_53 - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs/get - response: &ref_54 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.jobs - projects_locations_dlp_jobs_list: - operation: *ref_53 - response: *ref_54 - projects_locations_dlp_jobs_cancel: + mediaType: application/json + openAPIDocKey: '200' + projects_job_triggers_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}:cancel/post + #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/organizations_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_dlp_jobs_list - - $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 - insert: - - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/projects_dlp_jobs_create - - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_create - update: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/projects_dlp_jobs_delete - - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_delete - content: - id: dlp.content - name: content - title: Content - methods: - projects_content_reidentify: + projects_job_triggers_patch: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1content:reidentify/post' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_content_inspect: + projects_job_triggers_activate: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1content:inspect/post' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}:activate/post response: mediaType: application/json openAPIDocKey: '200' - projects_content_deidentify: + projects_job_triggers_create: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1content:deidentify/post' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1jobTriggers/post' response: mediaType: application/json openAPIDocKey: '200' - projects_locations_content_inspect: + _projects_job_triggers_list: + operation: &ref_51 + $ref: '#/paths/~1v2~1projects~1{projectsId}~1jobTriggers/get' + response: &ref_52 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.jobTriggers + projects_job_triggers_list: + operation: *ref_51 + response: *ref_52 + organizations_locations_job_triggers_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1content:inspect/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_content_reidentify: + organizations_locations_job_triggers_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1content:reidentify/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_content_deidentify: + organizations_locations_job_triggers_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1content:deidentify/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - image: - id: dlp.image - name: image - title: Image - methods: - projects_locations_image_redact: + organizations_locations_job_triggers_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1image:redact/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers/post response: mediaType: application/json openAPIDocKey: '200' - projects_image_redact: - operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1image:redact/post' - response: + _organizations_locations_job_triggers_list: + operation: &ref_53 + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers/get + response: &ref_54 mediaType: application/json openAPIDocKey: '200' + objectKey: $.jobTriggers + organizations_locations_job_triggers_list: + operation: *ref_53 + response: *ref_54 sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] + 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 + 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 paths: - /v2/infoTypes: + /v2/locations/{locationsId}/infoTypes: parameters: &ref_55 - - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/uploadType' 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.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: query - name: filter - schema: - type: string - - in: query - name: parent - schema: - type: string - - in: query - name: locationId - schema: - type: string - - in: query - name: languageCode - schema: - type: string - /v2/organizations/{organizationsId}/storedInfoTypes: - parameters: *ref_55 - get: - description: >- - Lists stored infoTypes. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.organizations.storedInfoTypes.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/GooglePrivacyDlpV2ListStoredInfoTypesResponse - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - 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 - 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 - schema: - type: string - /v2/organizations/{organizationsId}/storedInfoTypes/{storedInfoTypesId}: - parameters: *ref_55 - get: - description: >- - Gets a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.organizations.storedInfoTypes.get + operationId: dlp.locations.infoTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8587,24 +8512,44 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2ListInfoTypesResponse' parameters: - in: path - name: organizationsId + name: locationsId required: true schema: type: string - - in: path - name: storedInfoTypesId - required: true + - in: query + name: filter schema: type: string - delete: + - in: query + name: locationId + schema: + type: string + - in: query + name: languageCode + schema: + type: string + /v2/projects/{projectsId}/content:inspect: + parameters: *ref_55 + post: description: >- - Deletes a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.organizations.storedInfoTypes.delete + 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 @@ -8616,31 +8561,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentResponse' parameters: - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: storedInfoTypesId + name: projectsId required: true schema: type: string - patch: + /v2/projects/{projectsId}/content:reidentify: + parameters: *ref_55 + 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 + 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.organizations.storedInfoTypes.patch + operationId: dlp.projects.content.reidentify requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2ReidentifyContentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8652,32 +8592,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ReidentifyContentResponse parameters: - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: storedInfoTypesId + name: projectsId required: true schema: type: string - /v2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}: + /v2/projects/{projectsId}/content:deidentify: parameters: *ref_55 - patch: + post: description: >- - Updates the InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates - to learn more. - operationId: dlp.organizations.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.content.deidentify requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyContentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8689,24 +8628,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DeidentifyContentResponse parameters: - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: inspectTemplatesId + name: projectsId required: true schema: type: string + /v2/projects/{projectsId}/dlpJobs/{dlpJobsId}: + parameters: *ref_55 get: description: >- - Gets an InspectTemplate. 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.organizations.inspectTemplates.get + operationId: dlp.projects.dlpJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8718,24 +8657,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string - in: path - name: inspectTemplatesId + name: dlpJobsId required: true schema: type: string delete: description: >- - Deletes an InspectTemplate. 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.organizations.inspectTemplates.delete + operationId: dlp.projects.dlpJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8750,30 +8693,25 @@ paths: $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string - in: path - name: inspectTemplatesId + name: dlpJobsId required: true schema: type: string - /v2/organizations/{organizationsId}/inspectTemplates: + /v2/projects/{projectsId}/dlpJobs: parameters: *ref_55 - 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 + 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.inspectTemplates.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest + operationId: dlp.projects.dlpJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8785,19 +8723,54 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2ListDlpJobsResponse' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string - get: + - 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: orderBy + schema: + type: string + - in: query + name: type + schema: + type: string + - in: query + name: pageToken + schema: + type: string + post: description: >- - Lists InspectTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates - to learn more. - operationId: dlp.organizations.inspectTemplates.list + 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 @@ -8809,39 +8782,30 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' parameters: - in: path - name: organizationsId + name: projectsId 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 - /v2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}: + /v2/projects/{projectsId}/dlpJobs/{dlpJobsId}:cancel: parameters: *ref_55 - delete: + post: description: >- - Deletes a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + 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.organizations.deidentifyTemplates.delete + operationId: dlp.projects.dlpJobs.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2CancelDlpJobRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8856,27 +8820,34 @@ paths: $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string - in: path - name: deidentifyTemplatesId + name: dlpJobsId required: true schema: type: string - patch: + /v2/projects/{projectsId}/locations/{locationsId}/content:inspect: + parameters: *ref_55 + post: description: >- - Updates the DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.organizations.deidentifyTemplates.patch + 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/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8888,24 +8859,35 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentResponse' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string - in: path - name: deidentifyTemplatesId + name: locationsId required: true schema: type: string - get: + /v2/projects/{projectsId}/locations/{locationsId}/content:deidentify: + parameters: *ref_55 + post: description: >- - Gets a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.organizations.deidentifyTemplates.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.locations.content.deidentify + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyContentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8917,33 +8899,32 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DeidentifyContentResponse parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string - in: path - name: deidentifyTemplatesId + name: locationsId required: true schema: type: string - /v2/organizations/{organizationsId}/deidentifyTemplates: + /v2/projects/{projectsId}/locations/{locationsId}/content:reidentify: parameters: *ref_55 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 + 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.organizations.deidentifyTemplates.create + operationId: dlp.projects.locations.content.reidentify requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2ReidentifyContentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8955,19 +8936,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ReidentifyContentResponse parameters: - in: path - name: organizationsId + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId required: true schema: type: string + /v2/projects/{projectsId}/locations/{locationsId}/projectDataProfiles: + parameters: *ref_55 get: - description: >- - Lists DeidentifyTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.organizations.deidentifyTemplates.list + description: Lists project data profiles for an organization. + operationId: dlp.projects.locations.projectDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8980,10 +8966,15 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse + #/components/schemas/GooglePrivacyDlpV2ListProjectDataProfilesResponse parameters: - in: path - name: organizationsId + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId required: true schema: type: string @@ -8992,33 +8983,23 @@ paths: schema: type: string - in: query - name: locationId + name: pageSize schema: - type: string + type: integer + format: int32 - in: query name: orderBy schema: type: string - in: query - name: pageSize + name: filter schema: - type: integer - format: int32 - /v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/projectDataProfiles/{projectDataProfilesId}: parameters: *ref_55 - 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 + get: + description: Gets a project data profile. + operationId: dlp.projects.locations.projectDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9030,10 +9011,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2ProjectDataProfile' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -9042,12 +9023,18 @@ paths: required: true schema: type: string - get: + - in: path + name: projectDataProfilesId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/tableDataProfiles/{tableDataProfilesId}: + parameters: *ref_55 + delete: description: >- - Lists DeidentifyTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.organizations.locations.deidentifyTemplates.list + 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 @@ -9059,11 +9046,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -9072,37 +9058,47 @@ paths: required: true schema: type: string - - in: query - name: pageSize + - in: path + name: tableDataProfilesId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + get: + description: Gets a table data profile. + operationId: dlp.projects.locations.tableDataProfiles.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/GooglePrivacyDlpV2TableDataProfile' + parameters: + - in: path + name: projectsId + required: true schema: type: string - - in: query - name: orderBy + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: locationId + - in: path + name: tableDataProfilesId + required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}: + /v2/projects/{projectsId}/locations/{locationsId}/tableDataProfiles: parameters: *ref_55 - 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/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest + get: + description: Lists table data profiles for an organization. + operationId: dlp.projects.locations.tableDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9114,10 +9110,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListTableDataProfilesResponse parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -9126,17 +9123,38 @@ paths: required: true schema: type: string - - in: path - name: deidentifyTemplatesId - required: true + - in: query + name: pageToken schema: type: string - get: + - 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}/deidentifyTemplates: + parameters: *ref_55 + post: description: >- - Gets a DeidentifyTemplate. See + 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.get + operationId: dlp.projects.locations.deidentifyTemplates.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9151,7 +9169,7 @@ paths: $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -9160,17 +9178,12 @@ paths: required: true schema: type: string - - in: path - name: deidentifyTemplatesId - required: true - schema: - type: string - delete: + get: description: >- - Deletes a DeidentifyTemplate. See + Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.organizations.locations.deidentifyTemplates.delete + operationId: dlp.projects.locations.deidentifyTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9182,10 +9195,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -9194,19 +9208,31 @@ paths: required: true schema: type: string - - in: path - name: deidentifyTemplatesId - required: true + - in: query + name: pageToken + schema: + type: string + - in: query + name: locationId + schema: + type: string + - in: query + name: orderBy schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}: + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}: parameters: *ref_55 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.organizations.locations.storedInfoTypes.get + operationId: dlp.projects.locations.deidentifyTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9218,10 +9244,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -9231,23 +9257,22 @@ paths: schema: type: string - in: path - name: storedInfoTypesId + name: deidentifyTemplatesId 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 + Updates the DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.organizations.locations.storedInfoTypes.patch + operationId: dlp.projects.locations.deidentifyTemplates.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest + #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9259,10 +9284,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -9272,16 +9297,16 @@ paths: schema: type: string - in: path - name: storedInfoTypesId + name: deidentifyTemplatesId required: true schema: type: string 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.organizations.locations.storedInfoTypes.delete + operationId: dlp.projects.locations.deidentifyTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9296,7 +9321,7 @@ paths: $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -9306,18 +9331,25 @@ paths: schema: type: string - in: path - name: storedInfoTypesId + name: deidentifyTemplatesId required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes: + /v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates: parameters: *ref_55 - get: + post: description: >- - Lists stored infoTypes. 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.locations.storedInfoTypes.list + operationId: dlp.projects.locations.inspectTemplates.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9329,11 +9361,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -9342,35 +9373,12 @@ 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 - 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 + Lists InspectTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.organizations.locations.storedInfoTypes.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest + operationId: dlp.projects.locations.inspectTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9382,10 +9390,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -9394,14 +9403,31 @@ paths: required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}: + - in: query + name: pageToken + 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 + /v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}: parameters: *ref_55 - get: + delete: description: >- - Gets an InspectTemplate. See + Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.organizations.locations.inspectTemplates.get + operationId: dlp.projects.locations.inspectTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9413,10 +9439,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 @@ -9435,7 +9461,7 @@ paths: Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.organizations.locations.inspectTemplates.patch + operationId: dlp.projects.locations.inspectTemplates.patch requestBody: content: application/json: @@ -9456,7 +9482,7 @@ paths: $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -9470,12 +9496,12 @@ paths: required: true schema: type: string - delete: + get: description: >- - Deletes an InspectTemplate. See + Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.organizations.locations.inspectTemplates.delete + operationId: dlp.projects.locations.inspectTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9487,10 +9513,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 @@ -9504,21 +9530,16 @@ paths: required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates: + /v2/projects/{projectsId}/locations/{locationsId}/connections: parameters: *ref_55 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: Create a Connection to an external data source. + operationId: dlp.projects.locations.connections.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateConnectionRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9530,10 +9551,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -9543,11 +9564,8 @@ paths: schema: type: string 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 Connections in a parent. + operationId: dlp.projects.locations.connections.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9559,11 +9577,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2ListConnectionsResponse' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -9572,28 +9589,29 @@ paths: 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 + name: pageToken schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/tableDataProfiles: + - in: query + name: filter + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}: parameters: *ref_55 - get: - description: Lists table data profiles for an organization. - operationId: dlp.organizations.locations.tableDataProfiles.list + patch: + description: Update a Connection. + operationId: dlp.projects.locations.connections.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateConnectionRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9605,11 +9623,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListTableDataProfilesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -9618,28 +9635,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: connectionsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v2/organizations/{organizationsId}/locations/{locationsId}/tableDataProfiles/{tableDataProfilesId}: - parameters: *ref_55 - get: - description: Gets a table data profile. - operationId: dlp.organizations.locations.tableDataProfiles.get + delete: + description: Delete a Connection. + operationId: dlp.projects.locations.connections.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9651,10 +9654,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -9664,15 +9667,13 @@ paths: schema: type: string - in: path - name: tableDataProfilesId + name: connectionsId 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.organizations.locations.tableDataProfiles.delete + get: + description: Get a Connection by name. + operationId: dlp.projects.locations.connections.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9684,10 +9685,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -9697,18 +9698,15 @@ paths: schema: type: string - in: path - name: tableDataProfilesId + name: connectionsId required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers: + /v2/projects/{projectsId}/locations/{locationsId}/connections:search: parameters: *ref_55 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 + description: Searches for Connections in a parent. + operationId: dlp.projects.locations.connections.search security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9720,10 +9718,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListJobTriggersResponse' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2SearchConnectionsResponse parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -9732,14 +9731,6 @@ paths: required: true schema: type: string - - in: query - name: type - schema: - type: string - - in: query - name: pageToken - schema: - type: string - in: query name: filter schema: @@ -9750,25 +9741,26 @@ paths: type: integer format: int32 - in: query - name: orderBy - schema: - type: string - - in: query - name: locationId + name: pageToken schema: type: string + /v2/projects/{projectsId}/locations/{locationsId}/image:redact: + parameters: *ref_55 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 + 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/GooglePrivacyDlpV2CreateJobTriggerRequest' + $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9780,10 +9772,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageResponse' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -9792,19 +9784,11 @@ paths: required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}: + /v2/projects/{projectsId}/locations/{locationsId}/columnDataProfiles: parameters: *ref_55 - 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' + get: + description: Lists column data profiles for an organization. + operationId: dlp.projects.locations.columnDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9816,10 +9800,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListColumnDataProfilesResponse parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -9828,17 +9813,28 @@ paths: required: true schema: type: string - - in: path - name: jobTriggersId - required: true + - in: query + name: filter 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: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/columnDataProfiles/{columnDataProfilesId}: + parameters: *ref_55 + get: + description: Gets a column data profile. + operationId: dlp.projects.locations.columnDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9850,10 +9846,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -9863,16 +9859,24 @@ paths: schema: type: string - in: path - name: jobTriggersId + name: columnDataProfilesId required: true schema: type: string - get: + /v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes: + parameters: *ref_55 + post: description: >- - Gets a job trigger. 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.organizations.locations.jobTriggers.get + operationId: dlp.projects.locations.storedInfoTypes.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9884,10 +9888,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -9896,16 +9900,61 @@ paths: required: true schema: type: string + 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 + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse + parameters: - in: path - name: jobTriggersId + name: projectsId required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/discoveryConfigs/{discoveryConfigsId}: + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: orderBy + 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 + /v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}: parameters: *ref_55 - delete: - description: Deletes a discovery configuration. - operationId: dlp.organizations.locations.discoveryConfigs.delete + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9917,10 +9966,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -9930,19 +9979,23 @@ paths: schema: type: string - in: path - name: discoveryConfigsId + name: storedInfoTypesId required: true schema: type: string patch: - description: Updates a discovery configuration. - operationId: dlp.organizations.locations.discoveryConfigs.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/GooglePrivacyDlpV2UpdateDiscoveryConfigRequest + #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9954,10 +10007,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -9967,13 +10020,16 @@ paths: schema: type: string - in: path - name: discoveryConfigsId + name: storedInfoTypesId required: true schema: type: string - get: - description: Gets a discovery configuration. - operationId: dlp.organizations.locations.discoveryConfigs.get + 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 @@ -9985,10 +10041,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -9998,15 +10054,15 @@ paths: schema: type: string - in: path - name: discoveryConfigsId + name: storedInfoTypesId required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/discoveryConfigs: + /v2/projects/{projectsId}/locations/{locationsId}/discoveryConfigs/{discoveryConfigsId}: parameters: *ref_55 get: - description: Lists discovery configurations. - operationId: dlp.organizations.locations.discoveryConfigs.list + description: Gets a discovery configuration. + operationId: dlp.projects.locations.discoveryConfigs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10018,11 +10074,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListDiscoveryConfigsResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -10031,28 +10086,14 @@ 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 + - in: path + name: discoveryConfigsId + required: true schema: type: string - 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/GooglePrivacyDlpV2CreateDiscoveryConfigRequest + delete: + description: Deletes a discovery configuration. + operationId: dlp.projects.locations.discoveryConfigs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10064,10 +10105,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -10076,11 +10117,20 @@ paths: required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/projectDataProfiles/{projectDataProfilesId}: - parameters: *ref_55 - get: - description: Gets a project data profile. - operationId: dlp.organizations.locations.projectDataProfiles.get + - in: path + name: discoveryConfigsId + required: true + schema: + type: string + 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 @@ -10092,10 +10142,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ProjectDataProfile' + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -10105,15 +10155,15 @@ paths: schema: type: string - in: path - name: projectDataProfilesId + name: discoveryConfigsId required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/projectDataProfiles: + /v2/projects/{projectsId}/locations/{locationsId}/discoveryConfigs: parameters: *ref_55 get: - description: Lists project data profiles for an organization. - operationId: dlp.organizations.locations.projectDataProfiles.list + description: Lists discovery configurations. + operationId: dlp.projects.locations.discoveryConfigs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10126,10 +10176,10 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListProjectDataProfilesResponse + #/components/schemas/GooglePrivacyDlpV2ListDiscoveryConfigsResponse parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -10138,28 +10188,28 @@ 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 + name: orderBy schema: type: string - in: query - name: orderBy + name: pageSize schema: - type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/columnDataProfiles/{columnDataProfilesId}: - parameters: *ref_55 - get: - description: Gets a column data profile. - operationId: dlp.organizations.locations.columnDataProfiles.get + 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 @@ -10171,10 +10221,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -10183,16 +10233,19 @@ paths: required: true schema: type: string - - in: path - name: columnDataProfilesId - required: true - schema: - type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/columnDataProfiles: + /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}: parameters: *ref_55 - get: - description: Lists column data profiles for an organization. - operationId: dlp.organizations.locations.columnDataProfiles.list + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10204,11 +10257,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListColumnDataProfilesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -10217,28 +10269,17 @@ 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: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: jobTriggersId + required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/connections:search: - parameters: *ref_55 get: - description: Searches for Connections in a parent. - operationId: dlp.organizations.locations.connections.search + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10250,11 +10291,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2SearchConnectionsResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -10263,29 +10303,17 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: jobTriggersId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v2/organizations/{organizationsId}/locations/{locationsId}/dlpJobs: - parameters: *ref_55 - get: + delete: 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 + Deletes a job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.organizations.locations.dlpJobs.list + operationId: dlp.projects.locations.jobTriggers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10297,10 +10325,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListDlpJobsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -10309,39 +10337,23 @@ paths: required: true 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: filter - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: locationId + - in: path + name: jobTriggersId + required: true schema: type: string - /v2/projects/{projectsId}/deidentifyTemplates: + /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}:activate: parameters: *ref_55 - get: + post: description: >- - Lists DeidentifyTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.projects.deidentifyTemplates.list + 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' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10353,44 +10365,37 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' 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: orderBy + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: locationId + - in: path + name: jobTriggersId + required: true schema: type: string + /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}:hybridInspect: + parameters: *ref_55 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 + 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/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest + #/components/schemas/GooglePrivacyDlpV2HybridInspectJobTriggerRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10402,21 +10407,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridInspectResponse' parameters: - in: path name: projectsId required: true schema: type: string - /v2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: jobTriggersId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers: parameters: *ref_55 get: description: >- - Gets a DeidentifyTemplate. 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.projects.deidentifyTemplates.get + operationId: dlp.projects.locations.jobTriggers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10428,7 +10443,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2ListJobTriggersResponse' parameters: - in: path name: projectsId @@ -10436,16 +10451,47 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: locationsId required: true schema: type: string - delete: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: type + 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: locationId + schema: + type: string + post: description: >- - Deletes a DeidentifyTemplate. 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.projects.deidentifyTemplates.delete + operationId: dlp.projects.locations.jobTriggers.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10457,7 +10503,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path name: projectsId @@ -10465,22 +10511,23 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: locationsId required: true schema: type: string - patch: + /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:hybridInspect: + parameters: *ref_55 + post: description: >- - Updates the DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.projects.deidentifyTemplates.patch + 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/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest + #/components/schemas/GooglePrivacyDlpV2HybridInspectDlpJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10492,7 +10539,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridInspectResponse' parameters: - in: path name: projectsId @@ -10500,11 +10547,16 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: locationsId required: true schema: type: string - /v2/projects/{projectsId}/dlpJobs/{dlpJobsId}: + - in: path + name: dlpJobsId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}: parameters: *ref_55 delete: description: >- @@ -10515,7 +10567,7 @@ paths: and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. - operationId: dlp.projects.dlpJobs.delete + operationId: dlp.projects.locations.dlpJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10534,6 +10586,11 @@ paths: required: true schema: type: string + - in: path + name: locationsId + required: true + schema: + type: string - in: path name: dlpJobsId required: true @@ -10546,7 +10603,7 @@ paths: and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. - operationId: dlp.projects.dlpJobs.get + operationId: dlp.projects.locations.dlpJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10565,12 +10622,57 @@ paths: required: true schema: type: string + - in: path + name: locationsId + required: true + schema: + type: string - in: path name: dlpJobsId required: true schema: type: string - /v2/projects/{projectsId}/dlpJobs: + /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:finish: + parameters: *ref_55 + 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 + 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: dlpJobsId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs: parameters: *ref_55 post: description: >- @@ -10582,7 +10684,7 @@ paths: 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 + operationId: dlp.projects.locations.dlpJobs.create requestBody: content: application/json: @@ -10606,6 +10708,11 @@ paths: 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 @@ -10613,7 +10720,7 @@ paths: and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. - operationId: dlp.projects.dlpJobs.list + operationId: dlp.projects.locations.dlpJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10632,8 +10739,9 @@ paths: required: true schema: type: string - - in: query - name: orderBy + - in: path + name: locationsId + required: true schema: type: string - in: query @@ -10642,11 +10750,15 @@ paths: type: integer format: int32 - in: query - name: type + name: pageToken schema: type: string - in: query - name: pageToken + name: locationId + schema: + type: string + - in: query + name: type schema: type: string - in: query @@ -10654,10 +10766,10 @@ paths: schema: type: string - in: query - name: locationId + name: orderBy schema: type: string - /v2/projects/{projectsId}/dlpJobs/{dlpJobsId}:cancel: + /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:cancel: parameters: *ref_55 post: description: >- @@ -10668,7 +10780,7 @@ paths: and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. - operationId: dlp.projects.dlpJobs.cancel + operationId: dlp.projects.locations.dlpJobs.cancel requestBody: content: application/json: @@ -10693,129 +10805,23 @@ paths: schema: type: string - in: path - name: dlpJobsId - required: true - schema: - type: string - /v2/projects/{projectsId}/content:reidentify: - parameters: *ref_55 - 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 - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ReidentifyContentResponse - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - /v2/projects/{projectsId}/content:inspect: - parameters: *ref_55 - 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 - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentResponse' - parameters: - - in: path - name: projectsId + name: locationsId required: true schema: type: string - /v2/projects/{projectsId}/content:deidentify: - parameters: *ref_55 - 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/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}: parameters: *ref_55 - 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.projects.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 @@ -10827,7 +10833,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -10839,12 +10845,18 @@ paths: required: true schema: type: string - get: + patch: description: >- - Gets an InspectTemplate. See + Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.projects.inspectTemplates.get + operationId: dlp.projects.inspectTemplates.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10868,12 +10880,12 @@ paths: required: true schema: type: string - delete: + get: description: >- - Deletes an InspectTemplate. See + Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.projects.inspectTemplates.delete + operationId: dlp.projects.inspectTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10885,7 +10897,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: projectsId @@ -10956,7 +10968,7 @@ paths: schema: type: string - in: query - name: locationId + name: orderBy schema: type: string - in: query @@ -10964,7 +10976,7 @@ paths: schema: type: string - in: query - name: orderBy + name: locationId schema: type: string - in: query @@ -10972,14 +10984,23 @@ paths: schema: type: integer format: int32 - /v2/projects/{projectsId}/storedInfoTypes: + /v2/projects/{projectsId}/image:redact: parameters: *ref_55 - get: + post: description: >- - Lists stored infoTypes. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.projects.storedInfoTypes.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 @@ -10991,43 +11012,21 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageResponse' parameters: - in: path name: projectsId 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 - post: + /v2/projects/{projectsId}/jobTriggers/{jobTriggersId}: + parameters: *ref_55 + delete: description: >- - Creates a pre-built stored infoType to be used for inspection. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Deletes a job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.projects.storedInfoTypes.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest + operationId: dlp.projects.jobTriggers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11039,21 +11038,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId required: true schema: type: string - /v2/projects/{projectsId}/storedInfoTypes/{storedInfoTypesId}: - parameters: *ref_55 + - in: path + name: jobTriggersId + 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 job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.projects.storedInfoTypes.get + operationId: dlp.projects.jobTriggers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11065,7 +11067,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path name: projectsId @@ -11073,16 +11075,21 @@ paths: schema: type: string - in: path - name: storedInfoTypesId + name: jobTriggersId required: true schema: type: string - delete: + patch: description: >- - Deletes a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Updates a job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.projects.storedInfoTypes.delete + operationId: dlp.projects.jobTriggers.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11094,7 +11101,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path name: projectsId @@ -11102,23 +11109,22 @@ paths: schema: type: string - in: path - name: storedInfoTypesId + name: jobTriggersId required: true schema: type: string - patch: + /v2/projects/{projectsId}/jobTriggers/{jobTriggersId}:activate: + parameters: *ref_55 + 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 - to learn more. - operationId: dlp.projects.storedInfoTypes.patch + 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/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2ActivateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11130,7 +11136,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' parameters: - in: path name: projectsId @@ -11138,18 +11144,24 @@ paths: schema: type: string - in: path - name: storedInfoTypesId + name: jobTriggersId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}: + /v2/projects/{projectsId}/jobTriggers: parameters: *ref_55 - delete: + post: description: >- - Deletes a DeidentifyTemplate. 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.projects.locations.deidentifyTemplates.delete + operationId: dlp.projects.jobTriggers.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11161,35 +11173,19 @@ 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: locationsId - required: true - schema: - type: string - - in: path - name: deidentifyTemplatesId - required: true - schema: - type: string - patch: + get: description: >- - Updates the DeidentifyTemplate. 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.projects.locations.deidentifyTemplates.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest + operationId: dlp.projects.jobTriggers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11201,29 +11197,52 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2ListJobTriggersResponse' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: type schema: type: string - - in: path - name: deidentifyTemplatesId - required: true + - in: query + name: filter schema: type: string - get: + - 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 + schema: + type: string + /v2/projects/{projectsId}/storedInfoTypes: + parameters: *ref_55 + post: description: >- - Gets a DeidentifyTemplate. 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.locations.deidentifyTemplates.get + operationId: dlp.projects.storedInfoTypes.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11235,31 +11254,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $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: deidentifyTemplatesId - required: true - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates: - parameters: *ref_55 get: - description: >- - Lists DeidentifyTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + description: >- + Lists stored infoTypes. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.projects.locations.deidentifyTemplates.list + operationId: dlp.projects.storedInfoTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11272,48 +11279,45 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse + #/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: pageToken + name: pageSize schema: - type: string + type: integer + format: int32 - in: query - name: orderBy + name: locationId schema: type: string - in: query - name: pageSize + name: pageToken schema: - type: integer - format: int32 + type: string - in: query - name: locationId + name: orderBy schema: type: string - post: + /v2/projects/{projectsId}/storedInfoTypes/{storedInfoTypesId}: + parameters: *ref_55 + patch: 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 + 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.deidentifyTemplates.create + operationId: dlp.projects.storedInfoTypes.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest + #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11325,7 +11329,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: projectsId @@ -11333,15 +11337,16 @@ paths: schema: type: string - in: path - name: locationsId + name: storedInfoTypesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/projectDataProfiles/{projectDataProfilesId}: - parameters: *ref_55 - get: - description: Gets a project data profile. - operationId: dlp.projects.locations.projectDataProfiles.get + delete: + description: >- + Deletes a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + to learn more. + operationId: dlp.projects.storedInfoTypes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11353,7 +11358,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ProjectDataProfile' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11361,20 +11366,16 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: projectDataProfilesId + name: storedInfoTypesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/projectDataProfiles: - parameters: *ref_55 get: - description: Lists project data profiles for an organization. - operationId: dlp.projects.locations.projectDataProfiles.list + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11386,8 +11387,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListProjectDataProfilesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: projectsId @@ -11395,41 +11395,25 @@ paths: schema: type: string - in: path - name: locationsId + name: storedInfoTypesId required: true 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}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}: + /v2/projects/{projectsId}/deidentifyTemplates: parameters: *ref_55 - patch: + 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.projects.locations.inspectTemplates.patch + operationId: dlp.projects.deidentifyTemplates.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest + #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11441,29 +11425,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' 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 - delete: + get: description: >- - Deletes an InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Lists DeidentifyTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.projects.locations.inspectTemplates.delete + operationId: dlp.projects.deidentifyTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11475,29 +11449,39 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse 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: inspectTemplatesId - required: true + - in: query + name: locationId schema: type: string - get: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + /v2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}: + parameters: *ref_55 + delete: description: >- - Gets 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.projects.locations.inspectTemplates.get + operationId: dlp.projects.deidentifyTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11509,7 +11493,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11517,23 +11501,16 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: inspectTemplatesId + name: deidentifyTemplatesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates: - parameters: *ref_55 get: description: >- - Lists InspectTemplates. 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.projects.locations.inspectTemplates.list + operationId: dlp.projects.deidentifyTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11545,8 +11522,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: projectsId @@ -11554,40 +11530,22 @@ 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: locationId - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy - schema: - type: string - post: + 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.projects.locations.inspectTemplates.create + operationId: dlp.projects.deidentifyTemplates.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest + #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11599,7 +11557,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: projectsId @@ -11607,15 +11565,56 @@ paths: schema: type: string - in: path - name: locationsId + name: deidentifyTemplatesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/tableDataProfiles: + /v2/infoTypes: parameters: *ref_55 get: - description: Lists table data profiles for an organization. - operationId: dlp.projects.locations.tableDataProfiles.list + 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 + security: + - Oauth2: + - https://www.googleapis.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: query + name: filter + schema: + type: string + - in: query + name: languageCode + schema: + type: string + - in: query + name: locationId + schema: + type: string + - in: query + name: parent + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates: + parameters: *ref_55 + get: + description: >- + 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 @@ -11628,10 +11627,10 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListTableDataProfilesResponse + #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -11641,7 +11640,11 @@ paths: schema: type: string - in: query - name: pageToken + name: orderBy + schema: + type: string + - in: query + name: locationId schema: type: string - in: query @@ -11650,20 +11653,22 @@ paths: type: integer format: int32 - in: query - name: orderBy - schema: - type: string - - in: query - name: filter + name: pageToken schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/tableDataProfiles/{tableDataProfilesId}: - parameters: *ref_55 - delete: + post: 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 + 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 @@ -11675,10 +11680,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -11687,14 +11692,14 @@ paths: required: true schema: type: string - - in: path - name: tableDataProfilesId - required: true - schema: - type: string - get: - description: Gets a table data profile. - operationId: dlp.projects.locations.tableDataProfiles.get + /v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}: + parameters: *ref_55 + 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 @@ -11706,10 +11711,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -11719,15 +11724,22 @@ paths: schema: type: string - in: path - name: tableDataProfilesId + name: inspectTemplatesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}: - parameters: *ref_55 - get: - description: Get a Connection by name. - operationId: dlp.projects.locations.connections.get + 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 @@ -11739,10 +11751,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -11752,13 +11764,16 @@ paths: schema: type: string - in: path - name: connectionsId + name: inspectTemplatesId required: true schema: type: string - delete: - description: Delete a Connection. - operationId: dlp.projects.locations.connections.delete + 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 @@ -11770,10 +11785,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -11783,18 +11798,15 @@ paths: schema: type: string - in: path - name: connectionsId + name: inspectTemplatesId 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' + /v2/organizations/{organizationsId}/locations/{locationsId}/tableDataProfiles/{tableDataProfilesId}: + parameters: *ref_55 + get: + description: Gets a table data profile. + operationId: dlp.organizations.locations.tableDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11806,10 +11818,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -11819,20 +11831,15 @@ paths: schema: type: string - in: path - name: connectionsId + name: tableDataProfilesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections: - parameters: *ref_55 - 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' + 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 @@ -11844,10 +11851,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -11856,9 +11863,16 @@ paths: required: true schema: type: string + - in: path + name: tableDataProfilesId + required: true + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/tableDataProfiles: + parameters: *ref_55 get: - description: Lists Connections in a parent. - operationId: dlp.projects.locations.connections.list + description: Lists table data profiles for an organization. + operationId: dlp.organizations.locations.tableDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11870,10 +11884,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListConnectionsResponse' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListTableDataProfilesResponse parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -11883,7 +11898,7 @@ paths: schema: type: string - in: query - name: filter + name: pageToken schema: type: string - in: query @@ -11892,14 +11907,18 @@ paths: type: integer format: int32 - in: query - name: pageToken + name: filter schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections:search: + - in: query + name: orderBy + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/columnDataProfiles/{columnDataProfilesId}: parameters: *ref_55 get: - description: Searches for Connections in a parent. - operationId: dlp.projects.locations.connections.search + description: Gets a column data profile. + operationId: dlp.organizations.locations.columnDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11911,11 +11930,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2SearchConnectionsResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -11924,27 +11942,16 @@ 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: columnDataProfilesId + required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes: + /v2/organizations/{organizationsId}/locations/{locationsId}/columnDataProfiles: parameters: *ref_55 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 column data profiles for an organization. + operationId: dlp.organizations.locations.columnDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11957,10 +11964,10 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse + #/components/schemas/GooglePrivacyDlpV2ListColumnDataProfilesResponse parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -11970,7 +11977,7 @@ paths: schema: type: string - in: query - name: locationId + name: filter schema: type: string - in: query @@ -11986,18 +11993,19 @@ paths: schema: type: integer format: int32 - post: + /v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}: + parameters: *ref_55 + patch: description: >- - Creates a pre-built stored infoType to be used for inspection. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Updates a job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.projects.locations.storedInfoTypes.create + operationId: dlp.organizations.locations.jobTriggers.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12009,10 +12017,44 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path - name: projectsId + 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 + 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 + 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 @@ -12021,14 +12063,17 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}: - parameters: *ref_55 + - in: path + name: jobTriggersId + required: true + schema: + type: string delete: description: >- - Deletes a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Deletes a job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.projects.locations.storedInfoTypes.delete + operationId: dlp.organizations.locations.jobTriggers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12043,7 +12088,7 @@ paths: $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -12053,16 +12098,24 @@ paths: schema: type: string - in: path - name: storedInfoTypesId + name: jobTriggersId required: true schema: type: string - get: + /v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers: + parameters: *ref_55 + post: description: >- - Gets a stored infoType. 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.projects.locations.storedInfoTypes.get + operationId: dlp.organizations.locations.jobTriggers.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12074,10 +12127,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -12086,24 +12139,12 @@ paths: required: true schema: type: string - - in: path - name: storedInfoTypesId - required: true - schema: - type: string - patch: + 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 + Lists job triggers. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.projects.locations.storedInfoTypes.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest + operationId: dlp.organizations.locations.jobTriggers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12115,10 +12156,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2ListJobTriggersResponse' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -12127,22 +12168,41 @@ paths: required: true schema: type: string - - in: path - name: storedInfoTypesId - required: true + - in: query + name: filter schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/discoveryConfigs/{discoveryConfigsId}: + - 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 + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v2/organizations/{organizationsId}/locations/{locationsId}/dlpJobs: parameters: *ref_55 - patch: - description: Updates a discovery configuration. - operationId: dlp.projects.locations.discoveryConfigs.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateDiscoveryConfigRequest + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12154,10 +12214,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: '#/components/schemas/GooglePrivacyDlpV2ListDlpJobsResponse' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -12166,14 +12226,36 @@ paths: required: true schema: type: string - - in: path - name: discoveryConfigsId - required: true + - 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: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/connections:search: + parameters: *ref_55 get: - description: Gets a discovery configuration. - operationId: dlp.projects.locations.discoveryConfigs.get + description: Searches for Connections in a parent. + operationId: dlp.organizations.locations.connections.search security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12185,10 +12267,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2SearchConnectionsResponse parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -12197,14 +12280,33 @@ paths: required: true schema: type: string - - in: path - name: discoveryConfigsId - required: true + - in: query + name: pageToken schema: type: string - delete: - description: Deletes a discovery configuration. - operationId: dlp.projects.locations.discoveryConfigs.delete + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes: + parameters: *ref_55 + 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 @@ -12216,10 +12318,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -12228,16 +12330,12 @@ paths: required: true schema: type: string - - in: path - name: discoveryConfigsId - required: true - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/discoveryConfigs: - parameters: *ref_55 get: - description: Lists discovery configurations. - operationId: dlp.projects.locations.discoveryConfigs.list + 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 @@ -12250,10 +12348,10 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListDiscoveryConfigsResponse + #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -12263,27 +12361,71 @@ paths: schema: type: string - in: query - name: pageSize + name: locationId schema: - type: integer - format: int32 + type: string - in: query - name: orderBy + name: pageToken schema: type: string - in: query - name: pageToken + name: orderBy schema: type: string - post: - description: Creates a config for discovery to scan and profile storage. - operationId: dlp.projects.locations.discoveryConfigs.create + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}: + parameters: *ref_55 + 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/GooglePrivacyDlpV2CreateDiscoveryConfigRequest + #/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: organizationsId + 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 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 @@ -12295,10 +12437,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -12307,11 +12449,17 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/columnDataProfiles: - parameters: *ref_55 - get: - description: Lists column data profiles for an organization. - operationId: dlp.projects.locations.columnDataProfiles.list + - in: path + name: storedInfoTypesId + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12323,11 +12471,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListColumnDataProfilesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -12336,28 +12483,16 @@ paths: 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: storedInfoTypesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v2/projects/{projectsId}/locations/{locationsId}/columnDataProfiles/{columnDataProfilesId}: + /v2/organizations/{organizationsId}/locations/{locationsId}/projectDataProfiles/{projectDataProfilesId}: parameters: *ref_55 get: - description: Gets a column data profile. - operationId: dlp.projects.locations.columnDataProfiles.get + description: Gets a project data profile. + operationId: dlp.organizations.locations.projectDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12369,10 +12504,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' + $ref: '#/components/schemas/GooglePrivacyDlpV2ProjectDataProfile' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -12382,23 +12517,15 @@ paths: schema: type: string - in: path - name: columnDataProfilesId + name: projectDataProfilesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:hybridInspect: + /v2/organizations/{organizationsId}/locations/{locationsId}/projectDataProfiles: parameters: *ref_55 - 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 + get: + description: Lists project data profiles for an organization. + operationId: dlp.organizations.locations.projectDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12410,10 +12537,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridInspectResponse' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListProjectDataProfilesResponse parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -12422,23 +12550,31 @@ paths: required: true schema: type: string - - in: path - name: dlpJobsId - required: true + - in: query + name: orderBy schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}: + - in: query + name: filter + 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_55 - delete: + 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 DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.projects.locations.dlpJobs.delete + operationId: dlp.organizations.locations.deidentifyTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12450,10 +12586,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -12463,18 +12599,16 @@ paths: schema: type: string - in: path - name: dlpJobsId + name: deidentifyTemplatesId required: true schema: type: string - 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 DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.projects.locations.dlpJobs.get + operationId: dlp.organizations.locations.deidentifyTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12486,10 +12620,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -12499,22 +12633,22 @@ paths: schema: type: string - in: path - name: dlpJobsId + name: deidentifyTemplatesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:finish: - parameters: *ref_55 - 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 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/GooglePrivacyDlpV2FinishDlpJobRequest' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12526,10 +12660,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -12539,28 +12673,25 @@ paths: schema: type: string - in: path - name: dlpJobsId + name: deidentifyTemplatesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs: + /v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates: parameters: *ref_55 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 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/GooglePrivacyDlpV2CreateDlpJobRequest' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12572,10 +12703,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -12586,12 +12717,10 @@ paths: 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 DeidentifyTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.projects.locations.dlpJobs.list + operationId: dlp.organizations.locations.deidentifyTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12603,10 +12732,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListDlpJobsResponse' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -12620,43 +12750,60 @@ paths: schema: type: string - in: query - name: pageSize + name: locationId schema: - type: integer - format: int32 + type: string - in: query - name: type + name: pageToken schema: type: string - in: query - name: filter + name: pageSize + schema: + type: integer + format: int32 + /v2/organizations/{organizationsId}/locations/{locationsId}/discoveryConfigs/{discoveryConfigsId}: + parameters: *ref_55 + 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: query - name: pageToken + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: locationId + - in: path + name: discoveryConfigsId + required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:cancel: - parameters: *ref_55 - 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.locations.dlpJobs.cancel + patch: + description: Updates a discovery configuration. + operationId: dlp.organizations.locations.discoveryConfigs.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CancelDlpJobRequest' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateDiscoveryConfigRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12668,10 +12815,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -12681,29 +12828,13 @@ paths: schema: type: string - in: path - name: dlpJobsId + name: discoveryConfigsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/content:inspect: - parameters: *ref_55 - 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 discovery configuration. + operationId: dlp.organizations.locations.discoveryConfigs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12715,10 +12846,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -12727,19 +12858,22 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/content:reidentify: + - in: path + name: discoveryConfigsId + required: true + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/discoveryConfigs: parameters: *ref_55 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 + 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/GooglePrivacyDlpV2ReidentifyContentRequest' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateDiscoveryConfigRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12751,11 +12885,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ReidentifyContentResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -12764,23 +12897,9 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/content:deidentify: - parameters: *ref_55 - 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' + get: + description: Lists discovery configurations. + operationId: dlp.organizations.locations.discoveryConfigs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12793,10 +12912,10 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2DeidentifyContentResponse + #/components/schemas/GooglePrivacyDlpV2ListDiscoveryConfigsResponse parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -12805,23 +12924,33 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/image:redact: + - 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}/inspectTemplates/{inspectTemplatesId}: parameters: *ref_55 - post: + patch: 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 + Updates the 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/GooglePrivacyDlpV2RedactImageRequest' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12833,26 +12962,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - in: path - name: locationsId + name: inspectTemplatesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}: - parameters: *ref_55 - delete: + get: description: >- - Deletes a job trigger. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + Gets an InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.projects.locations.jobTriggers.delete + operationId: dlp.organizations.inspectTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12864,29 +12991,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: organizationsId required: true schema: type: string - in: path - name: jobTriggersId + name: inspectTemplatesId required: true schema: type: string - get: + delete: description: >- - Gets a job trigger. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + Deletes an InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.projects.locations.jobTriggers.get + operationId: dlp.organizations.inspectTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12898,34 +13020,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: organizationsId required: true schema: type: string - in: path - name: jobTriggersId + name: inspectTemplatesId required: true schema: type: string - patch: + /v2/organizations/{organizationsId}/inspectTemplates: + parameters: *ref_55 + post: description: >- - Updates a job trigger. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + 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.jobTriggers.patch + operationId: dlp.organizations.inspectTemplates.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateJobTriggerRequest' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12937,31 +13058,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: jobTriggersId + name: organizationsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers: - parameters: *ref_55 get: description: >- - Lists job triggers. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + Lists InspectTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.projects.locations.jobTriggers.list + operationId: dlp.organizations.inspectTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12973,25 +13082,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListJobTriggersResponse' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: organizationsId required: true schema: type: string - in: query - name: pageSize + name: locationId schema: - type: integer - format: int32 + type: string - in: query - name: filter + name: pageToken schema: type: string - in: query @@ -12999,29 +13103,54 @@ paths: schema: type: string - in: query - name: pageToken + name: pageSize schema: - type: string - - in: query - name: locationId + type: integer + format: int32 + /v2/organizations/{organizationsId}/storedInfoTypes/{storedInfoTypesId}: + parameters: *ref_55 + 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.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: organizationsId + required: true schema: type: string - - in: query - name: type + - in: path + name: storedInfoTypesId + 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 - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + Deletes a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.projects.locations.jobTriggers.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CreateJobTriggerRequest' + operationId: dlp.organizations.storedInfoTypes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13033,30 +13162,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - in: path - name: locationsId + name: storedInfoTypesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}:activate: - parameters: *ref_55 - post: + get: 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' + Gets a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + to learn more. + operationId: dlp.organizations.storedInfoTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13068,37 +13191,26 @@ 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 + name: organizationsId required: true schema: type: string - in: path - name: jobTriggersId + name: storedInfoTypesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}:hybridInspect: + /v2/organizations/{organizationsId}/storedInfoTypes: parameters: *ref_55 - post: + get: 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 + Lists stored infoTypes. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + to learn more. + operationId: dlp.organizations.storedInfoTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13110,40 +13222,43 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridInspectResponse' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: locationId schema: type: string - - in: path - name: jobTriggersId - required: true + - 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}/image:redact: - parameters: *ref_55 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 + 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/GooglePrivacyDlpV2RedactImageRequest' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13155,27 +13270,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - /v2/projects/{projectsId}/jobTriggers: + /v2/organizations/{organizationsId}/deidentifyTemplates: parameters: *ref_55 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 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.jobTriggers.create + operationId: dlp.organizations.deidentifyTemplates.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CreateJobTriggerRequest' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13187,19 +13303,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string get: description: >- - Lists job triggers. 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.projects.jobTriggers.list + operationId: dlp.organizations.deidentifyTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13211,24 +13327,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListJobTriggersResponse' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse parameters: - in: path - name: projectsId + name: organizationsId 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 + name: orderBy schema: type: string - in: query @@ -13236,21 +13349,17 @@ paths: schema: type: string - in: query - name: orderBy - schema: - type: string - - in: query - name: type + name: locationId schema: type: string - /v2/projects/{projectsId}/jobTriggers/{jobTriggersId}: + /v2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}: parameters: *ref_55 get: description: >- - Gets a job trigger. 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.projects.jobTriggers.get + operationId: dlp.organizations.deidentifyTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13262,24 +13371,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - in: path - name: jobTriggersId + name: deidentifyTemplatesId required: true schema: type: string delete: description: >- - Deletes a job trigger. 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.projects.jobTriggers.delete + operationId: dlp.organizations.deidentifyTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13294,61 +13403,27 @@ paths: $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - in: path - name: jobTriggersId + name: deidentifyTemplatesId required: true schema: type: string patch: description: >- - Updates a job trigger. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + Updates the DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.projects.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: projectsId - required: true - schema: - type: string - - in: path - name: jobTriggersId - required: true - schema: - type: string - /v2/projects/{projectsId}/jobTriggers/{jobTriggersId}:activate: - parameters: *ref_55 - 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 + operationId: dlp.organizations.deidentifyTemplates.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ActivateJobTriggerRequest' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13360,54 +13435,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: jobTriggersId + name: organizationsId required: true schema: type: string - /v2/locations/{locationsId}/infoTypes: - parameters: *ref_55 - 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 + name: deidentifyTemplatesId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: locationId - schema: - type: string - - in: query - name: languageCode - schema: - type: string 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 99a833ef..36e4e191 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: '20240524' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/dns/docs servers: @@ -2018,7 +2018,7 @@ components: - '2' x-stackQL-resources: resource_record_sets: - id: dns.resource_record_sets + id: google.dns.resource_record_sets name: resource_record_sets title: Resource_record_sets methods: @@ -2063,17 +2063,19 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/resource_record_sets/methods/list' - $ref: '#/components/x-stackQL-resources/resource_record_sets/methods/get' + - $ref: '#/components/x-stackQL-resources/resource_record_sets/methods/list' insert: - $ref: >- #/components/x-stackQL-resources/resource_record_sets/methods/create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/resource_record_sets/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/resource_record_sets/methods/delete changes: - id: dns.changes + id: google.dns.changes name: changes title: Changes methods: @@ -2104,14 +2106,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/changes/methods/list' - $ref: '#/components/x-stackQL-resources/changes/methods/get' + - $ref: '#/components/x-stackQL-resources/changes/methods/list' insert: - $ref: '#/components/x-stackQL-resources/changes/methods/create' update: [] delete: [] dns_keys: - id: dns.dns_keys + id: google.dns.dns_keys name: dns_keys title: Dns_keys methods: @@ -2141,7 +2143,7 @@ components: update: [] delete: [] projects: - id: dns.projects + id: google.dns.projects name: projects title: Projects methods: @@ -2158,7 +2160,7 @@ components: update: [] delete: [] managed_zone_operations: - id: dns.managed_zone_operations + id: google.dns.managed_zone_operations name: managed_zone_operations title: Managed_zone_operations methods: @@ -2190,7 +2192,7 @@ components: update: [] delete: [] managed_zones: - id: dns.managed_zones + id: google.dns.managed_zones name: managed_zones title: Managed_zones methods: @@ -2240,15 +2242,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/managed_zones/methods/list' - $ref: '#/components/x-stackQL-resources/managed_zones/methods/get' + - $ref: '#/components/x-stackQL-resources/managed_zones/methods/list' insert: - $ref: '#/components/x-stackQL-resources/managed_zones/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/managed_zones/methods/patch' + - $ref: '#/components/x-stackQL-resources/managed_zones/methods/update' delete: - $ref: '#/components/x-stackQL-resources/managed_zones/methods/delete' managed_zones_iam_policies: - id: dns.managed_zones_iam_policies + id: google.dns.managed_zones_iam_policies name: managed_zones_iam_policies title: Managed_zones_iam_policies methods: @@ -2285,7 +2289,7 @@ components: update: [] delete: [] policies: - id: dns.policies + id: google.dns.policies name: policies title: Policies methods: @@ -2331,15 +2335,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/policies/methods/list' - $ref: '#/components/x-stackQL-resources/policies/methods/get' + - $ref: '#/components/x-stackQL-resources/policies/methods/list' insert: - $ref: '#/components/x-stackQL-resources/policies/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/policies/methods/patch' + - $ref: '#/components/x-stackQL-resources/policies/methods/update' delete: - $ref: '#/components/x-stackQL-resources/policies/methods/delete' response_policies: - id: dns.response_policies + id: google.dns.response_policies name: response_policies title: Response_policies methods: @@ -2389,15 +2395,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/response_policies/methods/list' - $ref: '#/components/x-stackQL-resources/response_policies/methods/get' + - $ref: '#/components/x-stackQL-resources/response_policies/methods/list' insert: - $ref: '#/components/x-stackQL-resources/response_policies/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/response_policies/methods/patch' + - $ref: '#/components/x-stackQL-resources/response_policies/methods/update' delete: - $ref: '#/components/x-stackQL-resources/response_policies/methods/delete' response_policy_rules: - id: dns.response_policy_rules + id: google.dns.response_policy_rules name: response_policy_rules title: Response_policy_rules methods: @@ -2449,13 +2457,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/response_policy_rules/methods/get' - $ref: >- #/components/x-stackQL-resources/response_policy_rules/methods/list - - $ref: '#/components/x-stackQL-resources/response_policy_rules/methods/get' insert: - $ref: >- #/components/x-stackQL-resources/response_policy_rules/methods/create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/response_policy_rules/methods/patch + - $ref: >- + #/components/x-stackQL-resources/response_policy_rules/methods/update delete: - $ref: >- #/components/x-stackQL-resources/response_policy_rules/methods/delete 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 106ea967..67cfcca3 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: '20240523' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/document-ai/docs/ servers: @@ -37,969 +37,1029 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudDocumentaiV1Document: + GoogleCloudDocumentaiV1GcsDocument: + type: object + description: Specifies a document stored on Cloud Storage. + properties: + gcsUri: + type: string + description: The Cloud Storage object uri. + mimeType: + type: string + description: An IANA MIME type (RFC6838) of the content. + id: GoogleCloudDocumentaiV1GcsDocument + GoogleCloudDocumentaiV1beta1GcsSource: + type: object properties: - 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. - textStyles: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyle' - deprecated: true - description: Styles for the Document.text. - 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' 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). - pages: - type: array + description: >- + The Google Cloud Storage location where the input file will be read + from. + id: GoogleCloudDocumentaiV1beta1GcsSource + GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata: + description: The long-running operation metadata for the DeleteProcessor method. + properties: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + id: GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata + type: object + GoogleCloudDocumentaiV1beta1DocumentPageAnchor: + properties: + pageRefs: items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPage' - description: Visual page layout for the Document. - error: - description: Any error that occurred while processing this document. - $ref: '#/components/schemas/GoogleRpcStatus' - revisions: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef type: array - description: Placeholder. Revision history of this document. + description: One or more references to visual page elements + type: object + id: GoogleCloudDocumentaiV1beta1DocumentPageAnchor + 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. + GoogleCloudDocumentaiV1beta2DocumentTextAnchor: + type: object + id: GoogleCloudDocumentaiV1beta2DocumentTextAnchor + description: Text reference indexing into the Document.text. + properties: + textSegments: items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentRevision' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment + type: array + description: The text segments from the Document.text. content: 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 - format: byte - mimeType: - description: >- - An IANA published [media type (MIME - type)](https://www.iana.org/assignments/media-types/media-types.xhtml). - type: string - entityRelations: - type: array - description: Placeholder. Relationship among Document.entities. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntityRelation' - text: + 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: Optional. UTF-8 encoded text in reading order from the document. - textChanges: + GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse: + type: object + description: Response message for the UndeployProcessorVersion method. + properties: {} + id: GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse + GoogleCloudDocumentaiV1EvaluationMetrics: + type: object + id: GoogleCloudDocumentaiV1EvaluationMetrics + properties: + precision: + type: number + format: float + description: The calculated precision. + groundTruthOccurrencesCount: + description: The amount of occurrences in ground truth documents. + type: integer + format: int32 + truePositivesCount: + type: integer + description: The amount of true positives. + format: int32 + f1Score: + description: The calculated f1 score. + format: float + type: number + predictedOccurrencesCount: + type: integer + format: int32 + description: The amount of occurrences in predicted documents. + groundTruthDocumentCount: + type: integer + format: int32 + description: The amount of documents with a ground truth occurrence. + falseNegativesCount: + format: int32 + description: The amount of false negatives. + type: integer + falsePositivesCount: + format: int32 + description: The amount of false positives. + type: integer + recall: + format: float + type: number + description: The calculated recall. + predictedDocumentCount: + type: integer + format: int32 + description: The amount of documents with a predicted occurrence. + totalDocumentsCount: + description: The amount of documents that had an occurrence of this label. + format: int32 + type: integer + description: Evaluation metrics, either in aggregate or about a specific entity. + GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse: + properties: + responses: type: array + description: Responses for each individual document. 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. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta1ProcessDocumentResponse type: object - id: GoogleCloudDocumentaiV1Document + id: GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse 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. - GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse: + Response to an batch document processing request. This is returned in + the LRO Operation after the operation is complete. + GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse: type: object - id: GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse + description: Response of the import document operation. properties: {} - description: Response of the delete documents operation. - GoogleCloudDocumentaiV1ProcessorVersion: + id: GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse + GoogleCloudDocumentaiV1EnableProcessorResponse: + type: object + description: >- + Response message for the EnableProcessor method. Intentionally empty + proto for adding fields in future. + properties: {} + id: GoogleCloudDocumentaiV1EnableProcessorResponse + GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef: + id: GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef type: object + description: Represents a weak reference to a page element within a document. properties: - kmsKeyVersionName: + 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 - description: The KMS key version with which data is encrypted. - displayName: + confidence: + description: >- + Optional. Confidence of detected page element, if applicable. Range + `[0, 1]`. + type: number + 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/GoogleCloudDocumentaiV1beta1BoundingPoly' + 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. + enum: + - LAYOUT_TYPE_UNSPECIFIED + - BLOCK + - PARAGRAPH + - LINE + - TOKEN + - VISUAL_ELEMENT + - TABLE + - FORM_FIELD type: string - description: The display name of the processor version. - deprecationInfo: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo - description: If set, information about the eventual deprecation of this version. - kmsKeyName: - description: The KMS key name used for encryption. + layoutId: type: string - documentSchema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' - description: The schema of the processor version. Describes the output. - state: - enum: - - STATE_UNSPECIFIED - - DEPLOYED - - DEPLOYING - - UNDEPLOYED - - UNDEPLOYING - - CREATING - - DELETING - - FAILED - - IMPORTING - 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. - readOnly: true - type: string - description: Output only. The state of the processor version. - name: + description: Optional. Deprecated. Use PageRef.bounding_poly instead. + deprecated: true + GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview: + properties: + stateMessage: description: >- - Identifier. The resource name of the processor version. Format: - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` + A message providing more details about the current state of + processing. For example, the rejection reason when the state is + `rejected`. type: string - modelType: + state: + description: Human review state. e.g. `requested`, `succeeded`, `rejected`. type: string - 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. - description: Output only. The model type of this processor version. - readOnly: true - createTime: - description: The time the processor version was created. - format: google-datetime + description: Human Review information of the document. + id: GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview + type: object + GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue: + properties: + 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: type: string - latestEvaluation: - description: The most recently invoked evaluation for the processor version. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationReference' - googleManaged: + 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: + description: >- + Boolean value. Can be used for entities with binary values, or for + checkboxes. type: boolean - readOnly: true + datetimeValue: description: >- - Output only. Denotes that this `ProcessorVersion` is managed by - Google. - 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. - 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. + 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: + format: int32 + type: integer + description: Integer value. + floatValue: + type: number + description: Float value. + format: float + 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' + description: Parsed and normalized entity value. type: object + id: GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue + GoogleCloudDocumentaiV1ReviewDocumentResponse: properties: - shardCount: - format: int64 - type: string - description: Total number of shards. - textOffset: - format: int64 + gcsDestination: description: >- - The index of the first character in Document.text in the overall - document global text. + The Cloud Storage uri for the human reviewed document if the review + is succeeded. type: string - shardIndex: + rejectionReason: type: string - format: int64 - description: The 0-based index of this shard. - id: GoogleCloudDocumentaiV1DocumentShardInfo - GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata: - description: >- - The long-running operation metadata for the DeleteProcessorVersion - method. - id: GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata + description: The reason why the review is rejected by reviewer. + state: + enum: + - STATE_UNSPECIFIED + - REJECTED + - SUCCEEDED + 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. + type: object + id: GoogleCloudDocumentaiV1ReviewDocumentResponse + description: Response message for the ReviewDocument method. + GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata: + id: GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata type: object properties: commonMetadata: description: The basic metadata of the long-running operation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - GoogleCloudDocumentaiV1beta2GcsSource: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The long-running operation metadata for the DeleteProcessor method. + GoogleCloudDocumentaiV1ProcessorTypeLocationInfo: + description: The location information about where the processor is available. + type: object + id: GoogleCloudDocumentaiV1ProcessorTypeLocationInfo properties: - uri: + locationId: type: string + description: >- + The location ID. For supported locations, refer to [regional and + multi-regional support](/document-ai/docs/regions). + GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment: description: >- - The Google Cloud Storage location where the input file will be read - from. - id: GoogleCloudDocumentaiV1beta2GcsSource - type: object - GoogleCloudDocumentaiV1DisableProcessorRequest: + 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 + id: GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment type: object - description: Request message for the DisableProcessor method. - properties: {} - id: GoogleCloudDocumentaiV1DisableProcessorRequest - GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId: properties: - cwDocId: - deprecated: true - description: Id of the document (indexed) managed by Content Warehouse. + endIndex: + format: int64 + description: TextSegment half open end UTF-8 char index in the Document.text. type: string - gcsUri: - description: Required. The Cloud Storage URI where the actual document is stored. + startIndex: + format: int64 + description: TextSegment start UTF-8 char index in the Document.text. type: string - id: GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId + GoogleCloudDocumentaiV1DocumentOutputConfig: + id: GoogleCloudDocumentaiV1DocumentOutputConfig + description: >- + Config that controls the output of documents. All documents will be + written as a JSON file. + properties: + gcsOutputConfig: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig + description: Output config to write the results to Cloud Storage. type: object + GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata: description: >- - Identifies a document uniquely within the scope of a dataset in the - user-managed Cloud Storage option. - GoogleCloudDocumentaiV1DeleteProcessorMetadata: - id: GoogleCloudDocumentaiV1DeleteProcessorMetadata + The long-running operation metadata for the DeleteProcessorVersion + method. + id: GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata properties: commonMetadata: description: The basic metadata of the long-running operation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - description: The long-running operation metadata for the DeleteProcessor method. - type: object - GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat: - description: The statistic representing a dataset split type for this export. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata type: object + GoogleCloudDocumentaiV1ListEvaluationsResponse: + description: The response from `ListEvaluations`. + id: GoogleCloudDocumentaiV1ListEvaluationsResponse properties: - totalDocumentCount: - description: >- - Total number of documents with the given dataset split type to be - exported. - format: int32 - type: integer - splitType: - description: The dataset split type. + nextPageToken: type: string - 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 - id: GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat - GoogleCloudDocumentaiV1beta1DocumentPageSymbol: - properties: - detectedLanguages: + 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: type: array - description: A list of detected languages together with confidence. + description: The evaluations requested. items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' - description: Layout for Symbol. - id: GoogleCloudDocumentaiV1beta1DocumentPageSymbol + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Evaluation' type: object - description: A detected symbol. - GoogleCloudDocumentaiV1EvaluationCounters: - description: Evaluation counters for the documents that were used. - id: GoogleCloudDocumentaiV1EvaluationCounters + GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus: type: object + id: >- + GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus properties: - inputDocumentsCount: - type: integer - description: How many documents were sent for evaluation. - format: int32 - failedDocumentsCount: - description: >- - How many documents were not included in the evaluation as Document - AI failed to process them. - type: integer - format: int32 - evaluatedDocumentsCount: - format: int32 - description: How many documents were used in the evaluation. - type: integer - invalidDocumentsCount: - type: integer - format: int32 + documentInconsistencyType: + enumDescriptions: + - Default value. + - The document proto is invalid. + - Indexed docproto metadata is mismatched. + - The page image or thumbnails are missing. + description: The type of document inconsistency. + enum: + - DOCUMENT_INCONSISTENCY_TYPE_UNSPECIFIED + - DOCUMENT_INCONSISTENCY_TYPE_INVALID_DOCPROTO + - DOCUMENT_INCONSISTENCY_TYPE_MISMATCHED_METADATA + - DOCUMENT_INCONSISTENCY_TYPE_NO_PAGE_IMAGE + type: string + status: description: >- - How many documents were not included in the evaluation as they - didn't pass validation. - GoogleCloudDocumentaiV1ProcessorVersionAlias: - id: GoogleCloudDocumentaiV1ProcessorVersionAlias + The status of resyncing the document with regards to the detected + inconsistency. Empty if ResyncDatasetRequest.validate_only is + `true`. + $ref: '#/components/schemas/GoogleRpcStatus' + documentId: + description: The document identifier. + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' + description: Resync status for each document per inconsistency type. + GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata: properties: - alias: - description: The alias in the form of `processor_version` resource name. - type: string - processorVersion: - type: string - description: The resource name of aliased processor version. + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata type: object - description: Contains the alias and the aliased resource name of processor version. - GoogleCloudDocumentaiV1beta2DocumentEntityRelation: - properties: - subjectId: - type: string - description: Subject entity id. - relation: - type: string - description: Relationship description. - objectId: - type: string - description: Object entity id. - description: Relationship between Entities. + id: GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata + description: >- + The long-running operation metadata for the DeployProcessorVersion + method. + GoogleCloudDocumentaiV1beta3BatchProcessResponse: + description: Response message for BatchProcessDocuments. + properties: {} + id: GoogleCloudDocumentaiV1beta3BatchProcessResponse + type: object + GoogleCloudDocumentaiV1beta1Vertex: type: object - id: GoogleCloudDocumentaiV1beta2DocumentEntityRelation - GoogleCloudDocumentaiV1EvaluationMetrics: - description: Evaluation metrics, either in aggregate or about a specific entity. - id: GoogleCloudDocumentaiV1EvaluationMetrics properties: - precision: - format: float - type: number - description: The calculated precision. - groundTruthOccurrencesCount: - description: The amount of occurrences in ground truth documents. - type: integer - format: int32 - f1Score: - description: The calculated f1 score. - type: number - format: float - predictedOccurrencesCount: - format: int32 - type: integer - description: The amount of occurrences in predicted documents. - truePositivesCount: - type: integer - description: The amount of true positives. - format: int32 - recall: - format: float - description: The calculated recall. - type: number - falsePositivesCount: - description: The amount of false positives. - format: int32 - type: integer - groundTruthDocumentCount: - format: int32 - type: integer - description: The amount of documents with a ground truth occurrence. - predictedDocumentCount: + x: format: int32 - description: The amount of documents with a predicted occurrence. - type: integer - falseNegativesCount: type: integer - description: The amount of false negatives. + description: X coordinate. + 'y': format: int32 - totalDocumentsCount: - description: The amount of documents that had an occurrence of this label. type: integer - format: int32 - type: object - GoogleCloudDocumentaiV1beta1NormalizedVertex: + description: Y coordinate (starts from the top of the image). + description: >- + A vertex represents a 2D point in the image. NOTE: the vertex + coordinates are in the same scale as the original image. + id: GoogleCloudDocumentaiV1beta1Vertex + GoogleCloudDocumentaiV1beta1DocumentPageDimension: + id: GoogleCloudDocumentaiV1beta1DocumentPageDimension properties: - x: - type: number - description: X coordinate. + height: format: float - 'y': - description: Y coordinate (starts from the top of the image). + type: number + description: Page height. + unit: + type: string + description: Dimension unit. + width: 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. + description: Page width. + description: Dimension for the page. type: object - id: GoogleCloudDocumentaiV1beta1NormalizedVertex - GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse: - id: GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse - properties: - selectedDocuments: - description: The result of the sampling process. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument - sampleTestStatus: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of sampling documents in test split. - sampleTrainingStatus: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of sampling documents in training split. + GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode: type: object - description: Response of the sample documents operation. - GoogleCloudDocumentaiV1beta3ReviewDocumentResponse: - description: Response message for the ReviewDocument method. + description: A detected barcode. + id: GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode + properties: + barcode: + description: Detailed barcode information of the DetectedBarcode. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1Barcode' + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' + description: Layout for DetectedBarcode. + GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak: + properties: + type: + enum: + - TYPE_UNSPECIFIED + - SPACE + - WIDE_SPACE + - HYPHEN + type: string + description: Detected break type. + enumDescriptions: + - Unspecified break type. + - A single whitespace. + - A wider whitespace. + - A hyphen that indicates that a token has been split across lines. + id: GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak type: object - id: GoogleCloudDocumentaiV1beta3ReviewDocumentResponse + description: Detected break at the end of a Token. + GoogleCloudDocumentaiV1beta2DocumentPageLayout: properties: - rejectionReason: + textAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentTextAnchor' + description: Text anchor indexing into the Document.text. + confidence: + type: number + 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 + boundingPoly: + description: The bounding polygon for the Layout. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2BoundingPoly' + orientation: type: string - description: The reason why the review is rejected by reviewer. - state: - description: The state of the review operation. 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. + - 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. enum: - - STATE_UNSPECIFIED - - REJECTED - - SUCCEEDED - type: string - gcsDestination: + - ORIENTATION_UNSPECIFIED + - PAGE_UP + - PAGE_RIGHT + - PAGE_DOWN + - PAGE_LEFT + type: object + description: Visual element describing a layout unit on a page. + id: GoogleCloudDocumentaiV1beta2DocumentPageLayout + GoogleCloudDocumentaiV1DocumentStyle: + properties: + textDecoration: type: string description: >- - The Cloud Storage uri for the human reviewed document if the review - is succeeded. - GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse: + [Text + decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). + Follows CSS standard. + backgroundColor: + $ref: '#/components/schemas/GoogleTypeColor' + description: Text background color. + color: + $ref: '#/components/schemas/GoogleTypeColor' + description: Text color. + fontSize: + description: Font size. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyleFontSize' + textAnchor: + description: Text anchor indexing into the Document.text. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + textStyle: + type: string + description: >- + [Text + style](https://www.w3schools.com/cssref/pr_font_font-style.asp). + Possible values are `normal`, `italic`, and `oblique`. + fontFamily: + type: string + description: >- + Font family such as `Arial`, `Times New Roman`. + https://www.w3schools.com/cssref/pr_font_font-family.asp + fontWeight: + description: >- + [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). + Possible values are `normal`, `bold`, `bolder`, and `lighter`. + type: string + description: >- + Annotation for common text style attributes. This adheres to CSS + conventions as much as possible. type: object - id: GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse - description: Response message for the SetDefaultProcessorVersion method. - properties: {} - GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata: - description: Metadata of the batch export documents operation. + id: GoogleCloudDocumentaiV1DocumentStyle + GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata: + id: GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata + description: >- + The long-running operation metadata for the ImportProcessorVersion + method. properties: commonMetadata: - description: The basic metadata of the long-running operation. $ref: >- #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - individualExportStatuses: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus - type: array - description: The list of response details of each document. - splitExportStats: - description: The list of statistics for each dataset split type. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat + description: The basic metadata for the long-running operation. type: object - id: GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata - GoogleCloudDocumentaiV1BatchDocumentsInputConfig: + GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus: + properties: + 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 - description: The common config to specify a set of documents used as input. + description: The status of each individual document in the batch delete process. + GoogleCloudDocumentaiV1beta2DocumentProvenance: + id: GoogleCloudDocumentaiV1beta2DocumentProvenance properties: - gcsDocuments: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsDocuments' - description: The set of documents individually specified on Cloud Storage. - gcsPrefix: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsPrefix' + id: + type: integer + deprecated: true + format: int32 description: >- - The set of documents that match the specified Cloud Storage - `gcs_prefix`. - id: GoogleCloudDocumentaiV1BatchDocumentsInputConfig - GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse: + The Id of this operation. Needs to be unique within the scope of the + revision. + parents: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentProvenanceParent + type: array + description: References to the original elements that are replaced. + revision: + description: The index of the revision that produced this element. + format: int32 + deprecated: true + type: integer + type: + enumDeprecated: + - false + - false + - false + - false + - false + - true + - true + - true + type: string + enum: + - OPERATION_TYPE_UNSPECIFIED + - ADD + - REMOVE + - UPDATE + - REPLACE + - EVAL_REQUESTED + - EVAL_APPROVED + - EVAL_SKIPPED + 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. type: object description: >- - Response message for the EnableProcessor method. Intentionally empty + Structure to identify provenance relationships between annotations in + different revisions. + GoogleCloudDocumentaiV1beta3DisableProcessorResponse: + type: object + id: GoogleCloudDocumentaiV1beta3DisableProcessorResponse + description: >- + Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future. properties: {} - id: GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse - GoogleCloudDocumentaiV1ProcessorTypeLocationInfo: + GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig: type: object + id: GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig properties: - locationId: - description: >- - The location ID. For supported locations, refer to [regional and - multi-regional support](/document-ai/docs/regions). + fieldMask: type: string - id: GoogleCloudDocumentaiV1ProcessorTypeLocationInfo - description: The location information about where the processor is available. - GoogleCloudDocumentaiV1DocumentRevisionHumanReview: - properties: - stateMessage: + format: google-fieldmask description: >- - A message providing more details about the current state of - processing. For example, the rejection reason when the state is - `rejected`. - type: string - state: - description: Human review state. e.g. `requested`, `succeeded`, `rejected`. + 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}`. + gcsUri: type: string - type: object - description: Human Review information of the document. - id: GoogleCloudDocumentaiV1DocumentRevisionHumanReview - GoogleCloudDocumentaiV1beta1InputConfig: - type: object - description: The desired input location and metadata. - id: GoogleCloudDocumentaiV1beta1InputConfig + description: The Cloud Storage uri (a directory) of the output. + shardingConfig: + description: Specifies the sharding config for the output document. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig + description: The configuration used when outputting documents. + GoogleCloudDocumentaiV1beta3GcsPrefix: + id: GoogleCloudDocumentaiV1beta3GcsPrefix + description: Specifies all documents on Cloud Storage with a common prefix. properties: - mimeType: + gcsUriPrefix: + description: The URI prefix. type: string - description: >- - Required. Mimetype of the input. Current supported mimetypes are - application/pdf, image/tiff, and image/gif. In addition, - application/json type is supported for requests with - ProcessDocumentRequest.automl_params field set. The JSON file needs - to be in Document format. - gcsSource: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1GcsSource' - description: >- - The Google Cloud Storage location to read the input from. This must - be a single file. - 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: - 'y': - format: int32 - type: integer - description: Y coordinate (starts from the top of the image). - x: - format: int32 - type: integer - description: X coordinate. - id: GoogleCloudDocumentaiV1Vertex - type: object - GoogleCloudDocumentaiV1beta3ImportDocumentsResponse: - id: GoogleCloudDocumentaiV1beta3ImportDocumentsResponse type: object - description: Response of the import document operation. - properties: {} - GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse: + GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult: type: object - description: Response of the EvaluateProcessorVersion method. - id: GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse + 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. + id: >- + GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult properties: - evaluation: + 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 - description: The resource name of the created evaluation. - GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell: - id: GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell - description: A cell representation inside the table. + GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus: type: object properties: - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' - description: Layout for TableCell. - rowSpan: - format: int32 - description: How many rows this cell spans. - type: integer - detectedLanguages: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - type: array - colSpan: - format: int32 - type: integer - description: How many columns this cell spans. - GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus: - description: The status of each individual document in the batch delete process. - properties: - documentId: - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' - description: The document id of the document. + inputGcsSource: + description: >- + The source of the document, same as the input_gcs_source field in + the request when the batch process started. + type: string + 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. status: + description: The status processing the document. $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of deleting the document in storage. + humanReviewStatus: + description: The status of human review on the processed document. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1HumanReviewStatus' + id: GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus + description: The status of a each individual document in the batch process. + GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef: type: object - id: >- - GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus - GoogleCloudDocumentaiV1DocumentPageSymbol: + description: Represents a weak reference to a page element within a document. + id: GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef 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' - description: A detected symbol. - type: object - id: GoogleCloudDocumentaiV1DocumentPageSymbol - GoogleCloudDocumentaiV1DisableProcessorResponse: - properties: {} - id: GoogleCloudDocumentaiV1DisableProcessorResponse - description: >- - Response message for the DisableProcessor method. Intentionally empty - proto for adding fields in future. - type: object - GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata: - id: GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata - description: >- - The long-running operation metadata for the UndeployProcessorVersion - method. - type: object + layoutType: + 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/GoogleCloudDocumentaiV1beta2BoundingPoly' + 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. + layoutId: + description: Optional. Deprecated. Use PageRef.bounding_poly instead. + deprecated: true + type: string + confidence: + description: >- + Optional. Confidence of detected page element, if applicable. Range + `[0, 1]`. + type: number + format: float + page: + 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. + format: int64 + GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata: + description: Metadata of the EvaluateProcessorVersion method. + id: GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata properties: commonMetadata: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig: - id: GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig - type: object - description: Configuration specific to an unmanaged dataset. - properties: {} - GoogleCloudDocumentaiV1GcsDocuments: type: object - id: GoogleCloudDocumentaiV1GcsDocuments - description: Specifies a set of documents on Cloud Storage. - properties: - documents: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsDocument' - description: The list of documents. - GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus: + 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. id: >- - GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus - description: The status of each individual document in the batch move process. + GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult properties: status: + description: The validation status of import config. $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of moving the document. - documentId: - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' - description: The document id of the document. - GoogleCloudLocationListLocationsResponse: - type: object + inputGcsSource: + description: The source Cloud Storage URI specified in the import config. + type: string + GoogleRpcStatus: properties: - nextPageToken: - description: The standard List next-page token. + code: + format: int32 + type: integer + description: The status code, which should be an enum value of google.rpc.Code. + message: type: string - locations: description: >- - A list of locations that matches the specified filter in the - request. + 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/GoogleCloudLocationLocation' + 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 response message for Locations.ListLocations. - id: GoogleCloudLocationListLocationsResponse - GoogleCloudDocumentaiV1DocumentTextAnchor: - description: Text reference indexing into the Document.text. + 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 + GoogleCloudDocumentaiV1beta1DocumentPageImage: + description: Rendered image contents for this page. + type: object properties: - textSegments: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment - description: The text segments from the Document.text. - type: array - content: + mimeType: + 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. + Encoding [media type (MIME + type)](https://www.iana.org/assignments/media-types/media-types.xhtml) + for the image. + width: + description: Width of the image in pixels. + format: int32 + type: integer + height: + type: integer + description: Height of the image in pixels. + format: int32 + content: + description: Raw byte content of the image. + format: byte type: string - id: GoogleCloudDocumentaiV1DocumentTextAnchor + id: GoogleCloudDocumentaiV1beta1DocumentPageImage + GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo: + description: Information about the upcoming deprecation of this processor version. + id: GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo type: object - GoogleCloudDocumentaiV1DocumentPageDimension: - description: Dimension for the page. + properties: + replacementProcessorVersion: + description: If set, the processor version that will be used as a replacement. + type: string + deprecationTime: + format: google-datetime + description: The time at which this processor version will be deprecated. + type: string + GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores: type: object + description: Image quality scores for the page image. + id: GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores properties: - width: + qualityScore: + description: >- + The overall quality score. Range `[0, 1]` where `1` is perfect + quality. type: number format: float - description: Page width. - height: - format: float - description: Page height. - type: number - unit: - type: string - description: Dimension unit. - id: GoogleCloudDocumentaiV1DocumentPageDimension - GoogleCloudDocumentaiV1beta2OutputConfig: - description: The desired output location and metadata. + detectedDefects: + description: A list of detected defects. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect + GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse: + description: The response message for the ImportProcessorVersion method. type: object - id: GoogleCloudDocumentaiV1beta2OutputConfig properties: - pagesPerShard: - type: integer - format: int32 - description: >- - The max number of pages to include into each output Document shard - JSON on Google Cloud Storage. The valid range is [1, 100]. If not - specified, the default value is 20. For example, for one pdf file - with 100 pages, 100 parsed pages will be produced. If - `pages_per_shard` = 20, then 5 Document shard JSON files each - containing 20 parsed pages will be written under the prefix - OutputConfig.gcs_destination.uri and suffix pages-x-to-y.json where - x and y are 1-indexed page numbers. Example GCS outputs with 157 - pages and pages_per_shard = 50: pages-001-to-050.json - pages-051-to-100.json pages-101-to-150.json pages-151-to-157.json - gcsDestination: - description: The Google Cloud Storage location to write the output to. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2GcsDestination' - GoogleCloudDocumentaiV1OcrConfigPremiumFeatures: - type: object - id: GoogleCloudDocumentaiV1OcrConfigPremiumFeatures - properties: - enableSelectionMarkDetection: - type: boolean - description: >- - Turn on selection mark detector in OCR engine. Only available in OCR - 2.0 (and later) processors. - computeStyleInfo: - type: boolean - description: Turn on font identification model and return font style information. - enableMathOcr: - description: Turn on the model that can extract LaTeX math formulas. - type: boolean - description: Configurations for premium OCR features. - 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. - properties: - x: - description: X coordinate. - format: float - type: number - 'y': - description: Y coordinate (starts from the top of the image). - type: number - format: float - type: object - id: GoogleCloudDocumentaiV1NormalizedVertex - GoogleCloudDocumentaiV1beta1DocumentPageLayout: - description: Visual element describing a layout unit on a page. - properties: - boundingPoly: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1BoundingPoly' - description: The bounding polygon for the Layout. - orientation: - enum: - - ORIENTATION_UNSPECIFIED - - PAGE_UP - - PAGE_RIGHT - - PAGE_DOWN - - PAGE_LEFT - description: Detected orientation for the Layout. - 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. + processorVersion: type: string - confidence: - format: float - 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]`. - type: number - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentTextAnchor' - description: Text anchor indexing into the Document.text. - id: GoogleCloudDocumentaiV1beta1DocumentPageLayout + description: The destination processor version name. + id: GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse + 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 - GoogleCloudDocumentaiV1DocumentPageDetectedBarcode: + id: GoogleProtobufEmpty + GoogleCloudDocumentaiV1beta1DocumentPageToken: + id: GoogleCloudDocumentaiV1beta1DocumentPageToken properties: + detectedLanguages: + description: A list of detected languages together with confidence. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage + type: array + detectedBreak: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak + description: Detected break at the end of a Token. layout: - description: Layout for DetectedBarcode. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - barcode: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Barcode' - description: Detailed barcode information of the DetectedBarcode. - id: GoogleCloudDocumentaiV1DocumentPageDetectedBarcode - description: A detected barcode. - type: object - GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata: - properties: - commonMetadata: + description: Layout for Token. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' + provenance: + description: The history of this annotation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenance' + deprecated: true + styleInfo: + description: Text style attributes. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo + description: A detected token. type: object - GoogleCloudDocumentaiV1beta1DocumentProvenanceParent: - properties: - id: - deprecated: true - description: The id of the parent provenance. - type: integer - format: int32 - index: - 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: integer - revision: - type: integer - format: int32 - description: The index of the index into current revision's parent_ids list. - description: >- - The parent element the current element is based on. Used for - referencing/aligning, removal and replacement operations. - id: GoogleCloudDocumentaiV1beta1DocumentProvenanceParent + GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow: + id: GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow type: object - GoogleCloudDocumentaiV1beta2DocumentPageSymbol: - id: GoogleCloudDocumentaiV1beta2DocumentPageSymbol + description: A row of table cells. properties: - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' - description: Layout for Symbol. - detectedLanguages: + cells: type: array + description: Cells that make up this row. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - description: A detected symbol. + #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell + GoogleCloudDocumentaiV1beta3EnableProcessorResponse: + description: >- + Response message for the EnableProcessor method. Intentionally empty + proto for adding fields in future. + id: GoogleCloudDocumentaiV1beta3EnableProcessorResponse type: object - GoogleCloudDocumentaiV1beta1DocumentRevision: - description: Contains past or forward revisions of this document. + properties: {} + GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument: + id: GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument type: object properties: - id: - description: >- - Id of the revision, internally generated by doc proto storage. - Unique within the context of the document. + documentId: + description: An internal identifier for document. type: string - agent: - description: >- - If the change was made by a person specify the name or id of that - person. + GoogleCloudDocumentaiV1beta1DocumentShardInfo: + id: GoogleCloudDocumentaiV1beta1DocumentShardInfo + properties: + shardIndex: + format: int64 type: string - createTime: + description: The 0-based index of this shard. + shardCount: type: string - format: google-datetime - description: >- - The time that the revision was created, internally generated by doc - proto storage at the time of create. - processor: + description: Total number of shards. + format: int64 + textOffset: type: string + format: int64 description: >- - If the annotation was made by processor identify the processor by - its resource name. - parentIds: + The index of the first character in Document.text in the overall + document global text. + 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 + GoogleCloudDocumentaiV1DocumentPageTable: + id: GoogleCloudDocumentaiV1DocumentPageTable + description: A table representation similar to HTML table structure. + type: object + properties: + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for Table. + bodyRows: + description: Body rows of the table. type: array 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. - humanReview: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview - description: Human Review information of this revision. - parent: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow + detectedLanguages: + description: A list of detected languages together with confidence. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage type: array + provenance: deprecated: true + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: The history of this table. + headerRows: + type: array 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: GoogleCloudDocumentaiV1beta1DocumentRevision - GoogleCloudDocumentaiV1beta3DisableProcessorMetadata: - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiV1beta3DisableProcessorMetadata - description: The long-running operation metadata for the DisableProcessor method. - type: object - GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow + description: Header rows of the table. + GoogleCloudDocumentaiV1beta1InputConfig: type: object - id: GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment - 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: The desired input location and metadata. + id: GoogleCloudDocumentaiV1beta1InputConfig properties: - endIndex: - description: TextSegment half open end UTF-8 char index in the Document.text. - type: string - format: int64 - startIndex: + gcsSource: + description: >- + The Google Cloud Storage location to read the input from. This must + be a single file. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1GcsSource' + mimeType: + description: >- + Required. Mimetype of the input. Current supported mimetypes are + application/pdf, image/tiff, and image/gif. In addition, + application/json type is supported for requests with + ProcessDocumentRequest.automl_params field set. The JSON file needs + to be in Document format. type: string - description: TextSegment start UTF-8 char index in the Document.text. - format: int64 - GoogleCloudDocumentaiV1beta3GcsPrefix: + GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata: + description: Metadata of the batch export documents operation. type: object - id: GoogleCloudDocumentaiV1beta3GcsPrefix - description: Specifies all documents on Cloud Storage with a common prefix. + id: GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata properties: - gcsUriPrefix: - type: string - description: The URI prefix. - GoogleCloudDocumentaiV1beta2ProcessDocumentResponse: - description: Response to a single document processing request. + individualExportStatuses: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus + description: The list of response details of each document. + type: array + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + splitExportStats: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat + type: array + description: The list of statistics for each dataset split type. + GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata: + description: The long-running operation metadata for the EnableProcessor method. type: object + id: GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata properties: - inputConfig: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2InputConfig' - description: >- - Information about the input file. This is the same as the - corresponding input config in the request. - outputConfig: - description: >- - The output location of the parsed responses. The responses are - written to this location as JSON-serialized `Document` objects. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2OutputConfig' - id: GoogleCloudDocumentaiV1beta2ProcessDocumentResponse - GoogleCloudLocationLocation: - id: GoogleCloudLocationLocation - properties: - locationId: - type: string - description: 'The canonical id for this location. For example: `"us-east1"`.' - metadata: - type: object - 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. - labels: - description: >- - Cross-service attributes for the location. For example - {"cloud.googleapis.com/region": "us-east1"} - type: object - additionalProperties: - type: string - name: - description: >- - Resource name for the location, which may vary between - implementations. For example: - `"projects/example-project/locations/us-east1"` - type: string - displayName: - type: string - description: >- - The friendly name for this location, typically a nearby city name. - For example, "Tokyo". - type: object - description: A resource that represents a Google Cloud location. - GoogleCloudDocumentaiV1beta2NormalizedVertex: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + GoogleCloudDocumentaiV1NormalizedVertex: 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': type: number @@ -1009,478 +1069,399 @@ components: type: number description: X coordinate. format: float - id: GoogleCloudDocumentaiV1beta2NormalizedVertex - GoogleCloudDocumentaiV1beta1Vertex: description: >- - A vertex represents a 2D point in the image. NOTE: the vertex - coordinates are in the same scale as the original image. - id: GoogleCloudDocumentaiV1beta1Vertex + 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: GoogleCloudDocumentaiV1NormalizedVertex + GoogleCloudDocumentaiV1DisableProcessorMetadata: type: object + description: The long-running operation metadata for the DisableProcessor method. + id: GoogleCloudDocumentaiV1DisableProcessorMetadata properties: - x: - description: X coordinate. - type: integer - format: int32 - 'y': - format: int32 - description: Y coordinate (starts from the top of the image). - type: integer - GoogleCloudDocumentaiV1beta2DocumentPageVisualElement: - id: GoogleCloudDocumentaiV1beta2DocumentPageVisualElement + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse: + description: The response for TrainProcessorVersion. + type: object properties: - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' - description: Layout for VisualElement. - type: + processorVersion: + description: The resource name of the processor version produced by training. type: string - description: Type of the VisualElement. - detectedLanguages: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - type: object - description: >- - Detected non-text visual elements e.g. checkbox, signature etc. on the - page. - GoogleCloudDocumentaiV1BatchProcessResponse: - id: GoogleCloudDocumentaiV1BatchProcessResponse - properties: {} - type: object - description: Response message for BatchProcessDocuments. - GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse: - properties: {} - type: object - description: Response of the batch move documents operation. - id: GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse - GoogleCloudDocumentaiV1EvaluationReference: + id: GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse + GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus: properties: - aggregateMetricsExact: + status: + $ref: '#/components/schemas/GoogleRpcStatus' description: >- - An aggregate of the statistics for the evaluation with fuzzy - matching off. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationMetrics' - operation: - description: The resource name of the Long Running Operation for the evaluation. - type: string - evaluation: + The status of resyncing the dataset with regards to the detected + inconsistency. Empty if ResyncDatasetRequest.validate_only is + `true`. + datasetInconsistencyType: + description: The type of the inconsistency of the dataset. + enumDescriptions: + - Default value. + - The marker file under the dataset folder is not found. + enum: + - DATASET_INCONSISTENCY_TYPE_UNSPECIFIED + - DATASET_INCONSISTENCY_TYPE_NO_STORAGE_MARKER 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. - description: >- - Gives a short summary of an evaluation, and links to the evaluation - itself. - id: GoogleCloudDocumentaiV1EvaluationReference - type: object - GoogleCloudDocumentaiV1beta3DisableProcessorResponse: - id: GoogleCloudDocumentaiV1beta3DisableProcessorResponse - description: >- - Response message for the DisableProcessor method. Intentionally empty - proto for adding fields in future. + id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus + description: Resync status against inconsistency types on the dataset level. type: object - properties: {} - GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment: + GoogleLongrunningListOperationsResponse: + id: GoogleLongrunningListOperationsResponse properties: - startIndex: - format: int64 - description: TextSegment start UTF-8 char index in the Document.text. - type: string - endIndex: - description: TextSegment half open end UTF-8 char index in the Document.text. - format: int64 + nextPageToken: + description: The standard List next-page token. type: string - 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 - id: GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment + operations: + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' + type: array + description: >- + A list of operations that matches the specified filter in the + request. + description: The response message for Operations.ListOperations. type: object - GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus: - description: The status of a each individual document in the batch process. + GoogleCloudDocumentaiV1beta1OperationMetadata: + id: GoogleCloudDocumentaiV1beta1OperationMetadata + description: Contains metadata for the BatchProcessDocuments operation. properties: - humanReviewOperation: - 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. - deprecated: true + state: type: string - inputGcsSource: + enumDescriptions: + - The default value. This value is used if the state is omitted. + - Request is received. + - Request operation is waiting for scheduling. + - Request is being processed. + - The batch processing completed successfully. + - The batch processing was cancelled. + - The batch processing has failed. + description: The state of the current batch processing. + enum: + - STATE_UNSPECIFIED + - ACCEPTED + - WAITING + - RUNNING + - SUCCEEDED + - CANCELLED + - FAILED + updateTime: + format: google-datetime type: string - description: >- - The source of the document, same as the input_gcs_source field in - the request when the batch process started. - outputGcsDestination: + description: The last update time of the operation. + stateMessage: 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. - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status processing the document. - humanReviewStatus: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3HumanReviewStatus' - description: The status of human review on the processed document. - type: object - id: GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus - GoogleCloudDocumentaiV1beta3DocumentId: + A message providing more details about the current state of + processing. + createTime: + type: string + description: The creation time of the operation. + format: google-datetime type: object - properties: - gcsManagedDocId: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId - description: A document id within user-managed Cloud Storage. - 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 - id: GoogleCloudDocumentaiV1beta3DocumentId - description: Document Identifier. - GoogleCloudDocumentaiV1beta2DocumentTextChange: - description: This message is used for text changes aka. OCR corrections. + GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse: + id: GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse + description: Response message associated with the ExportProcessorVersion operation. type: object - id: GoogleCloudDocumentaiV1beta2DocumentTextChange properties: - changedText: + gcsUri: type: string - description: The text that replaces the text identified in the `text_anchor`. - provenance: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentProvenance - deprecated: true - type: array - description: The history of this annotation. - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentTextAnchor' - 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. - GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics: - properties: - confidenceLevel: - description: The confidence level. - type: number - format: float - metrics: - description: The metrics at the specific confidence level. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationMetrics' - id: GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics + description: The Cloud Storage URI containing the output artifacts. + GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse: type: object - description: Evaluations metrics, at a specific confidence level. - GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus: - description: The status of each individual document in the export process. + description: The response message for the ImportProcessorVersion method. properties: - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of the exporting of the document. - documentId: - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' - description: The path to source docproto of the document. - outputGcsDestination: - description: >- - The output_gcs_destination of the exported document if it was - successful, otherwise empty. + processorVersion: + description: The destination processor version name. type: string - id: >- - GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus - type: object - GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse: + id: GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse + GoogleCloudDocumentaiV1beta1GcsDestination: + description: >- + The Google Cloud Storage location where the output file will be written + to. properties: - evaluation: + uri: type: string - description: The resource name of the created evaluation. - type: object - id: GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse - description: Response of the EvaluateProcessorVersion method. - GoogleCloudDocumentaiV1beta1DocumentPageBlock: + id: GoogleCloudDocumentaiV1beta1GcsDestination type: object + GoogleCloudDocumentaiV1beta2Document: description: >- - A block has a set of lines (collected into paragraphs) that have a - common line-spacing and orientation. - properties: - provenance: - description: The history of this annotation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenance' - deprecated: true - detectedLanguages: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - type: array - layout: - description: Layout for Block. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' - id: GoogleCloudDocumentaiV1beta1DocumentPageBlock - GoogleCloudDocumentaiV1beta2BoundingPoly: - description: A bounding polygon for the detected image annotation. - id: GoogleCloudDocumentaiV1beta2BoundingPoly + 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: GoogleCloudDocumentaiV1beta2Document type: object properties: - normalizedVertices: + 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). + text: + type: string + description: Optional. UTF-8 encoded text in reading order from the document. + 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/GoogleCloudDocumentaiV1beta2NormalizedVertex' - description: The bounding polygon normalized vertices. - vertices: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentEntity' + 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/GoogleCloudDocumentaiV1beta2Vertex' - description: The bounding polygon vertices. - GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest: - type: object - properties: - evaluationDocuments: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentTextChange + content: + format: byte description: >- - 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. - id: GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest - GoogleCloudDocumentaiV1beta2DocumentPageAnchor: - properties: - pageRefs: - description: One or more references to visual page elements + 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 + pages: + description: Visual page layout for the Document. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPage' + type: array + entityRelations: + type: array + description: Placeholder. Relationship among Document.entities. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef + #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentEntityRelation + error: + $ref: '#/components/schemas/GoogleRpcStatus' + description: Any error that occurred while processing this document. + labels: + description: Labels for this document. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentLabel' type: array - id: GoogleCloudDocumentaiV1beta2DocumentPageAnchor - 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. - type: object - 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: - month: - type: integer + shardInfo: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentShardInfo' description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - format: int32 - day: - type: integer - format: int32 + 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. + mimeType: + 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. - 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 - GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata: - description: Metadata of the auto-labeling documents operation. - type: object - properties: - totalDocumentCount: - type: integer - description: Total number of the auto-labeling documents. - format: int32 - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - individualAutoLabelStatuses: - description: >- - The list of individual auto-labeling statuses of the dataset - documents. - type: array + An IANA published [media type (MIME + type)](https://www.iana.org/assignments/media-types/media-types.xhtml). + textStyles: items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus - id: GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata - GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse: - description: >- - Response to an batch document processing request. This is returned in - the LRO Operation after the operation is complete. - type: object - id: GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse - properties: - responses: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentStyle' + type: array + description: Styles for the Document.text. + deprecated: true + revisions: + description: Placeholder. Revision history of this document. items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2ProcessDocumentResponse + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentRevision' type: array - description: Responses for each individual document. - GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata: - description: >- - The long-running operation metadata for the ImportProcessorVersion - method. - id: GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata - type: object - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata for the long-running operation. - GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata: - description: Metadata of the EvaluateProcessorVersion method. - id: GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata + GoogleCloudDocumentaiV1EvaluationReference: type: object + id: GoogleCloudDocumentaiV1EvaluationReference properties: - commonMetadata: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - description: The basic metadata of the long-running operation. - GoogleCloudDocumentaiV1ListEvaluationsResponse: - description: The response from `ListEvaluations`. - properties: - nextPageToken: + aggregateMetrics: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationMetrics' + description: >- + An aggregate of the statistics for the evaluation with fuzzy + matching on. + evaluation: + description: The resource name of the evaluation. + type: string + operation: + description: The resource name of the Long Running Operation for the evaluation. type: string + aggregateMetricsExact: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationMetrics' 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: - type: array - description: The evaluations requested. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Evaluation' + 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. + GoogleCloudDocumentaiV1beta1DocumentEntityRelation: type: object - id: GoogleCloudDocumentaiV1ListEvaluationsResponse - GoogleCloudDocumentaiV1beta3BatchProcessMetadata: - id: GoogleCloudDocumentaiV1beta3BatchProcessMetadata properties: - stateMessage: - description: >- - A message providing more details about the current state of - processing. For example, the error message if the operation is - failed. + objectId: type: string - individualProcessStatuses: - description: The list of response details of each document. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus - type: array - createTime: + description: Object entity id. + subjectId: type: string - description: The creation time of the operation. - format: google-datetime - updateTime: - format: google-datetime - description: The last update time of the operation. + description: Subject entity id. + relation: + type: string + description: Relationship description. + description: Relationship between Entities. + id: GoogleCloudDocumentaiV1beta1DocumentEntityRelation + GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse: + properties: {} + type: object + description: Response of the delete documents operation. + id: GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse + GoogleCloudDocumentaiV1HumanReviewStatus: + description: The status of human review on a processed document. + 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 state: + description: The state of human review on the processing request. 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. + - >- + 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 - - WAITING - - RUNNING - - SUCCEEDED - - CANCELLING - - CANCELLED - - FAILED + - SKIPPED + - VALIDATION_PASSED + - IN_PROGRESS + - ERROR + stateMessage: + description: A message providing more details about the human review state. type: string type: object - description: The long-running operation metadata for BatchProcessDocuments. - GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig: + id: GoogleCloudDocumentaiV1HumanReviewStatus + GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsResponse: + type: object + id: GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsResponse + properties: {} + description: Response of the batch update documents operation. + GoogleCloudDocumentaiV1beta1Barcode: properties: - schema: - readOnly: true + rawValue: type: string description: >- - Output only. The schema in Document AI Warehouse associated with the - dataset. - collection: - readOnly: true + Raw value encoded in the barcode. For example: + `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. + format: type: string description: >- - Output only. The collection in Document AI Warehouse associated with - the dataset. - type: object - description: >- - Configuration specific to the Document AI Warehouse-based - implementation. - id: GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig - GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse: - id: GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse - description: The response message for the ImportProcessorVersion method. - properties: - processorVersion: + 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: + 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 - description: The destination processor version name. type: object - GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest: - description: Request message for the SetDefaultProcessorVersion method. + id: GoogleCloudDocumentaiV1beta1Barcode + description: Encodes the detailed information of a barcode. + GoogleCloudDocumentaiV1DocumentPageLine: + id: GoogleCloudDocumentaiV1DocumentPageLine type: object properties: - defaultProcessorVersion: + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + deprecated: true + description: The history of this annotation. + detectedLanguages: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + type: array + 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. + GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak: + description: Detected break at the end of a Token. + id: GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak + properties: + type: type: string - description: >- - Required. The resource name of child ProcessorVersion to use as - default. Format: - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}` - id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest - GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata: - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata - description: >- - The long-running operation metadata for the UndeployProcessorVersion - method. - type: object - GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue: + description: Detected break type. + enumDescriptions: + - Unspecified break type. + - A single whitespace. + - A wider whitespace. + - A hyphen that indicates that a token has been split across lines. + enum: + - TYPE_UNSPECIFIED + - SPACE + - WIDE_SPACE + - HYPHEN type: object - description: Parsed and normalized entity value. + GoogleCloudDocumentaiV1DocumentEntityNormalizedValue: properties: - integerValue: - description: Integer value. - format: int32 - type: integer - dateValue: - $ref: '#/components/schemas/GoogleTypeDate' + text: description: >- - Date value. Includes year, month, day. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/date.proto + 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 + addressValue: + description: >- + Postal address. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto + $ref: '#/components/schemas/GoogleTypePostalAddress' floatValue: - description: Float value. - type: number format: float + type: number + description: Float value. moneyValue: + $ref: '#/components/schemas/GoogleTypeMoney' description: >- Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto - $ref: '#/components/schemas/GoogleTypeMoney' + 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: + format: int32 + type: integer + description: Integer value. datetimeValue: $ref: '#/components/schemas/GoogleTypeDateTime' description: >- @@ -1491,1147 +1472,832 @@ components: description: >- Boolean value. Can be used for entities with binary values, or for checkboxes. - text: + description: Parsed and normalized entity value. + type: object + id: GoogleCloudDocumentaiV1DocumentEntityNormalizedValue + GoogleCloudDocumentaiV1beta2DocumentRevision: + description: Contains past or forward revisions of this document. + properties: + parent: + items: + format: int32 + type: integer + type: array + 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 + agent: 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. - addressValue: + If the change was made by a person specify the name or id of that + person. + id: + type: string description: >- - Postal address. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto - $ref: '#/components/schemas/GoogleTypePostalAddress' - id: GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue - GoogleCloudDocumentaiV1beta3EnableProcessorResponse: - id: GoogleCloudDocumentaiV1beta3EnableProcessorResponse + Id of the revision, internally generated by doc proto storage. + Unique within the context of the document. + humanReview: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview + description: Human Review information of this revision. + 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. + type: array + items: + type: string + processor: + description: >- + If the annotation was made by processor identify the processor by + its resource name. + 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. type: object - description: >- - Response message for the EnableProcessor method. Intentionally empty - proto for adding fields in future. - properties: {} - GoogleCloudDocumentaiV1DocumentStyleFontSize: + id: GoogleCloudDocumentaiV1beta2DocumentRevision + GoogleCloudDocumentaiV1DocumentPageParagraph: + description: A collection of lines that a human would perceive as a paragraph. + properties: + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for Paragraph. + detectedLanguages: + description: A list of detected languages together with confidence. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + deprecated: true + description: The history of this annotation. + id: GoogleCloudDocumentaiV1DocumentPageParagraph type: object + GoogleCloudDocumentaiV1beta2DocumentProvenanceParent: properties: - unit: - type: string + revision: + type: integer + format: int32 + description: The index of the index into current revision's parent_ids list. + id: + format: int32 + deprecated: true + type: integer + description: The id of the parent provenance. + index: + format: int32 + type: integer 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. - id: GoogleCloudDocumentaiV1DocumentStyleFontSize - GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse: - description: The response proto of ResyncDataset method. - id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse + The index of the parent item in the corresponding item list (eg. + list of entities, properties within entities, etc.) in the parent + revision. + description: >- + The parent element the current element is based on. Used for + referencing/aligning, removal and replacement operations. + id: GoogleCloudDocumentaiV1beta2DocumentProvenanceParent type: object - properties: {} - GoogleCloudDocumentaiV1DisableProcessorMetadata: + GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata: type: object - id: GoogleCloudDocumentaiV1DisableProcessorMetadata properties: commonMetadata: description: The basic metadata of the long-running operation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - description: The long-running operation metadata for the DisableProcessor method. - GoogleCloudDocumentaiV1beta1DocumentPageDimension: - type: object - description: Dimension for the page. + $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. + id: GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata + description: The metadata that represents a processor version being created. + GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect: properties: - width: - type: number - format: float - description: Page width. - height: + 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: type: number - description: Page height. format: float - unit: - description: Dimension unit. - type: string - id: GoogleCloudDocumentaiV1beta1DocumentPageDimension - GoogleCloudDocumentaiV1beta1BoundingPoly: - description: A bounding polygon for the detected image annotation. - id: GoogleCloudDocumentaiV1beta1BoundingPoly + description: >- + Confidence of detected defect. Range `[0, 1]` where `1` indicates + strong confidence that the defect exists. + type: object + description: Image Quality Defects + id: GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect + GoogleCloudDocumentaiV1DocumentTextAnchor: + id: GoogleCloudDocumentaiV1DocumentTextAnchor type: object properties: - normalizedVertices: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1NormalizedVertex' - description: The bounding polygon normalized vertices. - vertices: + 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: items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1Vertex' - description: The bounding polygon vertices. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment + description: The text segments from the Document.text. type: array - GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow: - description: A row of table cells. + description: Text reference indexing into the Document.text. + GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata: type: object - id: GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow + id: GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata properties: - cells: + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + description: >- + The long-running operation metadata for the UndeployProcessorVersion + method. + GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata: + description: The long-running operation metadata for the ReviewDocument method. + properties: + questionId: + type: string + description: The Crowd Compute question ID. + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + type: object + id: GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata + GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata: + properties: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + trainingDatasetValidation: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation + description: The training dataset validation information. + testDatasetValidation: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation + description: The test dataset validation information. + id: GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata + type: object + description: The metadata that represents a processor version being created. + GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics: + type: object + description: Metrics across multiple confidence levels. + id: GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics + properties: + metricsType: + type: string + 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. + enum: + - METRICS_TYPE_UNSPECIFIED + - AGGREGATE + description: The metrics type for the label. + auprcExact: + description: >- + The AUPRC for metrics with fuzzy matching disabled, i.e., exact + matching only. + type: number + format: float + confidenceLevelMetrics: + description: Metrics across confidence levels with fuzzy matching enabled. type: array - description: Cells that make up this row. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell - GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores: - id: GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores - properties: - qualityScore: - type: number + #/components/schemas/GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics + estimatedCalibrationError: description: >- - The overall quality score. Range `[0, 1]` where `1` is perfect - quality. + The Estimated Calibration Error (ECE) of the confidence of the + predicted entities. format: float - detectedDefects: + type: number + confidenceLevelMetricsExact: type: array - description: A list of detected defects. + description: Metrics across confidence levels with only exact matching. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect - description: Image quality scores for the page image. - type: object - GoogleCloudDocumentaiV1ListProcessorTypesResponse: - id: GoogleCloudDocumentaiV1ListProcessorTypesResponse - description: Response message for the ListProcessorTypes method. + #/components/schemas/GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics + auprc: + type: number + description: >- + The calculated area under the precision recall curve (AUPRC), + computed by integrating over all confidence thresholds. + format: float + estimatedCalibrationErrorExact: + format: float + description: >- + The ECE for the predicted entities with fuzzy matching disabled, + i.e., exact matching only. + type: number + GoogleCloudDocumentaiV1DocumentSchemaEntityType: properties: - nextPageToken: - type: string - description: Points to the next page, otherwise empty. - processorTypes: - description: The processor types. + 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 + baseTypes: items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorType' + type: string + description: >- + The entity type that this type is derived from. For now, one and + only one should be set. + type: array + properties: + description: Description the nested structure, or composition of an entity. type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty + name: + type: string + 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. + displayName: + type: string + description: User defined name for the type. type: object - GoogleCloudDocumentaiV1beta2DocumentPageMatrix: description: >- - Representation for transformation matrix, intended to be compatible and - used with OpenCV format for image manipulation. - id: GoogleCloudDocumentaiV1beta2DocumentPageMatrix + 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 + GoogleCloudDocumentaiV1BatchProcessResponse: + id: GoogleCloudDocumentaiV1BatchProcessResponse + type: object + properties: {} + description: Response message for BatchProcessDocuments. + GoogleCloudDocumentaiV1DocumentEntityRelation: type: object properties: - data: - format: byte - description: The matrix data. + objectId: + description: Object entity id. type: string - rows: - format: int32 - description: Number of rows in the matrix. - type: integer - 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 - cols: - description: Number of columns in the matrix. - format: int32 - type: integer - GoogleCloudDocumentaiV1ProcessResponse: - type: object - description: Response message for the ProcessDocument method. - id: GoogleCloudDocumentaiV1ProcessResponse + subjectId: + type: string + description: Subject entity id. + relation: + type: string + description: Relationship description. + description: Relationship between Entities. + id: GoogleCloudDocumentaiV1DocumentEntityRelation + GoogleCloudDocumentaiV1BatchProcessMetadata: properties: - humanReviewStatus: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1HumanReviewStatus' - description: The status of human review on the processed document. - document: + state: + type: string + 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. + stateMessage: description: >- - The document payload, will populate fields based on the processor's - behavior. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' - GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId: - description: >- - Identifies a document uniquely within the scope of a dataset in - unmanaged option. - id: GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId - properties: - docId: + A message providing more details about the current state of + processing. For example, the error message if the operation is + failed. type: string - description: Required. The id of the document. - type: object - GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues: - id: GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues - type: object - description: Defines the a list of enum values. - properties: - values: - description: The individual values that this enum values type can include. + updateTime: + description: The last update time of the operation. + format: google-datetime + type: string + individualProcessStatuses: type: array - items: - type: string - GoogleCloudDocumentaiV1beta2DocumentProvenance: - properties: - parents: - type: array - description: References to the original elements that are replaced. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentProvenanceParent - revision: - type: integer - deprecated: true - description: The index of the revision that produced this element. - format: int32 - id: - description: >- - The Id of this operation. Needs to be unique within the scope of the - revision. - type: integer - deprecated: true - format: int32 - 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. - 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. + #/components/schemas/GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus + description: The list of response details of each document. + createTime: + format: google-datetime type: string - description: >- - Structure to identify provenance relationships between annotations in - different revisions. - id: GoogleCloudDocumentaiV1beta2DocumentProvenance + description: The creation time of the operation. + id: GoogleCloudDocumentaiV1BatchProcessMetadata type: object - GoogleCloudDocumentaiV1DocumentPageImageQualityScores: - description: Image quality scores for the page image. - id: GoogleCloudDocumentaiV1DocumentPageImageQualityScores + description: The long-running operation metadata for BatchProcessDocuments. + GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata: properties: - detectedDefects: - description: A list of detected defects. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect - qualityScore: - description: >- - The overall quality score. Range `[0, 1]` where `1` is perfect - quality. - format: float - type: number - type: object - GoogleCloudDocumentaiV1GcsPrefix: + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + id: GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata type: object - id: GoogleCloudDocumentaiV1GcsPrefix - description: Specifies all documents on Cloud Storage with a common prefix. - properties: - gcsUriPrefix: - type: string - description: The URI prefix. - GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak: + GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata: type: object + description: >- + The long-running operation metadata for the SetDefaultProcessorVersion + method. + id: GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata properties: - type: - description: Detected break 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. - enum: - - TYPE_UNSPECIFIED - - SPACE - - WIDE_SPACE - - HYPHEN - description: Detected break at the end of a Token. - id: GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak - GoogleCloudDocumentaiV1DocumentPageVisualElement: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + GoogleCloudDocumentaiV1BoundingPoly: type: object - description: >- - Detected non-text visual elements e.g. checkbox, signature etc. on the - page. - id: GoogleCloudDocumentaiV1DocumentPageVisualElement + id: GoogleCloudDocumentaiV1BoundingPoly + description: A bounding polygon for the detected image annotation. properties: - detectedLanguages: + normalizedVertices: type: array items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - layout: - description: Layout for VisualElement. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - type: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1NormalizedVertex' + description: The bounding polygon normalized vertices. + vertices: + description: The bounding polygon vertices. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Vertex' + type: array + GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage: + description: Detected language for a structural component. + properties: + confidence: + description: Confidence of detected language. Range `[0, 1]`. + type: number + 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 - description: Type of the VisualElement. - GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell: - description: A cell representation inside the table. + id: GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage type: object + GoogleCloudDocumentaiV1beta2DocumentPageTable: + type: object + id: GoogleCloudDocumentaiV1beta2DocumentPageTable + description: A table representation similar to HTML table structure. properties: - colSpan: - type: integer - format: int32 - description: How many columns this cell spans. - detectedLanguages: - description: A list of detected languages together with confidence. + headerRows: + type: array items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage - type: array - rowSpan: - type: integer - description: How many rows this cell spans. - format: int32 + #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow + description: Header rows of the table. + provenance: + deprecated: true + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentProvenance' + description: The history of this table. layout: - description: Layout for TableCell. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' - id: GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell - GoogleCloudDocumentaiV1beta2DocumentPageFormField: - description: A form field detected on the page. - id: GoogleCloudDocumentaiV1beta2DocumentPageFormField - type: object - properties: - 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. - fieldName: - description: >- - Layout for the FormField name. e.g. `Address`, `Email`, `Grand - total`, `Phone number`, etc. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' - 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` - fieldValue: + description: Layout for Table. $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' - description: Layout for the FormField value. - nameDetectedLanguages: + bodyRows: + type: array + description: Body rows of the table. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage - type: array - description: A list of detected languages for name together with confidence. - correctedValueText: - 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. - type: string - valueDetectedLanguages: - description: A list of detected languages for value together with confidence. - type: array + #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow + detectedLanguages: + description: A list of detected languages together with confidence. items: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentProvenance' - description: The history of this annotation. - GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult: - id: >- - GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult - 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: - type: string - description: The source Cloud Storage URI specified in the import config. - type: object - GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata: + type: array + GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata: properties: commonMetadata: + description: The basic metadata of the long-running operation. $ref: >- #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The common metadata about the operation. + id: GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata type: object - description: Metadata message associated with the ExportProcessorVersion operation. - id: GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata - GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig: + GoogleCloudDocumentaiV1DocumentStyleFontSize: type: object - id: GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig - description: The configuration used when outputting documents. properties: - fieldMask: - type: string + size: + type: number + description: Font size for the text. + format: float + unit: 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 - gcsUri: - description: The Cloud Storage uri (a directory) of the output. - type: string - shardingConfig: - description: Specifies the sharding config for the output document. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig - GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak: - description: Detected break at the end of a Token. - id: GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak - properties: - type: - description: Detected break type. - enum: - - TYPE_UNSPECIFIED - - SPACE - - WIDE_SPACE - - HYPHEN + Unit for the font size. Follows CSS naming (such as `in`, `px`, and + `pt`). type: string - enumDescriptions: - - Unspecified break type. - - A single whitespace. - - A wider whitespace. - - A hyphen that indicates that a token has been split across lines. - type: object - GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig: - description: Configuration specific to spanner-based indexing. - id: GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig - properties: {} - type: object - GoogleCloudDocumentaiV1beta1DocumentShardInfo: + description: Font size with unit. + id: GoogleCloudDocumentaiV1DocumentStyleFontSize + GoogleCloudDocumentaiV1beta3CommonOperationMetadata: + id: GoogleCloudDocumentaiV1beta3CommonOperationMetadata + description: The common metadata for long running operations. type: object properties: - shardIndex: - description: The 0-based index of this shard. - format: int64 - type: string - textOffset: - type: string - format: int64 - description: >- - The index of the first character in Document.text in the overall - document global text. - shardCount: - description: Total number of shards. + createTime: 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. - id: GoogleCloudDocumentaiV1beta1DocumentShardInfo - GoogleCloudDocumentaiV1TrainProcessorVersionMetadata: - id: GoogleCloudDocumentaiV1TrainProcessorVersionMetadata - type: object - description: The metadata that represents a processor version being created. - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - trainingDatasetValidation: - description: The training dataset validation information. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation - testDatasetValidation: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation - description: The test dataset validation information. - GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus: - id: >- - GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus - type: object - properties: - inputGcsSource: + description: The creation time of the operation. + format: google-datetime + resource: 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: - description: >- - The output_gcs_destination of the processed document if it was - successful, otherwise empty. + description: A related resource to this operation. + updateTime: type: string - description: The status of each individual document in the import process. - GoogleCloudDocumentaiV1ProcessOptions: - type: object - properties: - fromEnd: - format: int32 - type: integer - description: Only process certain pages from the end, same as above. - schemaOverride: - 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. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' - fromStart: - type: integer - format: int32 - description: >- - Only process certain pages from the start. Process all if the - document has fewer pages. - 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 - id: GoogleCloudDocumentaiV1ProcessOptions - GoogleCloudDocumentaiV1DocumentPageImage: - description: Rendered image contents for this page. - properties: - height: - type: integer - format: int32 - description: Height of the image in pixels. - mimeType: + format: google-datetime + description: The last update time of the operation. + state: type: string + enumDescriptions: + - Unspecified state. + - Operation is still running. + - Operation is being cancelled. + - Operation succeeded. + - Operation failed. + - Operation is cancelled. + description: The state of the operation. + enum: + - STATE_UNSPECIFIED + - RUNNING + - CANCELLING + - SUCCEEDED + - FAILED + - CANCELLED + stateMessage: description: >- - Encoding [media type (MIME - type)](https://www.iana.org/assignments/media-types/media-types.xhtml) - for the image. - width: - format: int32 - description: Width of the image in pixels. - type: integer - content: - description: Raw byte content of the image. + A message providing more details about the current state of + processing. type: string - format: byte - id: GoogleCloudDocumentaiV1DocumentPageImage - type: object - GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef: - type: object + GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage: + id: GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage properties: - boundingPoly: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2BoundingPoly' - 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: - 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. - 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 confidence: type: number format: float + description: Confidence of detected language. Range `[0, 1]`. + languageCode: description: >- - Optional. Confidence of detected page element, if applicable. Range - `[0, 1]`. - 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: - description: Optional. Deprecated. Use PageRef.bounding_poly instead. + The [BCP-47 language + code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), + such as `en-US` or `sr-Latn`. type: string - deprecated: true - description: Represents a weak reference to a page element within a document. - id: GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef - GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse: - description: Response of the EvaluateProcessorVersion method. type: object - id: GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse + description: Detected language for a structural component. + GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse: + description: Response of the EvaluateProcessorVersion method. properties: evaluation: description: The resource name of the created evaluation. type: string - GoogleCloudDocumentaiV1DocumentPageAnchorPageRef: - id: GoogleCloudDocumentaiV1DocumentPageAnchorPageRef + type: object + id: GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse + GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect: + id: GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect + description: Image Quality Defects + type: object properties: - layoutId: - type: string - deprecated: true - description: Optional. Deprecated. Use PageRef.bounding_poly instead. - 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' - page: - type: string - 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. - 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. - enum: - - LAYOUT_TYPE_UNSPECIFIED - - BLOCK - - PARAGRAPH - - LINE - - TOKEN - - VISUAL_ELEMENT - - TABLE - - FORM_FIELD - type: string - description: >- - Optional. The type of the layout element that is being referenced if - any. confidence: description: >- - Optional. Confidence of detected page element, if applicable. Range - `[0, 1]`. - type: number + Confidence of detected defect. Range `[0, 1]` where `1` indicates + strong confidence that the defect exists. format: float - type: object - description: Represents a weak reference to a page element within a document. - GoogleCloudDocumentaiV1beta2OperationMetadata: - id: GoogleCloudDocumentaiV1beta2OperationMetadata - properties: - createTime: - format: google-datetime + type: number + type: type: string - description: The creation time of the operation. - stateMessage: description: >- - A message providing more details about the current state of - processing. - type: string - state: - enumDescriptions: - - The default value. This value is used if the state is omitted. - - Request is received. - - Request operation is waiting for scheduling. - - Request is being processed. - - The batch processing completed successfully. - - The batch processing was cancelled. - - The batch processing has failed. - type: string - enum: - - STATE_UNSPECIFIED - - ACCEPTED - - WAITING - - RUNNING - - SUCCEEDED - - CANCELLED - - FAILED - description: The state of the current batch processing. - updateTime: - format: google-datetime - description: The last update time of the operation. - type: string - type: object - description: Contains metadata for the BatchProcessDocuments operation. - GoogleCloudDocumentaiV1DocumentPageTableTableRow: - description: A row of table cells. - properties: - cells: - description: Cells that make up this row. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableCell - type: array - id: GoogleCloudDocumentaiV1DocumentPageTableTableRow - type: object - GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector: - description: A list of individual page numbers. - id: GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector + 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` + GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse: + properties: {} + description: The response proto of ExportDocuments method. type: object - properties: - pages: - description: Optional. Indices of the pages (starting from 1). - items: - format: int32 - type: integer - type: array - GoogleCloudDocumentaiV1DocumentPageBlock: - id: GoogleCloudDocumentaiV1DocumentPageBlock - description: >- - A block has a set of lines (collected into paragraphs) that have a - common line-spacing and orientation. + id: GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse + GoogleCloudDocumentaiV1beta1DocumentPageSymbol: + description: A detected symbol. type: object properties: - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this annotation. - deprecated: true - detectedLanguages: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - type: array layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for Block. - GoogleCloudDocumentaiV1beta2DocumentPageTable: - description: A table representation similar to HTML table structure. - type: object - properties: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' + description: Layout for Symbol. detectedLanguages: description: A list of detected languages together with confidence. type: array items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentProvenance' - description: The history of this table. - deprecated: true - bodyRows: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow - description: Body rows of the table. - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' - description: Layout for Table. - headerRows: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow - description: Header rows of the table. - id: GoogleCloudDocumentaiV1beta2DocumentPageTable - GoogleCloudDocumentaiV1DocumentStyle: - id: GoogleCloudDocumentaiV1DocumentStyle + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage + id: GoogleCloudDocumentaiV1beta1DocumentPageSymbol + GoogleTypePostalAddress: + type: object description: >- - Annotation for common text style attributes. This adheres to CSS - conventions as much as possible. + 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 properties: - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' - description: Text anchor indexing into the Document.text. - textStyle: - description: >- - [Text - style](https://www.w3schools.com/cssref/pr_font_font-style.asp). - Possible values are `normal`, `italic`, and `oblique`. + organization: type: string - fontSize: - description: Font size. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyleFontSize' - color: - $ref: '#/components/schemas/GoogleTypeColor' - description: Text color. - textDecoration: + description: Optional. The name of the organization at the address. + sortingCode: type: string description: >- - [Text - decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). - Follows CSS standard. - backgroundColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Text background color. - fontWeight: + 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: description: >- - [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). - Possible values are `normal`, `bold`, `bolder`, and `lighter`. - type: string - fontFamily: + 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 + addressLines: + type: array description: >- - Font family such as `Arial`, `Times New Roman`. - https://www.w3schools.com/cssref/pr_font_font-family.asp - type: object - GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo: - type: object - description: Font and other text style attributes. - id: GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo - properties: - superscript: + 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). + items: + type: string + locality: 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. - backgroundColor: - description: Color of the background. - $ref: '#/components/schemas/GoogleTypeColor' - pixelFontSize: - description: >- - Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ - `72.0`. - format: double - type: number - fontWeight: - format: int32 - description: >- - TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). - Normal is `400`, bold is `700`. - type: integer - textColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Color of the text. - fontType: - description: Name or style of the font. + 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 - smallcaps: - type: boolean - description: >- - Whether the text is in small caps. This feature is not supported - yet. - letterSpacing: - type: number - description: Letter spacing in points. - format: double - handwritten: - type: boolean - description: Whether the text is handwritten. - fontSize: - description: Font size in points (`1` point is `¹⁄₇₂` inches). + revision: format: int32 type: integer - strikeout: - type: boolean description: >- - Whether the text is strikethrough. This feature is not supported - yet. - italic: - type: boolean - description: Whether the text is italic. - underlined: - type: boolean - description: Whether the text is underlined. - bold: + 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: description: >- - Whether the text is bold (equivalent to font_weight is at least - `700`). - type: boolean - GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata: - description: The metadata that represents a processor version being created. - properties: - testDatasetValidation: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation - description: The test dataset validation information. - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - trainingDatasetValidation: - description: The training dataset validation information. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation - id: GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata - type: object - GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode: - description: A detected barcode. - id: GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode - properties: - barcode: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1Barcode' - description: Detailed barcode information of the DetectedBarcode. - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' - description: Layout for DetectedBarcode. - type: object - GoogleCloudDocumentaiV1FetchProcessorTypesResponse: - description: Response message for the FetchProcessorTypes method. - type: object - id: GoogleCloudDocumentaiV1FetchProcessorTypesResponse - properties: - processorTypes: + 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/GoogleCloudDocumentaiV1ProcessorType' - description: The list of processor types. - GoogleCloudDocumentaiV1beta1GcsDestination: - id: GoogleCloudDocumentaiV1beta1GcsDestination - type: object - description: >- - The Google Cloud Storage location where the output file will be written - to. - properties: - uri: + 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 - GoogleCloudDocumentaiV1DocumentTextChange: - type: object - id: GoogleCloudDocumentaiV1DocumentTextChange - description: This message is used for text changes aka. OCR corrections. - properties: - changedText: + languageCode: 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. - provenance: + 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". + sublocality: + type: string + description: >- + Optional. Sublocality of the address. For example, this can be + neighborhoods, boroughs, districts. + postalCode: + 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.). + GoogleCloudDocumentaiV1beta1DocumentPageParagraph: + type: object + description: A collection of lines that a human would perceive as a paragraph. + properties: + detectedLanguages: + description: A list of detected languages together with confidence. items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this annotation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage type: array + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' + description: Layout for Paragraph. + provenance: + description: The history of this annotation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenance' deprecated: true - GoogleCloudDocumentaiV1DocumentPageDetectedLanguage: - type: object + id: GoogleCloudDocumentaiV1beta1DocumentPageParagraph + GoogleCloudDocumentaiV1beta2NormalizedVertex: properties: - 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 - confidence: + x: format: float + description: X coordinate. type: number - description: Confidence of detected language. Range `[0, 1]`. - id: GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: Detected language for a structural component. - GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation: + 'y': + type: number + format: float + description: Y coordinate (starts from the top of the image). + 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. + id: GoogleCloudDocumentaiV1beta2NormalizedVertex + GoogleCloudDocumentaiV1DocumentSchemaMetadata: + id: GoogleCloudDocumentaiV1DocumentSchemaMetadata + type: object properties: - documentErrorCount: - description: The total number of document errors. - type: integer - format: int32 - datasetErrors: + documentSplitter: + type: boolean 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 - documentErrors: - items: - $ref: '#/components/schemas/GoogleRpcStatus' + 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: >- - 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 - datasetErrorCount: - format: int32 - type: integer - description: The total number of dataset errors. - id: GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation - description: >- - The dataset validation information. This includes any and all errors - with documents and the dataset. - type: object - GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata: + 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: + description: If set, all the nested entities must be prefixed with the parents. + type: boolean + documentAllowMultipleLabels: + type: boolean + description: >- + If true, on a given page, there can be multiple `document` + annotations covering it. + description: Metadata for global schema behavior. + GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata: + id: GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata type: object properties: commonMetadata: description: The basic metadata of the long-running operation. $ref: >- #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - id: GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata - description: Metadata of the sample documents operation. - GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation: - description: >- - The dataset validation information. This includes any and all errors - with documents and the dataset. + description: The long-running operation metadata for DeleteLabelerPool. + GoogleCloudDocumentaiV1DocumentProvenance: type: object - id: >- - GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation properties: - datasetErrors: - items: - $ref: '#/components/schemas/GoogleRpcStatus' - type: array - 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. - datasetErrorCount: - description: The total number of dataset errors. - type: integer - format: int32 - documentErrorCount: + revision: type: integer + deprecated: true + description: The index of the revision that produced this element. format: int32 - description: The total number of document errors. - 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. - GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse: - type: object - id: GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse - properties: {} - description: Response message for the DeployProcessorVersion method. - GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions: - description: >- - Options to control the training of the Custom Document Extraction (CDE) - Processor. - id: >- - GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions - properties: - trainingMethod: - enumDescriptions: - - '' - - '' - - '' - type: string - description: Training method to use for CDE training. - enum: - - TRAINING_METHOD_UNSPECIFIED - - MODEL_BASED - - TEMPLATE_BASED - type: object - GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata: - properties: - commonMetadata: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - description: The basic metadata of the long-running operation. - description: >- - The long-running operation metadata for the UndeployProcessorVersion - method. - id: GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata - type: object - GoogleCloudDocumentaiV1beta1GcsSource: - properties: - uri: - type: string - description: >- - The Google Cloud Storage location where the input file will be read - from. - id: GoogleCloudDocumentaiV1beta1GcsSource - type: object - GoogleCloudDocumentaiV1DocumentPageLayout: - type: object - id: GoogleCloudDocumentaiV1DocumentPageLayout - properties: - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' - description: Text anchor indexing into the Document.text. - orientation: + type: + enumDeprecated: + - false + - false + - false + - false + - false + - true + - true + - true + description: The type of provenance operation. enum: - - ORIENTATION_UNSPECIFIED - - PAGE_UP - - PAGE_RIGHT - - PAGE_DOWN - - PAGE_LEFT + - OPERATION_TYPE_UNSPECIFIED + - ADD + - REMOVE + - UPDATE + - REPLACE + - EVAL_REQUESTED + - EVAL_APPROVED + - EVAL_SKIPPED 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. + 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`. - >- - Orientation is aligned with page down. Turn the head 180 degrees - from upright to read. + 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`. - >- - Orientation is aligned with page left. Turn the head 90 degrees - counterclockwise from upright to read. - description: Detected orientation for the Layout. + 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: string - boundingPoly: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' - description: The bounding polygon for the Layout. - confidence: - format: float + id: + format: int32 + deprecated: true 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]`. - type: number - description: Visual element describing a layout unit on a page. - GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus: - id: >- - GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus + The Id of this operation. Needs to be unique within the scope of the + revision. + type: integer + parents: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentProvenanceParent + description: References to the original elements that are replaced. + id: GoogleCloudDocumentaiV1DocumentProvenance + description: >- + Structure to identify provenance relationships between annotations in + different revisions. + GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId: + description: >- + Identifies a document uniquely within the scope of a dataset in the + user-managed Cloud Storage option. + type: object + id: GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId properties: - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of deleting the document in storage. - documentId: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3DocumentId' - description: The document id of the document. + cwDocId: + description: Id of the document (indexed) managed by Content Warehouse. + deprecated: true + type: string + gcsUri: + description: Required. The Cloud Storage URI where the actual document is stored. + type: string + GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse: type: object - description: The status of each individual document in the batch delete process. + description: Response message for the SetDefaultProcessorVersion method. + id: GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse + properties: {} GoogleCloudDocumentaiV1beta2DocumentEntity: - id: GoogleCloudDocumentaiV1beta2DocumentEntity 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: GoogleCloudDocumentaiV1beta2DocumentEntity + type: object properties: mentionText: type: string @@ -2639,681 +2305,586 @@ components: mentionId: type: string description: Optional. Deprecated. Use `id` field instead. - properties: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentEntity' + textAnchor: description: >- - Optional. Entities can be nested to form a hierarchical data - structure representing the content in the document. - type: - description: Required. Entity type from a schema e.g. `Address`. - type: string + Optional. Provenance of the entity. Text anchor indexing into the + Document.text. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentTextAnchor' + redacted: + type: boolean + description: >- + Optional. Whether the entity will be redacted for de-identification + purposes. normalizedValue: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue 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/GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue + type: + type: string + description: Required. Entity type from a schema e.g. `Address`. confidence: + description: Optional. Confidence of detected Schema entity. Range `[0, 1]`. format: float type: number - description: Optional. Confidence of detected Schema entity. Range `[0, 1]`. + pageAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageAnchor' + description: >- + Optional. Represents the provenance of this entity wrt. the location + on the page where it was found. + properties: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentEntity' + description: >- + Optional. Entities can be nested to form a hierarchical data + structure representing the content in the document. + type: array id: description: >- Optional. Canonical id. This will be a unique value in the entity list for this document. type: string - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentTextAnchor' - description: >- - Optional. Provenance of the entity. Text anchor indexing into the - Document.text. provenance: $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentProvenance' description: Optional. The history of this annotation. - redacted: - description: >- - Optional. Whether the entity will be redacted for de-identification - purposes. - type: boolean - pageAnchor: - description: >- - Optional. Represents the provenance of this entity wrt. the location - on the page where it was found. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageAnchor' + GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata: + properties: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + type: object + description: >- + The long-running operation metadata for the UndeployProcessorVersion + method. + id: GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata + GoogleCloudDocumentaiV1DeployProcessorVersionResponse: + properties: {} + id: GoogleCloudDocumentaiV1DeployProcessorVersionResponse + type: object + description: Response message for the DeployProcessorVersion method. + GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus: + description: The status of each individual document in the batch move process. type: object - GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo: properties: - smallcaps: - type: boolean - description: >- - Whether the text is in small caps. 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: - type: boolean - description: Whether the text is italic. - letterSpacing: - type: number - description: Letter spacing in points. - format: double - fontType: - type: string - description: Name or style of the font. - subscript: - description: Whether the text is a subscript. This feature is not supported yet. - type: boolean - strikeout: - description: >- - Whether the text is strikethrough. This feature is not supported - yet. - type: boolean - handwritten: - description: Whether the text is handwritten. - type: boolean - bold: - type: boolean - description: >- - Whether the text is bold (equivalent to font_weight is at least - `700`). - fontSize: + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status of moving the document. + documentId: + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' + description: The document id of the document. + id: >- + GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus + GoogleCloudDocumentaiV1DocumentPageImage: + properties: + height: format: int32 - description: Font size in points (`1` point is `¹⁄₇₂` inches). + description: Height of the image in pixels. type: integer - textColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Color of the text. - backgroundColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Color of the background. - superscript: - description: >- - Whether the text is a superscript. This feature is not supported - yet. - type: boolean - underlined: - type: boolean - description: Whether the text is underlined. - fontWeight: + content: + description: Raw byte content of the image. + format: byte + type: string + mimeType: + type: string description: >- - TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). - Normal is `400`, bold is `700`. + Encoding [media type (MIME + type)](https://www.iana.org/assignments/media-types/media-types.xhtml) + for the image. + width: + description: Width of the image in pixels. type: integer format: int32 - id: GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo - description: Font and other text style attributes. - type: object - GoogleCloudDocumentaiV1beta2DocumentRevision: + description: Rendered image contents for this page. + id: GoogleCloudDocumentaiV1DocumentPageImage type: object - id: GoogleCloudDocumentaiV1beta2DocumentRevision + GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse: + id: GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse + description: Response of the sample documents operation. properties: - parentIds: + sampleTrainingStatus: + description: The status of sampling documents in training split. + $ref: '#/components/schemas/GoogleRpcStatus' + selectedDocuments: 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. - items: - type: string - createTime: - description: >- - The time that the revision was created, internally generated by doc - proto storage at the time of create. - type: string - format: google-datetime - processor: - type: string - description: >- - If the annotation was made by processor identify the processor by - its resource name. - parent: + description: The result of the sampling process. items: - format: int32 - type: integer - deprecated: true - type: array - 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. - agent: - type: string - description: >- - If the change was made by a person specify the name or id of that - person. - humanReview: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument + sampleTestStatus: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status of sampling documents in test split. + type: object + GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata: + type: object + id: GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata + properties: + errorDocumentCount: + type: integer + description: Total number of documents that failed to be deleted in storage. + format: int32 + totalDocumentCount: + format: int32 + description: Total number of documents deleting from dataset. + type: integer + commonMetadata: + description: The basic metadata of the long-running operation. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview - description: Human Review information of this revision. - id: - type: string - description: >- - Id of the revision, internally generated by doc proto storage. - Unique within the context of the document. - description: Contains past or forward revisions of this document. - GoogleCloudDocumentaiV1beta1DocumentPageVisualElement: + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + individualBatchDeleteStatuses: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus + description: The list of response details of each document. + GoogleCloudDocumentaiV1beta1DocumentPageTable: properties: layout: - description: Layout for VisualElement. + description: Layout for Table. $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' - type: - description: Type of the VisualElement. - type: string detectedLanguages: description: A list of detected languages together with confidence. items: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage type: array - description: >- - Detected non-text visual elements e.g. checkbox, signature etc. on the - page. - id: GoogleCloudDocumentaiV1beta1DocumentPageVisualElement + provenance: + description: The history of this table. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenance' + deprecated: true + bodyRows: + type: array + description: Body rows of the table. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow + headerRows: + description: Header rows of the table. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow type: object - GoogleCloudDocumentaiV1ReviewDocumentRequest: - description: Request message for the ReviewDocument method. - id: GoogleCloudDocumentaiV1ReviewDocumentRequest - properties: - inlineDocument: - description: An inline document proto. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' - documentSchema: - description: The document schema of the human review task. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' - enableSchemaValidation: - type: boolean - description: >- - Whether the validation should be performed on the ad-hoc review - request. - 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. - type: string - description: The priority of the human review task. - enum: - - DEFAULT - - URGENT + id: GoogleCloudDocumentaiV1beta1DocumentPageTable + description: A table representation similar to HTML table structure. + 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 type: object - GoogleCloudDocumentaiV1beta3RevisionRef: + id: GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment properties: - revisionCase: - enum: - - REVISION_CASE_UNSPECIFIED - - LATEST_HUMAN_REVIEW - - LATEST_TIMESTAMP - - BASE_OCR_REVISION - description: Reads the revision by the predefined case. - type: string - 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. - revisionId: + startIndex: + format: int64 + description: TextSegment start UTF-8 char index in the Document.text. type: string - description: Reads the revision given by the id. - latestProcessorVersion: + endIndex: + description: TextSegment half open end UTF-8 char index in the Document.text. + format: int64 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 - type: object - description: The revision reference specifies which revision on the document to read. - GoogleRpcStatus: - id: GoogleRpcStatus + GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation: type: object + description: >- + The dataset validation information. This includes any and all errors + with documents and the dataset. properties: - details: - type: array - items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. + datasetErrors: description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - message: + 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' + documentErrors: + items: + $ref: '#/components/schemas/GoogleRpcStatus' 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. + 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 + documentErrorCount: + type: integer + description: The total number of document errors. format: int32 + datasetErrorCount: 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). - 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. + format: int32 + description: The total number of dataset errors. + id: GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation + GoogleCloudDocumentaiV1Evaluation: properties: - pageRefs: - type: array - items: + createTime: + type: string + description: The time that the evaluation was created. + format: google-datetime + allEntitiesMetrics: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics + description: Metrics for all the entities in aggregate. + entityMetrics: + type: object + description: Metrics across confidence levels, for different entities. + additionalProperties: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchorPageRef - description: One or more references to visual page elements + #/components/schemas/GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics + documentCounters: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationCounters' + description: Counters for the documents used in the evaluation. + kmsKeyVersionName: + type: string + description: The KMS key version with which data is encrypted. + kmsKeyName: + description: The KMS key name used for encryption. + type: string + name: + description: >- + The resource name of the evaluation. Format: + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}` + type: string + description: An evaluation of a ProcessorVersion's performance. + id: GoogleCloudDocumentaiV1Evaluation type: object - GoogleCloudDocumentaiV1ListProcessorVersionsResponse: + GoogleCloudDocumentaiV1DocumentPageVisualElement: + id: GoogleCloudDocumentaiV1DocumentPageVisualElement + description: >- + Detected non-text visual elements e.g. checkbox, signature etc. on the + page. properties: - nextPageToken: + type: + description: Type of the VisualElement. type: string - description: Points to the next processor, otherwise empty. - processorVersions: - type: array + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for VisualElement. + detectedLanguages: + description: A list of detected languages together with confidence. items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersion' - description: The list of processors. - id: GoogleCloudDocumentaiV1ListProcessorVersionsResponse + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + type: array type: object - description: Response message for the ListProcessorVersions method. - GoogleCloudDocumentaiV1DocumentProvenance: + GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata: type: object description: >- - Structure to identify provenance relationships between annotations in - different revisions. + The long-running operation metadata for the UndeployProcessorVersion + method. properties: - id: - deprecated: true + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + id: GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata + GoogleCloudDocumentaiV1beta1DocumentPage: + description: A page in a Document. + id: GoogleCloudDocumentaiV1beta1DocumentPage + properties: + visualElements: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageVisualElement description: >- - The Id of this operation. Needs to be unique within the scope of the - revision. - format: int32 - type: integer - revision: - description: The index of the revision that produced this element. + A list of detected non-text visual elements e.g. checkbox, signature + etc. on the page. + image: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageImage' + 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. + imageQualityScores: + description: Image quality scores. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores + formFields: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageFormField + type: array + description: A list of visually detected form fields on the page. + tokens: + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageToken' + description: A list of visually detected tokens on the page. + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' + description: Layout for the page. + tables: + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageTable' + description: A list of visually detected tables on the page. + symbols: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageSymbol + description: A list of visually detected symbols on the page. + type: array + 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. format: int32 type: integer + dimension: + description: Physical dimension of the page. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDimension + paragraphs: + 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/GoogleCloudDocumentaiV1beta1DocumentPageParagraph + type: array + transforms: + description: >- + Transformation matrices that were applied to the original document + image to produce Page.image. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageMatrix + type: array + detectedBarcodes: + type: array + description: A list of detected barcodes. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode + lines: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLine' + 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. + provenance: deprecated: true - parents: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenance' + description: The history of this page. + blocks: + 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. type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageBlock' + detectedLanguages: + description: A list of detected languages together with confidence. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentProvenanceParent - description: References to the original elements that are replaced. - type: - description: The type of provenance operation. - enumDeprecated: - - false - - false - - false - - false - - false - - true - - true - - true - 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. - id: GoogleCloudDocumentaiV1DocumentProvenance - GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo: - id: GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage + type: array type: object + GoogleCloudDocumentaiV1FetchProcessorTypesResponse: properties: - deprecationTime: - description: The time at which this processor version will be deprecated. - type: string - format: google-datetime - replacementProcessorVersion: - type: string - description: If set, the processor version that will be used as a replacement. - description: Information about the upcoming deprecation of this processor version. - GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata: + processorTypes: + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorType' + description: The list of processor types. + id: GoogleCloudDocumentaiV1FetchProcessorTypesResponse + description: Response message for the FetchProcessorTypes method. + type: object + GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode: + type: object + description: A detected barcode. + id: GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - id: GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata + barcode: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2Barcode' + description: Detailed barcode information of the DetectedBarcode. + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' + description: Layout for DetectedBarcode. + GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse: type: object - description: The long-running operation metadata for the EnableProcessor method. - GoogleCloudDocumentaiV1beta2DocumentShardInfo: + description: Response message for the DeployProcessorVersion method. + id: GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse + properties: {} + GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow: + description: A row of table cells. + id: GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow properties: - textOffset: - type: string - description: >- - The index of the first character in Document.text in the overall - document global text. - format: int64 - shardIndex: - description: The 0-based index of this shard. - format: int64 - type: string - shardCount: - description: Total number of shards. - format: int64 - 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. - id: GoogleCloudDocumentaiV1beta2DocumentShardInfo + cells: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell + description: Cells that make up this row. + type: array type: object - GoogleCloudDocumentaiV1beta3CommonOperationMetadata: - id: GoogleCloudDocumentaiV1beta3CommonOperationMetadata + GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus: + description: The status of each individual document in the export process. type: object + id: >- + GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus properties: - updateTime: - type: string - format: google-datetime - description: The last update time of the operation. - resource: - type: string - description: A related resource to this operation. - createTime: - format: google-datetime - description: The creation time of the operation. - type: string - state: - type: string - enumDescriptions: - - Unspecified state. - - Operation is still running. - - Operation is being cancelled. - - Operation succeeded. - - Operation failed. - - Operation is cancelled. - description: The state of the operation. - enum: - - STATE_UNSPECIFIED - - RUNNING - - CANCELLING - - SUCCEEDED - - FAILED - - CANCELLED - stateMessage: + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status of the exporting of the document. + outputGcsDestination: description: >- - A message providing more details about the current state of - processing. + The output_gcs_destination of the exported document if it was + successful, otherwise empty. type: string - description: The common metadata for long running operations. - GoogleTypeTimeZone: - id: GoogleTypeTimeZone + documentId: + description: The path to source docproto of the document. + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' + GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata: + properties: + commonMetadata: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + description: The basic metadata of the long-running operation. + id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata description: >- - Represents a time zone from the [IANA Time Zone - Database](https://www.iana.org/time-zones). + The long-running operation metadata for the SetDefaultProcessorVersion + method. type: object + GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId: + description: >- + Identifies a document uniquely within the scope of a dataset in the + user-managed Cloud Storage option. 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 - GoogleCloudDocumentaiV1beta1DocumentEntityRelation: - id: GoogleCloudDocumentaiV1beta1DocumentEntityRelation - properties: - objectId: - type: string - description: Object entity id. - subjectId: + cwDocId: + deprecated: true + description: Id of the document (indexed) managed by Content Warehouse. type: string - description: Subject entity id. - relation: + gcsUri: type: string - description: Relationship description. - description: Relationship between Entities. - type: object - GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse: + description: Required. The Cloud Storage URI where the actual document is stored. + id: GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId type: object - description: Response message for the UndeployProcessorVersion method. - properties: {} - id: GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse - GoogleCloudDocumentaiV1beta1DocumentTextChange: + GoogleCloudDocumentaiV1beta3DocumentId: + description: Document Identifier. + id: GoogleCloudDocumentaiV1beta3DocumentId type: object - description: This message is used for text changes aka. OCR corrections. - id: GoogleCloudDocumentaiV1beta1DocumentTextChange properties: - textAnchor: - 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/GoogleCloudDocumentaiV1beta1DocumentTextAnchor' - provenance: - description: The history of this annotation. + 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: + description: A document id within user-managed Cloud Storage. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId + GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector: + properties: + pages: items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenance - deprecated: true + format: int32 + type: integer type: array - changedText: - type: string - description: The text that replaces the text identified in the `text_anchor`. - GoogleCloudDocumentaiV1beta2GcsDestination: - id: GoogleCloudDocumentaiV1beta2GcsDestination - description: >- - The Google Cloud Storage location where the output file will be written - to. - properties: - uri: - type: string + description: Optional. Indices of the pages (starting from 1). + id: GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector type: object - GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect: - description: Image Quality Defects + description: A list of individual page numbers. + GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse: + properties: {} + id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse + type: object + description: The response proto of ResyncDataset method. + GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo: + id: GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo type: object properties: - type: - type: string + subscript: + type: boolean + description: Whether the text is a subscript. This feature is not supported yet. + smallcaps: + type: boolean 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: + Whether the text is in small caps. This feature is not supported + yet. + superscript: + type: boolean description: >- - Confidence of detected defect. Range `[0, 1]` where `1` indicates - strong confidence that the defect exists. - format: float + Whether the text is a superscript. This feature is not supported + yet. + letterSpacing: + description: Letter spacing in points. + format: double type: number - id: GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect - GoogleCloudDocumentaiV1beta1ProcessDocumentResponse: - description: Response to a single document processing request. - type: object - properties: - inputConfig: + handwritten: + type: boolean + description: Whether the text is handwritten. + underlined: + type: boolean + description: Whether the text is underlined. + fontType: + description: Name or style of the font. + type: string + fontWeight: + type: integer + format: int32 description: >- - Information about the input file. This is the same as the - corresponding input config in the request. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1InputConfig' - outputConfig: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1OutputConfig' + TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). + Normal is `400`, bold is `700`. + strikeout: + type: boolean description: >- - The output location of the parsed responses. The responses are - written to this location as JSON-serialized `Document` objects. - id: GoogleCloudDocumentaiV1beta1ProcessDocumentResponse - GoogleCloudDocumentaiV1beta2DocumentTextAnchor: - id: GoogleCloudDocumentaiV1beta2DocumentTextAnchor - properties: - textSegments: - description: The text segments from the Document.text. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment - type: array - content: + Whether the text is strikethrough. This feature is not supported + yet. + backgroundColor: + $ref: '#/components/schemas/GoogleTypeColor' + description: Color of the background. + fontSize: + type: integer + format: int32 + description: Font size in points (`1` point is `¹⁄₇₂` inches). + bold: + type: boolean 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. - type: object - GoogleCloudDocumentaiV1beta2DocumentPageToken: - description: A detected token. - type: object - properties: - detectedLanguages: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage - type: array - description: A list of detected languages together with confidence. - provenance: - description: The history of this annotation. - deprecated: true - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentProvenance' - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' - description: Layout for Token. - detectedBreak: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak - description: Detected break at the end of a Token. - styleInfo: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo - description: Text style attributes. - id: GoogleCloudDocumentaiV1beta2DocumentPageToken - GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus: - type: object - properties: - status: - $ref: '#/components/schemas/GoogleRpcStatus' + Whether the text is bold (equivalent to font_weight is at least + `700`). + textColor: + $ref: '#/components/schemas/GoogleTypeColor' + description: Color of the text. + italic: + type: boolean + description: Whether the text is italic. + pixelFontSize: description: >- - The status of resyncing the dataset with regards to the detected - inconsistency. Empty if ResyncDatasetRequest.validate_only is - `true`. - datasetInconsistencyType: + Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ + `72.0`. + format: double + type: number + description: Font and other text style attributes. + GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak: + properties: + type: + description: Detected break type. enum: - - DATASET_INCONSISTENCY_TYPE_UNSPECIFIED - - DATASET_INCONSISTENCY_TYPE_NO_STORAGE_MARKER + - TYPE_UNSPECIFIED + - SPACE + - WIDE_SPACE + - HYPHEN type: string - description: The type of the inconsistency of the dataset. enumDescriptions: - - Default value. - - The marker file under the dataset folder is not found. - description: Resync status against inconsistency types on the dataset level. - id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus - GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata: - id: GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata - description: The long-running operation metadata for the ReviewDocument method. - properties: - questionId: - type: string - description: The Crowd Compute question ID. - commonMetadata: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - description: The basic metadata of the long-running operation. - type: object - GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse: - type: object - description: The response message for the ImportProcessorVersion method. - properties: - processorVersion: - type: string - description: The destination processor version name. - id: GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse - GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect: - id: GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect + - Unspecified break type. + - A single whitespace. + - A wider whitespace. + - A hyphen that indicates that a token has been split across lines. + description: Detected break at the end of a Token. type: object - properties: - confidence: - type: number - format: float - description: >- - Confidence of detected defect. Range `[0, 1]` where `1` indicates - strong confidence that the defect exists. - 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` - description: Image Quality Defects - GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata: + id: GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak + GoogleCloudDocumentaiV1DocumentProvenanceParent: + id: GoogleCloudDocumentaiV1DocumentProvenanceParent 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. - id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata - type: object - GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsResponse: - description: Response of the batch update documents operation. - id: GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsResponse - properties: {} - type: object - GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores: - properties: - detectedDefects: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect - type: array - description: A list of detected defects. - qualityScore: - format: float - description: >- - The overall quality score. Range `[0, 1]` where `1` is perfect - quality. - type: number + The parent element the current element is based on. Used for + referencing/aligning, removal and replacement operations. type: object - id: GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores - description: Image quality scores for the page image. - GoogleCloudDocumentaiV1DocumentProvenanceParent: properties: - revision: - type: integer - description: The index of the index into current revision's parent_ids list. - format: int32 index: type: integer format: int32 @@ -3321,216 +2892,395 @@ components: The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + revision: + format: int32 + type: integer + description: The index of the index into current revision's parent_ids list. id: - deprecated: true type: integer format: int32 description: The id of the parent provenance. - type: object - description: >- - The parent element the current element is based on. Used for - referencing/aligning, removal and replacement operations. - id: GoogleCloudDocumentaiV1DocumentProvenanceParent - GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata: - id: GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata + deprecated: true + GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata: properties: commonMetadata: $ref: >- #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata description: The basic metadata of the long-running operation. + id: GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata + description: Metadata of the sample documents operation. type: object - GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata: - type: object - id: GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata - description: >- - The long-running operation metadata for the DeployProcessorVersion - method. - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty: - type: object - id: GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty - description: Defines properties that can be part of the entity type. + GoogleCloudDocumentaiV1DocumentPageMatrix: properties: - valueType: - type: string - description: >- - A reference to the value type of the property. This type is subject - to the same conventions as the `Entity.base_types` field. - name: + cols: + format: int32 + type: integer + description: Number of columns in the matrix. + type: + format: int32 + type: integer description: >- - The name of the property. Follows the same guidelines as the - EntityType name. - type: string - displayName: + 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: User defined name for the property. - 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. - description: >- - Occurrence type limits the number of instances an entity type - appears in the document. - type: string - enum: - - OCCURRENCE_TYPE_UNSPECIFIED - - OPTIONAL_ONCE - - OPTIONAL_MULTIPLE - - REQUIRED_ONCE - - REQUIRED_MULTIPLE - GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse: - id: GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse + description: The matrix data. + format: byte + rows: + format: int32 + description: Number of rows in the matrix. + type: integer + id: GoogleCloudDocumentaiV1DocumentPageMatrix + description: >- + Representation for transformation matrix, intended to be compatible and + used with OpenCV format for image manipulation. + type: object + GoogleCloudDocumentaiV1beta2InputConfig: type: object - description: The response for TrainProcessorVersion. properties: - processorVersion: + contents: + format: byte type: string - description: The resource name of the processor version produced by training. - GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus: + description: >- + Content in bytes, represented as a stream of bytes. Note: As with + all `bytes` fields, proto buffer messages use a pure binary + representation, whereas JSON representations use base64. This field + only works for synchronous ProcessDocument method. + gcsSource: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2GcsSource' + description: >- + The Google Cloud Storage location to read the input from. This must + be a single file. + mimeType: + type: string + description: >- + Required. Mimetype of the input. Current supported mimetypes are + application/pdf, image/tiff, and image/gif. In addition, + application/json type is supported for requests with + ProcessDocumentRequest.automl_params field set. The JSON file needs + to be in Document format. + description: The desired input location and metadata. + id: GoogleCloudDocumentaiV1beta2InputConfig + GoogleCloudDocumentaiV1beta3RevisionRef: properties: - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of the importing of the document. - inputGcsSource: - description: The source Cloud Storage URI of the document. + revisionCase: + enum: + - REVISION_CASE_UNSPECIFIED + - LATEST_HUMAN_REVIEW + - LATEST_TIMESTAMP + - BASE_OCR_REVISION + type: string + 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. + latestProcessorVersion: type: string - outputDocumentId: description: >- - The document id of imported document if it was successful, otherwise - empty. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3DocumentId' + 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: + description: Reads the revision given by the id. + type: string + id: GoogleCloudDocumentaiV1beta3RevisionRef + description: The revision reference specifies which revision on the document to read. type: object - id: >- - GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus - description: The status of each individual document in the import process. - GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata: - description: >- - The long-running operation metadata for the ImportProcessorVersion - method. - id: GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata + GoogleCloudDocumentaiV1ProcessRequest: properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The basic metadata for the long-running operation. + 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 + skipHumanReview: + type: boolean + description: >- + Whether human review should be skipped for this request. Default to + `false`. + rawDocument: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1RawDocument' + description: A raw document content (bytes). + 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: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessOptions' + description: Inference-time options for the process API + inlineDocument: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' + description: An inline document proto. + gcsDocument: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsDocument' + description: A raw document on Google Cloud Storage. + id: GoogleCloudDocumentaiV1ProcessRequest + description: Request message for the ProcessDocument method. type: object - GoogleCloudDocumentaiV1beta1DocumentStyleFontSize: + GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse: type: object - id: GoogleCloudDocumentaiV1beta1DocumentStyleFontSize - description: Font size with unit. + description: Response of the EvaluateProcessorVersion method. + id: GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse properties: - size: - type: number - format: float - description: Font size for the text. - unit: - description: >- - Unit for the font size. Follows CSS naming (such as `in`, `px`, and - `pt`). + evaluation: type: string - GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus: + description: The resource name of the created evaluation. + GoogleCloudDocumentaiV1ProcessResponse: + id: GoogleCloudDocumentaiV1ProcessResponse type: object - description: The status of a each individual document in the batch process. - id: GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus properties: humanReviewStatus: $ref: '#/components/schemas/GoogleCloudDocumentaiV1HumanReviewStatus' description: The status of human review on the processed document. - inputGcsSource: - type: string + document: description: >- - The source of the document, same as the input_gcs_source field in - the request when the batch process started. - outputGcsDestination: + The document payload, will populate fields based on the processor's + behavior. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' + description: Response message for the ProcessDocument method. + GoogleTypeMoney: + properties: + currencyCode: + type: string + description: The three-letter currency code defined in ISO 4217. + nanos: + type: integer + format: int32 description: >- - The Cloud Storage output destination (in the request as - DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed - document if it was successful, otherwise empty. + 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. + units: type: string - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status processing the document. - GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse: - description: The response for TrainProcessorVersion. + description: >- + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. + format: int64 type: object + description: Represents an amount of money with its currency type. + id: GoogleTypeMoney + GoogleCloudDocumentaiV1Barcode: + description: Encodes the detailed information of a barcode. + id: GoogleCloudDocumentaiV1Barcode properties: - processorVersion: + rawValue: type: string - description: The resource name of the processor version produced by training. - id: GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse - GoogleCloudDocumentaiV1TrainProcessorVersionResponse: - description: The response for TrainProcessorVersion. - properties: - processorVersion: + description: >- + Raw value encoded in the barcode. For example: + `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. + valueFormat: + 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 - description: The resource name of the processor version produced by training. - id: GoogleCloudDocumentaiV1TrainProcessorVersionResponse + 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. type: object - GoogleCloudDocumentaiV1ListProcessorsResponse: - id: GoogleCloudDocumentaiV1ListProcessorsResponse + GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse: properties: - nextPageToken: - type: string - description: Points to the next processor, otherwise empty. - processors: - description: The list of processors. + responses: items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta2ProcessDocumentResponse type: array - description: Response message for the ListProcessors method. - type: object - GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse: + description: Responses for each individual document. + id: GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse type: object - id: GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse - properties: {} description: >- - Response message for the DisableProcessor method. Intentionally empty - proto for adding fields in future. - GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata: - id: GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata + Response to an batch document processing request. This is returned in + the LRO Operation after the operation is complete. + GoogleCloudDocumentaiV1beta1DocumentEntity: + 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. + id: GoogleCloudDocumentaiV1beta1DocumentEntity + properties: + redacted: + description: >- + Optional. Whether the entity will be redacted for de-identification + purposes. + type: boolean + normalizedValue: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue + 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. + id: + description: >- + Optional. Canonical id. This will be a unique value in the entity + list for this document. + type: string + confidence: + type: number + description: Optional. Confidence of detected Schema entity. Range `[0, 1]`. + format: float + type: + description: Required. Entity type from a schema e.g. `Address`. + type: string + textAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentTextAnchor' + description: >- + Optional. Provenance of the entity. Text anchor indexing into the + Document.text. + mentionId: + description: Optional. Deprecated. Use `id` field instead. + type: string + 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/GoogleCloudDocumentaiV1beta1DocumentEntity' + pageAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageAnchor' + 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 + provenance: + description: Optional. The history of this annotation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenance' + 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/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: >- - The long-running operation metadata for the SetDefaultProcessorVersion - method. + id: GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata + type: object + GoogleCloudLocationLocation: + id: GoogleCloudLocationLocation type: object - GoogleCloudDocumentaiV1DocumentPageParagraph: properties: - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this annotation. - deprecated: true - detectedLanguages: + 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 + locationId: + type: string + description: 'The canonical id for this location. For example: `"us-east1"`.' + name: + type: string + description: >- + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + labels: + additionalProperties: + type: string + type: object + description: >- + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + displayName: + description: >- + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + type: string + description: A resource that represents a Google Cloud location. + GoogleCloudDocumentaiV1beta1DocumentRevision: + properties: + parentIds: type: array items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for Paragraph. - description: A collection of lines that a human would perceive as a paragraph. + 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. + processor: + description: >- + If the annotation was made by processor identify the processor by + its resource name. + type: string + parent: + 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. + type: array + deprecated: true + humanReview: + description: Human Review information of this revision. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview + agent: + description: >- + 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 + 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. + description: Contains past or forward revisions of this document. + id: GoogleCloudDocumentaiV1beta1DocumentRevision type: object - id: GoogleCloudDocumentaiV1DocumentPageParagraph - GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse: + GoogleCloudDocumentaiV1GcsDocuments: + properties: + documents: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsDocument' + type: array + description: The list of documents. + id: GoogleCloudDocumentaiV1GcsDocuments + description: Specifies a set of documents on Cloud Storage. type: object - properties: {} - id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse - description: Response message for the SetDefaultProcessorVersion method. GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus: properties: status: @@ -3539,88 +3289,201 @@ components: 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 type: object - GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData: - id: GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData + description: The status of each individual document in the batch update process. + GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions: + description: >- + Options to control the training of the Custom Document Extraction (CDE) + Processor. + id: >- + GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions type: object - description: The input data used to train a new ProcessorVersion. properties: - trainingDocuments: - description: The documents used for training the new version. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig - testDocuments: - description: The documents used for testing the trained version. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig - GoogleCloudDocumentaiV1beta2DocumentPageLayout: - id: GoogleCloudDocumentaiV1beta2DocumentPageLayout + trainingMethod: + enumDescriptions: + - '' + - '' + - '' + type: string + description: Training method to use for CDE training. + enum: + - TRAINING_METHOD_UNSPECIFIED + - MODEL_BASED + - TEMPLATE_BASED + GoogleCloudDocumentaiV1beta2DocumentPageAnchor: + properties: + pageRefs: + type: array + description: One or more references to visual page elements + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef + 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. type: object + id: GoogleCloudDocumentaiV1beta2DocumentPageAnchor + GoogleCloudDocumentaiV1beta3Dataset: properties: - boundingPoly: - description: The bounding polygon for the Layout. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2BoundingPoly' - orientation: - enum: - - ORIENTATION_UNSPECIFIED - - PAGE_UP - - PAGE_RIGHT - - PAGE_DOWN - - PAGE_LEFT - 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. - description: Detected orientation for the Layout. - confidence: + documentWarehouseConfig: + deprecated: true 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 - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentTextAnchor' - description: Text anchor indexing into the Document.text. - description: Visual element describing a layout unit on a page. - GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata: + Optional. Deprecated. Warehouse-based dataset configuration is not + supported. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig + 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: + $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. + state: + description: Required. State of the dataset. Ignored when updating dataset. + type: string + 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 + gcsManagedConfig: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig + description: >- + Optional. User-managed Cloud Storage dataset configuration. Use this + configuration if the dataset documents are stored under a + user-managed Cloud Storage location. + name: + type: string + description: >- + Dataset resource name. Format: + `projects/{project}/locations/{location}/processors/{processor}/dataset` + type: object + description: >- + A singleton resource under a Processor which configures a collection of + documents. + id: GoogleCloudDocumentaiV1beta3Dataset + GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig: + description: Configuration specific to the Cloud Storage-based implementation. + type: object + properties: + gcsPrefix: + description: >- + Required. The Cloud Storage URI (a directory) where the documents + belonging to the dataset must be stored. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3GcsPrefix' + id: GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig + GoogleCloudDocumentaiV1Document: + id: GoogleCloudDocumentaiV1Document + properties: + pages: + description: Visual page layout for the Document. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPage' + revisions: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentRevision' + type: array + description: Placeholder. Revision history of this document. + 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' + textStyles: + deprecated: true + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyle' + description: Styles for the Document.text. + type: array + 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. + textChanges: + 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 + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextChange' + error: + $ref: '#/components/schemas/GoogleRpcStatus' + description: Any error that occurred while processing this document. + 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. + mimeType: + description: >- + An IANA published [media type (MIME + type)](https://www.iana.org/assignments/media-types/media-types.xhtml). + type: string + entityRelations: + type: array + description: Placeholder. Relationship among Document.entities. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntityRelation' + 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). + text: + type: string + description: Optional. UTF-8 encoded text in reading order from 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 + GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata: properties: commonMetadata: $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata - description: The long-running operation metadata for UpdateLabelerPool. - type: object - GoogleCloudDocumentaiV1UndeployProcessorVersionResponse: - description: Response message for the UndeployProcessorVersion method. - properties: {} - id: GoogleCloudDocumentaiV1UndeployProcessorVersionResponse + description: >- + The long-running operation metadata for the SetDefaultProcessorVersion + method. type: object - GoogleProtobufEmpty: - id: GoogleProtobufEmpty + id: GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata + GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsResponse: 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); } + description: The response proto of AutoLabelDocuments method. properties: {} - GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview: + id: GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsResponse + GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview: + id: GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview description: Human Review information of the document. - id: GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview type: object properties: stateMessage: @@ -3632,3783 +3495,3930 @@ components: state: type: string description: Human review state. e.g. `requested`, `succeeded`, `rejected`. - GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak: - id: GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak - description: Detected break at the end of a Token. + 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 + properties: + x: + format: int32 + description: X coordinate. + type: integer + 'y': + type: integer + description: Y coordinate (starts from the top of the image). + format: int32 + id: GoogleCloudDocumentaiV1Vertex + GoogleCloudDocumentaiV1ProcessorType: properties: type: type: string - description: Detected break type. - enumDescriptions: - - Unspecified break type. - - A single whitespace. - - A wider whitespace. - - A hyphen that indicates that a token has been split across lines. - enum: - - TYPE_UNSPECIFIED - - SPACE - - WIDE_SPACE - - HYPHEN - GoogleCloudDocumentaiV1DeployProcessorVersionResponse: - properties: {} - id: GoogleCloudDocumentaiV1DeployProcessorVersionResponse - description: Response message for the DeployProcessorVersion method. - type: object - GoogleCloudDocumentaiV1beta1DocumentPageParagraph: - type: object - id: GoogleCloudDocumentaiV1beta1DocumentPageParagraph - properties: - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenance' - description: The history of this annotation. - deprecated: true - detectedLanguages: + description: 'The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.' + 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. + availableLocations: + description: The locations in which this processor is available. + type: array items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - type: array - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' - description: Layout for Paragraph. - description: A collection of lines that a human would perceive as a paragraph. - GoogleCloudDocumentaiV1beta2DocumentPageLine: - id: GoogleCloudDocumentaiV1beta2DocumentPageLine - properties: - layout: - description: Layout for Line. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' - provenance: - deprecated: true - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentProvenance' - description: The history of this annotation. - detectedLanguages: + #/components/schemas/GoogleCloudDocumentaiV1ProcessorTypeLocationInfo + sampleDocumentUris: type: array - description: A list of detected languages together with confidence. + description: A set of Cloud Storage URIs of sample documents for this processor. items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage - description: >- - A collection of tokens that a human would perceive as a line. Does not - cross column boundaries, can be horizontal, vertical, etc. - type: object - GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata: - id: GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. + type: string + category: + description: The processor category, used by UI to group processor types. + 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. + type: string + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + description: Launch stage of the processor type + name: + description: >- + The resource name of the processor type. Format: + `projects/{project}/processorTypes/{processor_type}` + type: string type: object - description: Metadata of the EvaluateProcessorVersion method. - GoogleCloudDocumentaiV1beta1OutputConfig: - id: GoogleCloudDocumentaiV1beta1OutputConfig + id: GoogleCloudDocumentaiV1ProcessorType + description: >- + A processor type is responsible for performing a certain document + understanding task on a certain type of document. + GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues: properties: - pagesPerShard: + values: + type: array + items: + type: string + description: The individual values that this enum values type can include. + id: GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues + type: object + description: Defines the a list of enum values. + GoogleCloudDocumentaiV1beta2DocumentPageImage: + id: GoogleCloudDocumentaiV1beta2DocumentPageImage + description: Rendered image contents for this page. + type: object + properties: + content: + format: byte + type: string + description: Raw byte content of the image. + mimeType: + type: string + description: >- + Encoding [media type (MIME + type)](https://www.iana.org/assignments/media-types/media-types.xhtml) + for the image. + height: + type: integer + description: Height of the image in pixels. format: int32 + width: + description: Width of the image in pixels. type: integer - description: >- - The max number of pages to include into each output Document shard - JSON on Google Cloud Storage. The valid range is [1, 100]. If not - specified, the default value is 20. For example, for one pdf file - with 100 pages, 100 parsed pages will be produced. If - `pages_per_shard` = 20, then 5 Document shard JSON files each - containing 20 parsed pages will be written under the prefix - OutputConfig.gcs_destination.uri and suffix pages-x-to-y.json where - x and y are 1-indexed page numbers. Example GCS outputs with 157 - pages and pages_per_shard = 50: pages-001-to-050.json - pages-051-to-100.json pages-101-to-150.json pages-151-to-157.json - gcsDestination: - description: The Google Cloud Storage location to write the output to. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1GcsDestination' - type: object - description: The desired output location and metadata. - GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata: - id: GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata + format: int32 + GoogleCloudDocumentaiV1beta3EnableProcessorMetadata: type: object - description: Metadata of the EvaluateProcessorVersion method. + 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. - GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions: + id: GoogleCloudDocumentaiV1beta3EnableProcessorMetadata + GoogleCloudDocumentaiV1ListProcessorTypesResponse: type: object - id: >- - GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions properties: - trainSteps: - 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. - format: int32 - type: integer - learningRateMultiplier: - format: float - 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. - type: number - description: Options to control foundation model tuning of the processor. - GoogleLongrunningOperation: - type: object - description: >- - This resource represents a long-running operation that is the result of - a network API call. - id: GoogleLongrunningOperation + nextPageToken: + type: string + description: Points to the next page, otherwise empty. + processorTypes: + description: The processor types. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorType' + description: Response message for the ListProcessorTypes method. + id: GoogleCloudDocumentaiV1ListProcessorTypesResponse + GoogleCloudDocumentaiV1ReviewDocumentRequest: 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: - 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 - 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}`. + priority: + description: The priority of the human review task. + 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. type: string - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - The error result of the operation in case of failure or - cancellation. - metadata: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. + enum: + - DEFAULT + - URGENT + enableSchemaValidation: + 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. - GoogleCloudDocumentaiV1DocumentSchemaEntityType: + Whether the validation should be performed on the ad-hoc review + request. + inlineDocument: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' + description: An inline document proto. + documentSchema: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' + description: The document schema of the human review task. type: object + description: Request message for the ReviewDocument method. + id: GoogleCloudDocumentaiV1ReviewDocumentRequest + GoogleCloudDocumentaiV1beta2DocumentPageBlock: 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. + A block has a set of lines (collected into paragraphs) that have a + common line-spacing and orientation. properties: - baseTypes: + detectedLanguages: type: array - description: >- - The entity type that this type is derived from. For now, one and - only one should be set. - items: - type: string - 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/GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues - properties: - description: Description the nested structure, or composition of an entity. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty - type: array - name: - type: string - 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 - 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. + #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage + description: A list of detected languages together with confidence. + provenance: + deprecated: true + description: The history of this annotation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentProvenance' + layout: + description: Layout for Block. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' + id: GoogleCloudDocumentaiV1beta2DocumentPageBlock + type: object + GoogleCloudDocumentaiV1UndeployProcessorVersionRequest: + type: object + properties: {} + id: GoogleCloudDocumentaiV1UndeployProcessorVersionRequest + description: Request message for the UndeployProcessorVersion method. + GoogleCloudDocumentaiV1beta2Barcode: + id: GoogleCloudDocumentaiV1beta2Barcode + type: object properties: - confidence: - description: Optional. Confidence of detected Schema entity. Range `[0, 1]`. - type: number - format: float - 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. - 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 - redacted: + valueFormat: description: >- - Optional. Whether the entity will be redacted for de-identification - purposes. - type: boolean - mentionId: - description: Optional. Deprecated. Use `id` field instead. + 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: - description: >- - Optional. Canonical id. This will be a unique value in the entity - list for this document. + rawValue: type: string - pageAnchor: description: >- - Optional. Represents the provenance of this entity wrt. the location - on the page where it was found. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchor' - type: - description: Required. Entity type from a schema e.g. `Address`. - type: string - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + Raw value encoded in the barcode. For example: + `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. + format: description: >- - Optional. Provenance of the entity. Text anchor indexing into the - Document.text. - provenance: - description: Optional. The history of this annotation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - mentionText: + 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 - description: Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. - id: GoogleCloudDocumentaiV1DocumentEntity - type: object - GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId: + description: Encodes the detailed information of a barcode. + GoogleCloudDocumentaiV1beta3BatchProcessMetadata: type: object - id: GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId - description: >- - Identifies a document uniquely within the scope of a dataset in the - user-managed Cloud Storage option. + id: GoogleCloudDocumentaiV1beta3BatchProcessMetadata + description: The long-running operation metadata for BatchProcessDocuments. properties: - cwDocId: - deprecated: true + individualProcessStatuses: + description: The list of response details of each document. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus + type: array + stateMessage: type: string - description: Id of the document (indexed) managed by Content Warehouse. - gcsUri: + description: >- + A message providing more details about the current state of + processing. For example, the error message if the operation is + failed. + updateTime: type: string - description: Required. The Cloud Storage URI where the actual document is stored. - GoogleTypeColor: - 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(''); }; // ... + description: The last update time of the operation. + 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. + - 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 + createTime: + description: The creation time of the operation. + type: string + format: google-datetime + GoogleCloudDocumentaiV1DocumentPageDetectedBarcode: 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). + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for DetectedBarcode. + barcode: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Barcode' + description: Detailed barcode information of the DetectedBarcode. + type: object + description: A detected barcode. + id: GoogleCloudDocumentaiV1DocumentPageDetectedBarcode + GoogleCloudDocumentaiV1beta1NormalizedVertex: + id: GoogleCloudDocumentaiV1beta1NormalizedVertex + type: object + properties: + 'y': format: float + description: Y coordinate (starts from the top of the image). type: number - red: - type: number - format: float - description: The amount of red in the color as a value in the interval [0, 1]. - green: - description: The amount of green in the color as a value in the interval [0, 1]. + x: + description: X coordinate. type: number format: float + 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. + GoogleCloudDocumentaiV1DocumentSchema: type: object - GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage: - description: Detected language for a structural component. properties: - 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 - confidence: - format: float - type: number - description: Confidence of detected language. Range `[0, 1]`. - type: object - id: GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage - GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation: - type: object - id: >- - GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation - description: >- - The dataset validation information. This includes any and all errors - with documents and the dataset. - properties: - 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. + metadata: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaMetadata' + description: Metadata of the schema. + displayName: + description: Display name to show to users. + type: string + entityTypes: items: - $ref: '#/components/schemas/GoogleRpcStatus' - type: array - documentErrors: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaEntityType 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. - items: - $ref: '#/components/schemas/GoogleRpcStatus' - documentErrorCount: - description: The total number of document errors. - format: int32 - type: integer - datasetErrorCount: - format: int32 - type: integer - description: The total number of dataset errors. - GoogleCloudDocumentaiV1beta1DocumentEntity: - 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: GoogleCloudDocumentaiV1beta1DocumentEntity - properties: - pageAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageAnchor' - description: >- - Optional. Represents the provenance of this entity wrt. the location - on the page where it was found. - id: + description: Entity types of the schema. + description: + description: Description of the schema. type: string - description: >- - Optional. Canonical id. This will be a unique value in the entity - list for this document. - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenance' - description: Optional. The history of this annotation. - type: + description: The schema defines the output of the processed document by a processor. + id: GoogleCloudDocumentaiV1DocumentSchema + GoogleCloudDocumentaiV1TrainProcessorVersionRequest: + properties: + processorVersion: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersion' + description: Required. The processor version to be created. + baseProcessorVersion: type: string - description: Required. Entity type from a schema e.g. `Address`. - redacted: - type: boolean description: >- - Optional. Whether the entity will be redacted for de-identification - purposes. - normalizedValue: + 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}`. + customDocumentExtractionOptions: + description: Options to control Custom Document Extraction (CDE) Processor. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions + foundationModelTuningOptions: + description: Options to control foundation model tuning of a processor. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions + documentSchema: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' + description: Optional. The schema the processor version will be trained with. + inputData: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData + description: Optional. The input data used to train the ProcessorVersion. + id: GoogleCloudDocumentaiV1TrainProcessorVersionRequest + description: Request message for the TrainProcessorVersion method. + type: object + GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse: + id: GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse + properties: {} + description: Response message for the UndeployProcessorVersion method. + type: object + GoogleCloudDocumentaiV1beta3DisableProcessorMetadata: + properties: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + type: object + description: The long-running operation metadata for the DisableProcessor method. + id: GoogleCloudDocumentaiV1beta3DisableProcessorMetadata + GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect: + description: Image Quality Defects + id: GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect + properties: + type: 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. - mentionText: + 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: Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. - 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/GoogleCloudDocumentaiV1beta1DocumentEntity' - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentTextAnchor' - description: >- - Optional. Provenance of the entity. Text anchor indexing into the - Document.text. confidence: format: float + description: >- + Confidence of detected defect. Range `[0, 1]` where `1` indicates + strong confidence that the defect exists. type: number - description: Optional. Confidence of detected Schema entity. Range `[0, 1]`. - mentionId: - type: string - description: Optional. Deprecated. Use `id` field instead. type: object - GoogleCloudDocumentaiV1beta1DocumentTextAnchor: + GoogleCloudDocumentaiV1ProcessorVersionAlias: 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. + processorVersion: type: string - textSegments: - type: array - description: The text segments from the Document.text. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment + description: The resource name of aliased processor version. + alias: + type: string + description: The alias in the form of `processor_version` resource name. + id: GoogleCloudDocumentaiV1ProcessorVersionAlias type: object - id: GoogleCloudDocumentaiV1beta1DocumentTextAnchor - description: Text reference indexing into the Document.text. - GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode: - description: A detected barcode. + description: Contains the alias and the aliased resource name of processor version. + GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata: type: object - id: GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode - properties: - layout: - description: Layout for DetectedBarcode. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' - barcode: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2Barcode' - description: Detailed barcode information of the DetectedBarcode. - GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata: + description: >- + The long-running operation metadata for the ImportProcessorVersion + method. + id: GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata properties: - totalDocumentCount: - format: int32 - description: Total number of documents deleting from dataset. - type: integer commonMetadata: - description: The basic metadata of the long-running operation. $ref: >- #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - errorDocumentCount: - description: Total number of documents that failed to be deleted in storage. - type: integer - format: int32 - individualBatchDeleteStatuses: - description: The list of response details of each document. + description: The basic metadata for the long-running operation. + GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse: + type: object + id: GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse + description: The response for TrainProcessorVersion. + properties: + processorVersion: + type: string + description: The resource name of the processor version produced by training. + GoogleCloudDocumentaiV1DocumentPageToken: + id: GoogleCloudDocumentaiV1DocumentPageToken + properties: + 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. + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: The history of this annotation. + deprecated: true + detectedLanguages: + description: A list of detected languages together with confidence. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage type: array - id: GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata type: object - GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata: + description: A detected token. + GoogleCloudDocumentaiV1beta2ProcessDocumentResponse: properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - type: object - description: >- - The long-running operation metadata for updating the human review - configuration. - id: GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata - GoogleCloudDocumentaiV1Evaluation: - id: GoogleCloudDocumentaiV1Evaluation + outputConfig: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2OutputConfig' + description: >- + The output location of the parsed responses. The responses are + written to this location as JSON-serialized `Document` objects. + inputConfig: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2InputConfig' + description: >- + Information about the input file. This is the same as the + corresponding input config in the request. type: object + id: GoogleCloudDocumentaiV1beta2ProcessDocumentResponse + description: Response to a single document processing request. + GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata: properties: - allEntitiesMetrics: - description: Metrics for all the entities in aggregate. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics - kmsKeyVersionName: - type: string - description: The KMS key version with which data is encrypted. - kmsKeyName: - description: The KMS key name used for encryption. + destDatasetType: + enumDescriptions: + - Default value if the enum is not set. + - Identifies the train documents. + - Identifies the test documents. + - Identifies the unassigned documents. type: string - entityMetrics: - type: object - description: Metrics across confidence levels, for different entities. - additionalProperties: + deprecated: true + description: The destination dataset split type. + enum: + - DATASET_SPLIT_TYPE_UNSPECIFIED + - DATASET_SPLIT_TRAIN + - DATASET_SPLIT_TEST + - DATASET_SPLIT_UNASSIGNED + individualBatchMoveStatuses: + type: array + description: The list of response details of each document. + items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics - name: - description: >- - The resource name of the evaluation. Format: - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}` - type: string - createTime: - format: google-datetime + #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus + destSplitType: + enum: + - DATASET_SPLIT_TYPE_UNSPECIFIED + - DATASET_SPLIT_TRAIN + - DATASET_SPLIT_TEST + - DATASET_SPLIT_UNASSIGNED type: string - description: The time that the evaluation was created. - documentCounters: - description: Counters for the documents used in the evaluation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationCounters' - description: An evaluation of a ProcessorVersion's performance. - GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus: - description: Resync status for each document per inconsistency type. + description: The destination dataset split type. + enumDescriptions: + - Default value if the enum is not set. + - Identifies the train documents. + - Identifies the test documents. + - Identifies the unassigned documents. + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata type: object + id: GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata + GoogleCloudDocumentaiV1beta2OperationMetadata: + id: GoogleCloudDocumentaiV1beta2OperationMetadata properties: - documentId: - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' - description: The document identifier. - documentInconsistencyType: - description: The type of document inconsistency. - enumDescriptions: - - Default value. - - The document proto is invalid. - - Indexed docproto metadata is mismatched. - - The page image or thumbnails are missing. - enum: - - DOCUMENT_INCONSISTENCY_TYPE_UNSPECIFIED - - DOCUMENT_INCONSISTENCY_TYPE_INVALID_DOCPROTO - - DOCUMENT_INCONSISTENCY_TYPE_MISMATCHED_METADATA - - DOCUMENT_INCONSISTENCY_TYPE_NO_PAGE_IMAGE + updateTime: type: string - status: + description: The last update time of the operation. + format: google-datetime + stateMessage: 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 - GoogleCloudDocumentaiUiv1beta3RevisionRef: - properties: - revisionCase: - description: Reads the revision by the predefined case. + A message providing more details about the current state of + processing. type: string + state: 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. - enum: - - REVISION_CASE_UNSPECIFIED - - LATEST_HUMAN_REVIEW - - LATEST_TIMESTAMP - - BASE_OCR_REVISION - latestProcessorVersion: + - The default value. This value is used if the state is omitted. + - Request is received. + - Request operation is waiting for scheduling. + - Request is being processed. + - The batch processing completed successfully. + - The batch processing was cancelled. + - The batch processing has failed. + description: The state of the current batch processing. 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: - description: Reads the revision given by the id. + enum: + - STATE_UNSPECIFIED + - ACCEPTED + - WAITING + - RUNNING + - SUCCEEDED + - CANCELLED + - FAILED + createTime: type: string - description: The revision reference specifies which revision on the document to read. + format: google-datetime + description: The creation time of the operation. type: object - id: GoogleCloudDocumentaiUiv1beta3RevisionRef - GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect: + description: Contains metadata for the BatchProcessDocuments operation. + GoogleCloudDocumentaiV1beta2DocumentPageSymbol: type: object - description: Image Quality Defects + description: A detected symbol. properties: - type: + detectedLanguages: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage + description: A list of detected languages together with confidence. + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' + description: Layout for Symbol. + id: GoogleCloudDocumentaiV1beta2DocumentPageSymbol + GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus: + properties: + inputGcsSource: 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` + The source of the document, same as the input_gcs_source field in + the request when the batch process started. type: string - confidence: + humanReviewOperation: description: >- - Confidence of detected defect. Range `[0, 1]` where `1` indicates - strong confidence that the defect exists. - type: number - format: float - id: GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect - GoogleCloudDocumentaiV1HumanReviewStatus: - properties: - state: + 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 - 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 - description: The state of human review on the processing request. - humanReviewOperation: + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status processing the document. + humanReviewStatus: + description: The status of human review on the processed document. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3HumanReviewStatus' + outputGcsDestination: 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. + 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 - stateMessage: - description: A message providing more details about the human review state. + id: GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus + description: The status of a each individual document in the batch process. + type: object + GoogleCloudDocumentaiV1TrainProcessorVersionResponse: + properties: + processorVersion: type: string - description: The status of human review on a processed document. - id: GoogleCloudDocumentaiV1HumanReviewStatus + description: The resource name of the processor version produced by training. + description: The response for TrainProcessorVersion. type: object - GoogleCloudDocumentaiV1beta2DocumentPage: + id: GoogleCloudDocumentaiV1TrainProcessorVersionResponse + GoogleCloudDocumentaiV1beta2DocumentPageLine: + id: GoogleCloudDocumentaiV1beta2DocumentPageLine + description: >- + A collection of tokens that a human would perceive as a line. Does not + cross column boundaries, can be horizontal, vertical, etc. type: object - id: GoogleCloudDocumentaiV1beta2DocumentPage - description: A page in a Document. properties: - dimension: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDimension - description: Physical dimension of the page. - image: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageImage' - 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. - tables: - description: A list of visually detected tables on the page. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageTable' - lines: - 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. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLine' - transforms: - description: >- - Transformation matrices that were applied to the original document - image to produce Page.image. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageMatrix - type: array - formFields: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageFormField - description: A list of visually detected form fields on the page. - type: array - symbols: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageSymbol - type: array - description: A list of visually detected symbols on the page. - paragraphs: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageParagraph - description: >- - A list of visually detected text paragraphs on the page. A - collection of lines that a human would perceive as a paragraph. - blocks: - 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. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageBlock' + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' + description: Layout for Line. provenance: - description: The history of this page. + description: The history of this annotation. deprecated: true $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentProvenance' - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' - description: Layout for the page. detectedLanguages: + type: array items: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage description: A list of detected languages together with confidence. - type: array - 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. - type: integer - format: int32 - visualElements: - type: array - description: >- - A list of detected non-text visual elements e.g. checkbox, signature - etc. on the page. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageVisualElement - detectedBarcodes: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode - type: array - description: A list of detected barcodes. - tokens: - type: array - description: A list of visually detected tokens on the page. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageToken' - imageQualityScores: - description: Image quality scores. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores - GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata: - description: The long-running operation metadata for the CreateLabelerPool method. - id: GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata + GoogleCloudDocumentaiV1beta2DocumentPageDimension: + id: GoogleCloudDocumentaiV1beta2DocumentPageDimension properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. + height: + format: float + description: Page height. + type: number + width: + description: Page width. + format: float + type: number + unit: + description: Dimension unit. + type: string + description: Dimension for the page. type: object - GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata: + GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData: type: object - description: The metadata proto of `ResyncDataset` method. + description: The input data used to train a new ProcessorVersion. + id: GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData properties: - datasetResyncStatuses: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus - description: >- - The list of dataset resync statuses. Not checked when - ResyncDatasetRequest.dataset_documents is specified. - commonMetadata: + testDocuments: $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - individualDocumentResyncStatuses: - type: array - description: >- - The list of document resync statuses. The same document could have - multiple `individual_document_resync_statuses` if it has multiple - inconsistencies. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus - id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata - GoogleCloudDocumentaiV1DocumentOutputConfig: - description: >- - Config that controls the output of documents. All documents will be - written as a JSON file. - properties: - gcsOutputConfig: + #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig + description: The documents used for testing the trained version. + trainingDocuments: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig - description: Output config to write the results to Cloud Storage. - type: object - id: GoogleCloudDocumentaiV1DocumentOutputConfig - GoogleCloudDocumentaiV1EnableProcessorResponse: - properties: {} - type: object - description: >- - Response message for the EnableProcessor method. Intentionally empty - proto for adding fields in future. - id: GoogleCloudDocumentaiV1EnableProcessorResponse - GoogleCloudDocumentaiV1beta1DocumentPageMatrix: + #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig + description: The documents used for training the new version. + GoogleCloudDocumentaiV1Processor: + id: GoogleCloudDocumentaiV1Processor type: object - id: GoogleCloudDocumentaiV1beta1DocumentPageMatrix - description: >- - Representation for transformation matrix, intended to be compatible and - used with OpenCV format for image manipulation. properties: - cols: - description: Number of columns in the matrix. - type: integer - format: int32 - rows: - type: integer - description: Number of rows in the matrix. - format: int32 - data: + displayName: + description: The display name of the processor. + type: string + defaultProcessorVersion: + description: The default processor version. type: string - format: byte - description: The matrix data. type: + type: string 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 - GoogleCloudDocumentaiV1DocumentSchemaMetadata: - description: Metadata for global schema behavior. - id: GoogleCloudDocumentaiV1DocumentSchemaMetadata - 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: - 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). - documentAllowMultipleLabels: + The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. + To get a list of processor types, see FetchProcessorTypes. + name: + readOnly: true + type: string description: >- - If true, on a given page, there can be multiple `document` - annotations covering it. - type: boolean - type: object - GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig: - properties: - gcsPrefix: + Output only. Immutable. The resource name of the processor. Format: + `projects/{project}/locations/{location}/processors/{processor}` + createTime: + format: google-datetime + type: string + description: The time the processor was created. + kmsKeyName: + type: string description: >- - Required. The Cloud Storage URI (a directory) where the documents - belonging to the dataset must be stored. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3GcsPrefix' - description: Configuration specific to the Cloud Storage-based implementation. - type: object - id: GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig - GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata: - description: >- - The long-running operation metadata for the DeployProcessorVersion - method. - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - type: object - id: GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata - GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse: - type: object - description: Response of the import document operation. - properties: {} - id: GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse - GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata: - id: GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - importConfigValidationResults: - description: Validation statuses of the batch documents import config. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult - type: array - totalDocumentCount: - description: Total number of the documents that are qualified for importing. - type: integer - format: int32 - individualImportStatuses: - description: The list of response details of each document. + The [KMS key](https://cloud.google.com/security-key-management) used + for encryption and decryption in CMEK scenarios. + processorVersionAliases: + description: Output only. The processor version aliases. + readOnly: true type: array items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus - type: object - description: Metadata of the import document operation. - GoogleCloudDocumentaiV1TrainProcessorVersionRequest: - type: object - properties: - processorVersion: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersion' - description: Required. The processor version to be created. - foundationModelTuningOptions: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions - description: Options to control foundation model tuning of a processor. - baseProcessorVersion: - type: string - 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}`. - customDocumentExtractionOptions: - description: Options to control Custom Document Extraction (CDE) Processor. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions - documentSchema: - description: Optional. The schema the processor version will be trained with. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' - inputData: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData - description: Optional. The input data used to train the ProcessorVersion. - description: Request message for the TrainProcessorVersion method. - id: GoogleCloudDocumentaiV1TrainProcessorVersionRequest - GoogleCloudDocumentaiV1beta3Dataset: - id: GoogleCloudDocumentaiV1beta3Dataset - properties: - documentWarehouseConfig: - deprecated: true - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig - description: >- - Optional. Deprecated. Warehouse-based dataset configuration is not - supported. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionAlias' state: - description: Required. State of the dataset. Ignored when updating dataset. - 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. + readOnly: true enum: - STATE_UNSPECIFIED - - UNINITIALIZED - - INITIALIZING - - INITIALIZED - enumDescriptions: - - Default unspecified enum, should not be used. - - Dataset has not been initialized. - - Dataset is being initialized. - - Dataset has been initialized. - name: - description: >- - Dataset resource name. Format: - `projects/{project}/locations/{location}/processors/{processor}/dataset` + - ENABLED + - DISABLED + - ENABLING + - DISABLING + - CREATING + - FAILED + - DELETING 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 - unmanagedDatasetConfig: - description: >- - Optional. Unmanaged dataset configuration. Use this configuration if - the dataset documents are managed by the document service internally - (not user-managed). - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig - gcsManagedConfig: + processEndpoint: 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 - type: object + Output only. Immutable. The http endpoint that can be called to + invoke processing. + type: string + readOnly: true description: >- - A singleton resource under a Processor which configures a collection of - documents. - GoogleCloudDocumentaiV1DocumentEntityNormalizedValue: + The first-class citizen for Document AI. Each processor defines how to + extract structural information from a document. + GoogleCloudDocumentaiV1DisableProcessorRequest: + properties: {} type: object - id: GoogleCloudDocumentaiV1DocumentEntityNormalizedValue - description: Parsed and normalized entity value. + id: GoogleCloudDocumentaiV1DisableProcessorRequest + description: Request message for the DisableProcessor method. + GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse: + properties: {} + type: object + id: GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse + description: Response message for the SetDefaultProcessorVersion method. + GoogleCloudDocumentaiV1beta3ImportDocumentsResponse: + type: object + id: GoogleCloudDocumentaiV1beta3ImportDocumentsResponse + properties: {} + description: Response of the import document operation. + GoogleCloudDocumentaiV1DeleteProcessorMetadata: + type: object + id: GoogleCloudDocumentaiV1DeleteProcessorMetadata + description: The long-running operation metadata for the DeleteProcessor method. properties: - addressValue: - $ref: '#/components/schemas/GoogleTypePostalAddress' - description: >- - Postal address. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto - 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 - integerValue: - format: int32 - description: Integer value. - type: integer - floatValue: - type: number - format: float - description: Float value. - text: - 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: - description: >- - Boolean value. Can be used for entities with binary values, or for - checkboxes. - type: boolean - 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' - moneyValue: - description: >- - Money value. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/money.proto - $ref: '#/components/schemas/GoogleTypeMoney' - GoogleCloudDocumentaiV1DocumentPageTableTableCell: - description: A cell representation inside the table. + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell: type: object + id: GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell properties: - rowSpan: - description: How many rows this cell spans. - format: int32 - type: integer detectedLanguages: description: A list of detected languages together with confidence. type: array items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage colSpan: type: integer - format: int32 description: How many columns this cell spans. + format: int32 layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' description: Layout for TableCell. - id: GoogleCloudDocumentaiV1DocumentPageTableTableCell - GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata: - description: The long-running operation metadata for the ReviewDocument method. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' + rowSpan: + format: int32 + description: How many rows this cell spans. + type: integer + description: A cell representation inside the table. + 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). + GoogleCloudDocumentaiV1beta2DocumentShardInfo: + id: GoogleCloudDocumentaiV1beta2DocumentShardInfo type: object properties: - questionId: + shardIndex: + description: The 0-based index of this shard. + format: int64 type: string - description: The Crowd Compute question ID. - state: - enumDescriptions: - - Unspecified state. - - Operation is still running. - - Operation is being cancelled. - - Operation succeeded. - - Operation failed. - - Operation is cancelled. + shardCount: type: string - enum: - - STATE_UNSPECIFIED - - RUNNING - - CANCELLING - - SUCCEEDED - - FAILED - - CANCELLED - description: Used only when Operation.done is false. - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - createTime: - description: The creation time of the operation. - type: string - format: google-datetime - stateMessage: + format: int64 + description: Total number of shards. + textOffset: type: string description: >- - A message providing more details about the current state of - processing. For example, the error message if the operation is - failed. - updateTime: - format: google-datetime - description: The last update time of the operation. + The index of the first character in Document.text in the overall + document global text. + 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. + GoogleCloudDocumentaiV1DocumentPageDimension: + type: object + properties: + width: + format: float + description: Page width. + type: number + height: + format: float + type: number + description: Page height. + unit: type: string - id: GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata - GoogleCloudDocumentaiV1beta2DocumentStyle: - id: GoogleCloudDocumentaiV1beta2DocumentStyle + description: Dimension unit. + id: GoogleCloudDocumentaiV1DocumentPageDimension + description: Dimension for the page. + GoogleCloudDocumentaiV1DocumentEntity: type: object + id: GoogleCloudDocumentaiV1DocumentEntity description: >- - Annotation for common text style attributes. This adheres to CSS - conventions as much as possible. + 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: - fontSize: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentStyleFontSize - description: Font size. - fontWeight: + redacted: + type: boolean description: >- - [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). - Possible values are `normal`, `bold`, `bolder`, and `lighter`. - type: string - backgroundColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Text background color. - textStyle: + 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 + normalizedValue: description: >- - [Text - style](https://www.w3schools.com/cssref/pr_font_font-style.asp). - Possible values are `normal`, `italic`, and `oblique`. - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentTextAnchor' - description: Text anchor indexing into the Document.text. - textDecoration: + 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 + mentionId: type: string + description: Optional. Deprecated. Use `id` field instead. + pageAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchor' description: >- - [Text - decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). - Follows CSS standard. - fontFamily: + Optional. Represents the provenance of this entity wrt. the location + on the page where it was found. + id: description: >- - Font family such as `Arial`, `Times New Roman`. - https://www.w3schools.com/cssref/pr_font_font-family.asp + Optional. Canonical id. This will be a unique value in the entity + list for this document. type: string - color: - $ref: '#/components/schemas/GoogleTypeColor' - description: Text color. - GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse: - properties: {} - description: Response of the delete documents operation. - id: GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse - type: object - GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue: - type: object - properties: - 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' - 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 - moneyValue: - $ref: '#/components/schemas/GoogleTypeMoney' + textAnchor: description: >- - Money value. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/money.proto - text: + Optional. Provenance of the entity. Text anchor indexing into the + Document.text. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + type: + description: Required. Entity type from a schema e.g. `Address`. type: string + properties: 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. - integerValue: - description: Integer value. - format: int32 - type: integer - floatValue: - description: Float value. + Optional. Entities can be nested to form a hierarchical data + structure representing the content in the document. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' + type: array + provenance: + description: Optional. The history of this annotation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + confidence: format: float + description: Optional. Confidence of detected Schema entity. Range `[0, 1]`. type: number - addressValue: - $ref: '#/components/schemas/GoogleTypePostalAddress' + GoogleCloudDocumentaiV1beta1DocumentStyleFontSize: + properties: + size: + format: float + type: number + description: Font size for the text. + unit: description: >- - Postal address. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto - description: Parsed and normalized entity value. - id: GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue - GoogleCloudDocumentaiV1beta2DocumentProvenanceParent: + Unit for the font size. Follows CSS naming (such as `in`, `px`, and + `pt`). + type: string + description: Font size with unit. + type: object + id: GoogleCloudDocumentaiV1beta1DocumentStyleFontSize + GoogleCloudDocumentaiV1beta2DocumentEntityRelation: + type: object + properties: + relation: + description: Relationship description. + type: string + subjectId: + type: string + description: Subject entity id. + objectId: + type: string + description: Object entity id. + id: GoogleCloudDocumentaiV1beta2DocumentEntityRelation + description: Relationship between Entities. + GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse: + id: GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse + properties: {} type: object - id: GoogleCloudDocumentaiV1beta2DocumentProvenanceParent description: >- - The parent element the current element is based on. Used for - referencing/aligning, removal and replacement operations. + Response message for the DisableProcessor method. Intentionally empty + proto for adding fields in future. + GoogleCloudDocumentaiV1EvaluationCounters: + type: object + description: Evaluation counters for the documents that were used. + id: GoogleCloudDocumentaiV1EvaluationCounters properties: - revision: - description: The index of the index into current revision's parent_ids list. + invalidDocumentsCount: type: integer format: int32 - id: - deprecated: true - description: The id of the parent provenance. + description: >- + How many documents were not included in the evaluation as they + didn't pass validation. + failedDocumentsCount: type: integer format: int32 - index: description: >- - The index of the parent item in the corresponding item list (eg. - list of entities, properties within entities, etc.) in the parent - revision. + How many documents were not included in the evaluation as Document + AI failed to process them. + inputDocumentsCount: format: int32 + description: How many documents were sent for evaluation. type: integer - GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata: - description: The long-running operation metadata for the DisableProcessor method. + evaluatedDocumentsCount: + format: int32 + description: How many documents were used in the evaluation. + type: integer + GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig: type: object - id: GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - GoogleCloudDocumentaiV1DocumentPageMatrix: - id: GoogleCloudDocumentaiV1DocumentPageMatrix - description: >- - Representation for transformation matrix, intended to be compatible and - used with OpenCV format for image manipulation. + id: GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig + properties: {} + description: Configuration specific to an unmanaged dataset. + GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores: + description: Image quality scores for the page image. type: object properties: - type: - format: int32 - 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 + detectedDefects: + type: array + description: A list of detected defects. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect + qualityScore: + format: float + description: >- + The overall quality score. Range `[0, 1]` where `1` is perfect + quality. + type: number + id: GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores + GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig: + description: Configuration specific to spanner-based indexing. + type: object + id: GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig + properties: {} + GoogleCloudDocumentaiV1beta2DocumentTextChange: + description: This message is used for text changes aka. OCR corrections. + id: GoogleCloudDocumentaiV1beta2DocumentTextChange + type: object + properties: + changedText: + type: string + description: The text that replaces the text identified in the `text_anchor`. + provenance: + description: The history of this annotation. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentProvenance + type: array + deprecated: true + textAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentTextAnchor' + 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. + GoogleCloudDocumentaiV1ListProcessorsResponse: + description: Response message for the ListProcessors method. + type: object + id: GoogleCloudDocumentaiV1ListProcessorsResponse + properties: + nextPageToken: + type: string + description: Points to the next processor, otherwise empty. + processors: + type: array + description: The list of processors. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' + GoogleCloudDocumentaiV1UndeployProcessorVersionResponse: + id: GoogleCloudDocumentaiV1UndeployProcessorVersionResponse + properties: {} + type: object + description: Response message for the UndeployProcessorVersion method. + GoogleCloudDocumentaiV1beta1DocumentProvenanceParent: + type: object + properties: + revision: + description: The index of the index into current revision's parent_ids list. + type: integer + format: int32 + id: + deprecated: true + type: integer + description: The id of the parent provenance. + format: int32 + index: 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. + format: int32 + id: GoogleCloudDocumentaiV1beta1DocumentProvenanceParent + description: >- + The parent element the current element is based on. Used for + referencing/aligning, removal and replacement operations. + GoogleCloudDocumentaiV1beta2DocumentPageMatrix: + type: object + properties: cols: + format: int32 description: Number of columns in the matrix. type: integer - format: int32 data: + format: byte type: string description: The matrix data. - format: byte - rows: - description: Number of rows in the matrix. + type: format: int32 type: integer - GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus: - description: The status of individual documents in the auto-labeling process. - properties: - documentId: - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' description: >- - The document id of the auto-labeled document. This will replace the - gcs_uri. - status: - description: The status of the document auto-labeling. - $ref: '#/components/schemas/GoogleRpcStatus' - type: object - id: >- - GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus - GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig: - type: object - id: GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig - properties: - pagesOverlap: - description: The number of overlapping pages between consecutive shards. - type: integer - format: int32 - pagesPerShard: + 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: format: int32 type: integer - description: The number of pages per shard. - description: The sharding config for the output document. - GoogleCloudDocumentaiV1DocumentPage: + description: Number of rows in the matrix. + description: >- + Representation for transformation matrix, intended to be compatible and + used with OpenCV format for image manipulation. + id: GoogleCloudDocumentaiV1beta2DocumentPageMatrix + GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata: properties: - paragraphs: + totalDocumentCount: + type: integer + format: int32 + description: Total number of the documents that are qualified for importing. + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + individualImportStatuses: + description: The list of response details of each document. 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. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageParagraph' - image: - 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' - detectedBarcodes: items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedBarcode - description: A list of detected barcodes. - type: array - tables: - description: A list of visually detected tables on the page. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageTable' - blocks: - 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. + #/components/schemas/GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus + importConfigValidationResults: type: array items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageBlock' - pageNumber: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult + description: Validation statuses of the batch documents import config. + type: object + description: Metadata of the import document operation. + id: GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata + GoogleCloudDocumentaiV1beta1DocumentProvenance: + id: GoogleCloudDocumentaiV1beta1DocumentProvenance + description: >- + Structure to identify provenance relationships between annotations in + different revisions. + properties: + revision: type: integer + deprecated: true + description: The index of the revision that produced this element. + format: int32 + id: format: int32 + deprecated: true description: >- - 1-based index for current Page in a parent Document. Useful when a - page is taken out of a Document for individual processing. - visualElements: + 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. + type: string + 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 + parents: type: array + description: References to the original elements that are replaced. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageVisualElement - description: >- - A list of detected non-text visual elements e.g. checkbox, signature - etc. on the page. + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenanceParent + type: object + GoogleCloudDocumentaiV1beta2DocumentPageToken: + type: object + properties: detectedLanguages: items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - type: array - lines: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLine' - description: >- - A list of visually detected text lines on the page. A collection of - tokens that a human would perceive as a line. + #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage type: array - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for the page. - tokens: + description: A list of detected languages together with confidence. + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentProvenance' + deprecated: true + description: The history of this annotation. + layout: + description: Layout for Token. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' + styleInfo: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo + description: Text style attributes. + detectedBreak: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak + description: Detected break at the end of a Token. + id: GoogleCloudDocumentaiV1beta2DocumentPageToken + description: A detected token. + GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata: + properties: + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + type: object + description: >- + The long-running operation metadata for the DeployProcessorVersion + method. + id: GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata + GoogleCloudDocumentaiV1beta2BoundingPoly: + type: object + properties: + vertices: items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageToken' - description: A list of visually detected tokens on the page. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2Vertex' + description: The bounding polygon vertices. type: array - imageQualityScores: - description: Image quality scores. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScores - transforms: + normalizedVertices: + description: The bounding polygon normalized vertices. type: array items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageMatrix' + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2NormalizedVertex' + id: GoogleCloudDocumentaiV1beta2BoundingPoly + description: A bounding polygon for the detected image annotation. + GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus: + properties: + documentId: + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' description: >- - Transformation matrices that were applied to the original document - image to produce Page.image. - dimension: - description: Physical dimension of the page. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageDimension' - symbols: - description: A list of visually detected symbols on the page. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageSymbol' - provenance: - description: The history of this page. - deprecated: true - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - formFields: - description: A list of visually detected form fields on the page. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageFormField' - type: array + The document id of the auto-labeled document. This will replace the + gcs_uri. + status: + description: The status of the document auto-labeling. + $ref: '#/components/schemas/GoogleRpcStatus' + id: >- + GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus type: object - description: A page in a Document. - id: GoogleCloudDocumentaiV1DocumentPage - GoogleCloudDocumentaiV1beta1DocumentPageAnchor: + description: The status of individual documents in the auto-labeling process. + GoogleCloudDocumentaiV1EnableProcessorRequest: + properties: {} + type: object + description: Request message for the EnableProcessor method. + id: GoogleCloudDocumentaiV1EnableProcessorRequest + GoogleCloudDocumentaiV1beta1OutputConfig: properties: - pageRefs: - description: One or more references to visual page elements - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef + pagesPerShard: + format: int32 + type: integer + description: >- + The max number of pages to include into each output Document shard + JSON on Google Cloud Storage. The valid range is [1, 100]. If not + specified, the default value is 20. For example, for one pdf file + with 100 pages, 100 parsed pages will be produced. If + `pages_per_shard` = 20, then 5 Document shard JSON files each + containing 20 parsed pages will be written under the prefix + OutputConfig.gcs_destination.uri and suffix pages-x-to-y.json where + x and y are 1-indexed page numbers. Example GCS outputs with 157 + pages and pages_per_shard = 50: pages-001-to-050.json + pages-051-to-100.json pages-101-to-150.json pages-151-to-157.json + gcsDestination: + description: The Google Cloud Storage location to write the output to. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1GcsDestination' + type: object + id: GoogleCloudDocumentaiV1beta1OutputConfig + description: The desired output location and metadata. + GoogleCloudDocumentaiV1beta1DocumentPageLayout: + description: Visual element describing a layout unit on a page. + properties: + textAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentTextAnchor' + description: Text anchor indexing into the Document.text. + confidence: + format: float + 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]`. + type: number + orientation: + description: Detected orientation for the Layout. + 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 + enum: + - ORIENTATION_UNSPECIFIED + - PAGE_UP + - PAGE_RIGHT + - PAGE_DOWN + - PAGE_LEFT + boundingPoly: + description: The bounding polygon for the Layout. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1BoundingPoly' + type: object + id: GoogleCloudDocumentaiV1beta1DocumentPageLayout + GoogleCloudDocumentaiV1DocumentPageAnchor: + id: GoogleCloudDocumentaiV1DocumentPageAnchor type: object - id: GoogleCloudDocumentaiV1beta1DocumentPageAnchor 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. - GoogleCloudDocumentaiV1beta2Vertex: + properties: + pageRefs: + description: One or more references to visual page elements + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchorPageRef + type: array + GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadata: type: object - id: GoogleCloudDocumentaiV1beta2Vertex - description: >- - A vertex represents a 2D point in the image. NOTE: the vertex - coordinates are in the same scale as the original image. properties: - 'y': - description: Y coordinate (starts from the top of the image). + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + individualBatchUpdateStatuses: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus + description: The list of response details of each document. + type: array + id: GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadata + GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell: + description: A cell representation inside the table. + properties: + detectedLanguages: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage + type: array + description: A list of detected languages together with confidence. + rowSpan: format: int32 type: integer - x: - type: integer - description: X coordinate. + description: How many rows this cell spans. + colSpan: format: int32 - GoogleCloudDocumentaiV1Processor: - id: GoogleCloudDocumentaiV1Processor + description: How many columns this cell spans. + type: integer + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' + description: Layout for TableCell. type: object + id: GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell + GoogleCloudDocumentaiV1ProcessorVersion: + 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. properties: - processEndpoint: - type: string - description: >- - Output only. Immutable. The http endpoint that can be called to - invoke processing. - readOnly: true - defaultProcessorVersion: - description: The default processor version. + documentSchema: + description: The schema of the processor version. Describes the output. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' + kmsKeyName: type: string + description: The KMS key name used for encryption. displayName: - description: The display name of the processor. type: string + description: The display name of the processor version. 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. - description: Output only. The state of the processor. type: string - readOnly: true enum: - STATE_UNSPECIFIED - - ENABLED - - DISABLED - - ENABLING - - DISABLING + - DEPLOYED + - DEPLOYING + - UNDEPLOYED + - UNDEPLOYING - CREATING - - FAILED - DELETING - createTime: - description: The time the processor was created. - format: google-datetime + - FAILED + - IMPORTING + 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. + description: Output only. The state of the processor version. + readOnly: true + kmsKeyVersionName: type: string - name: + description: The KMS key version with which data is encrypted. + googleManaged: description: >- - Output only. Immutable. The resource name of the processor. Format: - `projects/{project}/locations/{location}/processors/{processor}` + Output only. Denotes that this `ProcessorVersion` is managed by + Google. + readOnly: true + type: boolean + modelType: type: string + enumDescriptions: + - The processor version has unspecified model type. + - The processor version has generative model type. + - The processor version has custom model type. + enum: + - MODEL_TYPE_UNSPECIFIED + - MODEL_TYPE_GENERATIVE + - MODEL_TYPE_CUSTOM readOnly: true - kmsKeyName: + description: Output only. The model type of this processor version. + deprecationInfo: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo + description: If set, information about the eventual deprecation of this version. + latestEvaluation: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationReference' + description: The most recently invoked evaluation for the processor version. + name: type: string description: >- - The [KMS key](https://cloud.google.com/security-key-management) used - for encryption and decryption in CMEK scenarios. - processorVersionAliases: - description: Output only. The processor version aliases. - type: array - readOnly: true - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionAlias' - type: + Identifier. The resource name of the processor version. Format: + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` + createTime: + format: google-datetime + description: The time the processor version was created. + type: string + type: object + GoogleCloudDocumentaiV1beta3HumanReviewStatus: + id: GoogleCloudDocumentaiV1beta3HumanReviewStatus + type: object + description: The status of human review on a processed document. + properties: + stateMessage: + description: A message providing more details about the human review state. + type: string + humanReviewOperation: + type: string description: >- - The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. - To get a list of processor types, see FetchProcessorTypes. + 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. + state: + description: The state of human review on the processing request. + 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 first-class citizen for Document AI. Each processor defines how to - extract structural information from a document. - GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata: - id: GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata + GoogleCloudDocumentaiV1beta1BoundingPoly: + id: GoogleCloudDocumentaiV1beta1BoundingPoly + properties: + normalizedVertices: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1NormalizedVertex' + type: array + description: The bounding polygon normalized vertices. + vertices: + type: array + description: The bounding polygon vertices. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1Vertex' + description: A bounding polygon for the detected image annotation. type: object - description: Metadata of the import document operation. + GoogleCloudDocumentaiV1OcrConfig: + id: GoogleCloudDocumentaiV1OcrConfig + type: object + description: Config for Document OCR. properties: - individualImportStatuses: + 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 + 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: + deprecated: true + type: boolean + description: >- + Turn on font identification model and return font style information. + Deprecated, use PremiumFeatures.compute_style_info instead. + premiumFeatures: + description: Configurations for premium OCR features. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1OcrConfigPremiumFeatures' + enableImageQualityScores: + type: boolean + 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. + advancedOcrOptions: + 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. type: array - description: The list of response details of each document. items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus - importConfigValidationResults: + type: string + hints: + description: Hints for the OCR model. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1OcrConfigHints' + GoogleCloudDocumentaiV1beta1DocumentPageLine: + type: object + properties: + provenance: + description: The history of this annotation. + deprecated: true + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenance' + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' + description: Layout for Line. + detectedLanguages: type: array - description: Validation statuses of the batch documents import config. + description: A list of detected languages together with confidence. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult - totalDocumentCount: - description: Total number of the documents that are qualified for importing. - format: int32 - type: integer + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage + description: >- + A collection of tokens that a human would perceive as a line. Does not + cross column boundaries, can be horizontal, vertical, etc. + id: GoogleCloudDocumentaiV1beta1DocumentPageLine + GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig: + id: GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig + description: >- + Configuration specific to the Document AI Warehouse-based + implementation. + type: object + properties: + schema: + type: string + readOnly: true + description: >- + Output only. The schema in Document AI Warehouse associated with the + dataset. + collection: + type: string + description: >- + Output only. The collection in Document AI Warehouse associated with + the dataset. + readOnly: true + GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata: + id: GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata + type: object + description: The long-running operation metadata for UpdateLabelerPool. + properties: commonMetadata: $ref: >- #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata description: The basic metadata of the long-running operation. - GoogleCloudDocumentaiV1beta1DocumentPage: - id: GoogleCloudDocumentaiV1beta1DocumentPage - description: A page in a Document. + GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata: + id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata type: object + description: The metadata proto of `ResyncDataset` method. properties: - blocks: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageBlock' - type: array + individualDocumentResyncStatuses: 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. - tokens: + The list of document resync statuses. The same document could have + multiple `individual_document_resync_statuses` if it has multiple + inconsistencies. items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageToken' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus type: array - description: A list of visually detected tokens on the page. - tables: + datasetResyncStatuses: items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageTable' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus type: array - description: A list of visually detected tables on the page. - formFields: - type: array - description: A list of visually detected form fields on the page. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageFormField - pageNumber: - type: integer - 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. - lines: description: >- - 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/GoogleCloudDocumentaiV1beta1DocumentPageLine' - type: array - symbols: - type: array - description: A list of visually detected symbols on the page. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageSymbol - dimension: - description: Physical dimension of the page. + The list of dataset resync statuses. Not checked when + ResyncDatasetRequest.dataset_documents is specified. + commonMetadata: + description: The basic metadata of the long-running operation. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDimension - imageQualityScores: + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + GoogleCloudDocumentaiV1BatchProcessRequest: + type: object + id: GoogleCloudDocumentaiV1BatchProcessRequest + description: Request message for BatchProcessDocuments. + properties: + 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. + type: object + additionalProperties: + type: string + documentOutputConfig: + description: The output configuration for the BatchProcessDocuments method. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentOutputConfig' + processOptions: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessOptions' + description: Inference-time options for the process API + skipHumanReview: + type: boolean + description: >- + Whether human review should be skipped for this request. Default to + `false`. + inputDocuments: + description: The input documents for the BatchProcessDocuments method. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores - description: Image quality scores. + #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig + GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus: + id: >- + GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus + description: The status of each individual document in the import process. + properties: + 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. + inputGcsSource: + type: string + description: The source Cloud Storage URI of the document. + type: object + GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse: + type: object + properties: {} + id: GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse + description: Response of the batch move documents operation. + GoogleCloudDocumentaiV1DocumentPageSymbol: + type: object + properties: detectedLanguages: description: A list of detected languages together with confidence. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage - type: array - visualElements: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageVisualElement - description: >- - A list of detected non-text visual elements e.g. checkbox, signature - etc. on the page. - type: array - detectedBarcodes: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode - description: A list of detected barcodes. - type: array - paragraphs: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageParagraph - description: >- - A list of visually detected text paragraphs on the page. A - collection of lines that a human would perceive as a paragraph. + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage type: array layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' - description: Layout for the page. - provenance: - description: The history of this page. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenance' - deprecated: true - image: - 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/GoogleCloudDocumentaiV1beta1DocumentPageImage' - transforms: - type: array - description: >- - Transformation matrices that were applied to the original document - image to produce Page.image. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageMatrix - GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId: + description: Layout for Symbol. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: A detected symbol. + id: GoogleCloudDocumentaiV1DocumentPageSymbol + GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus: + description: The status of each individual document in the batch delete process. + id: >- + GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus type: object properties: - docId: - type: string - description: Required. The id of the document. - id: GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status of deleting the document in storage. + documentId: + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' + description: The document id of the document. + GoogleCloudDocumentaiV1DeployProcessorVersionMetadata: + id: GoogleCloudDocumentaiV1DeployProcessorVersionMetadata description: >- - Identifies a document uniquely within the scope of a dataset in - unmanaged option. - GoogleCloudDocumentaiV1beta3BatchProcessResponse: - properties: {} - description: Response message for BatchProcessDocuments. - id: GoogleCloudDocumentaiV1beta3BatchProcessResponse + The long-running operation metadata for the DeployProcessorVersion + method. type: object - GoogleCloudDocumentaiV1beta2Document: properties: - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: Any error that occurred while processing this document. - entities: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentEntity' + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo: + type: object + id: GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo + description: Font and other text style attributes. + properties: + backgroundColor: + $ref: '#/components/schemas/GoogleTypeColor' + description: Color of the background. + underlined: + type: boolean + description: Whether the text is underlined. + handwritten: + description: Whether the text is handwritten. + type: boolean + letterSpacing: + type: number + description: Letter spacing in points. + format: double + bold: + type: boolean description: >- - A list of entities detected on Document.text. For document shards, - entities in this list may cross shard boundaries. - type: array - entityRelations: - description: Placeholder. Relationship among Document.entities. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentEntityRelation - labels: - type: array - description: Labels for this document. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentLabel' - textChanges: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentTextChange - type: array + Whether the text is bold (equivalent to font_weight is at least + `700`). + italic: + type: boolean + description: Whether the text is italic. + strikeout: + type: boolean 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. - content: - type: string + Whether the text is strikethrough. This feature is not supported + yet. + fontSize: + type: integer + description: Font size in points (`1` point is `¹⁄₇₂` inches). + format: int32 + superscript: + type: boolean 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 - shardInfo: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentShardInfo' + Whether the text is a superscript. This feature is not supported + yet. + fontWeight: 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. - uri: + TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). + Normal is `400`, bold is `700`. + type: integer + format: int32 + subscript: + description: Whether the text is a subscript. This feature is not supported yet. + type: boolean + pixelFontSize: + format: double + type: number 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). + Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ + `72.0`. + smallcaps: + description: >- + Whether the text is in small caps. This feature is not supported + yet. + type: boolean + fontType: + description: Name or style of the font. type: string - revisions: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentRevision' - description: Placeholder. Revision history of this document. - type: array - textStyles: + textColor: + $ref: '#/components/schemas/GoogleTypeColor' + description: Color of the text. + GoogleCloudDocumentaiV1beta2DocumentPageFormField: + id: GoogleCloudDocumentaiV1beta2DocumentPageFormField + description: A form field detected on the page. + type: object + properties: + 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/GoogleCloudDocumentaiV1beta2DocumentProvenance' + description: The history of this annotation. + nameDetectedLanguages: + description: A list of detected languages for name together with confidence. items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentStyle' - deprecated: true - description: Styles for the Document.text. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage type: array - mimeType: + fieldValue: + description: Layout for the FormField value. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' + correctedKeyText: description: >- - An IANA published [media type (MIME - type)](https://www.iana.org/assignments/media-types/media-types.xhtml). + 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 - pages: + fieldName: + description: >- + Layout for the FormField name. e.g. `Address`, `Email`, `Grand + total`, `Phone number`, etc. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' + 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. + valueDetectedLanguages: type: array - description: Visual page layout for the Document. + description: A list of detected languages for value together with confidence. items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPage' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage + GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue: + id: GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue + properties: text: type: string - description: Optional. UTF-8 encoded text in reading order from 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. - id: GoogleCloudDocumentaiV1beta2Document - type: object - GoogleCloudDocumentaiV1beta1DocumentPageImage: - id: GoogleCloudDocumentaiV1beta1DocumentPageImage - properties: - height: - format: int32 - type: integer - description: Height of the image in pixels. - mimeType: description: >- - Encoding [media type (MIME - type)](https://www.iana.org/assignments/media-types/media-types.xhtml) - for the image. - type: string - content: - format: byte - description: Raw byte content of the image. - type: string - width: - description: Width of the image in pixels. + 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. + 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 + integerValue: + description: Integer value. type: integer format: int32 - description: Rendered image contents for this page. + floatValue: + format: float + description: Float value. + type: number + booleanValue: + type: boolean + description: >- + Boolean value. Can be used for entities with binary values, or for + checkboxes. + moneyValue: + $ref: '#/components/schemas/GoogleTypeMoney' + description: >- + Money value. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/money.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: + $ref: '#/components/schemas/GoogleTypePostalAddress' + description: >- + Postal address. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto + description: Parsed and normalized entity value. type: object - GoogleCloudDocumentaiUiv1beta3DocumentId: + GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest: properties: - 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. - gcsManagedDocId: + evaluationDocuments: + description: >- + Optional. The documents used in the evaluation. If unspecified, use + the processor's dataset as evaluation input. $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId - description: A document id within user-managed Cloud Storage. - description: Document Identifier. - id: GoogleCloudDocumentaiUiv1beta3DocumentId + #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig + id: GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest + description: Evaluates the given ProcessorVersion against the supplied documents. type: object - GoogleCloudDocumentaiV1DeployProcessorVersionRequest: - description: Request message for the DeployProcessorVersion method. - id: GoogleCloudDocumentaiV1DeployProcessorVersionRequest - properties: {} + GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty: 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 + description: Defines properties that can be part of the entity type. + id: GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty properties: - sublocality: + occurrenceType: type: string + enum: + - OCCURRENCE_TYPE_UNSPECIFIED + - OPTIONAL_ONCE + - OPTIONAL_MULTIPLE + - REQUIRED_ONCE + - REQUIRED_MULTIPLE + 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: >- - Optional. Sublocality of the address. For example, this can be - neighborhoods, boroughs, districts. - postalCode: + Occurrence type limits the number of instances an entity type + appears in the document. + displayName: 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.). - 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 - languageCode: + description: User defined name for the property. + valueType: 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". - locality: - type: string + A reference to the value type of the property. This type is subject + to the same conventions as the `Entity.base_types` field. + name: 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. - organization: - description: Optional. The name of the organization at the address. + The name of the property. Follows the same guidelines as the + EntityType name. type: string - 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. + GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata: + type: object + id: GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata + properties: + totalDocumentCount: + description: Total number of the auto-labeling documents. type: integer format: int32 - 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 - 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). + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + individualAutoLabelStatuses: items: - type: string + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus type: array - 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. - 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 - id: GoogleTypePostalAddress + The list of individual auto-labeling statuses of the dataset + documents. + description: Metadata of the auto-labeling documents operation. + GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata: + id: GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata + description: The long-running operation metadata for the CreateLabelerPool method. type: object - GoogleCloudDocumentaiV1DeployProcessorVersionMetadata: - id: GoogleCloudDocumentaiV1DeployProcessorVersionMetadata properties: commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata description: The basic metadata of the long-running operation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - description: >- - The long-running operation metadata for the DeployProcessorVersion - method. + GoogleCloudDocumentaiV1ListProcessorVersionsResponse: type: object - GoogleCloudDocumentaiV1BatchProcessMetadata: properties: - stateMessage: - description: >- - A message providing more details about the current state of - processing. For example, the error message if the operation is - failed. - type: string - createTime: - format: google-datetime - type: string - description: The creation time of the operation. - individualProcessStatuses: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus - description: The list of response details of each document. + processorVersions: type: array - updateTime: - format: google-datetime - type: string - description: The last update time of the operation. - state: - 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 list of processors. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersion' + nextPageToken: + description: Points to the next processor, otherwise empty. type: string - description: The state of the current batch processing. - enum: - - STATE_UNSPECIFIED - - WAITING - - RUNNING - - SUCCEEDED - - CANCELLING - - CANCELLED - - FAILED - type: object - description: The long-running operation metadata for BatchProcessDocuments. - id: GoogleCloudDocumentaiV1BatchProcessMetadata - GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata: - id: GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata + id: GoogleCloudDocumentaiV1ListProcessorVersionsResponse + description: Response message for the ListProcessorVersions method. + GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata: + description: Metadata of the EvaluateProcessorVersion method. type: object - description: The metadata that represents a processor version being created. + id: GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata properties: 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 - testDatasetValidation: $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation - description: The test dataset validation information. - GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult: + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + GoogleTypeColor: + 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. + 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 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 - id: >- - GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult - type: object - GoogleCloudDocumentaiV1beta1DocumentPageFormField: - description: A form field detected on the page. + 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 + 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 + 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). + GoogleCloudDocumentaiV1beta1ProcessDocumentResponse: properties: - correctedValueText: - type: string + outputConfig: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1OutputConfig' 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: - description: A list of detected languages for name together with confidence. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage - fieldName: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' + The output location of the parsed responses. The responses are + written to this location as JSON-serialized `Document` objects. + inputConfig: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1InputConfig' description: >- - Layout for the FormField name. e.g. `Address`, `Email`, `Grand - total`, `Phone number`, etc. - fieldValue: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' - description: Layout for the FormField value. - correctedKeyText: + Information about the input file. This is the same as the + corresponding input config in the request. + id: GoogleCloudDocumentaiV1beta1ProcessDocumentResponse + description: Response to a single document processing request. + type: object + GoogleCloudDocumentaiV1beta2GcsSource: + type: object + properties: + uri: + type: string + id: GoogleCloudDocumentaiV1beta2GcsSource + description: >- + The Google Cloud Storage location where the input file will be read + from. + GoogleCloudDocumentaiV1beta1DocumentPageVisualElement: + type: object + description: >- + Detected non-text visual elements e.g. checkbox, signature etc. on the + page. + id: GoogleCloudDocumentaiV1beta1DocumentPageVisualElement + properties: + detectedLanguages: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage + description: A list of detected languages together with confidence. + type: + type: string + description: Type of the VisualElement. + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' + description: Layout for VisualElement. + GoogleCloudDocumentaiUiv1beta3RevisionRef: + id: GoogleCloudDocumentaiUiv1beta3RevisionRef + description: The revision reference specifies which revision on the document to read. + type: object + properties: + latestProcessorVersion: 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. - valueType: + 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: type: string + 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. + revisionId: + type: string + description: Reads the revision given by the id. + GoogleCloudDocumentaiV1OcrConfigHints: + description: Hints for OCR Engine + type: object + properties: + languageHints: + type: array + items: + 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` - provenance: - description: The history of this annotation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenance' - valueDetectedLanguages: - description: A list of detected languages for value together with confidence. + 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). + id: GoogleCloudDocumentaiV1OcrConfigHints + GoogleCloudDocumentaiV1beta1DocumentTextAnchor: + id: GoogleCloudDocumentaiV1beta1DocumentTextAnchor + type: object + properties: + textSegments: type: array items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage - id: GoogleCloudDocumentaiV1beta1DocumentPageFormField + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment + description: The text segments from the Document.text. + 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. + description: Text reference indexing into the Document.text. + GoogleCloudDocumentaiV1GcsPrefix: type: object - GoogleCloudDocumentaiV1beta2DocumentLabel: + description: Specifies all documents on Cloud Storage with a common prefix. + id: GoogleCloudDocumentaiV1GcsPrefix properties: - name: - description: >- - Name of the label. When the label is generated from AutoML Text - Classification model, this field represents the name of the - category. + gcsUriPrefix: + description: The URI prefix. type: string + GoogleCloudDocumentaiV1beta2DocumentLabel: + properties: automlModel: + type: string description: >- Label is generated AutoML model. This field stores the full resource name of the AutoML model. Format: `projects/{project-id}/locations/{location-id}/models/{model-id}` - type: string confidence: type: number format: float description: Confidence score between 0 and 1 for label assignment. + name: + description: >- + Name of the label. When the label is generated from AutoML Text + Classification model, this field represents the name of the + category. + type: string description: >- Label attaches schema information and/or other metadata to segments within a Document. Multiple Labels on a single field can denote either different labels, different instances of the same label created at different times, or some combination of both. - id: GoogleCloudDocumentaiV1beta2DocumentLabel - type: object - GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument: - id: GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument - properties: - documentId: - type: string - description: An internal identifier for document. - type: object - GoogleCloudDocumentaiV1DocumentPageToken: - properties: - styleInfo: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo - description: Text style attributes. - layout: - description: Layout for Token. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - provenance: - description: The history of this annotation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - deprecated: true - detectedBreak: - description: Detected break at the end of a Token. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak - detectedLanguages: - description: A list of detected languages together with confidence. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - type: object - id: GoogleCloudDocumentaiV1DocumentPageToken - description: A detected token. - GoogleCloudDocumentaiV1beta2InputConfig: - properties: - mimeType: - description: >- - Required. Mimetype of the input. Current supported mimetypes are - application/pdf, image/tiff, and image/gif. In addition, - application/json type is supported for requests with - ProcessDocumentRequest.automl_params field set. The JSON file needs - to be in Document format. - type: string - contents: - type: string - description: >- - Content in bytes, represented as a stream of bytes. Note: As with - all `bytes` fields, proto buffer messages use a pure binary - representation, whereas JSON representations use base64. This field - only works for synchronous ProcessDocument method. - format: byte - gcsSource: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2GcsSource' - description: >- - The Google Cloud Storage location to read the input from. This must - be a single file. - type: object - id: GoogleCloudDocumentaiV1beta2InputConfig - description: The desired input location and metadata. - GoogleCloudDocumentaiV1beta1DocumentPageLine: - properties: - provenance: - deprecated: true - description: The history of this annotation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenance' - detectedLanguages: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' - description: Layout for Line. - id: GoogleCloudDocumentaiV1beta1DocumentPageLine 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. - GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow: - id: GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow - description: A row of table cells. + id: GoogleCloudDocumentaiV1beta2DocumentLabel + GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata: type: object + id: GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata properties: - cells: - description: Cells that make up this row. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell - type: array - GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' description: >- The long-running operation metadata for the DeleteProcessorVersion method. + GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata: properties: + errorDocumentCount: + format: int32 + description: Total number of documents that failed to be deleted in storage. + type: integer + totalDocumentCount: + format: int32 + description: Total number of documents deleting from dataset. + type: integer commonMetadata: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata description: The basic metadata of the long-running operation. - type: object - id: GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata - GoogleCloudDocumentaiV1DocumentPageLine: - type: object - id: GoogleCloudDocumentaiV1DocumentPageLine - properties: - detectedLanguages: + individualBatchDeleteStatuses: type: array - description: A list of detected languages together with confidence. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - provenance: - deprecated: true - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this annotation. - layout: - description: Layout for Line. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: >- - A collection of tokens that a human would perceive as a line. Does not - cross column boundaries, can be horizontal, vertical, etc. - GoogleLongrunningListOperationsResponse: - id: GoogleLongrunningListOperationsResponse + #/components/schemas/GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus + description: The list of response details of each document. + id: GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata type: object - properties: - nextPageToken: - type: string - description: The standard List next-page token. - operations: + GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse: + description: Response of the delete documents operation. + type: object + properties: {} + id: GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse + GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions: + type: object + properties: + trainSteps: + format: int32 + type: integer 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. - GoogleCloudDocumentaiV1DocumentPageTable: - id: GoogleCloudDocumentaiV1DocumentPageTable + 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. + 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. + type: number + format: float + id: >- + GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions + description: Options to control foundation model tuning of the processor. + GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus: + id: >- + GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus type: object - description: A table representation similar to HTML table structure. properties: - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for Table. - bodyRows: - description: Body rows of the table. + outputDocumentId: + description: >- + The document id of imported document if it was successful, otherwise + empty. + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' + outputGcsDestination: + type: string + description: >- + The output_gcs_destination of the processed document if it was + successful, otherwise empty. + inputGcsSource: + description: The source Cloud Storage URI of the document. + type: string + 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. + GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse: + description: Response of the EvaluateProcessorVersion method. + id: GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse + type: object + properties: + evaluation: + type: string + description: The resource name of the created evaluation. + GoogleCloudDocumentaiV1DocumentShardInfo: + type: object + properties: + textOffset: + format: int64 + description: >- + The index of the first character in Document.text in the overall + document global text. + type: string + shardIndex: + description: The 0-based index of this shard. + format: int64 + type: string + shardCount: + description: Total number of shards. + format: int64 + type: string + 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. + GoogleCloudDocumentaiV1DocumentPageTableTableRow: + description: A row of table cells. + properties: + cells: + description: Cells that make up this row. + type: array items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow - type: array - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - deprecated: true - description: The history of this table. + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableCell + type: object + id: GoogleCloudDocumentaiV1DocumentPageTableTableRow + GoogleCloudDocumentaiV1beta2DocumentPage: + type: object + description: A page in a Document. + properties: detectedLanguages: + type: array items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage description: A list of detected languages together with confidence. + transforms: + description: >- + Transformation matrices that were applied to the original document + image to produce Page.image. type: array - headerRows: items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow + #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageMatrix + paragraphs: type: array - description: Header rows of the table. - GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata: - description: >- - The long-running operation metadata for the DeleteProcessorVersion - method. - type: object - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - id: GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata - GoogleCloudDocumentaiV1BatchProcessRequest: - properties: - 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 + 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/GoogleCloudDocumentaiV1beta2DocumentPageParagraph + symbols: + description: A list of visually detected symbols on the page. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageSymbol + type: array + tokens: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageToken' + type: array + description: A list of visually detected tokens on the page. + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' + description: Layout for the page. + pageNumber: + format: int32 description: >- - Whether human review should be skipped for this request. Default to - `false`. - processOptions: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessOptions' - description: Inference-time options for the process API - inputDocuments: + 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 + imageQualityScores: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig - description: The input documents for the BatchProcessDocuments method. - documentOutputConfig: - description: The output configuration for the BatchProcessDocuments method. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentOutputConfig' - id: GoogleCloudDocumentaiV1BatchProcessRequest - description: Request message for BatchProcessDocuments. - type: object - GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata: - type: object - properties: - commonMetadata: - description: The basic metadata of the long-running operation. + #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores + description: Image quality scores. + dimension: $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The long-running operation metadata for DeleteLabelerPool. - id: GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata - GoogleCloudDocumentaiV1beta1DocumentPageToken: - id: GoogleCloudDocumentaiV1beta1DocumentPageToken - description: A detected token. - properties: - detectedLanguages: + #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDimension + description: Physical dimension of the page. + visualElements: type: array - description: A list of detected languages together with confidence. + description: >- + A list of detected non-text visual elements e.g. checkbox, signature + etc. on the page. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' - description: Layout for Token. - provenance: - deprecated: true - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenance' - description: The history of this annotation. - styleInfo: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo - description: Text style attributes. - detectedBreak: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak - description: Detected break at the end of a Token. - type: object - GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata: - type: object - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - destDatasetType: - type: string - deprecated: true - 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. - individualBatchMoveStatuses: + #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageVisualElement + detectedBarcodes: items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus - type: array - description: The list of response details of each document. - destSplitType: - enumDescriptions: - - Default value if the enum is not set. - - Identifies the train documents. - - Identifies the test documents. - - Identifies the unassigned documents. - type: string - description: The destination dataset split type. - enum: - - DATASET_SPLIT_TYPE_UNSPECIFIED - - DATASET_SPLIT_TRAIN - - DATASET_SPLIT_TEST - - DATASET_SPLIT_UNASSIGNED - id: GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata - GoogleCloudDocumentaiV1DocumentEntityRelation: - type: object - properties: - objectId: - type: string - description: Object entity id. - subjectId: - type: string - description: Subject entity id. - relation: - type: string - description: Relationship description. - description: Relationship between Entities. - id: GoogleCloudDocumentaiV1DocumentEntityRelation - GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse: - type: object - properties: - gcsUri: - type: string - description: The Cloud Storage URI containing the output artifacts. - description: Response message associated with the ExportProcessorVersion operation. - id: GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse - GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata: - id: GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata - 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 SetDefaultProcessorVersion - method. - GoogleCloudDocumentaiV1beta2DocumentPageDimension: - type: object - properties: - unit: - description: Dimension unit. - type: string - width: - format: float - description: Page width. - type: number - height: - type: number - format: float - description: Page height. - id: GoogleCloudDocumentaiV1beta2DocumentPageDimension - description: Dimension for the page. - GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse: - description: The response proto of ExportDocuments method. - id: GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse - properties: {} - type: object - GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse: - description: Response message for the DeployProcessorVersion method. - type: object - properties: {} - id: GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse - GoogleCloudDocumentaiV1DocumentSchema: - id: GoogleCloudDocumentaiV1DocumentSchema - description: The schema defines the output of the processed document by a processor. - type: object - properties: - entityTypes: - description: Entity types of the schema. + #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode type: array + description: A list of detected barcodes. + formFields: items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaEntityType - metadata: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaMetadata' - description: Metadata of the schema. - description: - type: string - description: Description of the schema. - displayName: - type: string - description: Display name to show to users. - GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata: - properties: - individualBatchDeleteStatuses: - description: The list of response details of each document. + #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageFormField + description: A list of visually detected form fields on the page. type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - totalDocumentCount: - type: integer - description: Total number of documents deleting from dataset. - format: int32 - errorDocumentCount: - format: int32 - type: integer - description: Total number of documents that failed to be deleted in storage. - type: object - id: GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata - GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview: - properties: - state: - type: string - description: Human review state. e.g. `requested`, `succeeded`, `rejected`. - 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`. - id: GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview - type: object - description: Human Review information of the document. - GoogleCloudDocumentaiV1beta1Document: - 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. - properties: - mimeType: - type: string + blocks: description: >- - An IANA published [media type (MIME - type)](https://www.iana.org/assignments/media-types/media-types.xhtml). - entityRelations: + 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. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentEntityRelation - description: Placeholder. Relationship among Document.entities. - shardInfo: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageBlock' + image: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageImage' 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/GoogleCloudDocumentaiV1beta1DocumentShardInfo' - revisions: - type: array - description: Placeholder. Revision history of this document. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentRevision' - entities: + 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. + lines: type: array items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentEntity' + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLine' description: >- - A list of entities detected on Document.text. For document shards, - entities in this list may cross shard boundaries. - pages: - description: Visual page layout for the Document. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPage' - type: array - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: Any error that occurred while processing this document. - textStyles: + A list of visually detected text lines on the page. A collection of + tokens that a human would perceive as a line. + provenance: deprecated: true - description: Styles for the Document.text. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentStyle' + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentProvenance' + description: The history of this page. + tables: type: array - 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 - text: - description: Optional. UTF-8 encoded text in reading order from the document. - type: string - textChanges: items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentTextChange - 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 - content: - 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 - format: byte - id: GoogleCloudDocumentaiV1beta1Document + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageTable' + description: A list of visually detected tables on the page. + id: GoogleCloudDocumentaiV1beta2DocumentPage + GoogleCloudDocumentaiV1DocumentRevision: + description: Contains past or forward revisions of this document. type: object - GoogleCloudDocumentaiV1beta1DocumentStyle: properties: - fontWeight: + processor: description: >- - [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). - Possible values are `normal`, `bold`, `bolder`, and `lighter`. - type: string - fontFamily: + If the annotation was made by processor identify the processor by + its resource name. type: string + id: description: >- - 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. - fontSize: - description: Font size. + Id of the revision, internally generated by doc proto storage. + Unique within the context of the document. + type: string + humanReview: + description: Human Review information of this revision. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentStyleFontSize - textStyle: - description: >- - [Text - style](https://www.w3schools.com/cssref/pr_font_font-style.asp). - Possible values are `normal`, `italic`, and `oblique`. + #/components/schemas/GoogleCloudDocumentaiV1DocumentRevisionHumanReview + createTime: + format: google-datetime type: string - color: - description: Text color. - $ref: '#/components/schemas/GoogleTypeColor' - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentTextAnchor' - description: Text anchor indexing into the Document.text. - textDecoration: description: >- - [Text - decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). - Follows CSS standard. + The time that the revision was created, internally generated by doc + proto storage at the time of create. + parent: + 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. + deprecated: true + type: array + agent: type: string - description: >- - Annotation for common text style attributes. This adheres to CSS - conventions as much as possible. - id: GoogleCloudDocumentaiV1beta1DocumentStyle - type: object - 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 + 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. + type: array + id: GoogleCloudDocumentaiV1DocumentRevision + GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo: properties: - timeZone: - $ref: '#/components/schemas/GoogleTypeTimeZone' - description: Time zone. - year: + pixelFontSize: description: >- - Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a - datetime without a year. - format: int32 + Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ + `72.0`. + type: number + format: double + italic: + description: Whether the text is italic. + type: boolean + textColor: + $ref: '#/components/schemas/GoogleTypeColor' + description: Color of the text. + fontType: + description: Name or style of the font. + type: string + letterSpacing: + description: Letter spacing in points. + format: double + type: number + superscript: + type: boolean + description: >- + Whether the text is a superscript. This feature is not supported + yet. + strikeout: + type: boolean + description: >- + Whether the text is strikethrough. This feature is not supported + yet. + bold: + type: boolean + description: >- + Whether the text is bold (equivalent to font_weight is at least + `700`). + smallcaps: + type: boolean + description: >- + Whether the text is in small caps. This feature is not supported + yet. + subscript: + description: Whether the text is a subscript. This feature is not supported yet. + type: boolean + fontWeight: + description: >- + TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). + Normal is `400`, bold is `700`. type: integer - minutes: format: int32 - type: integer - description: >- - Optional. Minutes of hour of day. Must be from 0 to 59, defaults to - 0. - month: + fontSize: + description: Font size in points (`1` point is `¹⁄₇₂` inches). type: integer format: int32 + underlined: + description: Whether the text is underlined. + type: boolean + backgroundColor: + $ref: '#/components/schemas/GoogleTypeColor' + description: Color of the background. + handwritten: + description: Whether the text is handwritten. + type: boolean + description: Font and other text style attributes. + id: GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo + type: object + GoogleCloudDocumentaiV1EnableProcessorMetadata: + properties: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + id: GoogleCloudDocumentaiV1EnableProcessorMetadata + description: The long-running operation metadata for the EnableProcessor method. + type: object + GoogleCloudDocumentaiV1beta3ReviewDocumentResponse: + id: GoogleCloudDocumentaiV1beta3ReviewDocumentResponse + properties: + gcsDestination: description: >- - Optional. Month of year. Must be from 1 to 12, or 0 if specifying a - datetime without a month. - hours: + The Cloud Storage uri for the human reviewed document if the review + is succeeded. + type: string + state: + type: string + enum: + - STATE_UNSPECIFIED + - REJECTED + - SUCCEEDED + 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. + rejectionReason: + description: The reason why the review is rejected by reviewer. + type: string + type: object + description: Response message for the ReviewDocument method. + GoogleCloudDocumentaiV1beta1DocumentPageMatrix: + type: object + properties: + cols: + description: Number of columns in the matrix. format: int32 type: integer + type: + type: integer + 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. - 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. + 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 + type: string + description: The matrix data. + rows: + description: Number of rows in the matrix. format: int32 type: integer - day: + id: GoogleCloudDocumentaiV1beta1DocumentPageMatrix + description: >- + Representation for transformation matrix, intended to be compatible and + used with OpenCV format for image manipulation. + GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata: + description: >- + The long-running operation metadata for the DeleteProcessorVersion + method. + type: object + id: GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata + properties: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + GoogleCloudDocumentaiV1DocumentPageImageQualityScores: + type: object + properties: + qualityScore: 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. + The overall quality score. Range `[0, 1]` where `1` is perfect + quality. + type: number + format: float + detectedDefects: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect + description: A list of detected defects. + description: Image quality scores for the page image. + id: GoogleCloudDocumentaiV1DocumentPageImageQualityScores + GoogleCloudDocumentaiV1beta2Vertex: + id: GoogleCloudDocumentaiV1beta2Vertex + 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. + properties: + x: type: integer + description: X coordinate. format: int32 - nanos: + 'y': type: integer + description: Y coordinate (starts from the top of the image). format: int32 - description: >- - Optional. Fractions of seconds in nanoseconds. Must be from 0 to - 999,999,999, defaults to 0. - utcOffset: - 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 - type: string - GoogleCloudDocumentaiV1beta2DocumentPageBlock: - id: GoogleCloudDocumentaiV1beta2DocumentPageBlock + GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse: + description: Response message for the DeployProcessorVersion method. + properties: {} + id: GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse + type: object + GoogleCloudDocumentaiV1beta2DocumentPageVisualElement: + id: GoogleCloudDocumentaiV1beta2DocumentPageVisualElement description: >- - A block has a set of lines (collected into paragraphs) that have a - common line-spacing and orientation. + Detected non-text visual elements e.g. checkbox, signature etc. on the + page. + type: object properties: layout: $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' - description: Layout for Block. + description: Layout for VisualElement. detectedLanguages: - type: array items: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage description: A list of detected languages together with confidence. - provenance: - description: The history of this annotation. - deprecated: true - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentProvenance' - type: object - GoogleCloudDocumentaiV1BoundingPoly: - description: A bounding polygon for the detected image annotation. - id: GoogleCloudDocumentaiV1BoundingPoly - type: object - properties: - vertices: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Vertex' - description: The bounding polygon vertices. - normalizedVertices: - description: The bounding polygon normalized vertices. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1NormalizedVertex' type: array - GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse: - id: GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse - description: Response message for the UndeployProcessorVersion method. - properties: {} + type: + type: string + description: Type of the VisualElement. + GoogleCloudDocumentaiV1beta1DocumentStyle: + description: >- + Annotation for common text style attributes. This adheres to CSS + conventions as much as possible. type: object - GoogleCloudDocumentaiV1CommonOperationMetadata: + id: GoogleCloudDocumentaiV1beta1DocumentStyle properties: - stateMessage: + fontFamily: type: string description: >- - A message providing more details about the current state of - processing. - updateTime: - description: The last update time of the operation. - type: string - format: google-datetime - resource: + Font family such as `Arial`, `Times New Roman`. + https://www.w3schools.com/cssref/pr_font_font-family.asp + textStyle: type: string - description: A related resource to this operation. - state: + description: >- + [Text + style](https://www.w3schools.com/cssref/pr_font_font-style.asp). + Possible values are `normal`, `italic`, and `oblique`. + backgroundColor: + $ref: '#/components/schemas/GoogleTypeColor' + description: Text background color. + fontWeight: type: string - enumDescriptions: - - Unspecified state. - - Operation is still running. - - Operation is being cancelled. - - Operation succeeded. - - Operation failed. - - Operation is cancelled. - enum: - - STATE_UNSPECIFIED - - RUNNING - - CANCELLING - - SUCCEEDED - - FAILED - - CANCELLED - description: The state of the operation. - createTime: - format: google-datetime - description: The creation time of the operation. + description: >- + [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). + Possible values are `normal`, `bold`, `bolder`, and `lighter`. + textDecoration: type: string - id: GoogleCloudDocumentaiV1CommonOperationMetadata - type: object - description: The common metadata for long running operations. - GoogleCloudDocumentaiV1beta1DocumentPageTable: - description: A table representation similar to HTML table structure. - properties: - headerRows: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow - description: Header rows of the table. - provenance: - description: The history of this table. - deprecated: true - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenance' - detectedLanguages: - description: A list of detected languages together with confidence. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage - bodyRows: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow - type: array - description: Body rows of the table. - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' - description: Layout for Table. - id: GoogleCloudDocumentaiV1beta1DocumentPageTable - type: object - GoogleCloudDocumentaiV1beta2DocumentPageParagraph: - id: GoogleCloudDocumentaiV1beta2DocumentPageParagraph - description: A collection of lines that a human would perceive as a paragraph. - properties: - detectedLanguages: - description: A list of detected languages together with confidence. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage - type: array - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentProvenance' - deprecated: true - description: The history of this annotation. - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' - description: Layout for Paragraph. - type: object - GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata: - description: The long-running operation metadata for the DeleteProcessor method. - type: object - id: GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata - properties: - commonMetadata: - description: The basic metadata of the long-running operation. + description: >- + [Text + decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). + Follows CSS standard. + fontSize: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - GoogleCloudDocumentaiV1OcrConfigHints: - type: object - id: GoogleCloudDocumentaiV1OcrConfigHints - description: Hints for OCR Engine + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentStyleFontSize + description: Font size. + textAnchor: + description: Text anchor indexing into the Document.text. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentTextAnchor' + color: + $ref: '#/components/schemas/GoogleTypeColor' + description: Text color. + GoogleTypeDateTime: properties: - languageHints: - type: array - items: - type: string + seconds: 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). - GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata: - description: The common metadata for long running operations. - properties: - stateMessage: + 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 + minutes: 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: - description: A related resource to this operation. - type: string - state: - type: string - enum: - - STATE_UNSPECIFIED - - RUNNING - - CANCELLING - - SUCCEEDED - - FAILED - - CANCELLED - description: The state of the operation. - enumDescriptions: - - Unspecified state. - - Operation is still running. - - Operation is being cancelled. - - Operation succeeded. - - Operation failed. - - Operation is cancelled. - updateTime: - format: google-datetime - description: The last update time of the operation. + Optional. Minutes of hour of day. Must be from 0 to 59, defaults to + 0. + type: integer + format: int32 + utcOffset: type: string - type: object - id: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - GoogleCloudDocumentaiV1beta1DocumentProvenance: - properties: - id: + 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 + 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 + month: type: integer + format: int32 description: >- - The Id of this operation. Needs to be unique within the scope of the - revision. + Optional. Month of year. Must be from 1 to 12, or 0 if specifying a + datetime without a month. + timeZone: + description: Time zone. + $ref: '#/components/schemas/GoogleTypeTimeZone' + 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 - deprecated: true - revision: - deprecated: true + nanos: + type: integer + description: >- + Optional. Fractions of seconds in nanoseconds. Must be from 0 to + 999,999,999, defaults to 0. + format: int32 + 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. format: int32 type: integer - description: The index of the revision that produced this element. - parents: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenanceParent - description: References to the original elements that are replaced. - type: - type: string - enumDeprecated: - - false - - false - - false - - false - - false - - true - - true - - true - 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. - enum: - - OPERATION_TYPE_UNSPECIFIED - - ADD - - REMOVE - - UPDATE - - REPLACE - - EVAL_REQUESTED - - EVAL_APPROVED - - EVAL_SKIPPED + id: GoogleTypeDateTime type: object - id: GoogleCloudDocumentaiV1beta1DocumentProvenance description: >- - Structure to identify provenance relationships between annotations in - different revisions. - GoogleCloudDocumentaiV1GcsDocument: - type: object - id: GoogleCloudDocumentaiV1GcsDocument - description: Specifies a document stored on Cloud Storage. + 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. + GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId: properties: - gcsUri: - description: The Cloud Storage object uri. - type: string - mimeType: + docId: type: string - description: An IANA MIME type (RFC6838) of the content. - GoogleCloudDocumentaiV1beta1OperationMetadata: - id: GoogleCloudDocumentaiV1beta1OperationMetadata + description: Required. The id of the document. + id: GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId + description: >- + Identifies a document uniquely within the scope of a dataset in + unmanaged option. type: object + GoogleLongrunningOperation: + id: GoogleLongrunningOperation properties: - createTime: + 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 - format: google-datetime - description: The creation time of the operation. - updateTime: + 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. + 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`. + description: >- + This resource represents a long-running operation that is the result of + a network API call. + type: object + GoogleCloudDocumentaiV1DocumentRevisionHumanReview: + id: GoogleCloudDocumentaiV1DocumentRevisionHumanReview + properties: + state: type: string - description: The last update time of the operation. - format: google-datetime + description: Human review state. e.g. `requested`, `succeeded`, `rejected`. stateMessage: type: string description: >- A message providing more details about the current state of - processing. - state: + processing. For example, the rejection reason when the state is + `rejected`. + type: object + description: Human Review information of the document. + GoogleCloudDocumentaiV1beta2OutputConfig: + description: The desired output location and metadata. + id: GoogleCloudDocumentaiV1beta2OutputConfig + properties: + pagesPerShard: + format: int32 + type: integer + description: >- + The max number of pages to include into each output Document shard + JSON on Google Cloud Storage. The valid range is [1, 100]. If not + specified, the default value is 20. For example, for one pdf file + with 100 pages, 100 parsed pages will be produced. If + `pages_per_shard` = 20, then 5 Document shard JSON files each + containing 20 parsed pages will be written under the prefix + OutputConfig.gcs_destination.uri and suffix pages-x-to-y.json where + x and y are 1-indexed page numbers. Example GCS outputs with 157 + pages and pages_per_shard = 50: pages-001-to-050.json + pages-051-to-100.json pages-101-to-150.json pages-151-to-157.json + gcsDestination: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2GcsDestination' + description: The Google Cloud Storage location to write the output to. + 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 with the given dataset split type to be + exported. + type: integer + format: int32 + splitType: + type: string + description: The dataset split type. enumDescriptions: - - The default value. This value is used if the state is omitted. - - Request is received. - - Request operation is waiting for scheduling. - - Request is being processed. - - The batch processing completed successfully. - - The batch processing was cancelled. - - The batch processing has failed. - description: The state of the current batch processing. + - Default value if the enum is not set. + - Identifies the train documents. + - Identifies the test documents. + - Identifies the unassigned documents. enum: - - STATE_UNSPECIFIED - - ACCEPTED - - WAITING - - RUNNING - - SUCCEEDED - - CANCELLED - - FAILED - type: string - description: Contains metadata for the BatchProcessDocuments operation. - GoogleCloudDocumentaiV1DocumentPageFormField: + - DATASET_SPLIT_TYPE_UNSPECIFIED + - DATASET_SPLIT_TRAIN + - DATASET_SPLIT_TEST + - DATASET_SPLIT_UNASSIGNED + GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata: + description: Metadata of the EvaluateProcessorVersion method. + type: object properties: - nameDetectedLanguages: + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + id: GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata + GoogleCloudDocumentaiV1beta1DocumentTextChange: + id: GoogleCloudDocumentaiV1beta1DocumentTextChange + properties: + textAnchor: + 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/GoogleCloudDocumentaiV1beta1DocumentTextAnchor' + provenance: + deprecated: true type: array + description: The history of this annotation. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages for name together with confidence. - correctedValueText: + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenance + changedText: 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: + description: The text that replaces the text identified in the `text_anchor`. + description: This message is used for text changes aka. OCR corrections. + type: object + GoogleCloudDocumentaiV1beta2DocumentStyleFontSize: + description: Font size with unit. + id: GoogleCloudDocumentaiV1beta2DocumentStyleFontSize + properties: + unit: 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. - fieldName: - description: >- - Layout for the FormField name. e.g. `Address`, `Email`, `Grand - total`, `Phone number`, etc. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - fieldValue: - description: Layout for the FormField value. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - provenance: - description: The history of this annotation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - valueDetectedLanguages: - type: array - description: A list of detected languages for value together with confidence. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - 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` - type: object - id: GoogleCloudDocumentaiV1DocumentPageFormField - description: A form field detected on the page. - GoogleCloudDocumentaiV1beta2DocumentStyleFontSize: - type: object - properties: + 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 - unit: - type: string - description: >- - Unit for the font size. Follows CSS naming (such as `in`, `px`, and - `pt`). - id: GoogleCloudDocumentaiV1beta2DocumentStyleFontSize - description: Font size with unit. - GoogleCloudDocumentaiV1UndeployProcessorVersionRequest: - properties: {} - type: object - id: GoogleCloudDocumentaiV1UndeployProcessorVersionRequest - description: Request message for the UndeployProcessorVersion method. - GoogleCloudDocumentaiV1ProcessorType: type: object - id: GoogleCloudDocumentaiV1ProcessorType - description: >- - A processor type is responsible for performing a certain document - understanding task on a certain type of document. + GoogleTypeDate: properties: - sampleDocumentUris: - items: - type: string - type: array - description: A set of Cloud Storage URIs of sample documents for this processor. - type: - type: string - description: 'The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.' - availableLocations: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ProcessorTypeLocationInfo - description: The locations in which this processor is available. - type: array - category: - type: string - description: The processor category, used by UI to group processor types. - allowCreation: - type: boolean + month: 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: - 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. - description: Launch stage of the processor type - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - name: + 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 + day: description: >- - The resource name of the processor type. Format: - `projects/{project}/processorTypes/{processor_type}` - type: string - GoogleCloudDocumentaiV1beta3EnableProcessorMetadata: - id: GoogleCloudDocumentaiV1beta3EnableProcessorMetadata - description: The long-running operation metadata for the EnableProcessor method. - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + 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: + 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 + id: GoogleTypeDate type: object - GoogleCloudDocumentaiV1beta1Barcode: - description: Encodes the detailed information of a barcode. + GoogleCloudDocumentaiV1ProcessOptions: + description: Options for Process API + type: object + id: GoogleCloudDocumentaiV1ProcessOptions properties: - format: + fromEnd: + type: integer + format: int32 + description: Only process certain pages from the end, same as above. + fromStart: + format: int32 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 - rawValue: - type: string + Only process certain pages from the start. Process all if the + document has fewer pages. + type: integer + schemaOverride: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' description: >- - Raw value encoded in the barcode. For example: - `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. - valueFormat: + 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. + ocrConfig: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1OcrConfig' 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 + Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. + Returns error if set on other processor types. + individualPageSelector: + description: Which pages to process (1-indexed). + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector + GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig: type: object - id: GoogleCloudDocumentaiV1beta1Barcode - GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage: + id: GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig + description: The sharding config for the output document. properties: - confidence: - description: Confidence of detected language. Range `[0, 1]`. - type: number - 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 - description: Detected language for a structural component. - type: object - id: GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage - GoogleCloudDocumentaiV1DocumentRevision: + pagesOverlap: + format: int32 + description: The number of overlapping pages between consecutive shards. + type: integer + pagesPerShard: + type: integer + description: The number of pages per shard. + format: int32 + GoogleCloudDocumentaiV1CommonOperationMetadata: + id: GoogleCloudDocumentaiV1CommonOperationMetadata type: object - id: GoogleCloudDocumentaiV1DocumentRevision - description: Contains past or forward revisions of this document. properties: + updateTime: + type: string + format: google-datetime + description: The last update time of the operation. + resource: + description: A related resource to this operation. + type: string createTime: + description: The creation time of the operation. type: string - description: >- - The time that the revision was created, internally generated by doc - proto storage at the time of create. format: google-datetime - humanReview: - description: Human Review information of this revision. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentRevisionHumanReview - agent: + state: type: string - description: >- - If the change was made by a person specify the name or id of that - person. - id: - description: >- - Id of the revision, internally generated by doc proto storage. - Unique within the context of the document. + enum: + - STATE_UNSPECIFIED + - RUNNING + - CANCELLING + - SUCCEEDED + - FAILED + - CANCELLED + description: The state of the operation. + enumDescriptions: + - Unspecified state. + - Operation is still running. + - Operation is being cancelled. + - Operation succeeded. + - Operation failed. + - Operation is cancelled. + stateMessage: type: string - 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. - items: - format: int32 - type: integer - deprecated: true - type: array - processor: + A message providing more details about the current state of + processing. + description: The common metadata for long running operations. + GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse: + properties: {} + type: object + id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse + description: Response message for the SetDefaultProcessorVersion method. + GoogleCloudDocumentaiUiv1beta3DocumentId: + id: GoogleCloudDocumentaiUiv1beta3DocumentId + description: Document Identifier. + type: object + properties: + unmanagedDocId: + description: A document id within unmanaged dataset. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId + gcsManagedDocId: + description: A document id within user-managed Cloud Storage. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId + revisionRef: + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3RevisionRef' + description: Points to a specific revision of the document if set. + GoogleCloudDocumentaiV1RawDocument: + id: GoogleCloudDocumentaiV1RawDocument + type: object + description: Payload message of raw document content (bytes). + properties: + displayName: + 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. + type: string + content: + description: Inline document content. + format: byte + type: string + mimeType: type: string description: >- - If the annotation was made by processor identify the processor by - its resource name. - parentIds: + An IANA MIME type (RFC6838) indicating the nature and format of the + content. + GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation: + id: >- + GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation + description: >- + The dataset validation information. This includes any and all errors + with documents and the dataset. + type: object + properties: + documentErrorCount: + description: The total number of document errors. + type: integer + 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 items: - type: string + $ref: '#/components/schemas/GoogleRpcStatus' + documentErrors: 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. + 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 - GoogleCloudDocumentaiV1ProcessRequest: + items: + $ref: '#/components/schemas/GoogleRpcStatus' + datasetErrorCount: + description: The total number of dataset errors. + format: int32 + type: integer + GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata: properties: - rawDocument: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1RawDocument' - description: A raw document content (bytes). - inlineDocument: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' - description: An inline document proto. - skipHumanReview: - type: boolean - description: >- - Whether human review should be skipped for this request. Default to - `false`. - 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. - processOptions: - description: Inference-time options for the process API - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessOptions' - gcsDocument: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsDocument' - description: A raw document on Google Cloud Storage. - 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}`. - format: google-fieldmask - type: string - type: object - description: Request message for the ProcessDocument method. - id: GoogleCloudDocumentaiV1ProcessRequest - GoogleCloudDocumentaiV1ReviewDocumentResponse: + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The common metadata about the operation. + id: GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata type: object + description: Metadata message associated with the ExportProcessorVersion operation. + GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest: + description: Request message for the SetDefaultProcessorVersion method. + id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest properties: - gcsDestination: + defaultProcessorVersion: description: >- - The Cloud Storage uri for the human reviewed document if the review - is succeeded. - type: string - rejectionReason: - description: The reason why the review is rejected by reviewer. - 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. + Required. The resource name of child ProcessorVersion to use as + default. Format: + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}` type: string - enum: - - STATE_UNSPECIFIED - - REJECTED - - SUCCEEDED - description: The state of the review operation. - id: GoogleCloudDocumentaiV1ReviewDocumentResponse - description: Response message for the ReviewDocument method. - GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadata: type: object + GoogleCloudDocumentaiV1DocumentPageTableTableCell: + description: A cell representation inside the table. + type: object + id: GoogleCloudDocumentaiV1DocumentPageTableTableCell properties: - individualBatchUpdateStatuses: + colSpan: + type: integer + description: How many columns this cell spans. + format: int32 + detectedLanguages: type: array + description: A list of detected languages together with confidence. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus - description: The list of response details of each document. + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + rowSpan: + description: How many rows this cell spans. + format: int32 + type: integer + layout: + description: Layout for TableCell. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata: + type: object + id: 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. - id: GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadata - GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef: - description: Represents a weak reference to a page element within a document. - type: object + GoogleCloudDocumentaiV1beta1DocumentPageFormField: properties: - confidence: - format: float + fieldValue: + description: Layout for the FormField value. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' + valueDetectedLanguages: + type: array + description: A list of detected languages for value together with confidence. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage + nameDetectedLanguages: + type: array + description: A list of detected languages for name together with confidence. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenance' + description: The history of this annotation. + valueType: + type: string description: >- - Optional. Confidence of detected page element, if applicable. Range - `[0, 1]`. - type: number - page: + 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: >- + 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 + correctedKeyText: 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 - layoutId: - deprecated: true - type: string - description: Optional. Deprecated. Use PageRef.bounding_poly instead. - 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. - enum: - - LAYOUT_TYPE_UNSPECIFIED - - BLOCK - - PARAGRAPH - - LINE - - TOKEN - - VISUAL_ELEMENT - - TABLE - - FORM_FIELD + 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 - boundingPoly: + fieldName: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' 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/GoogleCloudDocumentaiV1beta1BoundingPoly' - id: GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef - GoogleCloudDocumentaiV1beta2Barcode: + Layout for the FormField name. e.g. `Address`, `Email`, `Grand + total`, `Phone number`, etc. + description: A form field detected on the page. + id: GoogleCloudDocumentaiV1beta1DocumentPageFormField + type: object + GoogleCloudDocumentaiV1beta1DocumentPageBlock: + description: >- + A block has a set of lines (collected into paragraphs) that have a + common line-spacing and orientation. + type: object properties: - format: + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' + description: Layout for Block. + detectedLanguages: + description: A list of detected languages together with confidence. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage + type: array + provenance: + deprecated: true + description: The history of this annotation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenance' + id: GoogleCloudDocumentaiV1beta1DocumentPageBlock + GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId: + type: object + description: >- + Identifies a document uniquely within the scope of a dataset in + unmanaged option. + id: GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId + properties: + docId: + description: Required. The id of the document. 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;;'`. + GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment: + type: object + id: GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment + properties: + endIndex: + description: TextSegment half open end UTF-8 char index in the Document.text. + format: int64 type: string - valueFormat: + startIndex: + format: int64 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. - id: GoogleCloudDocumentaiV1beta2Barcode - description: Encodes the detailed information of a barcode. + description: TextSegment start 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 + GoogleCloudDocumentaiV1beta2DocumentPageParagraph: + id: GoogleCloudDocumentaiV1beta2DocumentPageParagraph type: object - GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse: + description: A collection of lines that a human would perceive as a paragraph. properties: - responses: + provenance: + description: The history of this annotation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentProvenance' + deprecated: true + detectedLanguages: type: array - description: Responses for each individual document. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1ProcessDocumentResponse - id: GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse - type: object + #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage + description: A list of detected languages together with confidence. + layout: + description: Layout for Paragraph. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' + GoogleCloudDocumentaiV1DocumentPageBlock: description: >- - Response to an batch document processing request. This is returned in - the LRO Operation after the operation is complete. - GoogleCloudDocumentaiV1Barcode: + A block has a set of lines (collected into paragraphs) that have a + common line-spacing and orientation. + id: GoogleCloudDocumentaiV1DocumentPageBlock + properties: + detectedLanguages: + description: A list of detected languages together with confidence. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + type: array + provenance: + description: The history of this annotation. + deprecated: true + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + layout: + description: Layout for Block. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' type: object - description: Encodes the detailed information of a barcode. - id: GoogleCloudDocumentaiV1Barcode + GoogleCloudDocumentaiV1DocumentPage: properties: - valueFormat: + formFields: + description: A list of visually detected form fields on the page. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageFormField' + type: array + paragraphs: 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 - rawValue: + 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' + type: array + tables: + description: A list of visually detected tables on the page. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageTable' + pageNumber: description: >- - Raw value encoded in the barcode. For example: - `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. - type: string - format: - type: string + 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 + layout: + description: Layout for the page. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + lines: 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. - GoogleCloudDocumentaiV1EnableProcessorMetadata: - id: GoogleCloudDocumentaiV1EnableProcessorMetadata - 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 EnableProcessor method. - GoogleCloudDocumentaiV1OcrConfig: - properties: - computeStyleInfo: + 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' + visualElements: description: >- - Turn on font identification model and return font style information. - Deprecated, use PremiumFeatures.compute_style_info instead. - type: boolean + A list of detected non-text visual elements e.g. checkbox, signature + etc. on the page. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageVisualElement + type: array + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: The history of this page. deprecated: true - enableNativePdfParsing: - description: >- - Enables special handling for PDFs with existing text information. - Results in better text extraction quality in such PDF inputs. - type: boolean - enableSymbol: - description: Includes symbol level OCR information if set to true. - type: boolean - 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 - hints: - description: Hints for the OCR model. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1OcrConfigHints' - advancedOcrOptions: + tokens: + description: A list of visually detected tokens on the page. type: array items: - type: string + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageToken' + blocks: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageBlock' + type: array 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. - premiumFeatures: - description: Configurations for premium OCR features. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1OcrConfigPremiumFeatures' - enableImageQualityScores: + 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. + detectedLanguages: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages together with confidence. + type: array + transforms: + type: array 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 - id: GoogleCloudDocumentaiV1OcrConfig - description: Config for Document OCR. + Transformation matrices that were applied to the original document + image to produce Page.image. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageMatrix' + dimension: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageDimension' + description: Physical dimension of the page. + image: + 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' + detectedBarcodes: + type: array + description: A list of detected barcodes. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedBarcode + symbols: + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageSymbol' + description: A list of visually detected symbols on the page. + imageQualityScores: + description: Image quality scores. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScores type: object - GoogleCloudDocumentaiV1beta3HumanReviewStatus: - description: The status of human review on a processed document. - id: GoogleCloudDocumentaiV1beta3HumanReviewStatus + id: GoogleCloudDocumentaiV1DocumentPage + description: A page in a Document. + GoogleCloudDocumentaiV1OcrConfigPremiumFeatures: + id: GoogleCloudDocumentaiV1OcrConfigPremiumFeatures type: object properties: - humanReviewOperation: + computeStyleInfo: + description: Turn on font identification model and return font style information. + type: boolean + enableMathOcr: + type: boolean + description: Turn on the model that can extract LaTeX math formulas. + enableSelectionMarkDetection: + 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: - description: A message providing more details about the human review state. - type: string + Turn on selection mark detector in OCR engine. Only available in OCR + 2.0 (and later) processors. + description: Configurations for premium OCR features. + GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics: + description: Evaluations metrics, at a specific confidence level. + type: object + id: GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics + properties: + metrics: + description: The metrics at the specific confidence level. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationMetrics' + confidenceLevel: + format: float + type: number + description: The confidence level. + GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata: + properties: state: - description: The state of human review on the processing request. - type: string enum: - STATE_UNSPECIFIED - - SKIPPED - - VALIDATION_PASSED - - IN_PROGRESS - - ERROR + - RUNNING + - CANCELLING + - SUCCEEDED + - FAILED + - CANCELLED + description: The state of the operation. + type: string 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. - GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata: - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - type: object - id: GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata - description: The long-running operation metadata for the DeleteProcessor method. - GoogleCloudDocumentaiV1EnableProcessorRequest: - properties: {} - type: object - description: Request message for the EnableProcessor method. - id: GoogleCloudDocumentaiV1EnableProcessorRequest - GoogleCloudDocumentaiV1beta2DocumentPageImage: - id: GoogleCloudDocumentaiV1beta2DocumentPageImage - properties: - mimeType: - description: >- - Encoding [media type (MIME - type)](https://www.iana.org/assignments/media-types/media-types.xhtml) - for the image. + - 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 - height: - format: int32 - type: integer - description: Height of the image in pixels. - width: - type: integer - description: Width of the image in pixels. - format: int32 - content: + format: google-datetime + resource: type: string - description: Raw byte content of the image. - format: byte - type: object - description: Rendered image contents for this page. - GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsResponse: - id: GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsResponse - properties: {} + description: A related resource to this operation. + stateMessage: + type: string + description: >- + A message providing more details about the current state of + processing. + createTime: + description: The creation time of the operation. + format: google-datetime + type: string + description: The common metadata for long running operations. type: object - description: The response proto of AutoLabelDocuments method. - GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment: + id: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + GoogleCloudDocumentaiV1beta2DocumentStyle: 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 - type: object - id: GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment + Annotation for common text style attributes. This adheres to CSS + conventions as much as possible. properties: - startIndex: - description: TextSegment start UTF-8 char index in the Document.text. + fontWeight: type: string - format: int64 - endIndex: - description: TextSegment half open end UTF-8 char index in the Document.text. - format: int64 + description: >- + [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). + Possible values are `normal`, `bold`, `bolder`, and `lighter`. + textDecoration: + description: >- + [Text + decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). + Follows CSS standard. type: string - GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse: - type: object - id: GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse - description: Response message for the SetDefaultProcessorVersion method. - properties: {} - GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo: - properties: + textStyle: + 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/GoogleCloudDocumentaiV1beta2DocumentStyleFontSize + description: Font size. + textAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentTextAnchor' + description: Text anchor indexing into the Document.text. backgroundColor: $ref: '#/components/schemas/GoogleTypeColor' - description: Color of the background. - textColor: + 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 + color: + description: Text color. $ref: '#/components/schemas/GoogleTypeColor' - description: Color of the text. - bold: + type: object + id: GoogleCloudDocumentaiV1beta2DocumentStyle + GoogleCloudDocumentaiV1DocumentPageAnchorPageRef: + description: Represents a weak reference to a page element within a document. + type: object + properties: + boundingPoly: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' description: >- - Whether the text is bold (equivalent to font_weight is at least - `700`). - type: boolean - handwritten: - description: Whether the text is handwritten. - type: boolean - fontSize: - type: integer - description: Font size in points (`1` point is `¹⁄₇₂` inches). - format: int32 - italic: - description: Whether the text is italic. - type: boolean - letterSpacing: - description: Letter spacing in points. - format: double + 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: + 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. + type: string + description: >- + Optional. The type of the layout element that is being referenced if + any. + 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: + format: float + description: >- + Optional. Confidence of detected page element, if applicable. Range + `[0, 1]`. type: number - fontWeight: + layoutId: + deprecated: true + type: string + description: Optional. Deprecated. Use PageRef.bounding_poly instead. + id: GoogleCloudDocumentaiV1DocumentPageAnchorPageRef + GoogleCloudDocumentaiV1beta2GcsDestination: + properties: + uri: + type: string + description: >- + The Google Cloud Storage location where the output file will be written + to. + id: GoogleCloudDocumentaiV1beta2GcsDestination + type: object + GoogleCloudDocumentaiV1DocumentPageLayout: + id: GoogleCloudDocumentaiV1DocumentPageLayout + type: object + properties: + confidence: description: >- - TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). - Normal is `400`, bold is `700`. - type: integer - format: int32 - subscript: - type: boolean - description: Whether the text is a subscript. This feature is not supported yet. - smallcaps: - type: boolean + 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]`. + type: number + format: float + 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. + enum: + - ORIENTATION_UNSPECIFIED + - PAGE_UP + - PAGE_RIGHT + - PAGE_DOWN + - PAGE_LEFT + description: Detected orientation for the Layout. + type: string + textAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + description: Text anchor indexing into the Document.text. + description: Visual element describing a layout unit on a page. + GoogleCloudDocumentaiV1DisableProcessorResponse: + id: GoogleCloudDocumentaiV1DisableProcessorResponse + type: object + properties: {} + description: >- + Response message for the DisableProcessor method. Intentionally empty + proto for adding fields in future. + GoogleCloudDocumentaiV1beta1Document: + id: GoogleCloudDocumentaiV1beta1Document + type: object + 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. + properties: + shardInfo: description: >- - Whether the text is in small caps. This feature is not supported - yet. - fontType: - description: Name or style of the font. + 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/GoogleCloudDocumentaiV1beta1DocumentShardInfo' + textStyles: + description: Styles for the Document.text. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentStyle' + type: array + deprecated: true + content: + format: byte type: string - underlined: - type: boolean - description: Whether the text is underlined. - superscript: description: >- - Whether the text is a superscript. This feature is not supported - yet. - type: boolean - pixelFontSize: + 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: + $ref: '#/components/schemas/GoogleRpcStatus' + description: Any error that occurred while processing this document. + mimeType: + type: string description: >- - Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ - `72.0`. - type: number - format: double - strikeout: - type: boolean + An IANA published [media type (MIME + type)](https://www.iana.org/assignments/media-types/media-types.xhtml). + pages: + type: array + description: Visual page layout for the Document. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPage' + entityRelations: + description: Placeholder. Relationship among Document.entities. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentEntityRelation + textChanges: + type: array description: >- - Whether the text is strikethrough. This feature is not supported - yet. - id: GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo + 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/GoogleCloudDocumentaiV1beta1DocumentTextChange + text: + description: Optional. UTF-8 encoded text in reading order from the document. + type: string + entities: + description: >- + A list of entities detected on Document.text. For document shards, + entities in this list may cross shard boundaries. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentEntity' + type: array + 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 + revisions: + description: Placeholder. Revision history of this document. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentRevision' + GoogleCloudDocumentaiV1DocumentTextChange: + description: This message is used for text changes aka. OCR corrections. + properties: + 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. + provenance: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + type: array + description: The history of this annotation. + deprecated: true + changedText: + description: The text that replaces the text identified in the `text_anchor`. + type: string + id: GoogleCloudDocumentaiV1DocumentTextChange type: object - description: Font and other text style attributes. - GoogleCloudDocumentaiV1RawDocument: + GoogleCloudDocumentaiV1DeployProcessorVersionRequest: + id: GoogleCloudDocumentaiV1DeployProcessorVersionRequest + description: Request message for the DeployProcessorVersion method. + type: object + properties: {} + GoogleCloudDocumentaiV1BatchDocumentsInputConfig: + description: The common config to specify a set of documents used as input. + type: object + properties: + gcsDocuments: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsDocuments' + description: The set of documents individually specified on Cloud Storage. + gcsPrefix: + description: >- + The set of documents that match the specified Cloud Storage + `gcs_prefix`. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsPrefix' + id: GoogleCloudDocumentaiV1BatchDocumentsInputConfig + GoogleCloudDocumentaiV1TrainProcessorVersionMetadata: + type: object + properties: + testDatasetValidation: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation + description: The test dataset validation information. + trainingDatasetValidation: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation + description: The training dataset validation information. + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + id: GoogleCloudDocumentaiV1TrainProcessorVersionMetadata + description: The metadata that represents a processor version being created. + GoogleCloudLocationListLocationsResponse: + description: The response message for Locations.ListLocations. type: object + id: GoogleCloudLocationListLocationsResponse properties: - mimeType: + nextPageToken: type: string + description: The standard List next-page token. + locations: description: >- - An IANA MIME type (RFC6838) indicating the nature and format of the - content. - displayName: - 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. - type: string - content: - format: byte - type: string - description: Inline document content. - id: GoogleCloudDocumentaiV1RawDocument - description: Payload message of raw document content (bytes). - GoogleTypeMoney: + A list of locations that matches the specified filter in the + request. + items: + $ref: '#/components/schemas/GoogleCloudLocationLocation' + type: array + GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata: + id: GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata + properties: + importConfigValidationResults: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult + description: Validation statuses of the batch documents import config. + type: array + 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: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus + type: array + description: The list of response details of each document. + type: object + description: Metadata of the import document operation. + GoogleCloudDocumentaiV1DocumentPageFormField: type: object - description: Represents an amount of money with its currency type. properties: - units: + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: The history of this annotation. + valueType: description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. - format: int64 + 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 - currencyCode: + nameDetectedLanguages: + description: A list of detected languages for name together with confidence. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + correctedKeyText: 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 - id: GoogleTypeMoney - GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics: + 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: + description: A list of detected languages for value together with confidence. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + fieldName: + description: >- + Layout for the FormField name. e.g. `Address`, `Email`, `Grand + total`, `Phone number`, etc. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + correctedValueText: + 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. + type: string + fieldValue: + description: Layout for the FormField value. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: A form field detected on the page. + id: GoogleCloudDocumentaiV1DocumentPageFormField + GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse: + description: >- + Response message for the EnableProcessor method. Intentionally empty + proto for adding fields in future. + properties: {} type: object + id: GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse + GoogleCloudDocumentaiV1DocumentPageDetectedLanguage: + description: Detected language for a structural component. properties: - auprc: + confidence: type: number format: float - description: >- - The calculated area under the precision recall curve (AUPRC), - computed by integrating over all confidence thresholds. - 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: Confidence of detected language. Range `[0, 1]`. + languageCode: type: string - description: The metrics type for the label. - confidenceLevelMetricsExact: - description: Metrics across confidence levels with only exact matching. + description: >- + The [BCP-47 language + code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), + such as `en-US` or `sr-Latn`. + id: GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + type: object + GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation: + description: >- + The dataset validation information. This includes any and all errors + with documents and the dataset. + 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. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics - auprcExact: - description: >- - The AUPRC for metrics with fuzzy matching disabled, i.e., exact - matching only. - type: number - format: float - confidenceLevelMetrics: - description: Metrics across confidence levels with fuzzy matching enabled. + $ref: '#/components/schemas/GoogleRpcStatus' + datasetErrors: items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics + $ref: '#/components/schemas/GoogleRpcStatus' type: array - estimatedCalibrationError: - type: number - format: float description: >- - The Estimated Calibration Error (ECE) of the confidence of the - predicted entities. - estimatedCalibrationErrorExact: + 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. + datasetErrorCount: + description: The total number of dataset errors. + type: integer + format: int32 + documentErrorCount: + description: The total number of document errors. + format: int32 + type: integer + type: object + id: >- + GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation + GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata: + id: GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata + description: The long-running operation metadata for the ReviewDocument method. + properties: + questionId: + description: The Crowd Compute question ID. + type: string + updateTime: + description: The last update time of the operation. + type: string + format: google-datetime + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + stateMessage: + type: string description: >- - The ECE for the predicted entities with fuzzy matching disabled, - i.e., exact matching only. - type: number - format: float - id: GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics - description: Metrics across multiple confidence levels. + A message providing more details about the current state of + processing. For example, the error message if the operation is + failed. + createTime: + type: string + description: The creation time of the operation. + format: google-datetime + state: + 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. + enum: + - STATE_UNSPECIFIED + - RUNNING + - CANCELLING + - SUCCEEDED + - FAILED + - CANCELLED + type: object parameters: - callback: - description: JSONP + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: callback + 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"). + alt: + description: Data format for response. in: query - name: upload_protocol + name: alt schema: type: string + enum: + - json + - media + - proto key: description: >- API key. Your API key identifies your project and provides you with API @@ -7418,30 +7428,12 @@ components: name: key 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 - 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 @@ -7451,16 +7443,30 @@ components: name: quotaUser 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 + 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 + callback: + description: JSONP + in: query + name: callback schema: type: string - enum: - - json - - media - - proto _.xgafv: description: V1 error format. in: query @@ -7470,15 +7476,65 @@ components: enum: - '1' - '2' - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string x-stackQL-resources: + operations: + id: google.documentai.operations + name: operations + title: Operations + methods: + operations_delete: + operation: + $ref: '#/paths/~1v1~1operations~1{operationsId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_operations_cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + _projects_locations_operations_list: + operation: &ref_1 + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get + response: &ref_2 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + projects_locations_operations_list: + operation: *ref_1 + response: *ref_2 + projects_locations_operations_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_operations_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_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: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/operations/methods/operations_delete processor_types: - id: documentai.processor_types + id: google.documentai.processor_types name: processor_types title: Processor_types methods: @@ -7490,16 +7546,16 @@ components: mediaType: application/json openAPIDocKey: '200' _projects_locations_processor_types_list: - operation: &ref_1 + operation: &ref_3 $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processorTypes/get - response: &ref_2 + response: &ref_4 mediaType: application/json openAPIDocKey: '200' objectKey: $.processorTypes projects_locations_processor_types_list: - operation: *ref_1 - response: *ref_2 + operation: *ref_3 + response: *ref_4 projects_locations_fetch_processor_types: operation: $ref: >- @@ -7516,284 +7572,234 @@ components: insert: [] update: [] delete: [] - human_review_config: - id: documentai.human_review_config - name: human_review_config - title: Human_review_config + processors: + id: google.documentai.processors + name: processors + title: Processors methods: - projects_locations_processors_human_review_config_review_document: + projects_locations_processors_batch_process: 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}:batchProcess/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - processor_versions: - id: documentai.processor_versions - name: processor_versions - title: Processor_versions - methods: - projects_locations_processors_processor_versions_delete: + projects_locations_processors_enable: 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}:enable/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_get: + projects_locations_processors_delete: 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}/delete response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_processors_processor_versions_list: - operation: &ref_3 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions/get - response: &ref_4 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.processorVersions - projects_locations_processors_processor_versions_list: - operation: *ref_3 - response: *ref_4 - projects_locations_processors_processor_versions_process: + projects_locations_processors_get: 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}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_train: + projects_locations_processors_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}:process/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_deploy: - operation: + _projects_locations_processors_list: + operation: &ref_5 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:deploy/post - response: + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors/get + response: &ref_6 mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_evaluate_processor_version: + objectKey: $.processors + projects_locations_processors_list: + operation: *ref_5 + response: *ref_6 + projects_locations_processors_set_default_processor_version: 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}:setDefaultProcessorVersion/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_undeploy: + projects_locations_processors_disable: 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}:disable/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: [] delete: - $ref: >- - #/components/x-stackQL-resources/processor_versions/methods/projects_locations_processors_processor_versions_delete - evaluations: - id: documentai.evaluations - name: evaluations - title: Evaluations + #/components/x-stackQL-resources/processors/methods/projects_locations_processors_delete + human_review_config: + id: google.documentai.human_review_config + name: human_review_config + title: Human_review_config methods: - _projects_locations_processors_processor_versions_evaluations_list: - operation: &ref_5 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}~1evaluations/get - response: &ref_6 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.evaluations - projects_locations_processors_processor_versions_evaluations_list: - operation: *ref_5 - response: *ref_6 - projects_locations_processors_processor_versions_evaluations_get: + projects_locations_processors_human_review_config_review_document: 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}~1humanReviewConfig:reviewDocument/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/evaluations/methods/projects_locations_processors_processor_versions_evaluations_list - - $ref: >- - #/components/x-stackQL-resources/evaluations/methods/projects_locations_processors_processor_versions_evaluations_get + select: [] insert: [] update: [] delete: [] - processors: - id: documentai.processors - name: processors - title: Processors + evaluations: + id: google.documentai.evaluations + name: evaluations + title: Evaluations methods: - _projects_locations_processors_list: + _projects_locations_processors_processor_versions_evaluations_list: operation: &ref_7 $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}~1evaluations/get response: &ref_8 mediaType: application/json openAPIDocKey: '200' - objectKey: $.processors - projects_locations_processors_list: + objectKey: $.evaluations + projects_locations_processors_processor_versions_evaluations_list: operation: *ref_7 response: *ref_8 - 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_get: + projects_locations_processors_processor_versions_evaluations_get: 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~1{processorVersionsId}~1evaluations~1{evaluationsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_delete: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/evaluations/methods/projects_locations_processors_processor_versions_evaluations_get + - $ref: >- + #/components/x-stackQL-resources/evaluations/methods/projects_locations_processors_processor_versions_evaluations_list + insert: [] + update: [] + delete: [] + processor_versions: + id: google.documentai.processor_versions + name: processor_versions + title: Processor_versions + methods: + projects_locations_processors_processor_versions_evaluate_processor_version: 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~1{processorVersionsId}:evaluateProcessorVersion/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_set_default_processor_version: + projects_locations_processors_processor_versions_process: 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}:process/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_enable: + projects_locations_processors_processor_versions_delete: 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}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_process: + projects_locations_processors_processor_versions_get: 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}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_batch_process: + projects_locations_processors_processor_versions_batch_process: 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}:batchProcess/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_disable: + projects_locations_processors_processor_versions_train: 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}~1processorVersions:train/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/processors/methods/projects_locations_processors_list - - $ref: >- - #/components/x-stackQL-resources/processors/methods/projects_locations_processors_get - insert: - - $ref: >- - #/components/x-stackQL-resources/processors/methods/projects_locations_processors_create - update: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/processors/methods/projects_locations_processors_delete - operations: - id: documentai.operations - name: operations - title: Operations - methods: - projects_locations_operations_cancel: + projects_locations_processors_processor_versions_undeploy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/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_operations_list: + _projects_locations_processors_processor_versions_list: operation: &ref_9 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions/get response: &ref_10 mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations - projects_locations_operations_list: + objectKey: $.processorVersions + projects_locations_processors_processor_versions_list: operation: *ref_9 response: *ref_10 - projects_locations_operations_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_operations_get: + projects_locations_processors_processor_versions_deploy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1operations~1{operationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - operations_delete: - operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}/delete' + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:deploy/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get + #/components/x-stackQL-resources/processor_versions/methods/projects_locations_processors_processor_versions_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_operations_get + #/components/x-stackQL-resources/processor_versions/methods/projects_locations_processors_processor_versions_list insert: [] update: [] delete: - $ref: >- - #/components/x-stackQL-resources/operations/methods/operations_delete + #/components/x-stackQL-resources/processor_versions/methods/projects_locations_processors_processor_versions_delete locations: - id: documentai.locations + id: google.documentai.locations name: locations title: Locations methods: + projects_locations_get: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' _projects_locations_list: operation: &ref_11 $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' @@ -7804,38 +7810,36 @@ components: projects_locations_list: operation: *ref_11 response: *ref_12 - projects_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/projects_locations_list - $ref: >- #/components/x-stackQL-resources/locations/methods/projects_locations_get + - $ref: >- + #/components/x-stackQL-resources/locations/methods/projects_locations_list insert: [] update: [] delete: [] paths: - /v1/projects/{projectsId}/locations/{locationsId}/processorTypes/{processorTypesId}: + /v1/operations/{operationsId}: parameters: &ref_13 - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/uploadType' - get: - description: Gets a processor type detail. - operationId: documentai.projects.locations.processorTypes.get + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/_.xgafv' + 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: documentai.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7847,28 +7851,27 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorType' + $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: processorTypesId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processorTypes: + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: parameters: *ref_13 - get: - description: Lists the processor types that exist. - operationId: documentai.projects.locations.processorTypes.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 @@ -7880,8 +7883,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ListProcessorTypesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -7893,29 +7895,18 @@ paths: 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}/processors/{processorsId}/humanReviewConfig:reviewDocument: + /v1/projects/{projectsId}/locations/{locationsId}/operations: parameters: *ref_13 - post: + get: 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 + 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 @@ -7927,7 +7918,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -7939,18 +7930,27 @@ 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}/processorVersions/{processorVersionsId}: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: parameters: *ref_13 - delete: + get: description: >- - Deletes the processor version, all artifacts under the processor version - will be deleted. - operationId: documentai.projects.locations.processors.processorVersions.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: documentai.projects.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7975,18 +7975,15 @@ paths: schema: type: string - in: path - name: processorsId - required: true - schema: - type: string - - in: path - name: processorVersionsId + name: operationsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/processorTypes/{processorTypesId}: + parameters: *ref_13 get: - description: Gets a processor version detail. - operationId: documentai.projects.locations.processors.processorVersions.get + description: Gets a processor type detail. + operationId: documentai.projects.locations.processorTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7998,7 +7995,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersion' + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorType' parameters: - in: path name: projectsId @@ -8011,20 +8008,15 @@ paths: schema: type: string - in: path - name: processorsId - required: true - schema: - type: string - - in: path - name: processorVersionsId + name: processorTypesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions: + /v1/projects/{projectsId}/locations/{locationsId}/processorTypes: parameters: *ref_13 get: - description: Lists all versions of a processor. - operationId: documentai.projects.locations.processors.processorVersions.list + description: Lists the processor types that exist. + operationId: documentai.projects.locations.processorTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8037,20 +8029,15 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ListProcessorVersionsResponse + #/components/schemas/GoogleCloudDocumentaiV1ListProcessorTypesResponse parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: projectsId required: true schema: type: string - in: path - name: processorsId + name: locationsId required: true schema: type: string @@ -8063,16 +8050,18 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:process: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:batchProcess: parameters: *ref_13 post: - description: Processes a single document. - operationId: documentai.projects.locations.processors.processorVersions.process + 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/GoogleCloudDocumentaiV1ProcessRequest' + $ref: '#/components/schemas/GoogleCloudDocumentaiV1BatchProcessRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8084,7 +8073,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -8101,24 +8090,17 @@ paths: required: true schema: type: string - - in: path - name: processorVersionsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions:train: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:enable: parameters: *ref_13 post: - description: >- - Trains a new processor version. Operation metadata is returned as - TrainProcessorVersionMetadata. - operationId: documentai.projects.locations.processors.processorVersions.train + description: Enables a processor + operationId: documentai.projects.locations.processors.enable requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequest + #/components/schemas/GoogleCloudDocumentaiV1EnableProcessorRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8147,18 +8129,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:batchProcess: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}: parameters: *ref_13 - post: + delete: 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' + 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 @@ -8187,22 +8164,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_13 - 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 @@ -8214,7 +8178,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' parameters: - in: path name: projectsId @@ -8231,25 +8195,16 @@ 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}:process: parameters: *ref_13 post: - description: >- - Evaluates a ProcessorVersion against annotated documents, producing an - Evaluation. - operationId: >- - documentai.projects.locations.processors.processorVersions.evaluateProcessorVersion + description: Processes a single document. + operationId: documentai.projects.locations.processors.process requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8261,7 +8216,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessResponse' parameters: - in: path name: projectsId @@ -8278,22 +8233,18 @@ paths: required: true schema: type: string - - in: path - name: processorVersionsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:undeploy: + /v1/projects/{projectsId}/locations/{locationsId}/processors: parameters: *ref_13 post: - description: Undeploys the processor version. - operationId: documentai.projects.locations.processors.processorVersions.undeploy + description: >- + Creates a processor from the ProcessorType provided. The processor will + be at `ENABLED` state by default after its creation. + operationId: documentai.projects.locations.processors.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1UndeployProcessorVersionRequest + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8305,7 +8256,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' parameters: - in: path name: projectsId @@ -8317,22 +8268,9 @@ paths: required: true schema: type: string - - 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/{processorVersionsId}/evaluations: - parameters: *ref_13 get: - description: Retrieves a set of evaluations for a given processor version. - operationId: >- - documentai.projects.locations.processors.processorVersions.evaluations.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 @@ -8345,7 +8283,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ListEvaluationsResponse + #/components/schemas/GoogleCloudDocumentaiV1ListProcessorsResponse parameters: - in: path name: projectsId @@ -8357,16 +8295,6 @@ paths: required: true schema: type: string - - in: path - name: processorsId - required: true - schema: - type: string - - in: path - name: processorVersionsId - required: true - schema: - type: string - in: query name: pageSize schema: @@ -8376,12 +8304,19 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}/evaluations/{evaluationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:setDefaultProcessorVersion: parameters: *ref_13 - get: - description: Retrieves a specific evaluation. - operationId: >- - documentai.projects.locations.processors.processorVersions.evaluations.get + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8393,7 +8328,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Evaluation' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -8410,21 +8345,59 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:disable: + parameters: *ref_13 + 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: processorVersionsId + name: locationsId required: true schema: type: string - in: path - name: evaluationsId + name: processorsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/humanReviewConfig:reviewDocument: parameters: *ref_13 - get: - description: Lists all processors which belong to this project. - operationId: documentai.projects.locations.processors.list + 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 @@ -8436,8 +8409,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ListProcessorsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -8449,25 +8421,17 @@ 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 - post: - description: >- - Creates a processor from the ProcessorType provided. The processor will - be at `ENABLED` state by default after its creation. - operationId: documentai.projects.locations.processors.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}/evaluations: + parameters: *ref_13 + 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 @@ -8479,7 +8443,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ListEvaluationsResponse parameters: - in: path name: projectsId @@ -8491,11 +8456,31 @@ 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 + - 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}/evaluations/{evaluationsId}: parameters: *ref_13 get: - description: Gets a processor detail. - operationId: documentai.projects.locations.processors.get + description: Retrieves a specific evaluation. + operationId: >- + documentai.projects.locations.processors.processorVersions.evaluations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8507,7 +8492,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Evaluation' parameters: - in: path name: projectsId @@ -8524,11 +8509,30 @@ paths: required: true schema: type: string - delete: + - in: path + name: processorVersionsId + required: true + schema: + type: string + - in: path + name: evaluationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:evaluateProcessorVersion: + parameters: *ref_13 + post: 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 + Evaluates a ProcessorVersion against annotated documents, producing an + Evaluation. + operationId: >- + documentai.projects.locations.processors.processorVersions.evaluateProcessorVersion + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8557,19 +8561,21 @@ 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}:process: parameters: *ref_13 post: - description: >- - Set the default (active) version of a Processor that will be used in - ProcessDocument and BatchProcessDocuments. - operationId: documentai.projects.locations.processors.setDefaultProcessorVersion + description: Processes a single document. + operationId: documentai.projects.locations.processors.processorVersions.process requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8581,7 +8587,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessResponse' parameters: - in: path name: projectsId @@ -8598,17 +8604,18 @@ 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}: parameters: *ref_13 - post: - description: Enables a processor - operationId: documentai.projects.locations.processors.enable - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1EnableProcessorRequest + 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 @@ -8637,16 +8644,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:process: - parameters: *ref_13 - post: - description: Processes a single document. - operationId: documentai.projects.locations.processors.process - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessRequest' + - in: path + name: processorVersionsId + required: true + schema: + type: string + get: + description: Gets a processor version detail. + operationId: documentai.projects.locations.processors.processorVersions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8658,7 +8663,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessResponse' + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersion' parameters: - in: path name: projectsId @@ -8675,13 +8680,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:batchProcess: + - in: path + name: processorVersionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:batchProcess: parameters: *ref_13 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 + operationId: documentai.projects.locations.processors.processorVersions.batchProcess requestBody: content: application/json: @@ -8715,17 +8725,24 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:disable: + - in: path + name: processorVersionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions:train: parameters: *ref_13 post: - description: Disables a processor - operationId: documentai.projects.locations.processors.disable + 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/GoogleCloudDocumentaiV1DisableProcessorRequest + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8754,20 +8771,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:undeploy: parameters: *ref_13 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: Undeploys the processor version. + operationId: documentai.projects.locations.processors.processorVersions.undeploy + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1UndeployProcessorVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8779,7 +8793,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -8792,17 +8806,20 @@ paths: schema: type: string - in: path - name: operationsId + name: processorsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations: + - in: path + name: processorVersionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions: parameters: *ref_13 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 all versions of a processor. + operationId: documentai.projects.locations.processors.processorVersions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8814,7 +8831,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ListProcessorVersionsResponse parameters: - in: path name: projectsId @@ -8826,8 +8844,9 @@ paths: required: true schema: type: string - - in: query - name: filter + - in: path + name: processorsId + required: true schema: type: string - in: query @@ -8839,14 +8858,17 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:deploy: parameters: *ref_13 - 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 + post: + description: Deploys the processor version. + operationId: documentai.projects.locations.processors.processorVersions.deploy + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DeployProcessorVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8871,7 +8893,12 @@ paths: schema: type: string - in: path - name: operationsId + name: processorsId + required: true + schema: + type: string + - in: path + name: processorVersionsId required: true schema: type: string @@ -8906,11 +8933,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations: + /v1/projects/{projectsId}/locations/{locationsId}: parameters: *ref_13 get: - description: Lists information about the supported locations for this service. - operationId: documentai.projects.locations.list + description: Gets information about a location. + operationId: documentai.projects.locations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8922,31 +8949,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudLocationListLocationsResponse' + $ref: '#/components/schemas/GoogleCloudLocationLocation' 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: locationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}: + /v1/projects/{projectsId}/locations: parameters: *ref_13 get: - description: Gets information about a location. - operationId: documentai.projects.locations.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 @@ -8958,18 +8977,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudLocationLocation' + $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: filter schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 /v1/projects/{projectsId}/operations/{operationsId}: parameters: *ref_13 get: @@ -9001,30 +9028,3 @@ paths: required: true schema: type: string - /v1/operations/{operationsId}: - parameters: *ref_13 - 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: documentai.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: 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 61742ea6..f2e84886 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/domains.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/domains.yaml @@ -8,7 +8,7 @@ info: description: Enables management and configuration of domain names. version: v1 x-discovery-doc-revision: '20240520' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/domains/ servers: @@ -1909,7 +1909,7 @@ components: - '2' x-stackQL-resources: locations: - id: domains.locations + id: google.domains.locations name: locations title: Locations methods: @@ -1931,13 +1931,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: domains.operations + id: google.domains.operations name: operations title: Operations methods: @@ -1961,13 +1961,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: [] registrations: - id: domains.registrations + id: google.domains.registrations name: registrations title: Registrations methods: @@ -2068,14 +2068,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/registrations/methods/list' - $ref: '#/components/x-stackQL-resources/registrations/methods/get' + - $ref: '#/components/x-stackQL-resources/registrations/methods/list' insert: [] - update: [] + update: + - $ref: '#/components/x-stackQL-resources/registrations/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/registrations/methods/delete' registrations_register_parameters: - id: domains.registrations_register_parameters + id: google.domains.registrations_register_parameters name: registrations_register_parameters title: Registrations_register_parameters methods: @@ -2092,7 +2093,7 @@ components: update: [] delete: [] registrations_transfer_parameters: - id: domains.registrations_transfer_parameters + id: google.domains.registrations_transfer_parameters name: registrations_transfer_parameters title: Registrations_transfer_parameters methods: @@ -2109,7 +2110,7 @@ components: update: [] delete: [] registrations_importable_domains: - id: domains.registrations_importable_domains + id: google.domains.registrations_importable_domains name: registrations_importable_domains title: Registrations_importable_domains methods: @@ -2126,7 +2127,7 @@ components: update: [] delete: [] registrations_authorization_code: - id: domains.registrations_authorization_code + id: google.domains.registrations_authorization_code name: registrations_authorization_code title: Registrations_authorization_code methods: @@ -2143,7 +2144,7 @@ components: update: [] delete: [] registrations_iam_policies: - id: domains.registrations_iam_policies + id: google.domains.registrations_iam_policies name: registrations_iam_policies title: Registrations_iam_policies methods: 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 1687ae1d..9dd1eedc 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/essentialcontacts.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/essentialcontacts.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1 x-discovery-doc-revision: '20240526' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/essentialcontacts/docs/ servers: @@ -34,33 +34,10 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudEssentialcontactsV1ComputeContactsResponse: - description: Response message for the ComputeContacts method. - properties: - 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 - contacts: - items: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' - type: array - description: >- - All contacts for the resource that are subscribed to the specified - notification categories, including contacts inherited from any - parent resources. - type: object - id: GoogleCloudEssentialcontactsV1ComputeContactsResponse GoogleCloudEssentialcontactsV1SendTestMessageRequest: - description: Request message for the SendTestMessage method. - id: GoogleCloudEssentialcontactsV1SendTestMessageRequest - type: object properties: contacts: + type: array description: >- Required. The list of names of the contacts to send a test message to. Format: organizations/{organization_id}/contacts/{contact_id}, @@ -68,9 +45,7 @@ components: projects/{project_id}/contacts/{contact_id} items: type: string - type: array notificationCategory: - type: string enum: - NOTIFICATION_CATEGORY_UNSPECIFIED - ALL @@ -81,6 +56,10 @@ components: - LEGAL - PRODUCT_UPDATES - TECHNICAL_INCIDENTS + description: >- + Required. The notification category to send the test message for. + All contacts must be subscribed to this category. + type: string enumDescriptions: - Notification category is unrecognized or unspecified. - >- @@ -105,41 +84,24 @@ components: - >- Child category of TECHNICAL. If assigned, technical incident notifications will go to these contacts instead of TECHNICAL. - description: >- - Required. The notification category to send the test message for. - All contacts must be subscribed to this category. - 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 + description: Request message for the SendTestMessage method. + id: GoogleCloudEssentialcontactsV1SendTestMessageRequest GoogleCloudEssentialcontactsV1Contact: - description: A contact that will receive notifications from Google Cloud. id: GoogleCloudEssentialcontactsV1Contact - type: object properties: email: type: string description: >- Required. The email address to send notifications to. The email address does not need to be a Google Account. - 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. - format: google-datetime - type: string notificationCategorySubscriptions: type: array description: >- Required. The categories of notifications that the contact will receive communications for. items: + type: string enumDescriptions: - Notification category is unrecognized or unspecified. - >- @@ -174,12 +136,21 @@ components: - LEGAL - PRODUCT_UPDATES - TECHNICAL_INCIDENTS - type: string + name: + description: >- + Output only. The identifier for the contact. Format: + {resource_type}/{resource_id}/contacts/{contact_id} + type: string + readOnly: true + 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 validationState: - enum: - - VALIDATION_STATE_UNSPECIFIED - - VALID - - INVALID + type: string enumDescriptions: - The validation state is unknown or unspecified. - >- @@ -188,23 +159,31 @@ components: - >- The contact is considered invalid. This may become the state if the contact's email is found to be unreachable. + enum: + - VALIDATION_STATE_UNSPECIFIED + - VALID + - INVALID description: >- The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. - type: string - languageTag: + validateTime: 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. - name: - type: string - readOnly: true - description: >- - Output only. The identifier for the contact. Format: - {resource_type}/{resource_id}/contacts/{contact_id} + 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 + description: A contact that will receive notifications from Google Cloud. + 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); } + id: GoogleProtobufEmpty + properties: {} + type: object GoogleCloudEssentialcontactsV1ListContactsResponse: properties: contacts: @@ -223,7 +202,40 @@ components: description: Response message for the ListContacts method. type: object id: GoogleCloudEssentialcontactsV1ListContactsResponse + GoogleCloudEssentialcontactsV1ComputeContactsResponse: + properties: + 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' + 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 + id: GoogleCloudEssentialcontactsV1ComputeContactsResponse + description: Response message for the ComputeContacts method. + type: object parameters: + 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 quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -233,37 +245,44 @@ 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. + alt: + description: Data format for response. in: query - name: key + name: alt schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + enum: + - json + - media + - proto + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: oauth_token + name: uploadType schema: type: string - access_token: - description: OAuth access token. + callback: + description: JSONP in: query - name: access_token + 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 + access_token: + description: OAuth access token. + in: query + name: access_token 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: @@ -275,62 +294,21 @@ components: enum: - '1' - '2' - 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 - 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 x-stackQL-resources: contacts: - id: essentialcontacts.contacts + id: google.essentialcontacts.contacts name: contacts title: Contacts methods: - folders_contacts_compute: - operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts:compute/get' - response: - mediaType: application/json - openAPIDocKey: '200' - folders_contacts_create: - operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts/post' - response: - mediaType: application/json - openAPIDocKey: '200' - _folders_contacts_list: - operation: &ref_1 - $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts/get' - response: &ref_2 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.contacts - folders_contacts_list: - operation: *ref_1 - response: *ref_2 folders_contacts_patch: operation: $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts~1{contactsId}/patch' @@ -355,24 +333,31 @@ components: response: mediaType: application/json openAPIDocKey: '200' - organizations_contacts_delete: + _folders_contacts_list: + operation: &ref_1 + $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts/get' + response: &ref_2 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.contacts + folders_contacts_list: + operation: *ref_1 + response: *ref_2 + folders_contacts_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1contacts~1{contactsId}/delete + $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_contacts_patch: + folders_contacts_compute: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1contacts~1{contactsId}/patch + $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts:compute/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_contacts_get: + organizations_contacts_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1contacts~1{contactsId}/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1contacts/post' response: mediaType: application/json openAPIDocKey: '200' @@ -386,36 +371,38 @@ components: organizations_contacts_list: operation: *ref_3 response: *ref_4 - organizations_contacts_create: + organizations_contacts_delete: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1contacts/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1contacts~1{contactsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_contacts_compute: + organizations_contacts_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1contacts:compute/get + #/paths/~1v1~1organizations~1{organizationsId}~1contacts~1{contactsId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_contacts_send_test_message: + organizations_contacts_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1contacts:sendTestMessage/post + #/paths/~1v1~1organizations~1{organizationsId}~1contacts~1{contactsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_contacts_send_test_message: + organizations_contacts_send_test_message: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1contacts:sendTestMessage/post + #/paths/~1v1~1organizations~1{organizationsId}~1contacts:sendTestMessage/post response: mediaType: application/json openAPIDocKey: '200' - projects_contacts_compute: + organizations_contacts_compute: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts:compute/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1contacts:compute/get response: mediaType: application/json openAPIDocKey: '200' @@ -425,22 +412,22 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_contacts_delete: + projects_contacts_get: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1contacts~1{contactsId}/delete + $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts~1{contactsId}/get' response: mediaType: application/json openAPIDocKey: '200' - projects_contacts_get: + projects_contacts_delete: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts~1{contactsId}/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1contacts~1{contactsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_contacts_create: + projects_contacts_compute: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts/post' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts:compute/get' response: mediaType: application/json openAPIDocKey: '200' @@ -454,18 +441,31 @@ components: projects_contacts_list: operation: *ref_5 response: *ref_6 + projects_contacts_create: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts/post' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_contacts_send_test_message: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1contacts:sendTestMessage/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/contacts/methods/folders_contacts_list - $ref: >- #/components/x-stackQL-resources/contacts/methods/folders_contacts_get - $ref: >- #/components/x-stackQL-resources/contacts/methods/organizations_contacts_get - - $ref: >- - #/components/x-stackQL-resources/contacts/methods/organizations_contacts_list - $ref: >- #/components/x-stackQL-resources/contacts/methods/projects_contacts_get + - $ref: >- + #/components/x-stackQL-resources/contacts/methods/folders_contacts_list + - $ref: >- + #/components/x-stackQL-resources/contacts/methods/organizations_contacts_list - $ref: >- #/components/x-stackQL-resources/contacts/methods/projects_contacts_list insert: @@ -475,7 +475,13 @@ components: #/components/x-stackQL-resources/contacts/methods/organizations_contacts_create - $ref: >- #/components/x-stackQL-resources/contacts/methods/projects_contacts_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/contacts/methods/folders_contacts_patch + - $ref: >- + #/components/x-stackQL-resources/contacts/methods/organizations_contacts_patch + - $ref: >- + #/components/x-stackQL-resources/contacts/methods/projects_contacts_patch delete: - $ref: >- #/components/x-stackQL-resources/contacts/methods/folders_contacts_delete @@ -484,25 +490,27 @@ components: - $ref: >- #/components/x-stackQL-resources/contacts/methods/projects_contacts_delete paths: - /v1/folders/{foldersId}/contacts:compute: + /v1/folders/{foldersId}/contacts/{contactsId}: parameters: &ref_7 - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/alt' - 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 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/key' + patch: + description: 'Updates a contact. Note: A contact''s email address cannot be changed.' + operationId: essentialcontacts.folders.contacts.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -514,37 +522,88 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudEssentialcontactsV1ComputeContactsResponse + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' parameters: - in: path name: foldersId required: true schema: type: string - - in: query - name: pageSize + - in: path + name: contactsId + required: true schema: - type: integer - format: int32 + type: string - in: query - name: notificationCategories + name: updateMask schema: type: string - - in: query - name: pageToken + format: google-fieldmask + delete: + description: Deletes a contact. + operationId: essentialcontacts.folders.contacts.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: foldersId + required: true schema: type: string - /v1/folders/{foldersId}/contacts: + - in: path + name: contactsId + required: true + schema: + type: string + get: + description: Gets a single contact. + operationId: essentialcontacts.folders.contacts.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/GoogleCloudEssentialcontactsV1Contact' + parameters: + - in: path + name: foldersId + required: true + schema: + type: string + - in: path + name: contactsId + required: true + schema: + type: string + /v1/folders/{foldersId}/contacts:sendTestMessage: parameters: *ref_7 post: - description: Adds a new contact for a resource. - operationId: essentialcontacts.folders.contacts.create + 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/GoogleCloudEssentialcontactsV1Contact' + $ref: >- + #/components/schemas/GoogleCloudEssentialcontactsV1SendTestMessageRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -556,13 +615,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: foldersId required: true schema: type: string + /v1/folders/{foldersId}/contacts: + parameters: *ref_7 get: description: Lists the contacts that have been set on a resource. operationId: essentialcontacts.folders.contacts.list @@ -585,20 +646,18 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - /v1/folders/{foldersId}/contacts/{contactsId}: - parameters: *ref_7 - patch: - description: 'Updates a contact. Note: A contact''s email address cannot be changed.' - operationId: essentialcontacts.folders.contacts.patch + - 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: @@ -622,19 +681,14 @@ paths: required: true schema: type: string - - 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.folders.contacts.delete + /v1/folders/{foldersId}/contacts:compute: + parameters: *ref_7 + 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 @@ -646,21 +700,37 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudEssentialcontactsV1ComputeContactsResponse parameters: - in: path name: foldersId required: true schema: type: string - - in: path - name: contactsId - required: true + - in: query + name: pageToken schema: type: string - get: - description: Gets a single contact. - operationId: essentialcontacts.folders.contacts.get + - in: query + name: notificationCategories + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/organizations/{organizationsId}/contacts: + parameters: *ref_7 + 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 @@ -675,28 +745,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 - /v1/folders/{foldersId}/contacts:sendTestMessage: - parameters: *ref_7 - 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 + 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 @@ -708,13 +763,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudEssentialcontactsV1ListContactsResponse parameters: - in: path - name: foldersId + name: organizationsId 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}: parameters: *ref_7 delete: @@ -805,47 +870,19 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/contacts: + /v1/organizations/{organizationsId}/contacts:sendTestMessage: parameters: *ref_7 - 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 - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudEssentialcontactsV1ListContactsResponse - 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 post: - description: Adds a new contact for a resource. - operationId: essentialcontacts.organizations.contacts.create + 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 @@ -857,7 +894,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -904,19 +941,16 @@ paths: schema: type: integer format: int32 - /v1/organizations/{organizationsId}/contacts:sendTestMessage: + /v1/projects/{projectsId}/contacts/{contactsId}: parameters: *ref_7 - 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 + 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/GoogleCloudEssentialcontactsV1SendTestMessageRequest + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -928,52 +962,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/contacts:sendTestMessage: - parameters: *ref_7 - 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/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: projectsId + name: contactsId required: true schema: type: string - /v1/projects/{projectsId}/contacts:compute: - parameters: *ref_7 + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask 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.projects.contacts.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -985,37 +993,21 @@ 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: pageToken - 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 - /v1/projects/{projectsId}/contacts/{contactsId}: - parameters: *ref_7 - 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' + delete: + description: Deletes a contact. + operationId: essentialcontacts.projects.contacts.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1027,7 +1019,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -1039,14 +1031,14 @@ paths: required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a contact. - operationId: essentialcontacts.projects.contacts.delete + /v1/projects/{projectsId}/contacts:compute: + parameters: *ref_7 + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1058,21 +1050,32 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudEssentialcontactsV1ComputeContactsResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: contactsId - required: true + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: notificationCategories schema: type: string + /v1/projects/{projectsId}/contacts: + parameters: *ref_7 get: - description: Gets a single contact. - operationId: essentialcontacts.projects.contacts.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 @@ -1084,20 +1087,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + $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 - /v1/projects/{projectsId}/contacts: - parameters: *ref_7 post: description: Adds a new contact for a resource. operationId: essentialcontacts.projects.contacts.create @@ -1124,9 +1130,19 @@ paths: required: true schema: type: string - get: - description: Lists the contacts that have been set on a resource. - operationId: essentialcontacts.projects.contacts.list + /v1/projects/{projectsId}/contacts:sendTestMessage: + parameters: *ref_7 + 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/GoogleCloudEssentialcontactsV1SendTestMessageRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1138,20 +1154,10 @@ 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 - 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 181ad34e..fd5b737f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/eventarc.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/eventarc.yaml @@ -8,7 +8,7 @@ info: description: Build event-driven applications on Google Cloud Platform. version: v1 x-discovery-doc-revision: '20240524' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/eventarc servers: @@ -1377,7 +1377,7 @@ components: - '2' x-stackQL-resources: google_channel_config: - id: eventarc.google_channel_config + id: google.eventarc.google_channel_config name: google_channel_config title: Google_channel_config methods: @@ -1403,7 +1403,7 @@ components: update: [] delete: [] locations: - id: eventarc.locations + id: google.eventarc.locations name: locations title: Locations methods: @@ -1425,13 +1425,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: eventarc.operations + id: google.eventarc.operations name: operations title: Operations methods: @@ -1469,14 +1469,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' triggers: - id: eventarc.triggers + id: google.eventarc.triggers name: triggers title: Triggers methods: @@ -1525,11 +1525,12 @@ components: - $ref: '#/components/x-stackQL-resources/triggers/methods/list' insert: - $ref: '#/components/x-stackQL-resources/triggers/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/triggers/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/triggers/methods/delete' triggers_iam_policies: - id: eventarc.triggers_iam_policies + id: google.eventarc.triggers_iam_policies name: triggers_iam_policies title: Triggers_iam_policies methods: @@ -1566,7 +1567,7 @@ components: update: [] delete: [] channels: - id: eventarc.channels + id: google.eventarc.channels name: channels title: Channels methods: @@ -1615,11 +1616,12 @@ components: - $ref: '#/components/x-stackQL-resources/channels/methods/list' insert: - $ref: '#/components/x-stackQL-resources/channels/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/channels/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/channels/methods/delete' channels_iam_policies: - id: eventarc.channels_iam_policies + id: google.eventarc.channels_iam_policies name: channels_iam_policies title: Channels_iam_policies methods: @@ -1656,7 +1658,7 @@ components: update: [] delete: [] providers: - id: eventarc.providers + id: google.eventarc.providers name: providers title: Providers methods: @@ -1686,7 +1688,7 @@ components: update: [] delete: [] channel_connections: - id: eventarc.channel_connections + id: google.eventarc.channel_connections name: channel_connections title: Channel_connections methods: @@ -1734,7 +1736,7 @@ components: - $ref: >- #/components/x-stackQL-resources/channel_connections/methods/delete channel_connections_iam_policies: - id: eventarc.channel_connections_iam_policies + id: google.eventarc.channel_connections_iam_policies name: channel_connections_iam_policies title: Channel_connections_iam_policies methods: 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 98f44fb6..6d0b552e 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: '20240511' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/filestore/ servers: @@ -1608,7 +1608,7 @@ components: - '2' x-stackQL-resources: locations: - id: file.locations + id: google.file.locations name: locations title: Locations methods: @@ -1630,13 +1630,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: file.operations + id: google.file.operations name: operations title: Operations methods: @@ -1674,14 +1674,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' instances: - id: file.instances + id: google.file.instances name: instances title: Instances methods: @@ -1740,15 +1740,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/instances/methods/list' - $ref: '#/components/x-stackQL-resources/instances/methods/get' + - $ref: '#/components/x-stackQL-resources/instances/methods/list' insert: - $ref: '#/components/x-stackQL-resources/instances/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/instances/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/instances/methods/delete' snapshots: - id: file.snapshots + id: google.file.snapshots name: snapshots title: Snapshots methods: @@ -1793,15 +1794,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/snapshots/methods/list' - $ref: '#/components/x-stackQL-resources/snapshots/methods/get' + - $ref: '#/components/x-stackQL-resources/snapshots/methods/list' insert: - $ref: '#/components/x-stackQL-resources/snapshots/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/snapshots/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/snapshots/methods/delete' backups: - id: file.backups + id: google.file.backups name: backups title: Backups methods: @@ -1846,11 +1848,12 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/backups/methods/list' - $ref: '#/components/x-stackQL-resources/backups/methods/get' + - $ref: '#/components/x-stackQL-resources/backups/methods/list' insert: - $ref: '#/components/x-stackQL-resources/backups/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/backups/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/backups/methods/delete' paths: 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 9fd75ab6..ff94841b 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/firestore.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/firestore.yaml @@ -10,7 +10,7 @@ info: performance, and ease of application development. version: v1 x-discovery-doc-revision: '20240521' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/firestore servers: @@ -3295,7 +3295,7 @@ components: - '2' x-stackQL-resources: locations: - id: firestore.locations + id: google.firestore.locations name: locations title: Locations methods: @@ -3317,13 +3317,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] backups: - id: firestore.backups + id: google.firestore.backups name: backups title: Backups methods: @@ -3357,7 +3357,7 @@ components: delete: - $ref: '#/components/x-stackQL-resources/backups/methods/delete' databases: - id: firestore.databases + id: google.firestore.databases name: databases title: Databases methods: @@ -3415,15 +3415,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/databases/methods/list' - $ref: '#/components/x-stackQL-resources/databases/methods/get' + - $ref: '#/components/x-stackQL-resources/databases/methods/list' insert: - $ref: '#/components/x-stackQL-resources/databases/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/databases/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/databases/methods/delete' operations: - id: firestore.operations + id: google.firestore.operations name: operations title: Operations methods: @@ -3461,14 +3462,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' indexes: - id: firestore.indexes + id: google.firestore.indexes name: indexes title: Indexes methods: @@ -3506,15 +3507,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/indexes/methods/list' - $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: [] delete: - $ref: '#/components/x-stackQL-resources/indexes/methods/delete' fields: - id: firestore.fields + id: google.firestore.fields name: fields title: Fields methods: @@ -3548,10 +3549,11 @@ components: - $ref: '#/components/x-stackQL-resources/fields/methods/get' - $ref: '#/components/x-stackQL-resources/fields/methods/list' insert: [] - update: [] + update: + - $ref: '#/components/x-stackQL-resources/fields/methods/patch' delete: [] backup_schedules: - id: firestore.backup_schedules + id: google.firestore.backup_schedules name: backup_schedules title: Backup_schedules methods: @@ -3592,15 +3594,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/backup_schedules/methods/list' - $ref: '#/components/x-stackQL-resources/backup_schedules/methods/get' + - $ref: '#/components/x-stackQL-resources/backup_schedules/methods/list' insert: - $ref: '#/components/x-stackQL-resources/backup_schedules/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/backup_schedules/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/backup_schedules/methods/delete' documents: - id: firestore.documents + id: google.firestore.documents name: documents title: Documents methods: @@ -3726,16 +3729,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/documents/methods/get' - $ref: '#/components/x-stackQL-resources/documents/methods/list' + - $ref: '#/components/x-stackQL-resources/documents/methods/get' - $ref: '#/components/x-stackQL-resources/documents/methods/list_documents' insert: - $ref: '#/components/x-stackQL-resources/documents/methods/create_document' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/documents/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/documents/methods/delete' documents_collection_ids: - id: firestore.documents_collection_ids + id: google.firestore.documents_collection_ids name: documents_collection_ids title: Documents_collection_ids methods: 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 0fe7225a..318845aa 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: '20240518' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke servers: @@ -2564,7 +2564,7 @@ components: - '2' x-stackQL-resources: locations: - id: gkebackup.locations + id: google.gkebackup.locations name: locations title: Locations methods: @@ -2586,13 +2586,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: gkebackup.operations + id: google.gkebackup.operations name: operations title: Operations methods: @@ -2630,14 +2630,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' backup_plans: - id: gkebackup.backup_plans + id: google.gkebackup.backup_plans name: backup_plans title: Backup_plans methods: @@ -2682,15 +2682,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/backup_plans/methods/list' - $ref: '#/components/x-stackQL-resources/backup_plans/methods/get' + - $ref: '#/components/x-stackQL-resources/backup_plans/methods/list' insert: - $ref: '#/components/x-stackQL-resources/backup_plans/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/backup_plans/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/backup_plans/methods/delete' backup_plans_iam_policies: - id: gkebackup.backup_plans_iam_policies + id: google.gkebackup.backup_plans_iam_policies name: backup_plans_iam_policies title: Backup_plans_iam_policies methods: @@ -2727,7 +2728,7 @@ components: update: [] delete: [] backups: - id: gkebackup.backups + id: google.gkebackup.backups name: backups title: Backups methods: @@ -2772,15 +2773,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/backups/methods/list' - $ref: '#/components/x-stackQL-resources/backups/methods/get' + - $ref: '#/components/x-stackQL-resources/backups/methods/list' insert: - $ref: '#/components/x-stackQL-resources/backups/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/backups/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/backups/methods/delete' backups_backup_index_download_url: - id: gkebackup.backups_backup_index_download_url + id: google.gkebackup.backups_backup_index_download_url name: backups_backup_index_download_url title: Backups_backup_index_download_url methods: @@ -2799,7 +2801,7 @@ components: update: [] delete: [] backups_iam_policies: - id: gkebackup.backups_iam_policies + id: google.gkebackup.backups_iam_policies name: backups_iam_policies title: Backups_iam_policies methods: @@ -2836,7 +2838,7 @@ components: update: [] delete: [] volume_backups: - id: gkebackup.volume_backups + id: google.gkebackup.volume_backups name: volume_backups title: Volume_backups methods: @@ -2860,13 +2862,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/volume_backups/methods/list' - $ref: '#/components/x-stackQL-resources/volume_backups/methods/get' + - $ref: '#/components/x-stackQL-resources/volume_backups/methods/list' insert: [] update: [] delete: [] volume_backups_iam_policies: - id: gkebackup.volume_backups_iam_policies + id: google.gkebackup.volume_backups_iam_policies name: volume_backups_iam_policies title: Volume_backups_iam_policies methods: @@ -2903,7 +2905,7 @@ components: update: [] delete: [] restore_plans: - id: gkebackup.restore_plans + id: google.gkebackup.restore_plans name: restore_plans title: Restore_plans methods: @@ -2948,15 +2950,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/restore_plans/methods/list' - $ref: '#/components/x-stackQL-resources/restore_plans/methods/get' + - $ref: '#/components/x-stackQL-resources/restore_plans/methods/list' insert: - $ref: '#/components/x-stackQL-resources/restore_plans/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/restore_plans/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/restore_plans/methods/delete' restore_plans_iam_policies: - id: gkebackup.restore_plans_iam_policies + id: google.gkebackup.restore_plans_iam_policies name: restore_plans_iam_policies title: Restore_plans_iam_policies methods: @@ -2993,7 +2996,7 @@ components: update: [] delete: [] restores: - id: gkebackup.restores + id: google.gkebackup.restores name: restores title: Restores methods: @@ -3038,15 +3041,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/restores/methods/list' - $ref: '#/components/x-stackQL-resources/restores/methods/get' + - $ref: '#/components/x-stackQL-resources/restores/methods/list' insert: - $ref: '#/components/x-stackQL-resources/restores/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/restores/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/restores/methods/delete' restores_iam_policies: - id: gkebackup.restores_iam_policies + id: google.gkebackup.restores_iam_policies name: restores_iam_policies title: Restores_iam_policies methods: @@ -3083,7 +3087,7 @@ components: update: [] delete: [] volume_restores: - id: gkebackup.volume_restores + id: google.gkebackup.volume_restores name: volume_restores title: Volume_restores methods: @@ -3107,13 +3111,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/volume_restores/methods/list' - $ref: '#/components/x-stackQL-resources/volume_restores/methods/get' + - $ref: '#/components/x-stackQL-resources/volume_restores/methods/list' insert: [] update: [] delete: [] volume_restores_iam_policies: - id: gkebackup.volume_restores_iam_policies + id: google.gkebackup.volume_restores_iam_policies name: volume_restores_iam_policies title: Volume_restores_iam_policies methods: 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 c63fb8a3..dbcacd7e 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/gkehub.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/gkehub.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1 x-discovery-doc-revision: '20240519' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: >- https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster @@ -4390,7 +4390,7 @@ components: - '2' x-stackQL-resources: locations: - id: gkehub.locations + id: google.gkehub.locations name: locations title: Locations methods: @@ -4412,15 +4412,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/locations/methods/projects_locations_list - $ref: >- #/components/x-stackQL-resources/locations/methods/projects_locations_get + - $ref: >- + #/components/x-stackQL-resources/locations/methods/projects_locations_list insert: [] update: [] delete: [] operations: - id: gkehub.operations + id: google.gkehub.operations name: operations title: Operations methods: @@ -4458,17 +4458,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list insert: [] update: [] delete: - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_delete memberships: - id: gkehub.memberships + id: google.gkehub.memberships name: memberships title: Memberships methods: @@ -4520,19 +4520,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/memberships/methods/projects_locations_memberships_list - $ref: >- #/components/x-stackQL-resources/memberships/methods/projects_locations_memberships_get + - $ref: >- + #/components/x-stackQL-resources/memberships/methods/projects_locations_memberships_list insert: - $ref: >- #/components/x-stackQL-resources/memberships/methods/projects_locations_memberships_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/memberships/methods/projects_locations_memberships_patch delete: - $ref: >- #/components/x-stackQL-resources/memberships/methods/projects_locations_memberships_delete memberships_iam_policies: - id: gkehub.memberships_iam_policies + id: google.gkehub.memberships_iam_policies name: memberships_iam_policies title: Memberships_iam_policies methods: @@ -4569,7 +4571,7 @@ components: update: [] delete: [] bindings: - id: gkehub.bindings + id: google.gkehub.bindings name: bindings title: Bindings methods: @@ -4621,12 +4623,14 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/bindings/methods/projects_locations_memberships_bindings_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/bindings/methods/projects_locations_memberships_bindings_patch delete: - $ref: >- #/components/x-stackQL-resources/bindings/methods/projects_locations_memberships_bindings_delete scopes_memberships: - id: gkehub.scopes_memberships + id: google.gkehub.scopes_memberships name: scopes_memberships title: Scopes_memberships methods: @@ -4649,7 +4653,7 @@ components: update: [] delete: [] scopes: - id: gkehub.scopes + id: google.gkehub.scopes name: scopes title: Scopes methods: @@ -4701,12 +4705,14 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/scopes/methods/projects_locations_scopes_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/scopes/methods/projects_locations_scopes_patch delete: - $ref: >- #/components/x-stackQL-resources/scopes/methods/projects_locations_scopes_delete scopes_permitted: - id: gkehub.scopes_permitted + id: google.gkehub.scopes_permitted name: scopes_permitted title: Scopes_permitted methods: @@ -4729,7 +4735,7 @@ components: update: [] delete: [] scopes_iam_policies: - id: gkehub.scopes_iam_policies + id: google.gkehub.scopes_iam_policies name: scopes_iam_policies title: Scopes_iam_policies methods: @@ -4766,7 +4772,7 @@ components: update: [] delete: [] namespaces: - id: gkehub.namespaces + id: google.gkehub.namespaces name: namespaces title: Namespaces methods: @@ -4818,12 +4824,14 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/namespaces/methods/projects_locations_scopes_namespaces_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/namespaces/methods/projects_locations_scopes_namespaces_patch delete: - $ref: >- #/components/x-stackQL-resources/namespaces/methods/projects_locations_scopes_namespaces_delete rbacrolebindings: - id: gkehub.rbacrolebindings + id: google.gkehub.rbacrolebindings name: rbacrolebindings title: Rbacrolebindings methods: @@ -4875,12 +4883,14 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/rbacrolebindings/methods/projects_locations_scopes_rbacrolebindings_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/rbacrolebindings/methods/projects_locations_scopes_rbacrolebindings_patch delete: - $ref: >- #/components/x-stackQL-resources/rbacrolebindings/methods/projects_locations_scopes_rbacrolebindings_delete features: - id: gkehub.features + id: google.gkehub.features name: features title: Features methods: @@ -4925,19 +4935,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/features/methods/projects_locations_features_list - $ref: >- #/components/x-stackQL-resources/features/methods/projects_locations_features_get + - $ref: >- + #/components/x-stackQL-resources/features/methods/projects_locations_features_list insert: - $ref: >- #/components/x-stackQL-resources/features/methods/projects_locations_features_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/features/methods/projects_locations_features_patch delete: - $ref: >- #/components/x-stackQL-resources/features/methods/projects_locations_features_delete features_iam_policies: - id: gkehub.features_iam_policies + id: google.gkehub.features_iam_policies name: features_iam_policies title: Features_iam_policies methods: @@ -4974,7 +4986,7 @@ components: update: [] delete: [] fleets: - id: gkehub.fleets + id: google.gkehub.fleets name: fleets title: Fleets methods: @@ -5030,16 +5042,18 @@ components: response: *ref_30 sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/fleets/methods/projects_locations_fleets_list - $ref: >- #/components/x-stackQL-resources/fleets/methods/projects_locations_fleets_get + - $ref: >- + #/components/x-stackQL-resources/fleets/methods/projects_locations_fleets_list - $ref: >- #/components/x-stackQL-resources/fleets/methods/organizations_locations_fleets_list insert: - $ref: >- #/components/x-stackQL-resources/fleets/methods/projects_locations_fleets_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/fleets/methods/projects_locations_fleets_patch delete: - $ref: >- #/components/x-stackQL-resources/fleets/methods/projects_locations_fleets_delete 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 64249f97..f66a1543 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/gkeonprem.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/gkeonprem.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1 x-discovery-doc-revision: '20240228' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/anthos/clusters/docs/on-prem/ servers: @@ -3967,7 +3967,7 @@ components: - '2' x-stackQL-resources: locations: - id: gkeonprem.locations + id: google.gkeonprem.locations name: locations title: Locations methods: @@ -3989,15 +3989,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/locations/methods/projects_locations_list - $ref: >- #/components/x-stackQL-resources/locations/methods/projects_locations_get + - $ref: >- + #/components/x-stackQL-resources/locations/methods/projects_locations_list insert: [] update: [] delete: [] operations: - id: gkeonprem.operations + id: google.gkeonprem.operations name: operations title: Operations methods: @@ -4144,40 +4144,40 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get + #/components/x-stackQL-resources/operations/methods/projects_locations_bare_metal_clusters_bare_metal_node_pools_operations_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_bare_metal_clusters_operations_list + #/components/x-stackQL-resources/operations/methods/projects_locations_vmware_clusters_vmware_node_pools_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_bare_metal_clusters_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_bare_metal_clusters_bare_metal_node_pools_operations_list - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_bare_metal_clusters_bare_metal_node_pools_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_vmware_clusters_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_vmware_clusters_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_vmware_clusters_vmware_node_pools_operations_list - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_vmware_clusters_vmware_node_pools_operations_get + #/components/x-stackQL-resources/operations/methods/projects_locations_vmware_admin_clusters_operations_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_vmware_admin_clusters_operations_list + #/components/x-stackQL-resources/operations/methods/projects_locations_bare_metal_admin_clusters_operations_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_vmware_admin_clusters_operations_get + #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_bare_metal_clusters_operations_list + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_vmware_clusters_operations_list + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_vmware_admin_clusters_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_bare_metal_admin_clusters_operations_list - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_bare_metal_admin_clusters_operations_get + #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list insert: [] update: [] delete: - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_delete bare_metal_clusters: - id: gkeonprem.bare_metal_clusters + id: google.gkeonprem.bare_metal_clusters name: bare_metal_clusters title: Bare_metal_clusters methods: @@ -4243,19 +4243,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/bare_metal_clusters/methods/projects_locations_bare_metal_clusters_list - $ref: >- #/components/x-stackQL-resources/bare_metal_clusters/methods/projects_locations_bare_metal_clusters_get + - $ref: >- + #/components/x-stackQL-resources/bare_metal_clusters/methods/projects_locations_bare_metal_clusters_list insert: - $ref: >- #/components/x-stackQL-resources/bare_metal_clusters/methods/projects_locations_bare_metal_clusters_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/bare_metal_clusters/methods/projects_locations_bare_metal_clusters_patch delete: - $ref: >- #/components/x-stackQL-resources/bare_metal_clusters/methods/projects_locations_bare_metal_clusters_delete bare_metal_clusters_iam_policies: - id: gkeonprem.bare_metal_clusters_iam_policies + id: google.gkeonprem.bare_metal_clusters_iam_policies name: bare_metal_clusters_iam_policies title: Bare_metal_clusters_iam_policies methods: @@ -4292,7 +4294,7 @@ components: update: [] delete: [] bare_metal_node_pools: - id: gkeonprem.bare_metal_node_pools + id: google.gkeonprem.bare_metal_node_pools name: bare_metal_node_pools title: Bare_metal_node_pools methods: @@ -4351,19 +4353,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/bare_metal_node_pools/methods/projects_locations_bare_metal_clusters_bare_metal_node_pools_list - $ref: >- #/components/x-stackQL-resources/bare_metal_node_pools/methods/projects_locations_bare_metal_clusters_bare_metal_node_pools_get + - $ref: >- + #/components/x-stackQL-resources/bare_metal_node_pools/methods/projects_locations_bare_metal_clusters_bare_metal_node_pools_list insert: - $ref: >- #/components/x-stackQL-resources/bare_metal_node_pools/methods/projects_locations_bare_metal_clusters_bare_metal_node_pools_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/bare_metal_node_pools/methods/projects_locations_bare_metal_clusters_bare_metal_node_pools_patch delete: - $ref: >- #/components/x-stackQL-resources/bare_metal_node_pools/methods/projects_locations_bare_metal_clusters_bare_metal_node_pools_delete bare_metal_node_pools_iam_policies: - id: gkeonprem.bare_metal_node_pools_iam_policies + id: google.gkeonprem.bare_metal_node_pools_iam_policies name: bare_metal_node_pools_iam_policies title: Bare_metal_node_pools_iam_policies methods: @@ -4400,7 +4404,7 @@ components: update: [] delete: [] vmware_clusters: - id: gkeonprem.vmware_clusters + id: google.gkeonprem.vmware_clusters name: vmware_clusters title: Vmware_clusters methods: @@ -4466,19 +4470,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/vmware_clusters/methods/projects_locations_vmware_clusters_list - $ref: >- #/components/x-stackQL-resources/vmware_clusters/methods/projects_locations_vmware_clusters_get + - $ref: >- + #/components/x-stackQL-resources/vmware_clusters/methods/projects_locations_vmware_clusters_list insert: - $ref: >- #/components/x-stackQL-resources/vmware_clusters/methods/projects_locations_vmware_clusters_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/vmware_clusters/methods/projects_locations_vmware_clusters_patch delete: - $ref: >- #/components/x-stackQL-resources/vmware_clusters/methods/projects_locations_vmware_clusters_delete vmware_clusters_iam_policies: - id: gkeonprem.vmware_clusters_iam_policies + id: google.gkeonprem.vmware_clusters_iam_policies name: vmware_clusters_iam_policies title: Vmware_clusters_iam_policies methods: @@ -4515,7 +4521,7 @@ components: update: [] delete: [] vmware_node_pools: - id: gkeonprem.vmware_node_pools + id: google.gkeonprem.vmware_node_pools name: vmware_node_pools title: Vmware_node_pools methods: @@ -4574,19 +4580,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/vmware_node_pools/methods/projects_locations_vmware_clusters_vmware_node_pools_list - $ref: >- #/components/x-stackQL-resources/vmware_node_pools/methods/projects_locations_vmware_clusters_vmware_node_pools_get + - $ref: >- + #/components/x-stackQL-resources/vmware_node_pools/methods/projects_locations_vmware_clusters_vmware_node_pools_list insert: - $ref: >- #/components/x-stackQL-resources/vmware_node_pools/methods/projects_locations_vmware_clusters_vmware_node_pools_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/vmware_node_pools/methods/projects_locations_vmware_clusters_vmware_node_pools_patch delete: - $ref: >- #/components/x-stackQL-resources/vmware_node_pools/methods/projects_locations_vmware_clusters_vmware_node_pools_delete vmware_node_pools_iam_policies: - id: gkeonprem.vmware_node_pools_iam_policies + id: google.gkeonprem.vmware_node_pools_iam_policies name: vmware_node_pools_iam_policies title: Vmware_node_pools_iam_policies methods: @@ -4623,7 +4631,7 @@ components: update: [] delete: [] vmware_admin_clusters: - id: gkeonprem.vmware_admin_clusters + id: google.gkeonprem.vmware_admin_clusters name: vmware_admin_clusters title: Vmware_admin_clusters methods: @@ -4668,15 +4676,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/vmware_admin_clusters/methods/projects_locations_vmware_admin_clusters_list - $ref: >- #/components/x-stackQL-resources/vmware_admin_clusters/methods/projects_locations_vmware_admin_clusters_get + - $ref: >- + #/components/x-stackQL-resources/vmware_admin_clusters/methods/projects_locations_vmware_admin_clusters_list insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/vmware_admin_clusters/methods/projects_locations_vmware_admin_clusters_patch delete: [] vmware_admin_clusters_iam_policies: - id: gkeonprem.vmware_admin_clusters_iam_policies + id: google.gkeonprem.vmware_admin_clusters_iam_policies name: vmware_admin_clusters_iam_policies title: Vmware_admin_clusters_iam_policies methods: @@ -4713,7 +4723,7 @@ components: update: [] delete: [] bare_metal_admin_clusters: - id: gkeonprem.bare_metal_admin_clusters + id: google.gkeonprem.bare_metal_admin_clusters name: bare_metal_admin_clusters title: Bare_metal_admin_clusters methods: @@ -4772,17 +4782,19 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/bare_metal_admin_clusters/methods/projects_locations_bare_metal_admin_clusters_list - $ref: >- #/components/x-stackQL-resources/bare_metal_admin_clusters/methods/projects_locations_bare_metal_admin_clusters_get + - $ref: >- + #/components/x-stackQL-resources/bare_metal_admin_clusters/methods/projects_locations_bare_metal_admin_clusters_list insert: - $ref: >- #/components/x-stackQL-resources/bare_metal_admin_clusters/methods/projects_locations_bare_metal_admin_clusters_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/bare_metal_admin_clusters/methods/projects_locations_bare_metal_admin_clusters_patch delete: [] bare_metal_admin_clusters_iam_policies: - id: gkeonprem.bare_metal_admin_clusters_iam_policies + id: google.gkeonprem.bare_metal_admin_clusters_iam_policies name: bare_metal_admin_clusters_iam_policies title: Bare_metal_admin_clusters_iam_policies methods: 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 a71223d7..af0cefcc 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: '20240521' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/healthcare servers: @@ -4130,7 +4130,7 @@ components: - '2' x-stackQL-resources: locations: - id: healthcare.locations + id: google.healthcare.locations name: locations title: Locations methods: @@ -4152,13 +4152,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] datasets_iam_policies: - id: healthcare.datasets_iam_policies + id: google.healthcare.datasets_iam_policies name: datasets_iam_policies title: Datasets_iam_policies methods: @@ -4195,7 +4195,7 @@ components: update: [] delete: [] datasets: - id: healthcare.datasets + id: google.healthcare.datasets name: datasets title: Datasets methods: @@ -4247,15 +4247,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/datasets/methods/list' - $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: [] + update: + - $ref: '#/components/x-stackQL-resources/datasets/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/datasets/methods/delete' consent_stores_iam_policies: - id: healthcare.consent_stores_iam_policies + id: google.healthcare.consent_stores_iam_policies name: consent_stores_iam_policies title: Consent_stores_iam_policies methods: @@ -4292,7 +4293,7 @@ components: update: [] delete: [] consent_stores: - id: healthcare.consent_stores + id: google.healthcare.consent_stores name: consent_stores title: Consent_stores methods: @@ -4358,15 +4359,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/consent_stores/methods/list' - $ref: '#/components/x-stackQL-resources/consent_stores/methods/get' + - $ref: '#/components/x-stackQL-resources/consent_stores/methods/list' insert: - $ref: '#/components/x-stackQL-resources/consent_stores/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/consent_stores/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/consent_stores/methods/delete' attribute_definitions: - id: healthcare.attribute_definitions + id: google.healthcare.attribute_definitions name: attribute_definitions title: Attribute_definitions methods: @@ -4411,18 +4413,20 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/attribute_definitions/methods/get' - $ref: >- #/components/x-stackQL-resources/attribute_definitions/methods/list - - $ref: '#/components/x-stackQL-resources/attribute_definitions/methods/get' insert: - $ref: >- #/components/x-stackQL-resources/attribute_definitions/methods/create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/attribute_definitions/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/attribute_definitions/methods/delete consent_artifacts: - id: healthcare.consent_artifacts + id: google.healthcare.consent_artifacts name: consent_artifacts title: Consent_artifacts methods: @@ -4460,15 +4464,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/consent_artifacts/methods/list' - $ref: '#/components/x-stackQL-resources/consent_artifacts/methods/get' + - $ref: '#/components/x-stackQL-resources/consent_artifacts/methods/list' insert: - $ref: '#/components/x-stackQL-resources/consent_artifacts/methods/create' update: [] delete: - $ref: '#/components/x-stackQL-resources/consent_artifacts/methods/delete' consents: - id: healthcare.consents + id: google.healthcare.consents name: consents title: Consents methods: @@ -4534,15 +4538,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/consents/methods/list' - $ref: '#/components/x-stackQL-resources/consents/methods/get' + - $ref: '#/components/x-stackQL-resources/consents/methods/list' insert: - $ref: '#/components/x-stackQL-resources/consents/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/consents/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/consents/methods/delete' consents_revision: - id: healthcare.consents_revision + id: google.healthcare.consents_revision name: consents_revision title: Consents_revision methods: @@ -4561,7 +4566,7 @@ components: - $ref: >- #/components/x-stackQL-resources/consents_revision/methods/delete_revision consents_revisions: - id: healthcare.consents_revisions + id: google.healthcare.consents_revisions name: consents_revisions title: Consents_revisions methods: @@ -4584,7 +4589,7 @@ components: update: [] delete: [] user_data_mappings: - id: healthcare.user_data_mappings + id: google.healthcare.user_data_mappings name: user_data_mappings title: User_data_mappings methods: @@ -4636,15 +4641,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/user_data_mappings/methods/list' - $ref: '#/components/x-stackQL-resources/user_data_mappings/methods/get' + - $ref: '#/components/x-stackQL-resources/user_data_mappings/methods/list' insert: - $ref: '#/components/x-stackQL-resources/user_data_mappings/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/user_data_mappings/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/user_data_mappings/methods/delete' data_mapper_workspaces_iam_policies: - id: healthcare.data_mapper_workspaces_iam_policies + id: google.healthcare.data_mapper_workspaces_iam_policies name: data_mapper_workspaces_iam_policies title: Data_mapper_workspaces_iam_policies methods: @@ -4681,7 +4687,7 @@ components: update: [] delete: [] dicom_stores_iam_policies: - id: healthcare.dicom_stores_iam_policies + id: google.healthcare.dicom_stores_iam_policies name: dicom_stores_iam_policies title: Dicom_stores_iam_policies methods: @@ -4718,7 +4724,7 @@ components: update: [] delete: [] dicom_stores: - id: healthcare.dicom_stores + id: google.healthcare.dicom_stores name: dicom_stores title: Dicom_stores methods: @@ -4812,15 +4818,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/dicom_stores/methods/list' - $ref: '#/components/x-stackQL-resources/dicom_stores/methods/get' + - $ref: '#/components/x-stackQL-resources/dicom_stores/methods/list' insert: - $ref: '#/components/x-stackQL-resources/dicom_stores/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/dicom_stores/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/dicom_stores/methods/delete' dicom_stores_dicomstore_metrics: - id: healthcare.dicom_stores_dicomstore_metrics + id: google.healthcare.dicom_stores_dicomstore_metrics name: dicom_stores_dicomstore_metrics title: Dicom_stores_dicomstore_metrics methods: @@ -4839,7 +4846,7 @@ components: update: [] delete: [] studies_study: - id: healthcare.studies_study + id: google.healthcare.studies_study name: studies_study title: Studies_study methods: @@ -4856,7 +4863,7 @@ components: update: [] delete: [] studies: - id: healthcare.studies + id: google.healthcare.studies name: studies title: Studies methods: @@ -4895,7 +4902,7 @@ components: delete: - $ref: '#/components/x-stackQL-resources/studies/methods/delete' studies_metadata: - id: healthcare.studies_metadata + id: google.healthcare.studies_metadata name: studies_metadata title: Studies_metadata methods: @@ -4912,7 +4919,7 @@ components: update: [] delete: [] series_series: - id: healthcare.series_series + id: google.healthcare.series_series name: series_series title: Series_series methods: @@ -4929,7 +4936,7 @@ components: update: [] delete: [] series: - id: healthcare.series + id: google.healthcare.series name: series title: Series methods: @@ -4954,7 +4961,7 @@ components: delete: - $ref: '#/components/x-stackQL-resources/series/methods/delete' series_metadata: - id: healthcare.series_metadata + id: google.healthcare.series_metadata name: series_metadata title: Series_metadata methods: @@ -4971,7 +4978,7 @@ components: update: [] delete: [] instances_instance: - id: healthcare.instances_instance + id: google.healthcare.instances_instance name: instances_instance title: Instances_instance methods: @@ -4988,7 +4995,7 @@ components: update: [] delete: [] instances: - id: healthcare.instances + id: google.healthcare.instances name: instances title: Instances methods: @@ -5006,7 +5013,7 @@ components: delete: - $ref: '#/components/x-stackQL-resources/instances/methods/delete' instances_rendered: - id: healthcare.instances_rendered + id: google.healthcare.instances_rendered name: instances_rendered title: Instances_rendered methods: @@ -5023,7 +5030,7 @@ components: update: [] delete: [] instances_metadata: - id: healthcare.instances_metadata + id: google.healthcare.instances_metadata name: instances_metadata title: Instances_metadata methods: @@ -5040,7 +5047,7 @@ components: update: [] delete: [] frames_frames: - id: healthcare.frames_frames + id: google.healthcare.frames_frames name: frames_frames title: Frames_frames methods: @@ -5057,7 +5064,7 @@ components: update: [] delete: [] frames_rendered: - id: healthcare.frames_rendered + id: google.healthcare.frames_rendered name: frames_rendered title: Frames_rendered methods: @@ -5074,7 +5081,7 @@ components: update: [] delete: [] studies_study_metrics: - id: healthcare.studies_study_metrics + id: google.healthcare.studies_study_metrics name: studies_study_metrics title: Studies_study_metrics methods: @@ -5093,7 +5100,7 @@ components: update: [] delete: [] series_series_metrics: - id: healthcare.series_series_metrics + id: google.healthcare.series_series_metrics name: series_series_metrics title: Series_series_metrics methods: @@ -5112,7 +5119,7 @@ components: update: [] delete: [] hl7_v2_stores_iam_policies: - id: healthcare.hl7_v2_stores_iam_policies + id: google.healthcare.hl7_v2_stores_iam_policies name: hl7_v2_stores_iam_policies title: Hl7_v2_stores_iam_policies methods: @@ -5149,7 +5156,7 @@ components: update: [] delete: [] hl7_v2_stores: - id: healthcare.hl7_v2_stores + id: google.healthcare.hl7_v2_stores name: hl7_v2_stores title: Hl7_v2_stores methods: @@ -5208,15 +5215,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/hl7_v2_stores/methods/list' - $ref: '#/components/x-stackQL-resources/hl7_v2_stores/methods/get' + - $ref: '#/components/x-stackQL-resources/hl7_v2_stores/methods/list' insert: - $ref: '#/components/x-stackQL-resources/hl7_v2_stores/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/hl7_v2_stores/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/hl7_v2_stores/methods/delete' hl7_v2_stores_hl7v2_store_metrics: - id: healthcare.hl7_v2_stores_hl7v2_store_metrics + id: google.healthcare.hl7_v2_stores_hl7v2_store_metrics name: hl7_v2_stores_hl7v2_store_metrics title: Hl7_v2_stores_hl7v2_store_metrics methods: @@ -5235,7 +5243,7 @@ components: update: [] delete: [] messages: - id: healthcare.messages + id: google.healthcare.messages name: messages title: Messages methods: @@ -5287,15 +5295,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/messages/methods/list' - $ref: '#/components/x-stackQL-resources/messages/methods/get' + - $ref: '#/components/x-stackQL-resources/messages/methods/list' insert: - $ref: '#/components/x-stackQL-resources/messages/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/messages/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/messages/methods/delete' fhir_stores_iam_policies: - id: healthcare.fhir_stores_iam_policies + id: google.healthcare.fhir_stores_iam_policies name: fhir_stores_iam_policies title: Fhir_stores_iam_policies methods: @@ -5332,7 +5341,7 @@ components: update: [] delete: [] fhir_stores: - id: healthcare.fhir_stores + id: google.healthcare.fhir_stores name: fhir_stores title: Fhir_stores methods: @@ -5405,15 +5414,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/fhir_stores/methods/list' - $ref: '#/components/x-stackQL-resources/fhir_stores/methods/get' + - $ref: '#/components/x-stackQL-resources/fhir_stores/methods/list' insert: - $ref: '#/components/x-stackQL-resources/fhir_stores/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/fhir_stores/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/fhir_stores/methods/delete' fhir_stores_fhirstore_metrics: - id: healthcare.fhir_stores_fhirstore_metrics + id: google.healthcare.fhir_stores_fhirstore_metrics name: fhir_stores_fhirstore_metrics title: Fhir_stores_fhirstore_metrics methods: @@ -5432,7 +5442,7 @@ components: update: [] delete: [] fhir: - id: healthcare.fhir + id: google.healthcare.fhir name: fhir title: Fhir methods: @@ -5559,11 +5569,13 @@ components: select: [] insert: - $ref: '#/components/x-stackQL-resources/fhir/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/fhir/methods/update' + - $ref: '#/components/x-stackQL-resources/fhir/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/fhir/methods/delete' operations: - id: healthcare.operations + id: google.healthcare.operations name: operations title: Operations methods: @@ -5594,13 +5606,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: [] nlp: - id: healthcare.nlp + id: google.healthcare.nlp name: nlp title: Nlp methods: 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 cfcd2076..66d319ce 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/iam.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/iam.yaml @@ -13,7 +13,7 @@ info: this API doesn't disable the IAM Service Account Credentials API. version: v2 x-discovery-doc-revision: '20240523' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/iam/ servers: @@ -618,7 +618,7 @@ components: - '2' x-stackQL-resources: policies: - id: iam.policies + id: google.iam.policies name: policies title: Policies methods: @@ -661,15 +661,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/policies/methods/list_policies' - $ref: '#/components/x-stackQL-resources/policies/methods/get' + - $ref: '#/components/x-stackQL-resources/policies/methods/list_policies' insert: - $ref: '#/components/x-stackQL-resources/policies/methods/create_policy' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/policies/methods/update' delete: - $ref: '#/components/x-stackQL-resources/policies/methods/delete' operations: - id: iam.operations + id: google.iam.operations name: operations title: Operations methods: 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 2cd3dd87..a8014b84 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: '20240521' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: >- https://cloud.google.com/iam/docs/creating-short-lived-service-account-credentials @@ -315,7 +315,7 @@ components: - '2' x-stackQL-resources: service_accounts: - id: iamcredentials.service_accounts + id: google.iamcredentials.service_accounts name: service_accounts title: Service_accounts methods: 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 98f55ad8..90ac1723 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: '20240527' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/iap servers: @@ -1001,7 +1001,7 @@ components: - '2' x-stackQL-resources: iap_iam_policies: - id: iap.iap_iam_policies + id: google.iap.iap_iam_policies name: iap_iam_policies title: Iap_iam_policies methods: @@ -1035,7 +1035,7 @@ components: update: [] delete: [] iap_iap_settings: - id: iap.iap_iap_settings + id: google.iap.iap_iap_settings name: iap_iap_settings title: Iap_iap_settings methods: @@ -1059,7 +1059,7 @@ components: update: [] delete: [] iap: - id: iap.iap + id: google.iap.iap name: iap title: Iap methods: @@ -1075,7 +1075,7 @@ components: update: [] delete: [] dest_groups: - id: iap.dest_groups + id: google.iap.dest_groups name: dest_groups title: Dest_groups methods: @@ -1120,15 +1120,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/dest_groups/methods/list' - $ref: '#/components/x-stackQL-resources/dest_groups/methods/get' + - $ref: '#/components/x-stackQL-resources/dest_groups/methods/list' insert: - $ref: '#/components/x-stackQL-resources/dest_groups/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/dest_groups/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/dest_groups/methods/delete' brands: - id: iap.brands + id: google.iap.brands name: brands title: Brands methods: @@ -1152,14 +1153,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/brands/methods/list' - $ref: '#/components/x-stackQL-resources/brands/methods/get' + - $ref: '#/components/x-stackQL-resources/brands/methods/list' insert: - $ref: '#/components/x-stackQL-resources/brands/methods/create' update: [] delete: [] identity_aware_proxy_clients: - id: iap.identity_aware_proxy_clients + id: google.iap.identity_aware_proxy_clients name: identity_aware_proxy_clients title: Identity_aware_proxy_clients methods: @@ -1204,10 +1205,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/identity_aware_proxy_clients/methods/list - $ref: >- #/components/x-stackQL-resources/identity_aware_proxy_clients/methods/get + - $ref: >- + #/components/x-stackQL-resources/identity_aware_proxy_clients/methods/list insert: - $ref: >- #/components/x-stackQL-resources/identity_aware_proxy_clients/methods/create 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 638793b2..6f9ba624 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-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://developers.google.com/identity-toolkit/v3/ servers: @@ -1524,7 +1524,7 @@ components: type: string x-stackQL-resources: relyingparty_auth_uri: - id: identitytoolkit.relyingparty_auth_uri + id: google.identitytoolkit.relyingparty_auth_uri name: relyingparty_auth_uri title: Relyingparty_auth_uri methods: @@ -1542,7 +1542,7 @@ components: update: [] delete: [] relyingparty_account: - id: identitytoolkit.relyingparty_account + id: google.identitytoolkit.relyingparty_account name: relyingparty_account title: Relyingparty_account methods: @@ -1558,7 +1558,7 @@ components: update: [] delete: [] relyingparty: - id: identitytoolkit.relyingparty + id: google.identitytoolkit.relyingparty name: relyingparty title: Relyingparty methods: @@ -1646,7 +1646,7 @@ components: update: [] delete: [] relyingparty_account_info: - id: identitytoolkit.relyingparty_account_info + id: google.identitytoolkit.relyingparty_account_info name: relyingparty_account_info title: Relyingparty_account_info methods: @@ -1662,7 +1662,7 @@ components: update: [] delete: [] relyingparty_oob_confirmation_code: - id: identitytoolkit.relyingparty_oob_confirmation_code + id: google.identitytoolkit.relyingparty_oob_confirmation_code name: relyingparty_oob_confirmation_code title: Relyingparty_oob_confirmation_code methods: @@ -1678,7 +1678,7 @@ components: update: [] delete: [] relyingparty_project_config: - id: identitytoolkit.relyingparty_project_config + id: google.identitytoolkit.relyingparty_project_config name: relyingparty_project_config title: Relyingparty_project_config methods: @@ -1696,7 +1696,7 @@ components: update: [] delete: [] relyingparty_public_keys: - id: identitytoolkit.relyingparty_public_keys + id: google.identitytoolkit.relyingparty_public_keys name: relyingparty_public_keys title: Relyingparty_public_keys methods: @@ -1712,7 +1712,7 @@ components: update: [] delete: [] relyingparty_recaptcha_param: - id: identitytoolkit.relyingparty_recaptcha_param + id: google.identitytoolkit.relyingparty_recaptcha_param name: relyingparty_recaptcha_param title: Relyingparty_recaptcha_param methods: 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 a33bd976..05c0eb2f 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: '20240514' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/ servers: @@ -768,7 +768,7 @@ components: - '2' x-stackQL-resources: locations: - id: ids.locations + id: google.ids.locations name: locations title: Locations methods: @@ -790,13 +790,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: ids.operations + id: google.ids.operations name: operations title: Operations methods: @@ -834,14 +834,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' endpoints: - id: ids.endpoints + id: google.ids.endpoints name: endpoints title: Endpoints methods: @@ -886,15 +886,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/endpoints/methods/list' - $ref: '#/components/x-stackQL-resources/endpoints/methods/get' + - $ref: '#/components/x-stackQL-resources/endpoints/methods/list' insert: - $ref: '#/components/x-stackQL-resources/endpoints/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/endpoints/methods/delete' endpoints_iam_policies: - id: ids.endpoints_iam_policies + id: google.ids.endpoints_iam_policies name: endpoints_iam_policies title: Endpoints_iam_policies methods: 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 eca393b1..6920f1bf 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: '20240526' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/application-integration servers: @@ -34,75 +34,62 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudConnectorsV1BillingConfig: - type: object - properties: - billingCategory: - readOnly: true - description: Output only. Billing category for the connector. - type: string - enumDescriptions: - - Billing category is not specified. - - GCP/Technical connector. - - Non-GCP connector. - enum: - - BILLING_CATEGORY_UNSPECIFIED - - GCP_AND_TECHNICAL_CONNECTOR - - NON_GCP_CONNECTOR - id: GoogleCloudConnectorsV1BillingConfig - description: Billing config for the connection. - EnterpriseCrmFrontendsEventbusProtoEventParameters: + EnterpriseCrmEventbusProtoEventParameters: 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 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 workflow + between different tasks that are part of the same integration execution. - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - type: array - id: EnterpriseCrmFrontendsEventbusProtoEventParameters type: object - GoogleCloudIntegrationsV1alphaJwt: + GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse: + type: object + id: GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse properties: - jwt: - description: The token calculated by the header, payload and signature. - type: string - secret: - description: User's pre-shared secret to sign the token. - type: string - 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. - type: string - jwtHeader: + content: + description: String representation of the requested file. type: string - description: Identifies which algorithm is used to generate the signature. - type: object - id: 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. - EnterpriseCrmEventbusProtoCondition: + files: + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSerializedFile' + description: List containing String represendation for multiple file with type. + type: array + description: Response for DownloadIntegrationVersion. + EnterpriseCrmEventbusProtoParameterMap: type: object properties: - value: - description: Value that's checked for the key. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoValueType' - operator: - 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. + entries: + type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapEntry' + 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 enumDescriptions: - '' - '' @@ -113,595 +100,613 @@ components: - '' - '' - '' - enum: - - UNSET - - EQUALS - - CONTAINS - - LESS_THAN - - GREATER_THAN - - EXISTS - - DOES_NOT_EXIST - - IS_EMPTY - - IS_NOT_EMPTY + - '' + - '' + - '' + - '' + - '' + - >- + 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 - 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. + 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: + 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 type: string - deprecated: true - description: Condition that uses `operator` to evaluate the key against the value. - id: EnterpriseCrmEventbusProtoCondition - GoogleCloudIntegrationsV1alphaDownloadExecutionResponse: + id: EnterpriseCrmEventbusProtoParameterMap + description: >- + A generic multi-map that holds key value pairs. They keys and values can + be of any type, unless specified. + GoogleCloudIntegrationsV1alphaCoordinate: + id: GoogleCloudIntegrationsV1alphaCoordinate properties: - content: + 'y': + format: int32 + type: integer + description: Required. Y axis of the coordinate + x: + format: int32 + type: integer + description: Required. X axis of the coordinate + description: Configuration detail of coordinate, it used for UI + type: object + GoogleCloudIntegrationsV1alphaUsernameAndPassword: + properties: + password: type: string - description: The content of downloaded execution. + description: Password to be used + username: + description: Username to be used + type: string + id: GoogleCloudIntegrationsV1alphaUsernameAndPassword type: object - id: GoogleCloudIntegrationsV1alphaDownloadExecutionResponse - description: Response for downloading an execution. - GoogleCloudConnectorsV1EventingRuntimeData: + description: Username and password pair. + EnterpriseCrmEventbusProtoCloudLoggingDetails: + id: EnterpriseCrmEventbusProtoCloudLoggingDetails description: >- - Eventing runtime data has the details related to eventing managed by the - system. - type: object + 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: - eventsListenerEndpoint: + 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. + enum: + - CLOUD_LOGGING_SEVERITY_UNSPECIFIED + - INFO + - ERROR + - WARNING + type: string description: >- - Output only. Events listener endpoint. The value will populated - after provisioning the events listener. - readOnly: true + Severity selected by the customer for the logs to be sent to Cloud + Logging, for the integration version getting executed. + enableCloudLogging: + description: >- + Status of whether Cloud Logging is enabled or not for the + integration version getting executed. + type: boolean + type: object + EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity: + properties: + gaiaId: type: string - webhookData: - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1EventingRuntimeDataWebhookData - readOnly: true - description: Output only. Webhook data. - eventsListenerPscSa: + format: int64 + emailAddress: type: string - description: >- - Output only. Events listener PSC Service attachment. The value will - be populated after provisioning the events listener with private - connectivity enabled. - readOnly: true - status: - description: Output only. Current status of eventing. - readOnly: true - $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingStatus' - id: GoogleCloudConnectorsV1EventingRuntimeData - GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow: + type: object + id: EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity + GoogleCloudIntegrationsV1alphaIntegrationParameter: properties: - authCode: + jsonSchema: type: string - description: Authorization code to be exchanged for access and refresh tokens. - scopes: - items: - type: string - type: array description: >- - Scopes the connection will request when the user performs the auth - code flow. - clientId: - description: Client ID for user-provided OAuth app. - type: string - clientSecret: - description: Client secret for user-provided OAuth app. - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - pkceVerifier: - description: PKCE verifier to be used during the auth code exchange. - type: string - enablePkce: - description: Whether to enable PKCE when the user performs the auth code flow. - type: boolean - redirectUri: - description: Redirect URI to be provided during the auth code exchange. - type: string - authUri: - type: string - description: Auth URL for Authorization Code Flow - 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 - id: GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow - EnterpriseCrmLoggingGwsFieldLimits: - id: EnterpriseCrmLoggingGwsFieldLimits - properties: - logAction: - enumDescriptions: - - '' - - '' - - '' + This schema will be used to validate runtime JSON-typed values of + this parameter. + inputOutputType: type: string enum: - - LOG_ACTION_UNSPECIFIED - - DONT_LOG - - LOG - maxStringLength: - description: >- - maximum string length. If the field exceeds this amount the field is - shortened. - type: integer - format: int32 - maxArraySize: - type: integer - description: >- - maximum array size. If the array exceds this size, the field (list) - is truncated. - format: int32 - logType: - description: To which type(s) of logs the limits apply. - items: - enum: - - LOG_TYPE_UNSPECIFIED - - GWS - - GTS - - ALL - enumDescriptions: - - '' - - Limits apply when log detail records are written to GWS. - - >- - Limits apply when log detail records are written to GTS (e.g., - RecordIO files). - - Limits apply to *all* output log types. - type: string - type: array - shortenerType: + - IN_OUT_TYPE_UNSPECIFIED + - IN + - OUT + - IN_OUT + description: Specifies the input/output type for the parameter. enumDescriptions: - - '' - - String is shortened to max_string_length. - - String is replaced by its hex-string hash. + - Default. - >- - String is replaced by a combination of string shortening and a - hex-string hash. + Input parameters for the integration. EventBus validates that + these parameters exist in the integrations before execution. - >- - String shortening for email addresses. Shortening may be done on - the user and/or domain portion of the email address. + Output Parameters for the integration. EventBus will only return + the integration parameters tagged with OUT in the response back. - >- - String is replaced by a combination of string shortening and a - hex-string hash for an email address. - - Shortens a domain name (e.g., as part of an email address or URL). + 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 + description: Whether this parameter is a transient parameter. + masked: + description: True if this parameter should be masked in the logs + type: boolean + 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. + 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 + searchable: + type: boolean + description: Searchable in the execution log or not. + 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 + dataType: + description: Type of the parameter. enum: - - SHORTENER_TYPE_UNSPECIFIED - - SHORTEN - - HASH - - SHORTEN_WITH_HASH - - SHORTEN_EMAIL - - SHORTEN_EMAIL_WITH_HASH - - SHORTEN_DOMAIN + - 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 + 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). + 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. type: object + id: GoogleCloudIntegrationsV1alphaIntegrationParameter description: >- - Describes string and array limits when writing to logs. When a limit is - exceeded the *shortener_type* describes how to shorten the field. - next_id: 6 - EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange: - id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange - properties: - max: - type: number - description: The inclusive maximum of the acceptable range. - format: double - min: - type: number - description: The inclusive minimum of the acceptable range. - format: double + 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. + GoogleCloudConnectorsV1EventingRuntimeDataWebhookData: type: object - description: Range used to validate doubles and floats. - GoogleCloudConnectorsV1EventingConfigDeadLetterConfig: properties: - topic: - description: Optional. Topic to push events which couldn't be processed. + name: + readOnly: true + description: Output only. Name of the Webhook type: string - projectId: - description: Optional. Project which has the topic given. + nextRefreshTime: type: string - id: GoogleCloudConnectorsV1EventingConfigDeadLetterConfig - description: Dead Letter configuration details provided by the user. - type: object - GoogleCloudIntegrationsV1alphaResolveSuspensionResponse: - type: object - id: GoogleCloudIntegrationsV1alphaResolveSuspensionResponse - description: Response for Suspensions.ResolveSuspensions. - properties: {} - GoogleCloudIntegrationsV1alphaListIntegrationsResponse: - type: object - id: GoogleCloudIntegrationsV1alphaListIntegrationsResponse - properties: - integrations: - description: The integrations which match the request. - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaIntegration' + format: google-datetime + readOnly: true + description: >- + Output only. Next webhook refresh time. Will be null if refresh is + not supported. + additionalVariables: type: array - nextPageToken: - type: string - description: The next page token for the response. - description: Response for ListIntegrations. - GoogleCloudConnectorsV1ConnectionStatus: - properties: - status: - description: Status provides detailed information for the state. + readOnly: true + items: + $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' + description: Output only. Additional webhook related field values. + id: + description: Output only. ID to uniquely identify webhook. + readOnly: true type: string - description: - description: Description. + createTime: + readOnly: true type: string + format: google-datetime + description: Output only. Timestamp when the webhook was created. + updateTime: + type: string + format: google-datetime + readOnly: true + description: Output only. Timestamp when the webhook was last updated. + id: GoogleCloudConnectorsV1EventingRuntimeDataWebhookData + description: WebhookData has details of webhook configuration. + GoogleCloudIntegrationsV1alphaExecutionDetails: + id: GoogleCloudIntegrationsV1alphaExecutionDetails + properties: + eventExecutionSnapshotsSize: + type: string + format: int64 + description: Total size of all event_execution_snapshots for an execution + executionSnapshots: + type: array + description: List of snapshots taken during the execution. + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionSnapshot + attemptStats: + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAttemptStats' + description: List of Start and end time of the execution attempts. 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. + - Default. + - Execution is scheduled and awaiting to be triggered. + - Execution is processing. - >- - Connection is not running because the authorization configuration - is not complete. - type: string - description: State. + 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 - - CREATING - - ACTIVE - - INACTIVE - - DELETING - - UPDATING - - ERROR - - AUTHORIZATION_REQUIRED - description: ConnectionStatus indicates the state of the connection. + - PENDING + - PROCESSING + - SUCCEEDED + - FAILED + - CANCELLED + - RETRY_ON_HOLD + - SUSPENDED + type: string + description: >- + Contains the details of the execution info: this includes the tasks + execution details plus the event execution statistics. type: object - id: GoogleCloudConnectorsV1ConnectionStatus - GoogleCloudConnectorsV1LockConfig: - id: GoogleCloudConnectorsV1LockConfig + 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: - reason: + tokens: + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoToken' + type: array + name: type: string - description: Describes why a connection is locked. - locked: - type: boolean - description: Indicates whether or not the connection is locked. + email: + description: Required. + type: string + GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest: + properties: + authConfigId: + description: >- + The auth config id necessary to fetch the necessary credentials to + create the project for external clients + type: string + appsScriptProject: + type: string + description: The name of the Apps Script project to be created. + description: Request for CreateAppsScriptProject rpc call. + id: GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest type: object - description: >- - Determines whether or no a connection is locked. If locked, a reason - must be specified. - GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse: + EnterpriseCrmEventbusProtoProtoParameterArray: + id: EnterpriseCrmEventbusProtoProtoParameterArray type: object - description: Response for Creating Cloud Function rpc call. properties: - triggerUrl: + protoValues: + items: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + type: array + EnterpriseCrmEventbusProtoProtoArrayFunction: + type: object + properties: + functionName: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' type: string - description: The trigger url that will be returned - id: GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse - GoogleCloudIntegrationsV1alphaClientCertificate: - description: Contains client certificate information - id: GoogleCloudIntegrationsV1alphaClientCertificate + enum: + - UNSPECIFIED + - GET + - APPEND + - SIZE + - TO_SET + - APPEND_ALL + - TO_JSON + - SET + - REMOVE + - REMOVE_AT + - CONTAINS + - FOR_EACH + - FILTER + id: EnterpriseCrmEventbusProtoProtoArrayFunction + GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse: + id: GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse type: object properties: - passphrase: + scriptId: 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. - sslCertificate: + description: The id of the linked Apps Script project. + description: Response for LinkAppsScriptProject rpc call. + EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot: + id: EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot + properties: + snapshotTime: + format: int64 + description: Indicates when this snapshot is taken. type: string + conditionResults: + description: All of the computed conditions that been calculated. + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoConditionResult' + type: array + checkpointTaskNumber: 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: + Indicates "right after which checkpoint task's execution" this + snapshot is taken. + type: string + eventParams: + description: The parameters in Event object. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + taskExecutionDetails: + description: All of the task execution details at the given point of time. + items: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetails + type: array + eventExecutionSnapshotId: 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----- - GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse: - properties: - scriptId: - description: The id of the linked Apps Script project. + Auto-generated. Used as primary key for EventExecutionSnapshots + table. + diffParams: + description: The parameters in Event object that differs from last snapshot. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + taskName: + description: The task name associated with this snapshot. Could be empty. + type: string + deprecated: true + eventExecutionSnapshotMetadata: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata + eventExecutionInfoId: + description: Points to the event execution info this snapshot belongs to. type: string type: object - description: Response for LinkAppsScriptProject rpc call. - id: GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse - EnterpriseCrmEventbusProtoTaskUiModuleConfig: + GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest: + id: GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest properties: - moduleId: + scriptId: 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 - 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. - type: object - description: Task author would use this type to configure a config module. - id: EnterpriseCrmEventbusProtoTaskUiModuleConfig - GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest: - description: Request for PublishIntegrationVersion. - id: GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest + description: The id of the Apps Script project to be linked. + description: Request for LinkAppsScriptProject rpc call. type: object - properties: - configParameters: - type: object - additionalProperties: - description: Properties of the object. - type: any - description: Optional. Config parameters used during integration execution. - GoogleCloudConnectorsV1ResourceRequests: - id: GoogleCloudConnectorsV1ResourceRequests + GoogleCloudIntegrationsV1alphaExecution: type: object - description: Resource requests defined for connection pods of a given connector type. + description: >- + The Execution resource contains detailed information of an individual + integration execution. properties: - memory: + responseParams: + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + description: Event parameters come out as part of the response. + deprecated: true + integrationVersionState: + enum: + - INTEGRATION_STATE_UNSPECIFIED + - DRAFT + - ACTIVE + - ARCHIVED + - SNAPSHOT + description: Output only. State of the integration version readOnly: true type: string - description: Output only. Memory request. - cpu: - description: Output only. CPU request. + enumDescriptions: + - Default. + - Draft. + - Active. + - Archived. + - Snapshot. + name: type: string - readOnly: true - GoogleCloudIntegrationsV1alphaListSuspensionsResponse: - description: Response for Suspensions.ListSuspensions. - id: GoogleCloudIntegrationsV1alphaListSuspensionsResponse - type: object - properties: - suspensions: - description: >- - The suspensions for the relevant execution which the caller has - permissions to view and resolve. + description: Auto-generated primary key. + requestParams: + description: Event parameters come in as part of the request. + deprecated: true items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuspension' + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry type: array - nextPageToken: + executionDetails: + description: Detailed info of this execution. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecutionDetails' + triggerId: type: string - description: Token to retrieve the next page of results. - EnterpriseCrmEventbusProtoStringArray: - type: object - properties: - values: - type: array - items: - type: string - id: EnterpriseCrmEventbusProtoStringArray - EnterpriseCrmFrontendsEventbusProtoTaskEntity: - id: EnterpriseCrmFrontendsEventbusProtoTaskEntity - type: object - properties: - disabledForVpcSc: - description: True if the task has conflict with vpcsc - type: boolean - paramSpecs: description: >- - Declarations for inputs/outputs for a TypedTask. This is also - associated with the METADATA mask. + 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. + replayInfo: + description: Output only. Replay info for the execution + readOnly: true $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage - metadata: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskMetadata' - description: Metadata inclueds the task name, author and so on. - stats: - description: Deprecated - statistics from the Monarch query. - $ref: '#/components/schemas/EnterpriseCrmEventbusStats' + #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionReplayInfo + directSubExecutions: + description: Direct sub executions of the following Execution. + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' + type: array + updateTime: + description: Output only. Last modified time of the execution. + readOnly: true + type: string + format: google-datetime + createTime: + type: string + description: Output only. Created time of the execution. + readOnly: true + format: google-datetime + responseParameters: + type: object + description: Event parameters returned as part of the response. + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + executionMethod: + type: string + description: The ways user posts this event. + enum: + - EXECUTION_METHOD_UNSPECIFIED + - POST + - POST_TO_QUEUE + - SCHEDULE + enumDescriptions: + - Default value. + - Sync post. + - Async post. + - Async post with schedule time. + requestParameters: + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + description: Event parameters come in as part of the request. + type: object + eventExecutionDetails: deprecated: true - uiConfig: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskUiConfig' + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetails' + description: The execution info about this event. + cloudLoggingDetails: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaCloudLoggingDetails + description: Cloud Logging details for the integration version + snapshotNumber: + format: int64 + type: string + readOnly: true description: >- - UI configuration for this task Also associated with the METADATA - mask. - 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 + Output only. An increasing sequence that is set when a new snapshot + is created + id: GoogleCloudIntegrationsV1alphaExecution + EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange: + description: Range used to validate longs and ints. + properties: + max: type: string - description: >- - Contains a task's metadata and associated information. Next available - id: 7 - EnterpriseCrmEventbusProtoDoubleParameterArray: + format: int64 + description: The inclusive maximum of the acceptable range. + min: + format: int64 + description: The inclusive minimum of the acceptable range. + type: string + type: object + id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange + EnterpriseCrmEventbusProtoStringParameterArray: type: object + id: EnterpriseCrmEventbusProtoStringParameterArray properties: - doubleValues: + stringValues: type: array items: - format: double - type: number - id: EnterpriseCrmEventbusProtoDoubleParameterArray - EnterpriseCrmEventbusProtoFieldMappingConfig: - description: >- - Field Mapping Config to map multiple output fields values from input - fields values. - id: EnterpriseCrmEventbusProtoFieldMappingConfig - type: object - properties: - mappedFields: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoMappedField' - type: array - EnterpriseCrmEventbusProtoBooleanFunction: - type: object - properties: - functionName: - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - UNSPECIFIED - - TO_JSON - - NOT - - AND - - NAND - - OR - - XOR - - NOR - - XNOR - - TO_STRING - - EQUALS - type: string - id: EnterpriseCrmEventbusProtoBooleanFunction - EnterpriseCrmEventbusProtoIntParameterArray: - id: EnterpriseCrmEventbusProtoIntParameterArray - properties: - intValues: - items: - format: int64 - type: string - type: array - type: object - EnterpriseCrmEventbusProtoToken: - id: EnterpriseCrmEventbusProtoToken - type: object - properties: - name: - type: string - value: - type: string - GoogleCloudIntegrationsV1alphaRuntimeEntitySchema: - properties: - fieldSchema: - description: List of fields in the entity. - type: string - entity: - type: string - description: Name of the entity. - arrayFieldSchema: - description: The above schema, but for an array of the associated entity. - type: string - description: Metadata of an entity, including a schema for its properties. - id: GoogleCloudIntegrationsV1alphaRuntimeEntitySchema - type: object - EnterpriseCrmEventbusProtoStringParameterArray: - id: EnterpriseCrmEventbusProtoStringParameterArray - type: object - properties: - stringValues: - type: array - items: - type: string - GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode: - id: GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode - type: object + type: string + GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode: properties: clientId: - type: string description: The client's id. - tokenEndpoint: - type: string - description: The token url endpoint to send the token request to. - scope: - description: A space-delimited list of requested scope permissions. - type: string - authCode: - description: The Auth Code that is used to initially retrieve the access token. type: string - authParams: - description: The auth parameters sent along with the auth code request. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' - accessToken: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken' - description: The access token received from the token endpoint. 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 - authEndpoint: - 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. + authCode: + description: The Auth Code that is used to initially retrieve the access token. type: string clientSecret: - type: string description: The client's secret. - tokenParams: - description: The token parameters sent along with the token request. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' + type: string requestType: enumDescriptions: - Unspecified request type @@ -710,13 +715,28 @@ components: - >- 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: Represent how to pass parameters to fetch access token + scope: + type: string + description: A space-delimited list of requested scope permissions. + tokenParams: + description: The token parameters sent along with the token request. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' + authEndpoint: + description: The auth url endpoint to send the auth code request to. + type: string + tokenEndpoint: + description: The token url endpoint to send the token request to. + type: string + authParams: + description: The auth parameters sent along with the auth code request. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' 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 @@ -724,624 +744,384 @@ components: 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. - GoogleCloudConnectorsV1AuthConfigUserPassword: + id: GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode type: object - description: Parameters to support Username and Password Authentication. + EnterpriseCrmEventbusProtoParamSpecEntryConfig: + id: EnterpriseCrmEventbusProtoParamSpecEntryConfig properties: - password: - description: Secret version reference containing the password. - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - username: - description: Username. + parameterNameOption: type: string - id: GoogleCloudConnectorsV1AuthConfigUserPassword - EnterpriseCrmEventbusProtoEventExecutionDetails: - id: EnterpriseCrmEventbusProtoEventExecutionDetails - type: object - properties: - eventRetriesFromBeginningCount: - type: integer - format: int32 - description: >- - Indicates the number of times the execution has restarted from the - beginning. - ryeLockUnheldCount: - 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/ - format: int32 - eventExecutionState: + enum: + - DEFAULT_NOT_PARAMETER_NAME + - IS_PARAMETER_NAME + - KEY_IS_PARAMETER_NAME + - VALUE_IS_PARAMETER_NAME enumDescriptions: - - '' + - This field is not a parameter name. - >- - Event is received and waiting for the execution. This happens when - firing the event via "postToQueue" or "schedule". - - Event is under processing. + 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. - >- - Event execution successfully finished. There's no more change - after this state. - - Event execution failed. There's no more change after this state. + 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. - >- - 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 - enum: - - UNSPECIFIED - - ON_HOLD - - IN_PROCESS - - SUCCEEDED - - FAILED - - CANCELED - - RETRY_ON_HOLD - - SUSPENDED - networkAddress: + 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. + helpText: description: >- - The network address (aka. bns address) that indicates where the - event executor is running. + Detailed help text for this parameter containing information not + provided elsewhere. For example, instructions on how to migrate from + a deprecated parameter. type: string - eventExecutionSnapshot: - type: array - items: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshot - logFilePath: - description: The log file path (aka. cns address) for this event. + hideDefaultValue: + type: boolean + description: Whether the default value is hidden in the UI. + descriptivePhrase: + description: A short phrase to describe what this parameter contains. type: string - eventAttemptStats: - items: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats - type: array - eventExecutionSnapshotsSize: - description: Total size of all event_execution_snapshots for an execution + uiPlaceholderText: type: string - format: int64 - nextExecutionTime: - format: int64 description: >- - Next scheduled execution time in case the execution status was - RETRY_ON_HOLD. + Placeholder text which will appear in the UI input form for this + parameter. + subSectionLabel: + type: string + description: >- + A user-friendly label for subSection under which the parameter will + be displayed. + inputDisplayOption: + type: string + enum: + - DEFAULT + - STRING_MULTI_LINE + - NUMBER_SLIDER + - BOOLEAN_TOGGLE + 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. + isHidden: + description: Whether this field is hidden in the UI. + type: boolean + label: + description: A user-friendly label for the parameter. type: string + type: object + EnterpriseCrmFrontendsEventbusProtoParameterMap: 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: 11 - GoogleCloudIntegrationsV1alphaCertificate: - description: The certificate definition + A generic multi-map that holds key value pairs. They keys and values can + be of any type, unless specified. type: object - id: GoogleCloudIntegrationsV1alphaCertificate + id: EnterpriseCrmFrontendsEventbusProtoParameterMap properties: - validStartTime: - format: google-datetime - type: string - description: Output only. The timestamp after which certificate will be valid - readOnly: true - name: - type: string - readOnly: true - description: Output only. Auto generated primary key - description: - type: string - description: Description of the certificate - rawCertificate: - description: >- - Input only. Raw client certificate which would be registered with - trawler - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaClientCertificate' - displayName: - description: Required. Name of the certificate - type: string - requestorId: - description: >- - Immutable. Requestor ID to be used to register certificate with - trawler + valueType: + 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 - validEndTime: + 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 + entries: + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapEntry + type: array + keyType: type: string - format: google-datetime - description: Output only. The timestamp after which certificate will expire - readOnly: true - credentialId: + 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: >- - Immutable. Credential id that will be used to register with trawler - INTERNAL_ONLY - type: string - certificateStatus: - type: string + 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: - - 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 - description: Status of the certificate - EnterpriseCrmEventbusProtoSuspensionConfig: + - 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 + EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry: type: object + id: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry properties: - customMessage: - type: string - description: >- - Optional information to provide recipients of the suspension in - addition to the resolution URL, typically containing relevant - parameter values from the originating workflow. - suspensionExpiration: + children: description: >- - Indicates the next steps when no external actions happen on the - suspension. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuspensionExpiration' - whoMayResolve: - description: Identities able to resolve this suspension. - type: array + Child parameters nested within this parameter. This field only + applies to protobuf parameters items: $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissions - notifications: - type: array - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNotification' - id: EnterpriseCrmEventbusProtoSuspensionConfig - GoogleCloudIntegrationsV1alphaLiftSuspensionResponse: - id: GoogleCloudIntegrationsV1alphaLiftSuspensionResponse - properties: - eventExecutionInfoId: - type: string - description: Execution Id that will be returned - type: object - description: Response of lift Suspense - EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray: - type: object - properties: - doubleValues: + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry type: array - items: - type: number - format: double - id: EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray - GoogleCloudIntegrationsV1alphaAuthToken: - id: GoogleCloudIntegrationsV1alphaAuthToken - type: object - properties: - type: + jsonSchema: type: string - description: Authentication type, e.g. "Basic", "Bearer", etc. - token: + 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 + key: type: string - description: The token for the auth type. - description: >- - The credentials to authenticate a user agent with a server that is put - in HTTP Authorization request header. - GoogleCloudIntegrationsV1alphaProjectProperties: - description: Metadata information for the given project - properties: - provisionedRegions: - description: A list of provisioned regions on the current project - type: array - items: - type: string - billingType: + 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. + 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 + inOutType: + description: Specifies the input/output type for the parameter. + enum: + - IN_OUT_TYPE_UNSPECIFIED + - IN + - OUT + - IN_OUT 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 + Input parameters for the workflow. EventBus validates that these + parameters exist in the workflows before execution. - >- - Argentum subscription for Application Integration users. To be - used in the future. + Output Parameters for the workflow. EventBus will only return the + workflow parameters tagged with OUT in the response back. - >- - Special billing type to avoid any billing to clients (eg: trusted - tester program). This should not be used without consulting with - the leads. - description: 'Required. Required: The client billing type that was requested' - enum: - - BILLING_TYPE_UNSPECIFIED - - APIGEE_TRIALS - - APIGEE_SUBSCRIPTION - - PAYG - - SUBSCRIPTION - - NO_BILLING - ipEnablementState: - 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 - 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 + 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: type: string - type: object - id: GoogleCloudIntegrationsV1alphaProjectProperties - EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata: - type: object - properties: - taskName: - type: string - description: the task name associated with this snapshot. Could be empty. - taskLabel: - type: string - description: the task label associated with this snapshot. Could be empty. - 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') - eventAttemptNum: - description: the event attempt number this snapshot belongs to. - type: integer - format: int32 - taskAttemptNum: - description: the task attempt number this snapshot belongs to. Could be empty. - type: integer - format: int32 - taskNumber: - type: string - description: The task number associated with this snapshot. Could be empty. - ancestorIterationNumbers: - type: array - items: - type: string - description: >- - Ancestor iteration number for the task(it will only be non-empty if - the task is under 'private workflow') - integrationName: + description: Optional. The description about the parameter + protoDefPath: type: string description: >- - The direct integration which the event execution snapshots belongs - to - id: >- - EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata - EnterpriseCrmEventbusProtoTaskAlertConfig: - type: object - properties: - playbookUrl: + 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: >- - Link to a playbook for resolving the issue that triggered this - alert. + 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 - thresholdValue: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue - description: >- - The metric value, above or below which the alert should be - triggered. - errorEnumList: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList - onlyFinalAttempt: + required: type: boolean - description: Only count final task attempts, not retries. - metricType: - 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: - 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. - format: int64 - alertDisabled: - description: >- - Set to false by default. When set to true, the metrics are not - aggregated or pushed to Monarch for this workflow alert. + containsLargeData: type: boolean - clientId: - type: string - description: >- - Client associated with this alert configuration. Must be a client - enabled in one of the containing workflow's triggers. - 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). - thresholdType: - enum: - - UNSPECIFIED_THRESHOLD_TYPE - - EXPECTED_MIN - - EXPECTED_MAX + Indicates whether this variable contains large data and need to be + uploaded to Cloud Storage. + dataType: + description: The data type of the parameter. 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. - '' - 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. - warningEnumList: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList - 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 - 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. - description: >- - Message to be used to configure alerting in the {@code TaskConfig} - protos for tasks in an event. - id: EnterpriseCrmEventbusProtoTaskAlertConfig - EnterpriseCrmEventbusProtoErrorDetail: - id: EnterpriseCrmEventbusProtoErrorDetail - type: object - description: An error, warning, or information message associated with a workflow. - properties: - severity: - type: string - description: 'The severity of the error: ERROR|WARN|INFO.' - enum: - - SEVERITY_UNSPECIFIED - - ERROR - - WARN - - INFO - enumDescriptions: - '' - '' - '' - '' - taskNumber: - description: >- - The task try-number, in which, the error occurred. If zero, the - error happened at the event level. - format: int32 - type: integer - errorCode: - description: The associated error-code, which can be a common or internal code. - $ref: '#/components/schemas/CrmlogErrorCode' - errorMessage: - type: string - description: >- - The full text of the error message, including any parameters that - were thrown along with the exception. - EnterpriseCrmEventbusProtoSuspensionResolutionInfo: - type: object - properties: - lastModifiedTimestamp: - format: google-datetime - type: string - description: Auto-generated. - encryptedSuspensionResolutionInfo: - type: string - description: Encrypted SuspensionResolutionInfo - format: byte - audit: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit - status: - enumDescriptions: - '' - '' - '' - '' - enum: - - PENDING_UNSPECIFIED - - REJECTED - - LIFTED - - CANCELED - type: string - clientId: - type: string - description: The event data user sends as request. - externalTraffic: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoExternalTraffic' - description: The origin of the suspension for periodic notifications. - suspensionId: - type: string - description: Primary key for the SuspensionResolutionInfoTable. - wrappedDek: - type: string - description: Wrapped dek - format: byte - workflowName: - type: string - description: Required. The name of the originating workflow. - product: - enumDescriptions: - '' - '' - '' - '' - description: >- - Which Google product the suspension belongs to. If not set, the - suspension belongs to Integration Platform by 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. + - '' + - '' + - '' enum: - - UNSPECIFIED_PRODUCT - - IP - - APIGEE - - SECURITY - type: string - suspensionConfig: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuspensionConfig' - createdTimestamp: - type: string - format: google-datetime - description: Auto-generated. - eventExecutionInfoId: - description: Required. ID of the associated execution. - type: string - taskNumber: - description: Required. Task number of the associated SuspensionTask. - type: string - cloudKmsConfig: - description: KMS info, used by cmek/gmek integration - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudKmsConfig' - id: EnterpriseCrmEventbusProtoSuspensionResolutionInfo - GoogleCloudConnectorsV1ConnectorVersionInfraConfig: - type: object - properties: - resourceRequests: - description: Output only. System resource requests. - readOnly: true - $ref: '#/components/schemas/GoogleCloudConnectorsV1ResourceRequests' - hpaConfig: - readOnly: true - description: Output only. HPA autoscaling config. - $ref: '#/components/schemas/GoogleCloudConnectorsV1HPAConfig' - sharedDeployment: - readOnly: true - description: Output only. The name of shared connector deployment. - type: string - ratelimitThreshold: - format: int64 - readOnly: true - description: >- - Output only. Max QPS supported by the connector version before - throttling of requests. - type: string - resourceLimits: - $ref: '#/components/schemas/GoogleCloudConnectorsV1ResourceLimits' - readOnly: true - description: Output only. System resource limits. - connectionRatelimitWindowSeconds: - description: >- - Output only. The window used for ratelimiting runtime requests to - connections. - format: int64 - readOnly: true - type: string - internalclientRatelimitThreshold: - format: int64 - description: >- - Output only. Max QPS supported for internal requests originating - from Connd. - type: string - readOnly: true - deploymentModel: - enumDescriptions: - - Deployment model is not specified. - - Default model gke mst. - - Cloud run mst. + - 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 + producer: type: string - description: Optional. Indicates whether connector is deployed on GKE/CloudRun - enum: - - DEPLOYMENT_MODEL_UNSPECIFIED - - GKE_MST - - CLOUD_RUN_MST - id: GoogleCloudConnectorsV1ConnectorVersionInfraConfig - description: >- - This cofiguration provides infra configs like rate limit threshold which - need to be configurable for every connector version - EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry: - id: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry - type: object - properties: attributes: description: Metadata information about the parameters. $ref: '#/components/schemas/EnterpriseCrmEventbusProtoAttributes' - jsonSchema: - type: string + protoDefName: description: >- - This schema will be used to validate runtime JSON-typed values of - this parameter. - 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 - type: string - description: Specifies the input/output type for the parameter. - description: - description: Optional. The description about the parameter + The name of the protobuf type if the parameter has a protobuf data + type. type: string - containsLargeData: - type: boolean + producedBy: description: >- - Indicates whether this variable contains large data and need to be - uploaded to Cloud Storage. - children: + 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' + EnterpriseCrmFrontendsEventbusProtoParameterEntry: + type: object + properties: + value: description: >- - Child parameters nested within this parameter. This field only - applies to protobuf parameters - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry - type: array - defaultValue: + Values for the defined keys. Each value can either be string, int, + double or any proto message. $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. 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 workflow definition. + type: string dataType: - description: The data type of the parameter. + 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: Explicitly getting the type of the parameter. type: string + masked: + type: boolean + description: True if this parameter should be masked in the logs + id: EnterpriseCrmFrontendsEventbusProtoParameterEntry + description: Key-value pair of EventBus parameters. + EnterpriseCrmFrontendsEventbusProtoParamSpecEntry: + type: object + properties: + dataType: + description: The data type of the parameter. enumDescriptions: - '' - '' @@ -1383,515 +1163,264 @@ components: - BYTES_ARRAY - NON_SERIALIZABLE_OBJECT - JSON_VALUE - 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: + protoDef: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition + description: Populated if this represents a proto or proto array. + config: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryConfig' + description: Optional fields, such as help text and other useful info. + key: + type: string 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". + 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. + validationRule: + description: >- + Rule used to validate inputs (individual values and collection + elements) for this parameter. + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRule + jsonSchema: + description: If the data_type is JSON_VALUE, then this will define its schema. type: string - producer: + className: type: string - producedBy: 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' - required: + 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. + isDeprecated: + description: >- + If set, this entry is deprecated, so further use of this parameter + should be prohibited. type: boolean - isTransient: + isOutput: type: boolean - description: Whether this parameter is a transient parameter. - protoDefName: + collectionElementClassName: description: >- - The name of the protobuf type if the parameter has a protobuf data - type. + 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 - GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest: - type: object - id: GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest - description: >- - LINT.IfChange Use this request to post all workflows associated with a - given trigger id. Next available id: 13 - properties: - 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. - type: string - ignoreErrorIfNoActiveWorkflow: - 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 - 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/*" - scheduledTime: - format: int64 - description: >- - Optional. Time in milliseconds since epoch when the given event - would be scheduled. - type: string - quotaRetryCount: - description: >- - Optional. This is a field to see the quota retry count for - integration execution - format: int32 - type: integer - 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 - testMode: + required: + description: If set, the user must provide an input value for this parameter. type: boolean + defaultValue: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType 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. - parameters: - description: Passed in as parameters to each workflow execution. Optional. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' - priority: - type: string - description: >- - The request priority this request should be processed at. For - internal users: - 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. - enum: - - UNSPCIFIED - - SHEDDABLE - - SHEDDABLE_PLUS - - CRITICAL - - CRITICAL_PLUS - userGeneratedExecutionId: - 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. - type: string - 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. - GoogleCloudIntegrationsV1alphaCloudKmsConfig: - id: GoogleCloudIntegrationsV1alphaCloudKmsConfig + 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' + id: EnterpriseCrmFrontendsEventbusProtoParamSpecEntry + GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse: type: object - description: Configuration information for Client's Cloud KMS information + id: GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse + description: Response for listing RuntimeActionSchemas for a specific Connection. properties: - keyVersion: - 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. - 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. - 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. - kmsLocation: - description: Required. Location name of the key ring, e.g. "us-west1". - type: string - kmsProjectId: + nextPageToken: type: string - 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 - EnterpriseCrmEventbusProtoTransformExpression: + description: Next page token. + runtimeActionSchemas: + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaRuntimeActionSchema + description: Runtime action schemas. + type: array + GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse: + description: The response for executing an integration. type: object + id: GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse properties: - transformationFunctions: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFunction' + executionInfoIds: + description: The execution info id for the executed integrations. type: array - description: Transformations to be applied sequentially. - initialValue: - description: Initial value upon which to perform transformations. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBaseValue' - id: EnterpriseCrmEventbusProtoTransformExpression - GoogleCloudConnectorsV1EventingRuntimeDataWebhookData: + items: + type: string + GoogleCloudIntegrationsV1alphaCertificate: properties: - name: - readOnly: true - description: Output only. Name of the Webhook + certificateStatus: + enum: + - 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 type: string - createTime: + description: Status of the certificate + validEndTime: + description: Output only. The timestamp after which certificate will expire format: google-datetime - type: string readOnly: true - description: Output only. Timestamp when the webhook was created. - nextRefreshTime: + type: string + requestorId: + type: string description: >- - Output only. Next webhook refresh time. Will be null if refresh is - not supported. + Immutable. Requestor ID to be used to register certificate with + trawler + name: + type: string + readOnly: true + description: Output only. Auto generated primary key + validStartTime: format: google-datetime readOnly: true type: string - id: - description: Output only. ID to uniquely identify webhook. - readOnly: true + description: Output only. The timestamp after which certificate will be valid + displayName: type: string - additionalVariables: - description: Output only. Additional webhook related field values. - readOnly: true - type: array - items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' - updateTime: - format: google-datetime + description: Required. Name of the certificate + rawCertificate: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaClientCertificate' + description: >- + Input only. Raw client certificate which would be registered with + trawler + description: type: string - readOnly: true - description: Output only. Timestamp when the webhook was last updated. - type: object - id: GoogleCloudConnectorsV1EventingRuntimeDataWebhookData - description: WebhookData has details of webhook configuration. - EnterpriseCrmEventbusProtoEventBusProperties: - id: EnterpriseCrmEventbusProtoEventBusProperties - description: >- - LINT.IfChange This message is used for storing key value pair properties - for each Event / Task in the EventBus. + description: Description of the certificate + credentialId: + type: string + description: >- + Immutable. Credential id that will be used to register with trawler + INTERNAL_ONLY type: object - properties: - properties: - description: An unordered list of property entries. - type: array - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoPropertyEntry' - GoogleCloudIntegrationsV1alphaClientConfig: - description: The configuration information for the Client - id: GoogleCloudIntegrationsV1alphaClientConfig + id: GoogleCloudIntegrationsV1alphaCertificate + description: The certificate definition + EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition: + id: EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition type: object properties: - isGmek: - type: boolean - description: Optional. Indicates the client is provisioned with CMEK or GMEK. - p4ServiceAccount: - description: The service agent associated with this client - type: string - cloudKmsConfig: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' - description: Cloud KMS config for Auth Module to encrypt/decrypt credentials. - enableVariableMasking: - description: >- - Optional. True if variable masking feature should be turned on for - this region - type: boolean - id: - type: string - description: Globally unique ID (project_id + region) - region: - description: The region the client is linked to. - type: string - description: - type: string - description: Description of what the client is used for - runAsServiceAccount: - type: string + fullName: 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: - description: The GCP project id of the client associated with - type: string - createTime: - description: The timestamp when the client was first created. - type: string - format: google-datetime - billingType: - 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 - enum: - - BILLING_TYPE_UNSPECIFIED - - BILLING_TYPE_APIGEE_TRIALS - - BILLING_TYPE_APIGEE_SUBSCRIPTION - - BILLING_TYPE_PAYG + The fully-qualified proto name. This message, for example, would be + "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition". type: string - clientState: - description: Indicates the activity state the client + path: type: string - enum: - - CLIENT_STATE_UNSPECIFIED - - CLIENT_STATE_ACTIVE - - CLIENT_STATE_DISABLED - 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 - GoogleCloudIntegrationsV1alphaLiftSuspensionRequest: + description: Path to the proto file that contains the message type's definition. + 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. properties: - suspensionResult: + clientSecret: + description: Secret version reference containing the client secret. + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + clientId: 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. + description: The client identifier. type: object - id: GoogleCloudIntegrationsV1alphaLiftSuspensionRequest - description: Request for lift Suspension - EnterpriseCrmLoggingGwsSanitizeOptions: - description: >- - Identifies whether a field contains, or may contain, PII or sensitive - data, and how to sanitize the field if it does. If a field's privacy - type cannot be determined then it is sanitized (e.g., scrubbed). The - specific sanitizer implementation is determined by run-time - configuration and environment options (e.g., prod vs. qa). next_id: 5 + id: GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials + GoogleCloudIntegrationsV1alphaProjectProperties: type: object properties: - sanitizeType: + billingType: enumDescriptions: - '' - - Replace value with a scrubbed value (usu. a constant). + - A trial org provisioned through Apigee Provisioning Wizard - >- - Transform a value so that it cannot be tracked across events. - However, a given value, is transformed to the same value *within* - an event. E.g., "foo.com" is transformed to "0xabcdef" for event - 1001, and to "0xfedcba" for event 1002. + Subscription based on concurrency model for Apigee and Application + Integration users. + - Consumption based users of IP - >- - Transform values as with ANONYMIZER, but the same transformation - is repeated for a limited time (e.g., 1 day). + Argentum subscription for Application Integration users. To be + used in the future. - >- - The value is transformed using a well-defined obfuscator (e.g., - D3_CUSTOMER_ID). - - The value is encrypted. - - No sanitization is required. + Special billing type to avoid any billing to clients (eg: trusted + tester program). This should not be used without consulting with + the leads. type: string enum: - - SANITIZE_TYPE_UNSPECIFIED - - SCRUB - - ANONYMIZE - - ANONYMIZE_LIMITED_REPEATABLE - - OBFUSCATE - - ENCRYPT - - DO_NOT_SANITIZE - isAlreadySanitized: - type: boolean - description: >- - If true, the value has already been sanitized and needs no further - sanitization. For instance, a D3 customer id is already an - obfuscated entity and *might not* need further sanitization. - logType: - description: To which type(s) of logs the sanitize options apply. - type: array - items: - enumDescriptions: - - '' - - Limits apply when log detail records are written to GWS. - - >- - Limits apply when log detail records are written to GTS (e.g., - RecordIO files). - - Limits apply to *all* output log types. - enum: - - LOG_TYPE_UNSPECIFIED - - GWS - - GTS - - ALL - type: string - privacy: + - BILLING_TYPE_UNSPECIFIED + - APIGEE_TRIALS + - APIGEE_SUBSCRIPTION + - PAYG + - SUBSCRIPTION + - NO_BILLING + description: 'Required. Required: The client billing type that was requested' + ipEnablementState: enumDescriptions: - - '' - - Field does *NOT* contain PII or sensitive data. - - Field contains PII. - - Field contains Sensitive PII. - - Unsure if field contains PII. + - 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: - - PRIVACY_TYPE_UNSPECIFIED - - NOT_PII - - PII - - SPII - - UNSURE + - IP_ENABLEMENT_STATE_UNSPECIFIED + - IP_ENABLEMENT_STATE_STANDALONE + - IP_ENABLEMENT_STATE_APIGEE + - IP_ENABLEMENT_STATE_APIGEE_ENTITLED type: string - id: EnterpriseCrmLoggingGwsSanitizeOptions - EnterpriseCrmEventbusProtoBaseFunction: + provisionedRegions: + description: A list of provisioned regions on the current project + items: + type: string + type: array + description: Metadata information for the given project + id: GoogleCloudIntegrationsV1alphaProjectProperties + 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: + jwtClaims: + description: JwtClaims providers fields to generate the token. + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims + clientKey: + 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' + id: GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer type: object - id: EnterpriseCrmEventbusProtoBaseFunction + GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest: properties: - functionName: - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - UNSPECIFIED - - NOW_IN_MILLIS - - INT_LIST - - ENVIRONMENT - - GET_EXECUTION_ID - - GET_INTEGRATION_NAME - - GET_REGION - - GET_UUID - - GET_PROJECT_ID + cloudKmsConfig: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' + description: >- + Required. REQUIRED: Cloud KMS config for AuthModule to + encrypt/decrypt credentials. + type: object + id: GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest + description: Request for the SwitchEncryption rpc + GoogleCloudIntegrationsV1alphaAttemptStats: + properties: + endTime: + format: google-datetime + type: string + description: The end time of the integration execution for current attempt. + startTime: + format: google-datetime + type: string + description: >- + The start time of the integration execution for current attempt. + This could be in the future if it's been scheduled. + id: GoogleCloudIntegrationsV1alphaAttemptStats + description: Status for the execution attempt. + type: object + GoogleCloudIntegrationsV1alphaGenerateTokenResponse: + type: object + properties: + message: type: string + description: The message that notifies the user if the request succeeded or not. + id: GoogleCloudIntegrationsV1alphaGenerateTokenResponse + description: Returns success or error message GoogleCloudIntegrationsV1alphaAuthConfig: + description: The AuthConfig resource use to hold channels and connection config data. type: object id: GoogleCloudIntegrationsV1alphaAuthConfig properties: - decryptedCredential: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCredential' - description: Raw auth credentials. - credentialType: - 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. - 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 - type: string - visibility: - description: The visibility of the auth config. - type: string - enum: - - AUTH_CONFIG_VISIBILITY_UNSPECIFIED - - PRIVATE - - CLIENT_VISIBLE - enumDescriptions: - - Visibility not specified. - - Profile visible to the creator only. - - Profile visible within the client. - validTime: - type: string - format: google-datetime - description: >- - The time until the auth config is valid. Empty or max value is - considered the auth config won't expire. - certificateId: - description: Certificate id for client certificate - type: string - createTime: - format: google-datetime - description: Output only. The timestamp when the auth config is created. - readOnly: true - type: string - displayName: - type: string - description: Required. The name of the auth config. - expiryNotificationDuration: - items: - format: google-duration - type: string - 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 - encryptedCredential: - format: byte - description: >- - Auth credential encrypted by Cloud KMS. Can be decrypted as - Credential with proper KMS key. - type: string - description: - type: string - description: A description of the auth config. - updateTime: - description: Output only. The timestamp when the auth config is modified. - readOnly: true - type: string - format: google-datetime - reason: - type: string - description: The reason / details of the current status. state: - description: The status of the auth config. enumDescriptions: - Status not specified. - Valid Auth config. @@ -1902,6 +1431,7 @@ components: - Auth config expired. - Auth config unauthorized. - Auth config not supported. + description: The status of the auth config. enum: - STATE_UNSPECIFIED - VALID @@ -1911,1207 +1441,1017 @@ components: - UNAUTHORIZED - UNSUPPORTED type: string - overrideValidTime: + displayName: + type: string + description: Required. The name of the auth config. + createTime: + readOnly: true + description: Output only. The timestamp when the auth config is created. + type: string format: google-datetime + updateTime: + format: google-datetime + readOnly: true + type: string + description: Output only. The timestamp when the auth config is modified. + reason: + type: string + description: The reason / details of the current status. + creatorEmail: + description: >- + The creator's email address. Generated based on the End User + Credentials/LOAS role of the user making the call. + type: string + overrideValidTime: 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 - lastModifierEmail: + decryptedCredential: + description: Raw auth credentials. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCredential' + encryptedCredential: + type: string + description: >- + Auth credential encrypted by Cloud KMS. Can be decrypted as + Credential with proper KMS key. + format: byte + expiryNotificationDuration: + items: + type: string + format: google-duration + type: array + 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. + certificateId: + description: Certificate id for client certificate + type: string + description: + description: A description of the auth config. + type: string + validTime: + description: >- + The time until the auth config is valid. Empty or max value is + considered the auth config won't expire. type: string + format: google-datetime + lastModifierEmail: description: >- The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call. + type: string + visibility: + type: string + description: The visibility of the auth config. + enumDescriptions: + - Visibility not specified. + - Profile visible to the creator only. + - Profile visible within the client. + enum: + - AUTH_CONFIG_VISIBILITY_UNSPECIFIED + - PRIVATE + - CLIENT_VISIBLE + 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 + 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. + type: string name: description: >- Resource name of the auth config. For more information, see Manage authentication profiles. projects/{project}/locations/{location}/authConfigs/{authConfig}. type: string - creatorEmail: - description: >- - The creator's email address. Generated based on the End User - Credentials/LOAS role of the user making the call. - type: string - description: The AuthConfig resource use to hold channels and connection config data. - GoogleCloudConnectorsV1LogConfig: - type: object + EnterpriseCrmFrontendsEventbusProtoTaskEntity: properties: - level: - enumDescriptions: - - Log level unspecified. - - Only error logs are enabled. - - Info and error logs are enabled. - - Debug and high verbosity logs are enabled. - description: Optional. Log configuration level. + taskType: type: string + 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: - - LOG_LEVEL_UNSPECIFIED - - ERROR - - INFO - - DEBUG - enabled: - type: boolean - description: >- - Enabled represents whether logging is enabled or not for a - connection. - description: Log configuration for the connection. - id: GoogleCloudConnectorsV1LogConfig - GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration: - properties: - liftWhenExpired: - description: >- - Whether the suspension will be REJECTED or LIFTED upon expiration. - REJECTED is the default behavior. + - TASK + - ASIS_TEMPLATE + - IO_TEMPLATE + disabledForVpcSc: + description: True if the task has conflict with vpcsc type: boolean - expireTime: + uiConfig: description: >- - Output only. Time after which the suspension expires, if no action - taken. - readOnly: true - type: string - format: google-datetime - remindTime: - format: google-datetime + UI configuration for this task Also associated with the METADATA + mask. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskUiConfig' + metadata: + description: Metadata inclueds the task name, author and so on. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskMetadata' + paramSpecs: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage 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. - type: string - id: GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration - description: Expiration configs for the approval request. + 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 + id: EnterpriseCrmFrontendsEventbusProtoTaskEntity + description: >- + Contains a task's metadata and associated information. Next available + id: 7 type: object - GoogleCloudIntegrationsV1alphaParameterMap: + 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: 11 + id: EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails properties: - 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 - 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. - 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). - entries: + eventAttemptStats: items: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapEntry - description: A list of parameter map entries. + #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats type: array - 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). + eventExecutionSnapshot: description: >- - Option to specify key 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 - type: string - 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 - EnterpriseCrmEventbusProtoIntFunction: - properties: - functionName: + 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 + eventExecutionState: + description: The execution state of this event. type: string 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 + - ON_HOLD + - IN_PROCESS + - SUCCEEDED + - FAILED + - CANCELED + - RETRY_ON_HOLD + - SUSPENDED enumDescriptions: - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - type: object - id: EnterpriseCrmEventbusProtoIntFunction - GoogleCloudIntegrationsV1alphaValueType: - type: object - id: GoogleCloudIntegrationsV1alphaValueType - description: The type of the parameter. - properties: - doubleValue: - format: double - type: number - description: Double Number. - intArray: - description: Integer Array. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaIntParameterArray' - stringArray: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaStringParameterArray - description: String Array. - stringValue: + - >- + 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. + logFilePath: type: string - description: String. - intValue: - description: Integer. + description: The log file path (aka. cns address) for this event. + ryeLockUnheldCount: + type: integer + format: int32 + 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/ + eventExecutionSnapshotsSize: format: int64 type: string - jsonValue: + description: Total size of all event_execution_snapshots for an execution + networkAddress: type: string - description: Json. - booleanArray: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaBooleanParameterArray - description: Boolean Array. - doubleArray: - description: Double Number Array. - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDoubleParameterArray - booleanValue: - description: Boolean. - type: boolean - GoogleCloudIntegrationsV1alphaTaskExecutionDetails: - id: GoogleCloudIntegrationsV1alphaTaskExecutionDetails + description: >- + The network address (aka. bns address) that indicates where the + event executor is running. + nextExecutionTime: + type: string + format: int64 + description: >- + Next scheduled execution time in case the execution status was + RETRY_ON_HOLD. + eventRetriesFromBeginningCount: + type: integer + format: int32 + description: >- + Indicates the number of times the execution has restarted from the + beginning. + type: object + EnterpriseCrmEventbusProtoScatterResponse: type: object - description: Contains the details of the execution of this task. properties: - taskAttemptStats: - description: Status for the current task execution attempt. + scatterElement: + description: The element that was scattered for this execution. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' + responseParams: + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterEntry' type: array + description: >- + A list of all the response parameters in the aggregtorMap stored + with the remapped key. + isSuccessful: + 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. + type: boolean + executionIds: items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAttemptStats' - taskNumber: - description: Pointer to the task config it used for execution. + type: string + type: array + description: The execution ids of each Subworkflow fired by this scatter. + errorMsg: + description: The error message of the failure if applicable. type: string - taskExecutionState: + id: EnterpriseCrmEventbusProtoScatterResponse + EnterpriseCrmLoggingGwsFieldLimits: + description: >- + Describes string and array limits when writing to logs. When a limit is + exceeded the *shortener_type* describes how to shorten the field. + next_id: 6 + properties: + maxStringLength: + format: int32 + description: >- + maximum string length. If the field exceeds this amount the field is + shortened. + type: integer + logAction: + enum: + - LOG_ACTION_UNSPECIFIED + - DONT_LOG + - LOG 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 - description: The execution state of this task. - EnterpriseCrmEventbusProtoStringArrayFunction: - properties: - functionName: - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - '' - '' - '' + maxArraySize: + format: int32 + type: integer + description: >- + maximum array size. If the array exceds this size, the field (list) + is truncated. + shortenerType: + type: string + enumDescriptions: - '' + - String is shortened to max_string_length. + - String is replaced by its hex-string hash. + - >- + String is replaced by a combination of string shortening and a + hex-string hash. + - >- + String shortening for email addresses. Shortening may be done on + the user and/or domain portion of the email address. + - >- + String is replaced by a combination of string shortening and a + hex-string hash for an email address. + - Shortens a domain name (e.g., as part of an email address or URL). enum: - - UNSPECIFIED - - GET - - APPEND - - SIZE - - TO_SET - - APPEND_ALL - - TO_JSON - - SET - - REMOVE - - REMOVE_AT - - CONTAINS - - FOR_EACH - - FILTER + - SHORTENER_TYPE_UNSPECIFIED + - SHORTEN + - HASH + - SHORTEN_WITH_HASH + - SHORTEN_EMAIL + - SHORTEN_EMAIL_WITH_HASH + - SHORTEN_DOMAIN + logType: + items: + enum: + - LOG_TYPE_UNSPECIFIED + - GWS + - GTS + - ALL + enumDescriptions: + - '' + - Limits apply when log detail records are written to GWS. + - >- + Limits apply when log detail records are written to GTS (e.g., + RecordIO files). + - Limits apply to *all* output log types. + type: string + description: To which type(s) of logs the limits apply. + type: array + id: EnterpriseCrmLoggingGwsFieldLimits + type: object + GoogleCloudIntegrationsV1alphaTestIntegrationsResponse: + id: GoogleCloudIntegrationsV1alphaTestIntegrationsResponse + description: The response for testing an integration. + properties: + eventParameters: + deprecated: true + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + description: Details for the integration that were executed. + 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. + type: array + deprecated: true + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + 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 + executionFailed: + description: Is true if any execution in the integration failed. False otherwise. + type: boolean + executionId: + description: The id of the execution corresponding to this run of integration. type: string - id: EnterpriseCrmEventbusProtoStringArrayFunction type: object - EnterpriseCrmEventbusProtoBaseValue: + 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); } + properties: {} type: object + GoogleCloudIntegrationsV1alphaFile: properties: - baseFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFunction' - description: >- - Start with a function that does not build on existing values. Eg. - CurrentTime, Min, Max, Exists, etc. - literalValue: - description: Start with a literal value. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' - referenceValue: + type: type: string - description: Start with a reference value to dereference. - id: EnterpriseCrmEventbusProtoBaseValue - GoogleCloudIntegrationsV1alphaIntegrationVersion: - id: GoogleCloudIntegrationsV1alphaIntegrationVersion + enum: + - INTEGRATION_FILE_UNSPECIFIED + - INTEGRATION + - INTEGRATION_CONFIG_VARIABLES + enumDescriptions: + - Default value. + - Integration file. + - Integration Config variables. + description: >- + File information like Integration version, Integration Config + variables etc. + integrationConfig: + type: object + additionalProperties: + description: Properties of the object. + type: any + description: Integration version config file + integrationVersion: + description: Integration version + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + description: >- + To store Integration version related file i.e. Integration Version, + Config variable etc. + id: GoogleCloudIntegrationsV1alphaFile + type: object + EnterpriseCrmEventbusProtoConditionalFailurePolicies: properties: - integrationParameters: - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationParameter + failurePolicies: type: array 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. - parentTemplateId: + The list of failure policies that will be applied to the task in + order. + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' + defaultFailurePolicy: description: >- - Optional. The id of the template which was used to create this - integration_version. + The default failure policy to be applied if no conditional failure + policy matches + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' + id: EnterpriseCrmEventbusProtoConditionalFailurePolicies + type: object + GoogleCloudIntegrationsV1alphaIntegration: + description: The integration definition. + properties: + lastModifierEmail: + type: string + description: Required. The last modifier of this integration + 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 + active: + description: Required. If any integration version is published. + type: boolean updateTime: - description: Output only. Auto-generated. readOnly: true + type: string format: google-datetime + description: Output only. Auto-generated. + creatorEmail: type: string - triggerConfigsInternal: - type: array - description: Optional. Trigger configurations. - deprecated: true - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoTriggerConfig - errorCatcherConfigs: - type: array description: >- - Optional. Error Catch Task configuration for the integration. It's - optional. - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaErrorCatcherConfig - lockHolder: - description: >- - Optional. The edit lock holder's email address. Generated based on - the End User Credentials/LOAS role of the user making the call. + Output only. The creator's email address. Generated based on the End + User Credentials/LOAS role of the user making the call. + readOnly: true + description: type: string - enableVariableMasking: - description: >- - Optional. True if variable masking feature should be turned on for - this version - type: boolean - taskConfigs: + description: Optional. + type: object + id: GoogleCloudIntegrationsV1alphaIntegration + GoogleCloudIntegrationsV1alphaLiftSuspensionResponse: + description: Response of lift Suspense + id: GoogleCloudIntegrationsV1alphaLiftSuspensionResponse + type: object + properties: + eventExecutionInfoId: + type: string + description: Execution Id that will be returned + EnterpriseCrmEventbusProtoSuspensionConfig: + id: EnterpriseCrmEventbusProtoSuspensionConfig + type: object + properties: + notifications: 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. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNotification' type: array - taskConfigsInternal: + suspensionExpiration: + description: >- + Indicates the next steps when no external actions happen on the + suspension. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuspensionExpiration' + whoMayResolve: + description: Identities able to resolve this suspension. type: array items: - $ref: '#/components/schemas/EnterpriseCrmFrontendsEventbusProtoTaskConfig' - deprecated: true + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissions + customMessage: description: >- - Optional. Task configuration for the integration. It's optional, but - the integration doesn't do anything without task_configs. - lastModifierEmail: + 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 + GoogleCloudIntegrationsV1alphaReplayExecutionRequest: + type: object + id: GoogleCloudIntegrationsV1alphaReplayExecutionRequest + properties: + replayReason: + description: Optional. The user provided reason for replaying the execution. + type: string + description: 'Request for replaying an execution Next ID: 3' + GoogleCloudConnectorsV1EventingConfig: + description: Eventing Configuration of a connection + properties: + additionalVariables: + description: Additional eventing related field values + type: array + items: + $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' + enrichmentEnabled: + type: boolean + description: Enrichment Enabled. + privateConnectivityEnabled: + type: boolean + description: Optional. Private Connectivity Enabled. + eventsListenerIngressEndpoint: description: >- - Optional. The last modifier's email address. Generated based on the - End User Credentials/LOAS role of the user making the call. - status: - description: >- - Output only. Generated by eventbus. User should not set it as an - input. - deprecated: true + Optional. Ingress endpoint of the event listener. This is used only + when private connectivity is enabled. + type: string + deadLetterConfig: + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1EventingConfigDeadLetterConfig + description: Optional. Dead letter configuration for eventing of a connection. + proxyDestinationConfig: + description: Optional. Proxy for Eventing auto-registration. + $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' + registrationDestinationConfig: + description: Registration endpoint for auto registration. + $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' + listenerAuthConfig: + $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' + description: Optional. Auth details for the event listener. + authConfig: + description: Auth details for the webhook adapter. + $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' + id: GoogleCloudConnectorsV1EventingConfig + type: object + EnterpriseCrmEventbusProtoDoubleFunction: + type: object + id: EnterpriseCrmEventbusProtoDoubleFunction + properties: + functionName: enumDescriptions: - '' - '' - '' - '' - '' - enum: - - UNKNOWN - - DRAFT - - ACTIVE - - ARCHIVED - - SNAPSHOT + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' type: string - readOnly: true - origin: enum: - UNSPECIFIED - - UI - - PIPER_V2 - - PIPER_V3 - - APPLICATION_IP_PROVISIONING - - TEST_CASE + - TO_JSON + - TO_STRING + - ADD + - SUBTRACT + - MULTIPLY + - DIVIDE + - EXPONENT + - ROUND + - FLOOR + - CEIL + - GREATER_THAN + - LESS_THAN + - EQUALS + - GREATER_THAN_EQUALS + - LESS_THAN_EQUALS + - MOD + GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials: + id: GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials + 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. + properties: + scope: + type: string + description: A space-delimited list of requested scope permissions. + tokenEndpoint: 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. - deprecated: true - enumDeprecated: - - false - - false - - true - - false - - false - - false - description: >- - Optional. The origin that indicates where this integration is coming - from. - 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. + The token endpoint is used by the client to obtain an access token + by presenting its authorization grant or refresh token. + tokenParams: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' + description: Token parameters for the auth request. + clientId: + description: The client's ID. type: string - format: int64 - triggerConfigs: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTriggerConfig' - description: Optional. Trigger configurations. - type: array - name: + accessToken: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken' + description: Access token fetched from the authorization server. + clientSecret: + description: The client's secret. type: string - readOnly: true - description: Output only. Auto-generated primary key. - cloudLoggingDetails: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCloudLoggingDetails - description: Optional. Cloud Logging details for the integration version - databasePersistencePolicy: - description: >- - Optional. Flag to disable database persistence for execution data, - including event execution info, execution export info, execution - metadata index and execution param index. + requestType: 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 + - 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 - description: + enum: + - REQUEST_TYPE_UNSPECIFIED + - REQUEST_BODY + - QUERY_PARAMETERS + - ENCODED_HEADER + description: Represent how to pass parameters to fetch access token + GoogleCloudIntegrationsV1alphaParameterMapField: + id: GoogleCloudIntegrationsV1alphaParameterMapField + properties: + referenceKey: type: string - description: Optional. The integration description. - 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. - userLabel: + description: Referencing one of the Integration variables. + literalValue: + description: Passing a literal value. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + type: object + description: Field represents either the key or value in an entry. + GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse: + type: object + id: GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse + description: Response for ListIntegrationVersions. + properties: + noPermission: + description: Whether the user has no permission on the version or not. + type: boolean + nextPageToken: description: >- - Optional. A user-defined label that annotates an integration - version. Typically, this is only set when the integration version is - created. + 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 - 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. - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoWorkflowParameters - deprecated: true - createTime: + integrationVersions: + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + type: array + description: The integrations which match the request. + GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest: + properties: {} + description: Request for TakeoverEditLock. + type: object + id: GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest + GoogleCloudIntegrationsV1alphaResolveSuspensionResponse: + id: GoogleCloudIntegrationsV1alphaResolveSuspensionResponse + type: object + description: Response for Suspensions.ResolveSuspensions. + properties: {} + EnterpriseCrmEventbusProtoIntArray: + id: EnterpriseCrmEventbusProtoIntArray + type: object + properties: + values: + items: + format: int64 + type: string + type: array + 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 + type: object + properties: + secret: type: string - format: google-datetime - readOnly: true - description: Output only. Auto-generated. - createdFromTemplate: + description: User's pre-shared secret to sign the token. + jwtHeader: type: string - description: >- - Optional. Optional. The resource name of the template from which the - integration is created. - state: - enumDescriptions: - - Default. - - Draft. - - Active. - - Archived. - - Snapshot. + description: Identifies which algorithm is used to generate the signature. + jwt: type: string - description: Output only. User should not set it as an input. - enum: - - INTEGRATION_STATE_UNSPECIFIED - - DRAFT - - ACTIVE - - ARCHIVED - - SNAPSHOT - readOnly: true - teardown: - deprecated: true - 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' - runAsServiceAccount: + description: The token calculated by the header, payload and signature. + jwtPayload: 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. + 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. type: string - type: object - description: The integration version definition. - GoogleCloudConnectorsV1DestinationConfig: - description: Define the Connectors target endpoint. + EnterpriseCrmEventbusProtoCombinedCondition: + deprecated: true + id: EnterpriseCrmEventbusProtoCombinedCondition + description: >- + This message recursively combines constituent conditions using logical + AND. type: object properties: - destinations: - description: The destinations for the key. + conditions: + description: A set of individual constituent conditions. items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Destination' + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCondition' type: array - key: + EnterpriseCrmEventbusProtoConditionResult: + description: Contains the combined condition calculation results. + properties: + result: + type: boolean description: >- - The key is the destination identifier that is supported by the - Connector. + the result comes out after evaluate the combined condition. True if + there's no combined condition specified. + nextTaskNumber: type: string - id: GoogleCloudConnectorsV1DestinationConfig - GoogleCloudIntegrationsV1alphaParameterMapEntry: - id: GoogleCloudIntegrationsV1alphaParameterMapEntry + description: the next task number. + currentTaskNumber: + description: the current task number. + type: string + id: EnterpriseCrmEventbusProtoConditionResult type: object - description: Entry is a pair of key and value. - properties: - key: - description: Key of the map entry. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapField' - value: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapField' - description: Value of the map entry. - EnterpriseCrmEventbusProtoSuccessPolicy: + EnterpriseCrmEventbusStats: type: object - id: EnterpriseCrmEventbusProtoSuccessPolicy properties: - finalState: - description: >- - State to which the execution snapshot status will be set if the task - succeeds. - 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. - enum: - - UNSPECIFIED - - SUCCEEDED - - SUSPENDED - type: string + durationInSeconds: + type: number + format: double + description: Average duration in seconds. + qps: + description: Queries per second. + format: double + type: number + warningRate: + format: double + description: Average warning rate. + type: number + errorRate: + format: double + type: number + description: Average error rate. + dimensions: + $ref: '#/components/schemas/EnterpriseCrmEventbusStatsDimensions' + description: Dimensions that these stats have been aggregated on. + id: EnterpriseCrmEventbusStats description: >- - Policy that dictates the behavior for the task after it completes - successfully. - GoogleCloudIntegrationsV1alphaGetClientResponse: + Stats for the requested dimensions: QPS, duration, and error/warning + rate + GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse: type: object - id: GoogleCloudIntegrationsV1alphaGetClientResponse - description: Response for the GetClient rpc properties: - client: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaClientConfig' - description: 'Required. Required: The client configuration that was requested' - EnterpriseCrmEventbusProtoCustomSuspensionRequest: + integrationVersion: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + description: Version after the lock is acquired by the new user. + id: GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse + description: Response for TakeoverEditLock. + GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse: + id: GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse type: object - id: EnterpriseCrmEventbusProtoCustomSuspensionRequest properties: - postToQueueWithTriggerIdRequest: - description: Request to fire an event containing the SuspensionInfo message. - $ref: >- - #/components/schemas/GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest - suspensionInfoEventParameterKey: + regions: + items: + type: string + description: All regions where Connector Platform is provisioned. + type: array + description: Response containing all provisioned regions for Connector Platform. + GoogleCloudConnectorsV1LockConfig: + type: object + properties: + locked: + description: Indicates whether or not the connection is locked. + type: boolean + reason: type: string - description: >- - In the fired event, set the SuspensionInfo message as the value for - this key. - CrmlogErrorCode: - id: CrmlogErrorCode + description: Describes why a connection is locked. description: >- - Registered ids for errors, as "oneof" enums. Each task or logical - grouping of tasks may share the same enum. + Determines whether or no a connection is locked. If locked, a reason + must be specified. + id: GoogleCloudConnectorsV1LockConfig + EnterpriseCrmFrontendsEventbusProtoRollbackStrategy: + description: 'Next available id: 4' properties: - commonErrorCode: + rollbackTaskImplementationClassName: 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 - 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. - - '' - - '' - - '' - - '' - - '' - 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: object - EnterpriseCrmEventbusProtoScatterResponse: - properties: - responseParams: - type: array - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterEntry' description: >- - A list of all the response parameters in the aggregtorMap stored - with the remapped key. - executionIds: - type: array - description: The execution ids of each Subworkflow fired by this scatter. + Required. This is the name of the task that needs to be executed + upon rollback of this task. + parameters: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + description: Optional. The customized parameters the user can pass to this task. + taskNumbersToRollback: items: type: string - errorMsg: - description: The error message of the failure if applicable. - type: string - scatterElement: - description: The element that was scattered for this execution. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' - isSuccessful: - type: boolean + type: array 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. + 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 - id: EnterpriseCrmEventbusProtoScatterResponse - GoogleCloudIntegrationsV1alphaIntegrationConfigParameter: - properties: - parameter: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationParameter - description: >- - Optional. Integration Parameter to provide the default value, data - type and attributes required for the Integration config variables. - 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' - 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. + GoogleCloudIntegrationsV1alphaGetClientResponse: type: object - id: GoogleCloudIntegrationsV1alphaIntegrationConfigParameter - EnterpriseCrmEventbusProtoBuganizerNotification: + properties: + client: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaClientConfig' + description: 'Required. Required: The client configuration that was requested' + description: Response for the GetClient rpc + id: GoogleCloudIntegrationsV1alphaGetClientResponse + EnterpriseCrmEventbusProtoCloudKmsConfig: type: object - id: EnterpriseCrmEventbusProtoBuganizerNotification + id: EnterpriseCrmEventbusProtoCloudKmsConfig properties: - componentId: - type: string - format: int64 + keyRingName: description: >- - ID of the buganizer component within which to create a new issue. - Required. - assigneeEmailAddress: + 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 - description: Whom to assign the new bug. Optional. - templateId: - description: ID of the buganizer template to use. Optional. - format: int64 + locationName: type: string - title: + description: Location name of the key ring, e.g. "us-west1". + gcpProjectId: + 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). + type: string + keyVersionName: type: string - description: Title of the issue to be created. Required. - EnterpriseCrmEventbusProtoConditionResult: - properties: - result: - type: boolean description: >- - the result comes out after evaluate the combined condition. True if - there's no combined condition specified. - currentTaskNumber: + 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. + 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 - description: the current task number. - nextTaskNumber: - description: the next task number. + keyName: type: string - description: Contains the combined condition calculation results. - type: object - id: EnterpriseCrmEventbusProtoConditionResult + 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. GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest: + type: object properties: - parameters: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' - deprecated: true - description: Passed in as parameters to each integration execution. + inputParameters: + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + type: object + description: Optional. Input parameters used by integration execution. triggerId: + type: string description: >- Required. Matched against all {@link TriggerConfig}s across all integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id) - type: string + 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. + deprecated: true + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry scheduleTime: - 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. + format: google-datetime type: string + parameters: + description: Passed in as parameters to each integration execution. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + deprecated: true 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. + type: string 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 - parameterEntries: - deprecated: true - 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. - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - inputParameters: - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - description: Optional. Input parameters used by integration execution. description: 'The request for scheduling an integration. Next available id: 11' id: GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest - type: object - EnterpriseCrmEventbusProtoFunction: + EnterpriseCrmEventbusProtoParameterEntry: + id: EnterpriseCrmEventbusProtoParameterEntry properties: - functionType: - description: The name of the function to perform. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFunctionType' - parameters: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTransformExpression' - description: List of parameters required for the transformation. - type: array - type: object - id: EnterpriseCrmEventbusProtoFunction - GoogleCloudIntegrationsV1alphaFile: + masked: + type: boolean + description: True if this parameter should be masked in the logs + 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: object - description: >- - To store Integration version related file i.e. Integration Version, - Config variable etc. + description: Key-value pair of EventBus parameters. + GoogleCloudIntegrationsV1alphaCredential: + description: Defines parameters for a single, canonical credential. + id: GoogleCloudIntegrationsV1alphaCredential properties: - integrationConfig: - description: Integration version config file - additionalProperties: - type: any - description: Properties of the object. - type: object - integrationVersion: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - description: Integration version - type: + credentialType: + description: Credential type associated with auth config. enumDescriptions: - - Default value. - - Integration file. - - Integration Config variables. + - 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 + 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 + oauth2ClientCredentials: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials + description: OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials + oauth2ResourceOwnerCredentials: + description: OAuth2 resource owner credentials + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials + usernameAndPassword: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUsernameAndPassword + description: Username and password credential + authToken: + description: Auth token credential + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthToken' + oidcToken: + description: Google OIDC ID Token + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaOidcToken' + oauth2AuthorizationCode: description: >- - File information like Integration version, Integration Config - variables etc. - enum: - - INTEGRATION_FILE_UNSPECIFIED - - INTEGRATION - - INTEGRATION_CONFIG_VARIABLES - id: GoogleCloudIntegrationsV1alphaFile - GoogleCloudIntegrationsV1alphaIntegration: - description: The integration definition. - id: GoogleCloudIntegrationsV1alphaIntegration + 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 + jwt: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaJwt' + description: JWT credential + serviceAccountCredentials: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaServiceAccountCredentials + description: Service account credential + type: object + EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats: + id: EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats type: object properties: - updateTime: - readOnly: true - type: string - description: Output only. Auto-generated. - format: google-datetime - active: - description: Required. If any integration version is published. - type: boolean - lastModifierEmail: + endTime: + format: int64 type: string - description: Required. The last modifier of this integration - creatorEmail: - readOnly: true + description: The end time of the event execution for current attempt. + startTime: + format: int64 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. - name: - type: string - description: Required. The resource name of the integration. - description: - description: Optional. - type: string - createTime: - type: string - description: Required. Output only. Auto-generated. - readOnly: true - format: google-datetime - GoogleCloudIntegrationsV1alphaSerializedFile: - id: GoogleCloudIntegrationsV1alphaSerializedFile - type: object - description: To store string representation of Integration file. - properties: - content: - type: string - description: String representation of the file content. - file: - type: string - description: >- - File information like Integration version, Integration Config - variables etc. - enum: - - INTEGRATION_FILE_UNSPECIFIED - - INTEGRATION - - INTEGRATION_CONFIG_VARIABLES - enumDescriptions: - - Default value. - - Integration file. - - Integration Config variables. - 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: 11 + The start time of the event execution for current attempt. This + could be in the future if it's been scheduled. + GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse: + id: GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse type: object + description: Response to list SfdcInstances. properties: - nextExecutionTime: - type: string - format: int64 - description: >- - Next scheduled execution time in case the execution status was - RETRY_ON_HOLD. - eventRetriesFromBeginningCount: - format: int32 - description: >- - Indicates the number of times the execution has restarted from the - beginning. - type: integer - logFilePath: - description: The log file path (aka. cns address) for this event. - type: string - ryeLockUnheldCount: - type: integer - format: int32 - 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/ - networkAddress: - description: >- - The network address (aka. bns address) that indicates where the - event executor is running. - type: string - eventExecutionSnapshotsSize: - description: Total size of all event_execution_snapshots for an execution - type: string - format: int64 - 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 - eventExecutionState: - description: The execution state of this event. - type: string - 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. - eventAttemptStats: + sfdcInstances: type: array + description: The list of SfdcInstances retrieved. items: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats - id: EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails - GoogleCloudIntegrationsV1alphaUsernameAndPassword: - properties: - password: - type: string - description: Password to be used - username: - type: string - description: Username to be used - id: GoogleCloudIntegrationsV1alphaUsernameAndPassword - description: Username and password pair. - type: object - GoogleCloudIntegrationsV1alphaListAuthConfigsResponse: - id: GoogleCloudIntegrationsV1alphaListAuthConfigsResponse - type: object - description: Response to list AuthConfigs. - properties: - authConfigs: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' - type: array - description: The list of AuthConfigs retrieved. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' nextPageToken: - type: string description: The token used to retrieve the next page of results. - GoogleCloudConnectorsV1ResourceLimits: - type: object - description: Resource limits defined for connection pods of a given connector type. - id: GoogleCloudConnectorsV1ResourceLimits - properties: - cpu: - description: Output only. CPU limit. - type: string - readOnly: true - memory: type: string - description: Output only. Memory limit. - readOnly: true - EnterpriseCrmEventbusProtoBooleanArrayFunction: - type: object - id: EnterpriseCrmEventbusProtoBooleanArrayFunction + EnterpriseCrmEventbusProtoIntFunction: + id: EnterpriseCrmEventbusProtoIntFunction properties: functionName: - enum: - - UNSPECIFIED - - GET - - APPEND - - SIZE - - TO_SET - - APPEND_ALL - - TO_JSON - - SET - - REMOVE - - REMOVE_AT - - CONTAINS - - FOR_EACH - - FILTER - type: string enumDescriptions: - '' - '' @@ -3126,666 +2466,529 @@ components: - '' - '' - '' - GoogleCloudIntegrationsV1alphaCredential: - properties: - oauth2ClientCredentials: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials - description: OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials - authToken: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthToken' - description: Auth token credential - oidcToken: - description: Google OIDC ID Token - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaOidcToken' - credentialType: - description: Credential type associated with auth config. - 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 + - '' + - '' + - '' 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 - oauth2ResourceOwnerCredentials: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials - description: OAuth2 resource owner 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 - serviceAccountCredentials: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaServiceAccountCredentials - description: Service account credential - jwt: - description: JWT credential - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaJwt' - usernameAndPassword: - description: Username and password credential - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUsernameAndPassword + - 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: object - description: Defines parameters for a single, canonical credential. - id: GoogleCloudIntegrationsV1alphaCredential - EnterpriseCrmEventbusProtoProtoParameterArray: - properties: - protoValues: - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - type: array - id: EnterpriseCrmEventbusProtoProtoParameterArray + EnterpriseCrmEventbusProtoExternalTraffic: type: object - GoogleCloudIntegrationsV1alphaFailurePolicy: - id: GoogleCloudIntegrationsV1alphaFailurePolicy properties: - 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. + gcpProjectId: type: string - format: google-datetime - maxRetries: - format: int32 - 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. - retryStrategy: + description: User’s GCP project id the traffic is referring to. + retryRequestForQuota: + description: Enqueue the execution request due to quota issue + type: boolean + source: 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. - description: Defines what happens to the task upon failure. + - '' + - '' + - '' + type: string + description: >- + LINT.ThenChange(//depot/google3/enterprise/crm/eventbus/proto/product.proto:product, + //depot/google3/java/com/google/enterprise/crm/integrationplatform/api/utils/ConverterUtils.java:source_to_product) enum: - - RETRY_STRATEGY_UNSPECIFIED - - IGNORE - - NONE - - FATAL - - FIXED_INTERVAL - - LINEAR_BACKOFF - - EXPONENTIAL_BACKOFF - - RESTART_INTEGRATION_WITH_BACKOFF + - SOURCE_UNSPECIFIED + - APIGEE + - SECURITY + gcpProjectNumber: + description: User’s GCP project number the traffic is referring to. type: string - condition: + location: type: string - description: >- - Optional. The string condition that will be evaluated to determine - if the task should be retried with this failure policy. - type: object + description: Location for the user's request. + description: Represents external traffic type and id. + id: EnterpriseCrmEventbusProtoExternalTraffic + EnterpriseCrmEventbusProtoParameterValueType: 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). - GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue: + LINT.IfChange To support various types of parameter values. Next + available id: 14 properties: - percentage: - type: integer - description: Percentage threshold. - format: int32 - absolute: - description: Absolute value threshold. - type: string + stringArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringParameterArray' + intValue: format: int64 - id: GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue - 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. - GoogleCloudConnectorsV1Destination: - id: GoogleCloudConnectorsV1Destination - type: object - properties: - serviceAttachment: - description: >- - PSC service attachments. Format: - projects/*/regions/*/serviceAttachments/* - deprecated: true - type: string - host: - description: For publicly routable host. type: string - port: - type: integer - description: >- - The port is the target port number that is accepted by the - destination. - format: int32 - GoogleCloudIntegrationsV1alphaListExecutionsResponse: - properties: - executions: - type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' - description: The detailed information of requested executions - executionInfos: - type: array - description: Required. The detailed information of requested executions. - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo - deprecated: true - nextPageToken: + booleanValue: + type: boolean + doubleArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleParameterArray' + protoArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoParameterArray' + booleanArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBooleanParameterArray' + doubleValue: + type: number + format: double + protoValue: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + stringValue: type: string - description: The token used to retrieve the next page results. - type: object - description: Response for listing the integration execution data. - id: GoogleCloudIntegrationsV1alphaListExecutionsResponse - EnterpriseCrmEventbusStatsDimensions: - id: EnterpriseCrmEventbusStatsDimensions + intArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntParameterArray' + serializedObjectValue: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoSerializedObjectParameter + id: EnterpriseCrmEventbusProtoParameterValueType type: object + GoogleCloudIntegrationsV1alphaIntegrationVersion: + id: GoogleCloudIntegrationsV1alphaIntegrationVersion + description: The integration version definition. properties: - enumFilterType: + state: + readOnly: true + enumDescriptions: + - Default. + - Draft. + - Active. + - Archived. + - Snapshot. enum: - - DEFAULT_INCLUSIVE - - EXCLUSIVE - description: Whether to include or exclude the enums matching the regex. + - INTEGRATION_STATE_UNSPECIFIED + - DRAFT + - ACTIVE + - ARCHIVED + - SNAPSHOT type: string - enumDescriptions: - - '' - - '' - taskNumber: + description: Output only. User should not set it as an input. + createdFromTemplate: type: string - clientId: + description: >- + Optional. Optional. The resource name of the template from which the + integration is created. + lastModifierEmail: type: string - taskName: + description: >- + Optional. The last modifier's email address. Generated based on the + End User Credentials/LOAS role of the user making the call. + userLabel: type: string - warningEnumString: + description: >- + Optional. A user-defined label that annotates an integration + version. Typically, this is only set when the integration version is + created. + cloudLoggingDetails: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaCloudLoggingDetails + description: Optional. Cloud Logging details for the integration version + description: type: string - errorEnumString: + description: Optional. The integration description. + enableVariableMasking: + description: >- + Optional. True if variable masking feature should be turned on for + this version + type: boolean + triggerConfigs: + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTriggerConfig' + description: Optional. Trigger configurations. + 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 + parentTemplateId: type: string - workflowId: + description: >- + Optional. The id of the template which was used to create this + integration_version. + createTime: + description: Output only. Auto-generated. + readOnly: true type: string - triggerId: + format: google-datetime + databasePersistencePolicy: type: string description: >- - Stats have been or will be aggregated on set fields for any - semantically-meaningful combination. - workflowName: - type: string - retryAttempt: - type: string + Optional. Flag to disable database persistence for execution data, + including event execution info, execution export info, execution + metadata index and execution param index. enumDescriptions: - - '' - - >- - Task has completed successfully or has depleted all retry - attempts. - - Task has failed but may be retried. - - Task has been deliberately canceled. + - 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 + origin: + description: >- + Optional. The origin that indicates where this integration is coming + from. + deprecated: true enum: - UNSPECIFIED - - FINAL - - RETRYABLE - - CANCELED - EnterpriseCrmEventbusProtoEventParameters: - type: object - properties: - parameters: + - UI + - PIPER_V2 + - PIPER_V3 + - APPLICATION_IP_PROVISIONING + - TEST_CASE + enumDeprecated: + - false + - false + - true + - false + - false + - false + 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. + type: string + errorCatcherConfigs: + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaErrorCatcherConfig + 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. + Optional. Error Catch Task configuration for the integration. It's + optional. + taskConfigsInternal: items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterEntry' + $ref: '#/components/schemas/EnterpriseCrmFrontendsEventbusProtoTaskConfig' + deprecated: true + description: >- + Optional. Task configuration for the integration. It's optional, but + the integration doesn't do anything without task_configs. type: array - 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 - GoogleCloudConnectorsV1HPAConfig: - id: GoogleCloudConnectorsV1HPAConfig - type: object - description: Autoscaling config for connector deployment system metrics. - properties: - cpuUtilizationThreshold: - readOnly: true - type: string + triggerConfigsInternal: + description: Optional. Trigger configurations. + type: array + deprecated: true + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoTriggerConfig + snapshotNumber: format: int64 - description: Output only. Percent CPU utilization where HPA triggers autoscaling. - memoryUtilizationThreshold: - readOnly: true description: >- - Output only. Percent Memory utilization where HPA triggers - autoscaling. + 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. type: string - format: int64 - EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit: - properties: - resolvedByCpi: + 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. + 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 - timestamp: + 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. + lockHolder: + description: >- + 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 - format: google-datetime - resolvedBy: + name: + description: Output only. Auto-generated primary key. + readOnly: true type: string - id: EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit - type: object - EnterpriseCrmEventbusProtoDoubleArrayFunction: - id: EnterpriseCrmEventbusProtoDoubleArrayFunction - type: object - properties: - functionName: + teardown: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTeardown' + 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 + 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. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoWorkflowParameters + deprecated: true + status: + enum: + - UNKNOWN + - DRAFT + - ACTIVE + - ARCHIVED + - SNAPSHOT + description: >- + Output only. Generated by eventbus. User should not set it as an + input. enumDescriptions: - '' - '' - '' - '' - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - UNSPECIFIED - - GET - - APPEND - - SIZE - - SUM - - AVG - - MAX - - MIN - - TO_SET - - APPEND_ALL - - TO_JSON - - SET - - REMOVE - - REMOVE_AT - - CONTAINS - - FOR_EACH - - FILTER + deprecated: true type: string - EnterpriseCrmEventbusProtoMappedField: - properties: - inputField: - description: The input field being mapped from. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoField' - outputField: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoField' - description: The output field being mapped to. - id: EnterpriseCrmEventbusProtoMappedField - description: Mapped field is a pair of input field and output field. - type: object - GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest: - id: GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest - description: Request for UnpublishIntegrationVersion. - properties: {} + readOnly: true + updateTime: + format: google-datetime + description: Output only. Auto-generated. + type: string + readOnly: true type: object - EnterpriseCrmEventbusProtoIntArrayFunction: + EnterpriseCrmEventbusProtoSuccessPolicy: + description: >- + Policy that dictates the behavior for the task after it completes + successfully. type: object + id: EnterpriseCrmEventbusProtoSuccessPolicy properties: - functionName: + finalState: + description: >- + State to which the execution snapshot status will be set if the task + succeeds. + type: string + enum: + - UNSPECIFIED + - SUCCEEDED + - SUSPENDED enumDescriptions: - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - UNSPECIFIED - - GET - - APPEND - - SIZE - - SUM - - AVG - - MAX - - MIN - - TO_SET - - APPEND_ALL - - TO_JSON - - SET - - REMOVE - - REMOVE_AT - - CONTAINS - - FOR_EACH - - FILTER - type: string - id: EnterpriseCrmEventbusProtoIntArrayFunction - EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition: + - >- + 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. + EnterpriseCrmEventbusProtoTaskAlertConfig: + id: EnterpriseCrmEventbusProtoTaskAlertConfig type: object + description: >- + Message to be used to configure alerting in the {@code TaskConfig} + protos for tasks in an event. properties: - fullName: - description: >- - The fully-qualified proto name. This message, for example, would be - "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition". - type: string - path: - description: Path to the proto file that contains the message type's definition. - type: string - id: EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition - GoogleCloudIntegrationsV1alphaRuntimeActionSchema: - properties: - action: - type: string - description: Name of the action. - inputSchema: - type: string - description: Input parameter schema for the action. - outputSchema: + alertName: type: string - description: Output parameter schema for the action. - description: Metadata of an action, including schemas for its inputs and outputs. - id: GoogleCloudIntegrationsV1alphaRuntimeActionSchema - type: object - GoogleCloudIntegrationsV1alphaErrorCatcherConfig: - description: Configuration detail of a error catch task - id: GoogleCloudIntegrationsV1alphaErrorCatcherConfig - type: object - properties: - errorCatcherId: 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 - type: string - startErrorTasks: + 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. + onlyFinalAttempt: + type: boolean + description: Only count final task attempts, not retries. + playbookUrl: description: >- - Required. The set of start tasks that are to be executed for the - error catch flow - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask' - type: array - label: + Link to a playbook for resolving the issue that triggered this + alert. type: string - description: >- - Optional. The user created label for a particular error catcher. - Optional. - position: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' - description: >- - Optional. Informs the front-end application where to draw this error - catcher config on the UI. - errorCatcherNumber: + durationThresholdMs: type: string description: >- - Required. A number to uniquely identify each error catcher config - within the workflow on UI. - 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 + numAggregationPeriods: + 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. + clientId: type: string description: >- - Optional. User-provided description intended to give more business - context about the error catcher config. - GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest: - id: GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest - description: Request for UploadIntegrationVersion. - properties: - fileFormat: - description: File format for upload request. + Client associated with this alert configuration. Must be a client + enabled in one of the containing workflow's triggers. + metricType: enumDescriptions: - - Unspecified file format - - JSON File Format - - YAML File Format - type: string + - >- + 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: - - FILE_FORMAT_UNSPECIFIED - - JSON - - YAML - content: - description: The textproto of the integration_version. + - METRIC_TYPE_UNSPECIFIED + - TASK_ERROR_RATE + - TASK_WARNING_RATE + - TASK_RATE + - TASK_AVERAGE_DURATION + - TASK_PERCENTILE_DURATION type: string - type: object - GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest: - properties: - enableVariableMasking: + alertDisabled: 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 - GoogleCloudIntegrationsV1alphaSfdcInstance: - description: >- - The SfdcInstance resource use to hold channels and connection config - data. - id: GoogleCloudIntegrationsV1alphaSfdcInstance - properties: - authConfigId: - description: A list of AuthConfigs that can be tried to open the channel to SFDC - type: array - items: - type: string - createTime: - description: Output only. Time when the instance is created - readOnly: true - format: google-datetime - type: string - displayName: - description: User selected unique name/alias to easily reference an instance. + Set to false by default. When set to true, the metrics are not + aggregated or pushed to Monarch for this workflow alert. + thresholdType: + 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. type: string - deleteTime: - format: google-datetime - readOnly: 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. + - '' + warningEnumList: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList + errorEnumList: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList + aggregationPeriod: type: string description: >- - Output only. Time when the instance was deleted. Empty if not - deleted. - serviceAuthority: - type: string + 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: description: >- - URL used for API calls after authentication (the login authority is - configured within the referenced AuthConfig). - sfdcOrgId: - description: The SFDC Org Id. This is defined in salesforce. - type: string - description: - description: A description of the sfdc instance. - type: string - name: + The metric value, above or below which the alert should be + triggered. + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue + GoogleCloudIntegrationsV1alphaClientCertificate: + id: GoogleCloudIntegrationsV1alphaClientCertificate + type: object + description: Contains client certificate information + properties: + passphrase: description: >- - Resource name of the SFDC instance - projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}. + '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 - updateTime: - readOnly: true - description: Output only. Time when the instance was last updated + encryptedPrivateKey: type: string - format: google-datetime - type: object - GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials: - id: GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials - properties: - requestType: - description: Represent how to pass parameters to fetch access token - type: string - 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. - scope: - description: A space-delimited list of requested scope permissions. - type: string - 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: - description: Access token fetched from the authorization server. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken' - username: - type: string - description: The user's username. - password: - description: The user's password. - type: string - clientSecret: - type: string - description: The client's secret. - clientId: - type: string - description: The client's ID. - tokenParams: - description: Token parameters for the auth request. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' - 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 - EnterpriseCrmEventbusProtoNodeIdentifier: - properties: - elementType: - enumDescriptions: - - '' - - '' - - '' - description: Destination node where the edge ends. It can only be a task config. - enum: - - UNKNOWN_TYPE - - TASK_CONFIG - - TRIGGER_CONFIG - type: string - elementIdentifier: - type: string - description: Configuration of the edge. - description: 'Represents a node identifier (type + id). Next highest id: 3' - id: EnterpriseCrmEventbusProtoNodeIdentifier - type: object - EnterpriseCrmEventbusProtoParameterMapEntry: - id: EnterpriseCrmEventbusProtoParameterMapEntry - type: object - properties: - value: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapField' - key: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapField' - description: Entry is a pair of key and value. - EnterpriseCrmEventbusProtoParameterEntry: - type: object - 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 integration definition. + 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 - value: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' 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 - id: EnterpriseCrmEventbusProtoParameterEntry + 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----- GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata: - type: object - id: GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata properties: - task: + ancestorIterationNumbers: + type: array + items: + type: string + 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. type: string - description: the task name associated with this snapshot. taskAttempt: - description: the task attempt number this snapshot belongs to. type: integer format: int32 + description: the task attempt number this snapshot belongs to. + task: + type: string + description: the task name associated with this snapshot. ancestorTaskNumbers: items: type: string @@ -3794,564 +2997,431 @@ components: task is under 'private workflow') type: array taskNumber: - description: The task number associated with this snapshot. type: string + description: The task number associated with this snapshot. integrationName: - type: string description: >- The direct integration which the event execution snapshots belongs to + type: string executionAttempt: format: int32 description: the execution attempt number this snapshot belongs to. type: integer - ancestorIterationNumbers: - type: array + type: object + description: Metadata of the execution snapshot. + id: GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata + GoogleCloudIntegrationsV1alphaLiftSuspensionRequest: + properties: + suspensionResult: + type: string description: >- - Ancestor iteration number for the task(it will only be non-empty if - the task is under 'private workflow') - items: - type: string - taskLabel: - description: the task label associated with this snapshot. Could be empty. + 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 + description: Request for lift Suspension + id: GoogleCloudIntegrationsV1alphaLiftSuspensionRequest + EnterpriseCrmEventbusProtoBaseFunction: + properties: + functionName: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - UNSPECIFIED + - NOW_IN_MILLIS + - INT_LIST + - ENVIRONMENT + - GET_EXECUTION_ID + - GET_INTEGRATION_NAME + - GET_REGION + - GET_UUID + - GET_PROJECT_ID type: string - description: Metadata of the execution snapshot. - GoogleCloudIntegrationsV1alphaTaskConfig: type: object + id: EnterpriseCrmEventbusProtoBaseFunction + EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange: properties: - taskTemplate: + min: + type: number + description: The inclusive minimum of the acceptable range. + format: double + max: + format: double + type: number + description: The inclusive maximum of the acceptable range. + id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange + type: object + description: Range used to validate doubles and floats. + GoogleCloudIntegrationsV1alphaCloudSchedulerConfig: + properties: + location: description: >- - Optional. Used to define task-template name if task is of type - task-template + Required. The location where associated cloud scheduler job will be + created type: string - nextTasks: + serviceAccountEmail: 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 - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask' - taskId: + Required. Service account used by Cloud Scheduler to trigger the + integration at scheduled time 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`). - task: + cronTab: + description: Required. The cron tab of cloud scheduler trigger. type: string - description: Optional. The name for the task. - displayName: - description: >- - Optional. User-provided label that is attached to this TaskConfig in - the UI. - type: string - parameters: - type: object - description: Optional. The customized parameters the user can pass to this task. - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaEventParameter' - nextTasksExecutionPolicy: - 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. - type: string - description: >- - Optional. The policy dictating the execution of the next set of - tasks for the current task. - conditionalFailurePolicies: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaConditionalFailurePolicies - description: >- - Optional. The list of conditional failure policies that will be - applied to the task in order. - position: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' - description: >- - Optional. Informs the front-end application where to draw this error - catcher config on the UI. - description: - type: string - description: >- - Optional. User-provided description intended to give additional - business context about the task. - successPolicy: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuccessPolicy' - description: >- - Optional. Determines what action to take upon successful task - completion. - 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). - taskExecutionStrategy: - description: Optional. The policy dictating the execution strategy of this task. - 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. - enum: - - TASK_EXECUTION_STRATEGY_UNSPECIFIED - - WHEN_ALL_SUCCEED - - WHEN_ANY_SUCCEED - - WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED - type: string - 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' - errorCatcherId: + errorMessage: type: string description: >- - Optional. Optional Error catcher id of the error catch flow which - will be executed when execution error happens in the task - externalTaskType: + Optional. When the job was deleted from Pantheon UI, error_message + will be populated when Get/List integrations + id: GoogleCloudIntegrationsV1alphaCloudSchedulerConfig + type: object + description: Cloud Scheduler Trigger configuration + GoogleCloudConnectorsV1AuthConfigSshPublicKey: + properties: + sshClientCertPass: + description: Password (passphrase) for ssh client certificate if it has one. + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + certType: type: string - enum: - - EXTERNAL_TASK_TYPE_UNSPECIFIED - - NORMAL_TASK - - ERROR_TASK - description: Optional. External task type of the 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 - jsonValidationOption: + description: Format of SSH Client cert. + sshClientCert: + description: SSH Client Cert. It should contain both public and private key. + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + username: + description: The user account used to authenticate. 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. - id: GoogleCloudIntegrationsV1alphaTaskConfig - description: >- - The task configuration details. This is not the implementation of Task. - There might be multiple TaskConfigs for the same Task. - 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 - id: GoogleCloudIntegrationsV1alphaEventParameter + id: GoogleCloudConnectorsV1AuthConfigSshPublicKey + description: Parameters to support Ssh public key Authentication. + GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse: + id: GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse + description: Response for DownloadJsonPackage. + properties: + files: + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFile' + description: List containing JSON for multiple file with type information. + type: array + type: object + GoogleCloudIntegrationsV1alphaIntegrationConfigParameter: + type: object properties: value: description: >- Values for the defined keys. Each value can either be string, int, - double or any proto message. + double or any proto message or a serialized object. $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - key: - type: string + parameter: 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: - description: True if this parameter should be masked in the logs - type: boolean - EnterpriseCrmEventbusProtoTaskUiConfig: - id: EnterpriseCrmEventbusProtoTaskUiConfig - type: object - properties: - taskUiModuleConfigs: - type: array - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskUiModuleConfig' - description: Configurations of included config modules. + Optional. Integration Parameter to provide the default value, data + type and attributes required for the Integration config variables. + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationParameter 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: - EnterpriseCrmEventbusProtoCloudLoggingDetails: + 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. + id: GoogleCloudIntegrationsV1alphaIntegrationConfigParameter + GoogleCloudIntegrationsV1alphaReplayExecutionResponse: type: object properties: - enableCloudLogging: - type: boolean - description: >- - Status of whether Cloud Logging is enabled or not for the - integration version getting executed. - 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. + outputParameters: + type: object description: >- - 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 + OUTPUT parameters in format of Map. Where Key is the name of the + parameter. The parameters would only be present in case of + synchrounous execution Note: Name of the system generated parameters + are wrapped by backtick(`) to distinguish them from the user defined + parameters. + additionalProperties: + type: any + description: Properties of the object. + executionId: type: string + description: The id of the execution corresponding to this run of integration. + replayedExecutionId: + type: string + description: The execution id which is replayed + id: GoogleCloudIntegrationsV1alphaReplayExecutionResponse + description: 'Response for replaying an execution Next ID: 4' + GoogleCloudIntegrationsV1alphaServiceAccountCredentials: 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 - GoogleCloudIntegrationsV1alphaAccessToken: - description: >- - The access token represents the authorization of a specific application - to access specific parts of a user’s data. - id: GoogleCloudIntegrationsV1alphaAccessToken - type: object + Represents the service account which can be used to generate access + token for authenticating the service call. properties: - refreshTokenExpireTime: - description: The approximate time until the refresh token retrieved is valid. - type: string - format: google-datetime - tokenType: - type: string - description: >- - Only support "bearer" token in v1 as bearer token is the predominant - type used with OAuth 2.0. - refreshToken: + serviceAccount: description: >- - If the access token will expire, use the refresh token to obtain - another access token. + Name of the service account that has the permission to make the + request. type: string - accessTokenExpireTime: + scope: + description: A space-delimited list of requested scope permissions. type: string - description: >- - Required. The approximate time until the access token retrieved is - valid. - format: google-datetime - accessToken: - description: >- - The access token encapsulating the security identity of a process or - thread. - type: string - EnterpriseCrmEventbusProtoSerializedObjectParameter: - properties: - objectValue: - type: string - format: byte - id: EnterpriseCrmEventbusProtoSerializedObjectParameter type: object - EnterpriseCrmEventbusProtoCloudKmsConfig: + id: GoogleCloudIntegrationsV1alphaServiceAccountCredentials + EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit: + id: EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit + type: object properties: - 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: + resolvedBy: 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. - gcpProjectId: + resolvedByCpi: 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). - keyName: + timestamp: 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. - locationName: + format: google-datetime + 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). + id: EnterpriseCrmEventbusProtoNextTeardownTask + properties: + name: 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. + description: Required. Name of the next teardown task. + type: object + GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse: + id: GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse + properties: + projectId: type: string - id: EnterpriseCrmEventbusProtoCloudKmsConfig + description: The created AppsScriptProject ID. type: object - GoogleCloudIntegrationsV1alphaReplayExecutionResponse: + description: Response for CreateAppsScriptProject rpc call. + EnterpriseCrmEventbusProtoDoubleArrayFunction: type: object - description: 'Response for replaying an execution Next ID: 4' properties: - executionId: - type: string - description: The id of the execution corresponding to this run of integration. - replayedExecutionId: - description: The execution id which is replayed + 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 - outputParameters: - additionalProperties: - description: Properties of the object. - type: any - description: >- - OUTPUT parameters in format of Map. Where Key is the name of the - parameter. The parameters would only be present in case of - synchrounous execution Note: Name of the system generated parameters - are wrapped by backtick(`) to distinguish them from the user defined - parameters. - type: object - id: GoogleCloudIntegrationsV1alphaReplayExecutionResponse - EnterpriseCrmEventbusProtoCloudSchedulerConfig: - description: Cloud Scheduler Trigger configuration + id: EnterpriseCrmEventbusProtoDoubleArrayFunction + EnterpriseCrmEventbusProtoTaskMetadata: + description: >- + TaskMetadata are attributes that are associated to every common Task we + have. + type: object + id: EnterpriseCrmEventbusProtoTaskMetadata properties: - location: - description: >- - Required. The location where associated cloud scheduler job will be - created + externalDocLink: type: string - errorMessage: - description: >- - Optional. When the job was deleted from Pantheon UI, error_message - will be populated when Get/List integrations + description: Doc link for external-facing documentation (separate from g3doc). + g3DocLink: type: string - serviceAccountEmail: + description: URL to the associated G3 Doc for the task if available + standaloneExternalDocHtml: description: >- - Required. Service account used by Cloud Scheduler to trigger the - integration at scheduled time - type: string - cronTab: - type: string - description: Required. The cron tab of cloud scheduler trigger. - type: object - id: EnterpriseCrmEventbusProtoCloudSchedulerConfig - EnterpriseCrmEventbusProtoTriggerCriteria: - type: object - properties: - condition: + 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 + tags: + type: array 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. - parameters: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' - description: Optional. To be used in TaskConfig for the implementation class. - triggerCriteriaTaskImplementationClassName: + 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. + items: + type: string + defaultSpec: description: >- - Optional. Implementation class name. The class should implement the - “TypedTask” interface. - type: string - id: EnterpriseCrmEventbusProtoTriggerCriteria - GoogleCloudIntegrationsV1alphaCoordinate: - id: GoogleCloudIntegrationsV1alphaCoordinate - description: Configuration detail of coordinate, it used for UI - properties: - 'y': - type: integer - description: Required. Y axis of the coordinate - format: int32 - x: - type: integer - description: Required. X axis of the coordinate - format: int32 - type: object - EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity: - properties: - emailAddress: - type: string - gaiaId: + 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 - format: int64 - id: EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity - type: object - EnterpriseCrmEventbusProtoParamSpecEntryConfig: - id: EnterpriseCrmEventbusProtoParamSpecEntryConfig - properties: - hideDefaultValue: - type: boolean - description: Whether the default value is hidden in the UI. - inputDisplayOption: - enum: - - DEFAULT - - STRING_MULTI_LINE - - NUMBER_SLIDER - - BOOLEAN_TOGGLE + 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 + status: 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. - parameterNameOption: + 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: - - DEFAULT_NOT_PARAMETER_NAME - - IS_PARAMETER_NAME - - KEY_IS_PARAMETER_NAME - - VALUE_IS_PARAMETER_NAME + - UNSPECIFIED_STATUS + - DEFAULT_INACTIVE + - ACTIVE type: string + description: >- + Allows author to indicate if the task is ready to use or not. If not + set, then it will default to INACTIVE. + system: 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. - subSectionLabel: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - UNSPECIFIED_SYSTEM + - GENERIC + - BUGANIZER + - SALESFORCE + - CLOUD_SQL + - PLX + - SHEETS + - GOOGLE_GROUPS + - EMAIL + - SPANNER + - DATA_BRIDGE type: string - description: >- - A user-friendly label for subSection under which the parameter will - be displayed. - isHidden: - description: Whether this field is hidden in the UI. + isDeprecated: type: boolean - label: + description: The deprecation status of the current task. Default value is false; + externalDocHtml: type: string - description: A user-friendly label for the parameter. - uiPlaceholderText: + description: External-facing documention embedded in the RHP for this task. + activeTaskName: type: string description: >- - Placeholder text which will appear in the UI input form for this - parameter. - descriptivePhrase: - description: A short phrase to describe what this parameter contains. + The new task name to replace the current task if it is deprecated. + Otherwise, it is the same as the current task name. + 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 type: string - helpText: + 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 + admins: + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskMetadataAdmin' + type: array + externalCategorySequence: + type: integer + format: int32 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 - type: object - GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse: - id: GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse - properties: - integrationVersion: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - description: Version after the lock is acquired by the new user. - description: Response for TakeoverEditLock. - type: object - EnterpriseCrmEventbusProtoTeardownTaskConfig: - properties: - nextTeardownTask: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNextTeardownTask' - teardownTaskImplementationClassName: - type: string - description: Required. Implementation class name. - name: + Sequence with which the task in specific category to be displayed in + task discovery panel for external users. + codeSearchLink: type: string + description: The Code Search link to the Task Java file. + defaultJsonValidationOption: + enum: + - UNSPECIFIED_JSON_VALIDATION_OPTION + - SKIP + - PRE_EXECUTION + - POST_EXECUTION + - PRE_POST_EXECUTION description: >- - Required. Unique identifier of the teardown task within this Config. - We use this field as the identifier to find next teardown tasks. - properties: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventBusProperties' - parameters: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' - description: The parameters the user can pass to this task. - creatorEmail: - type: string - description: The creator's email address. - id: EnterpriseCrmEventbusProtoTeardownTaskConfig - type: object - GoogleCloudIntegrationsV1alphaCloudSchedulerConfig: - type: object - id: GoogleCloudIntegrationsV1alphaCloudSchedulerConfig - properties: - serviceAccountEmail: + Controls whether JSON workflow parameters are validated against + provided schemas before and/or after this task's execution. type: string - description: >- - Required. Service account used by Cloud Scheduler to trigger the - integration at scheduled time - cronTab: + 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. + docMarkdown: type: string - description: Required. The cron tab of cloud scheduler trigger. - errorMessage: + description: Snippet of markdown documentation to embed in the RHP for this task. + description: + description: In a few sentences, describe the purpose and usage of the task. type: string - description: >- - Optional. When the job was deleted from Pantheon UI, error_message - will be populated when Get/List integrations - location: + descriptiveName: type: string description: >- - Required. The location where associated cloud scheduler job will be - created - description: Cloud Scheduler Trigger configuration - GoogleCloudIntegrationsV1alphaGetClientMetadataResponse: - properties: - properties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaProjectProperties' - description: 'Required. Required: The client configuration that was requested' - description: Response for the GetClientMetadata rpc - type: object - id: GoogleCloudIntegrationsV1alphaGetClientMetadataResponse - EnterpriseCrmEventbusProtoConnectorsGenericConnectorTaskConfig: - properties: - connection: - description: User-selected connection. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoConnectorsConnection' - operation: - 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 + 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") + externalDocMarkdown: + description: 'DEPRECATED: Use external_doc_html.' type: string + category: enumDescriptions: - '' - '' @@ -4359,862 +3429,902 @@ components: - '' - '' - '' - - '' - - '' - id: EnterpriseCrmEventbusProtoConnectorsGenericConnectorTaskConfig - type: object - EnterpriseCrmEventbusAuthconfigAuthConfigTaskParam: + - Internal IP tasks that should not be available in the UI. + - Tasks that are relevant to cloud systems teams and typically + - >- + include connecting to Vector salesforce, CRM Hub Spanner etc. 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 + type: string + iconLink: + type: string + 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. + EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats: type: object - id: EnterpriseCrmEventbusAuthconfigAuthConfigTaskParam properties: - useServiceAccountInContext: - type: boolean - authConfigId: + endTime: + description: The end time of the task execution for current attempt. + format: int64 type: string - description: UUID of the AuthConfig. - allowedCredentialTypes: - type: array + startTime: + format: int64 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: - 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 - allowedServiceAccountInContext: - type: boolean - scope: + The start time of the task execution for current attempt. This could + be in the future if it's been scheduled. type: string - description: A space-delimited list of requested scope permissions. - EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage: - type: object + id: EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats + EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList: + description: List of error enums for alerts. properties: - parameters: + filterType: + enumDescriptions: + - '' + - '' + enum: + - DEFAULT_INCLUSIVE + - EXCLUSIVE + type: string + enumStrings: items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParamSpecEntry + type: string type: array - id: EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage - GoogleCloudIntegrationsV1alphaSuspension: - description: A record representing a suspension. + id: EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList + type: object + EnterpriseCrmEventbusProtoBuganizerNotification: type: object + id: EnterpriseCrmEventbusProtoBuganizerNotification properties: - suspensionConfig: - description: >- - Controls the notifications and resolver permissions for this - suspension. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuspensionConfig' - deprecated: true - eventExecutionInfoId: - description: Required. ID of the associated execution. - type: string - lastModifyTime: - readOnly: true + assigneeEmailAddress: type: string - format: google-datetime - description: Output only. Auto-generated. - state: - enum: - - RESOLUTION_STATE_UNSPECIFIED - - PENDING - - REJECTED - - LIFTED - description: >- - Required. State of this suspension, indicating what action a - resolver has taken. + description: Whom to assign the new bug. Optional. + templateId: + format: int64 type: string - enumDescriptions: - - Unset state. - - The suspension has not yet been resolved. - - The resolver has rejected the suspension. - - The resolver has lifted the suspension. - audit: - description: Metadata pertaining to the resolution of this suspension. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionAudit' - name: + description: ID of the buganizer template to use. Optional. + componentId: type: string - description: Resource name for suspensions suspension/{suspension_id} - approvalConfig: + format: int64 description: >- - Controls the notifications and approval permissions for this - suspension. - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig - createTime: - description: Output only. Auto-generated. - type: string - readOnly: true - format: google-datetime - taskId: - description: Required. Task id of the associated SuspensionTask. - type: string - integration: - description: Required. The name of the originating integration. + ID of the buganizer component within which to create a new issue. + Required. + title: + description: Title of the issue to be created. Required. type: string - id: GoogleCloudIntegrationsV1alphaSuspension - EnterpriseCrmEventbusProtoBooleanParameterArray: - properties: - booleanValues: - items: - type: boolean - type: array - type: object - id: EnterpriseCrmEventbusProtoBooleanParameterArray - EnterpriseCrmEventbusProtoCoordinate: - type: object - id: EnterpriseCrmEventbusProtoCoordinate - description: Represents two-dimensional positions. - properties: - 'y': - format: int32 - type: integer - x: - format: int32 - type: integer - EnterpriseCrmEventbusProtoExternalTraffic: - description: Represents external traffic type and id. + GoogleCloudIntegrationsV1alphaProvisionClientRequest: type: object + description: Request for the Provision rpc + id: GoogleCloudIntegrationsV1alphaProvisionClientRequest properties: - source: - enumDescriptions: - - '' - - '' - - '' - enum: - - SOURCE_UNSPECIFIED - - APIGEE - - SECURITY + cloudKmsConfig: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' description: >- - LINT.ThenChange(//depot/google3/enterprise/crm/eventbus/proto/product.proto:product, - //depot/google3/java/com/google/enterprise/crm/integrationplatform/api/utils/ConverterUtils.java:source_to_product) - type: string - gcpProjectId: - type: string - description: User’s GCP project id the traffic is referring to. - location: + Optional. OPTIONAL: Cloud KMS config for AuthModule to + encrypt/decrypt credentials. + runAsServiceAccount: type: string - description: Location for the user's request. - retryRequestForQuota: - description: Enqueue the execution request due to quota issue + description: >- + Optional. User input run-as service account, if empty, will bring up + a new default service account + createSampleWorkflows: type: boolean - gcpProjectNumber: - type: string - description: User’s GCP project number the traffic is referring to. - id: EnterpriseCrmEventbusProtoExternalTraffic - GoogleCloudIntegrationsV1alphaIntegrationAlertConfig: - description: >- - Message to be used to configure custom alerting in the {@code - EventConfig} protos for an event. + description: >- + Optional. Indicates if sample workflow should be created along with + provisioning + provisionGmek: + 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. + type: boolean + skipCpProvision: + type: boolean + description: Optional. Indicates if skip CP provision or not + GoogleCloudIntegrationsV1alphaFailurePolicy: + id: GoogleCloudIntegrationsV1alphaFailurePolicy type: object - id: GoogleCloudIntegrationsV1alphaIntegrationAlertConfig properties: - durationThreshold: - 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. - type: string - aggregationPeriod: - type: string + maxRetries: + format: int32 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. - metricType: + 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: + description: Defines what happens to the task upon failure. enumDescriptions: + - UNSPECIFIED. - >- - 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. + Ignores the failure of this task. The rest of the integration will + be executed Assuming this task succeeded. - >- - Specifies alerting on the rate of errors for the enclosing - integration. + 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. - >- - Specifies alerting on the rate of warnings for the enclosing - integration. Warnings use the same enum values as errors. + 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 errors for any task in the - enclosing integration. + 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. - >- - Specifies alerting on the rate of warnings for any task in the - enclosing integration. + 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. - >- - Specifies alerting on the rate of executions over all tasks in the - enclosing integration. + 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. - >- - 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 - onlyFinalAttempt: - type: boolean - description: >- - For either events or tasks, depending on the type of alert, count - only final attempts, not retries. - 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. + 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 - 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. enum: - - THRESHOLD_TYPE_UNSPECIFIED - - EXPECTED_MIN - - EXPECTED_MAX - disableAlert: - type: boolean - description: >- - Set to false by default. When set to true, the metrics are not - aggregated or pushed to Monarch for this integration alert. - thresholdValue: - description: >- - The metric value, above or below which the alert should be - triggered. - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue - alertThreshold: - 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. - 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 - GoogleCloudIntegrationsV1alphaAttemptStats: - description: Status for the execution attempt. - type: object - id: GoogleCloudIntegrationsV1alphaAttemptStats - properties: - endTime: - format: google-datetime + - RETRY_STRATEGY_UNSPECIFIED + - IGNORE + - NONE + - FATAL + - FIXED_INTERVAL + - LINEAR_BACKOFF + - EXPONENTIAL_BACKOFF + - RESTART_INTEGRATION_WITH_BACKOFF + condition: type: string - description: The end time of the integration execution for current attempt. - startTime: description: >- - The start time of the integration execution for current attempt. - This could be in the future if it's been scheduled. + Optional. The string condition that will be evaluated to determine + if the task should be retried with this failure policy. + intervalTime: type: string + description: >- + Required if retry_strategy is FIXED_INTERVAL or + LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines + the initial interval in seconds for backoff. format: google-datetime - EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot: - id: EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot + 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). + EnterpriseCrmFrontendsEventbusProtoParameterValueType: + id: EnterpriseCrmFrontendsEventbusProtoParameterValueType + description: 'To support various types of parameter values. Next available id: 14' + type: object properties: - eventExecutionInfoId: - description: Points to the event execution info this snapshot belongs to. - type: string - eventExecutionSnapshotMetadata: + intArray: $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata - diffParams: + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoIntParameterArray + protoArray: $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - description: The parameters in Event object that differs from last snapshot. - eventExecutionSnapshotId: + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoProtoParameterArray + booleanArray: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray + protoValue: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + stringValue: type: string - description: >- - Auto-generated. Used as primary key for EventExecutionSnapshots - table. - eventParams: - description: The parameters in Event object. + stringArray: $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - taskExecutionDetails: - type: array - items: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetails - description: All of the task execution details at the given point of time. - snapshotTime: - description: Indicates when this snapshot is taken. + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoStringParameterArray + serializedObjectValue: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter + doubleValue: + format: double + type: number + booleanValue: + type: boolean + jsonValue: type: string + intValue: format: int64 - conditionResults: - description: All of the computed conditions that been calculated. - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoConditionResult' - type: array - checkpointTaskNumber: type: string + doubleArray: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray + EnterpriseCrmEventbusProtoProtoFunction: + id: EnterpriseCrmEventbusProtoProtoFunction + type: object + properties: + functionName: + type: string + 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 + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest: + description: Request to enable/disable variable masking for a provisioned client + properties: + enableVariableMasking: + type: boolean description: >- - Indicates "right after which checkpoint task's execution" this - snapshot is taken. - taskName: + Required. REQUIRED: True if variable masking feature should be + turned on for this region + type: object + id: GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest + EnterpriseCrmEventbusProtoSerializedObjectParameter: + id: EnterpriseCrmEventbusProtoSerializedObjectParameter + properties: + objectValue: + format: byte type: string - description: The task name associated with this snapshot. Could be empty. - deprecated: true type: object - GoogleCloudConnectorsV1AuthConfig: + GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata: + id: GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata + type: object properties: - additionalVariables: + actions: + type: array + description: List of actions. items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' + type: string + entities: + items: + type: string type: array - description: List containing additional auth configs. - sshPublicKey: - $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfigSshPublicKey' - description: SSH Public Key. - oauth2ClientCredentials: - description: Oauth2ClientCredentials. + description: List of entity names. + description: Metadata of runtime connection schema. + EnterpriseCrmEventbusProtoParamSpecEntryValidationRule: + id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRule + type: object + properties: + stringRegex: $ref: >- - #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials - authType: - type: string - enum: - - AUTH_TYPE_UNSPECIFIED - - USER_PASSWORD - - OAUTH2_JWT_BEARER - - OAUTH2_CLIENT_CREDENTIALS - - SSH_PUBLIC_KEY - - OAUTH2_AUTH_CODE_FLOW - - GOOGLE_AUTHENTICATION - 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 - description: The type of authentication configured. - authKey: - description: Identifier key for auth config - type: string - oauth2AuthCodeFlow: + #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex + intRange: $ref: >- - #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow - description: Oauth2AuthCodeFlow. - oauth2JwtBearer: + #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange + doubleRange: $ref: >- - #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer - description: Oauth2JwtBearer. - userPassword: - description: UserPassword. - $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfigUserPassword' - id: GoogleCloudConnectorsV1AuthConfig - description: AuthConfig defines details of a authentication type. - type: object - GoogleCloudIntegrationsV1alphaParameterMapField: + #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange + EnterpriseCrmEventbusProtoBooleanFunction: properties: - referenceKey: - description: Referencing one of the Integration variables. + functionName: type: string - literalValue: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - description: Passing a literal value. - id: GoogleCloudIntegrationsV1alphaParameterMapField + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - UNSPECIFIED + - TO_JSON + - NOT + - AND + - NAND + - OR + - XOR + - NOR + - XNOR + - TO_STRING + - EQUALS type: object - description: Field represents either the key or value in an entry. - EnterpriseCrmEventbusProtoWorkflowAlertConfig: + id: EnterpriseCrmEventbusProtoBooleanFunction + GoogleCloudIntegrationsV1alphaDoubleParameterArray: properties: - playbookUrl: + doubleValues: + description: Double number array. + type: array + items: + format: double + type: number + id: GoogleCloudIntegrationsV1alphaDoubleParameterArray + type: object + description: This message only contains a field of double number array. + GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse: + type: object + properties: + nextPageToken: type: string + description: The token used to retrieve the next page of results. + sfdcChannels: + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + description: The list of SfdcChannels retrieved. + description: Response to list SfdcChannels. + id: GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse + EnterpriseCrmEventbusProtoField: + properties: + transformExpression: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTransformExpression' description: >- - Link to a playbook for resolving the issue that triggered this - alert. - 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. - aggregationPeriod: + 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: >- - For an EXPECTED_MIN threshold, this aggregation_period must be - lesser than 24 hours. - type: string - 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 - 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. - 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 + This holds the default values for the fields. This value is supplied + by user so may or may not contain PII or SPII data. + referenceKey: type: string - errorEnumList: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList - thresholdValue: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue - description: >- - The metric value, above or below which the alert should be - triggered. - alertName: 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. - type: string - clientId: + 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$ + fieldType: type: string - description: Client associated with this alert configuration. - warningEnumList: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList - numAggregationPeriods: - type: integer - format: int32 - description: >- - For how many contiguous aggregation periods should the expected min - or max be violated for the alert to be fired. - 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: - - UNSPECIFIED_THRESHOLD_TYPE - - EXPECTED_MIN - - EXPECTED_MAX + - 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. 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 - 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. - onlyFinalAttempt: - description: >- - For either events or tasks, depending on the type of alert, count - only final attempts, not retries. - type: boolean - description: >- - Message to be used to configure custom alerting in the {@code - EventConfig} protos for an event. + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - >- + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. + - '' + - '' + - '' + protoDefPath: + 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 + cardinality: + type: string + enum: + - UNSPECIFIED + - OPTIONAL + 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. + description: Information about the value and type of the field. + id: EnterpriseCrmEventbusProtoField type: object - id: EnterpriseCrmEventbusProtoWorkflowAlertConfig - GoogleCloudIntegrationsV1alphaTestIntegrationsResponse: + GoogleCloudIntegrationsV1alphaIntParameterArray: + description: This message only contains a field of integer array. + id: GoogleCloudIntegrationsV1alphaIntParameterArray type: object - description: The response for testing an integration. - id: GoogleCloudIntegrationsV1alphaTestIntegrationsResponse properties: - parameterEntries: + intValues: + 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 integration - execution. + type: string + format: int64 + description: Integer array. + EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata: + properties: + ancestorIterationNumbers: + items: + type: string type: array - deprecated: true - executionFailed: - description: Is true if any execution in the integration failed. False otherwise. - type: boolean - executionId: - type: string - description: The id of the execution corresponding to this run of integration. - parameters: - 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. - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - eventParameters: - deprecated: true - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - description: Details for the integration that were executed. - GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest: - description: The request for executing an integration. - type: object - properties: - executionId: + Ancestor iteration number for the task(it will only be non-empty if + the task is under 'private workflow') + eventAttemptNum: + description: the event attempt number this snapshot belongs to. + format: int32 + type: integer + taskName: + description: the task name associated with this snapshot. Could be empty. type: string - description: Optional. The id of the ON_HOLD execution to be resumed. - requestId: + taskAttemptNum: + format: int32 + type: integer + description: the task attempt number this snapshot belongs to. Could be empty. + taskNumber: 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 - inputParameters: - description: Optional. Input parameters used by integration execution. - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - parameterEntries: - 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 + description: The task number associated with this snapshot. Could be empty. + taskLabel: + description: the task label associated with this snapshot. Could be empty. + type: string + ancestorTaskNumbers: items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - deprecated: true - 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`. - type: string - doNotPropagateError: + Ancestor task number for the task(it will only be non-empty if the + task is under 'private workflow') + type: array + integrationName: 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. - type: boolean - id: GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest - GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest: - id: GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest - type: object - properties: - runAsServiceAccount: - description: 'Required. REQUIRED: Run-as service account to be updated' + The direct integration which the event execution snapshots belongs + to type: string - description: Request for the ReplaceServiceAccount rpc - EnterpriseCrmEventbusProtoTeardown: - properties: - teardownTaskConfigs: - description: Required. - type: array - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTeardownTaskConfig' - id: EnterpriseCrmEventbusProtoTeardown + id: >- + EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata type: object - EnterpriseCrmEventbusProtoLoopMetadata: + EnterpriseCrmEventbusProtoCloudSchedulerConfig: 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 - 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 + errorMessage: type: string - errorMsg: + description: >- + Optional. When the job was deleted from Pantheon UI, error_message + will be populated when Get/List integrations + cronTab: type: string - description: Add the error message when loops fail. - currentIterationCount: + description: Required. The cron tab of cloud scheduler trigger. + location: + description: >- + Required. The location where associated cloud scheduler job will be + created type: string - format: int64 - description: Starting from 1, not 0. - currentIterationDetail: + serviceAccountEmail: 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. - id: EnterpriseCrmEventbusProtoLoopMetadata + Required. Service account used by Cloud Scheduler to trigger the + integration at scheduled time + id: EnterpriseCrmEventbusProtoCloudSchedulerConfig + description: Cloud Scheduler Trigger configuration type: object - GoogleCloudIntegrationsV1alphaSuccessPolicy: - id: GoogleCloudIntegrationsV1alphaSuccessPolicy - description: >- - Policy that dictates the behavior for the task after it completes - successfully. + EnterpriseCrmEventbusProtoFunctionType: + id: EnterpriseCrmEventbusProtoFunctionType properties: - finalState: - type: string + booleanFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBooleanFunction' + stringFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringFunction' + protoFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoFunction' + jsonFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoJsonFunction' description: >- - State to which the execution snapshot status will be set if the task - succeeds. - enum: - - FINAL_STATE_UNSPECIFIED - - SUCCEEDED - - SUSPENDED - 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. - type: object - EnterpriseCrmEventbusProtoEventExecutionSnapshot: - id: EnterpriseCrmEventbusProtoEventExecutionSnapshot + LINT.ThenChange(//depot/google3/alkali/apps/integrationplatform/client/workflow_editor/utils/transform_function.ts) + baseFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBaseFunction' + description: LINT.IfChange + intArrayFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntArrayFunction' + protoArrayFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoArrayFunction' + stringArrayFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringArrayFunction' + intFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntFunction' + booleanArrayFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBooleanArrayFunction' + doubleFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleFunction' + doubleArrayFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleArrayFunction' type: object + EnterpriseCrmEventbusProtoTeardownTaskConfig: properties: - workflowName: - description: Name of the workflow this event execution snapshot belongs to. + teardownTaskImplementationClassName: + description: Required. Implementation class name. type: string - eventExecutionSnapshotId: + properties: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventBusProperties' + parameters: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + description: The parameters the user can pass to this task. + creatorEmail: + description: The creator's email address. type: string + nextTeardownTask: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNextTeardownTask' + name: description: >- - Auto-generated. Used as primary key for EventExecutionSnapshots - table. - eventParams: - description: The parameters in Event object. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + Required. Unique identifier of the teardown task within this Config. + We use this field as the identifier to find next teardown tasks. + type: string + type: object + id: EnterpriseCrmEventbusProtoTeardownTaskConfig + GoogleCloudIntegrationsV1alphaGetClientMetadataResponse: + type: object + id: GoogleCloudIntegrationsV1alphaGetClientMetadataResponse + properties: + properties: + description: 'Required. Required: The client configuration that was requested' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaProjectProperties' + description: Response for the GetClientMetadata rpc + EnterpriseCrmEventbusStatsDimensions: + id: EnterpriseCrmEventbusStatsDimensions + properties: clientId: - description: Client that the execution snapshot is associated to. type: string - eventExecutionSnapshotMetadata: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata - exceedMaxSize: - type: boolean - description: indicate whether snapshot exceeded maximum size before clean up + workflowName: + type: string + warningEnumString: + type: string + workflowId: + type: string + retryAttempt: + enum: + - 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 taskName: - description: The task name associated with this snapshot. Could be empty. type: string - deprecated: true - checkpointTaskNumber: + enumFilterType: + description: Whether to include or exclude the enums matching the regex. + type: string + enum: + - DEFAULT_INCLUSIVE + - EXCLUSIVE + enumDescriptions: + - '' + - '' + errorEnumString: + type: string + triggerId: + type: string description: >- - Indicates "right after which checkpoint task's execution" this - snapshot is taken. + Stats have been or will be aggregated on set fields for any + semantically-meaningful combination. + taskNumber: type: string - diffParams: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' - description: The parameters in Event object that differs from last snapshot. - taskExecutionDetails: + type: object + EnterpriseCrmFrontendsEventbusProtoParameterMapField: + id: EnterpriseCrmFrontendsEventbusProtoParameterMapField + properties: + literalValue: + description: Passing a literal value. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType + referenceKey: + type: string + description: Referencing one of the WF variables. + description: Field represents either the key or value in an entry. + type: object + GoogleCloudIntegrationsV1alphaListCertificatesResponse: + type: object + description: Response to list Certificates. + id: GoogleCloudIntegrationsV1alphaListCertificatesResponse + properties: + certificates: items: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetails + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + type: array + description: The list of Certificates retrieved. + nextPageToken: + description: The token used to retrieve the next page of results. + type: string + EnterpriseCrmEventbusProtoStringArray: + properties: + values: type: array - description: All of the task execution details at the given point of time. - conditionResults: items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoConditionResult' - description: All of the computed conditions that been calculated. + type: string + type: object + id: EnterpriseCrmEventbusProtoStringArray + EnterpriseCrmFrontendsEventbusProtoWorkflowParameters: + id: EnterpriseCrmFrontendsEventbusProtoWorkflowParameters + type: object + 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. + properties: + 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/EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry type: array - eventExecutionInfoId: - description: Points to the event execution info this snapshot belongs to. + GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest: + properties: + fileFormat: + enumDescriptions: + - Unspecified file format + - JSON File Format + - YAML File Format + description: File format for upload request. type: string - snapshotTime: - description: Indicates when this snapshot is taken. - format: int64 + enum: + - FILE_FORMAT_UNSPECIFIED + - JSON + - YAML + content: type: string - description: >- - Contains the snapshot of the event execution for a given checkpoint. - Next available id: 15 - EnterpriseCrmEventbusProtoSuspensionExpiration: + description: The textproto of the integration_version. + description: Request for UploadIntegrationVersion. + id: GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest + type: object + EnterpriseCrmEventbusProtoDoubleParameterArray: + id: EnterpriseCrmEventbusProtoDoubleParameterArray type: object properties: - liftWhenExpired: - description: >- - Whether the suspension will be REJECTED or LIFTED upon expiration. - REJECTED is the default behavior. - type: boolean - expireAfterMs: - description: Milliseconds after which the suspension expires, if no action taken. - type: integer - format: int32 - 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 - id: EnterpriseCrmEventbusProtoSuspensionExpiration - GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest: - description: Request for LinkAppsScriptProject rpc call. + doubleValues: + type: array + items: + format: double + type: number + GoogleCloudIntegrationsV1alphaSuspensionAudit: + id: GoogleCloudIntegrationsV1alphaSuspensionAudit type: object + description: Contains when and by whom the suspension was resolved. properties: - scriptId: - description: The id of the Apps Script project to be linked. + resolver: + description: Email address of the person who resolved this suspension. type: string - id: GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest - EnterpriseCrmEventbusProtoParameterMap: + resolveTime: + description: Time at which this suspension was resolved. + type: string + format: google-datetime + GoogleCloudIntegrationsV1alphaIntegrationAlertConfig: + id: GoogleCloudIntegrationsV1alphaIntegrationAlertConfig + description: >- + Message to be used to configure custom alerting in the {@code + EventConfig} protos for an event. properties: - keyType: + disableAlert: + type: boolean 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: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' + Set to false by default. When set to true, the metrics are not + aggregated or pushed to Monarch for this integration 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: + - 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. + type: string + 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: - - 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 + - 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 - entries: + onlyFinalAttempt: + description: >- + For either events or tasks, depending on the type of alert, count + only final attempts, not retries. + type: boolean + 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 + durationThreshold: + 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. + format: google-duration + 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. + type: string + thresholdValue: + description: >- + The metric value, above or below which the alert should be + triggered. + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue + alertThreshold: + type: integer + format: int32 + description: >- + For how many contiguous aggregation periods should the expected min + or max be violated for the alert to be fired. + type: object + EnterpriseCrmEventbusProtoMappedField: + description: Mapped field is a pair of input field and output field. + type: object + 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. + id: EnterpriseCrmEventbusProtoMappedField + EnterpriseCrmFrontendsEventbusProtoStringParameterArray: + properties: + stringValues: + items: + type: string type: array + id: EnterpriseCrmFrontendsEventbusProtoStringParameterArray + type: object + GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse: + properties: + nextPageToken: + description: Next page token. + type: string + runtimeEntitySchemas: items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapEntry' - valueType: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaRuntimeEntitySchema + description: Runtime entity schemas. + type: array + description: Response for listing RuntimeEntitySchemas for a specific Connection. + type: object + id: GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse + EnterpriseCrmEventbusProtoConnectorsGenericConnectorTaskConfig: + properties: + connection: + description: User-selected connection. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoConnectorsConnection' + operation: enumDescriptions: - '' - '' @@ -5224,965 +4334,2425 @@ 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 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 - id: EnterpriseCrmEventbusProtoParameterMap + - OPERATION_UNSPECIFIED + - EXECUTE_ACTION + - LIST_ENTITIES + - GET_ENTITY + - CREATE_ENTITY + - UPDATE_ENTITY + - DELETE_ENTITY + - EXECUTE_QUERY + description: Operation to perform using the configured connection. type: object - description: >- - A generic multi-map that holds key value pairs. They keys and values can - be of any type, unless specified. - EnterpriseCrmFrontendsEventbusProtoParamSpecEntry: - description: 'Key-value pair of EventBus task parameters. Next id: 13' + id: EnterpriseCrmEventbusProtoConnectorsGenericConnectorTaskConfig + GoogleCloudIntegrationsV1alphaSfdcChannel: + type: object + id: GoogleCloudIntegrationsV1alphaSfdcChannel + description: The SfdcChannel that points to a CDC or Platform Event Channel. properties: - isOutput: - type: boolean - isDeprecated: + isActive: + 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 + name: + type: string description: >- - If set, this entry is deprecated, so further use of this parameter - should be prohibited. - 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. - - '' - - '' - - '' - description: The data type of the parameter. + Resource name of the SFDC channel + projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}. + description: + description: The description for this channel 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 - protoDef: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition - description: Populated if this represents a proto or proto array. - config: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryConfig' - description: Optional fields, such as help text and other useful info. - className: - 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. + channelTopic: type: string - key: + description: The Channel topic defined by salesforce once an channel is opened + updateTime: + description: Output only. Time when the channel was last updated + format: google-datetime + readOnly: true 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. - collectionElementClassName: + createTime: + description: Output only. Time when the channel is created + format: google-datetime type: string - 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. - 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 - required: - description: If set, the user must provide an input value for this parameter. - type: boolean - jsonSchema: + readOnly: true + deleteTime: + readOnly: true type: string - description: If the data_type is JSON_VALUE, then this will define its schema. - validationRule: + format: google-datetime description: >- - Rule used to validate inputs (individual values and collection - elements) for this parameter. - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRule - type: object - id: EnterpriseCrmFrontendsEventbusProtoParamSpecEntry - GoogleCloudConnectorsV1EncryptionKey: - properties: - type: - description: Type. - enum: - - TYPE_UNSPECIFIED - - GOOGLE_MANAGED - - CUSTOMER_MANAGED - enumDescriptions: - - Value type is not specified. - - Google Managed. - - Customer Managed. + Output only. Time when the channel was deleted. Empty if not + deleted. + lastReplayId: + description: Last sfdc messsage replay id for channel type: string - kmsKeyName: + displayName: + description: Client level unique name/alias to easily reference a channel. type: string - 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: object - id: GoogleCloudConnectorsV1EncryptionKey - description: Encryption Key value. - GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse: - description: The response for executing an integration. - type: object - id: GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse - properties: - executionInfoIds: - type: array - description: The execution info id for the executed integrations. - items: - type: string - GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse: - properties: - regions: - items: - type: string - description: All regions where Connector Platform is provisioned. - type: array - id: GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse - description: Response containing all provisioned regions for Connector Platform. - type: object - GoogleCloudConnectorsV1EventingStatus: - id: GoogleCloudConnectorsV1EventingStatus + GoogleCloudConnectorsV1BillingConfig: + id: GoogleCloudConnectorsV1BillingConfig type: object - description: EventingStatus indicates the state of eventing. + description: Billing config for the connection. properties: - description: - readOnly: true - description: Output only. Description of error if State is set to "ERROR". + billingCategory: type: string - state: enumDescriptions: - - Default state. - - Eventing is enabled and ready to receive events. - - Eventing is not active due to an error. - - Ingress endpoint required. + - Billing category is not specified. + - GCP/Technical connector. + - Non-GCP connector. readOnly: true - description: Output only. State. enum: - - STATE_UNSPECIFIED - - ACTIVE - - ERROR - - INGRESS_ENDPOINT_REQUIRED - type: string - EnterpriseCrmFrontendsEventbusProtoTaskConfig: - description: >- - The task configuration details. This is not the implementation of Task. - There might be multiple TaskConfigs for the same Task. + - BILLING_CATEGORY_UNSPECIFIED + - GCP_AND_TECHNICAL_CONNECTOR + - NON_GCP_CONNECTOR + description: Output only. Billing category for the 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: - jsonValidationOption: + triggerId: type: string - 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. description: >- - If set, overrides the option configured in the Task implementation - class. - alertConfigs: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskAlertConfig' - type: array + Matched against all {@link TriggerConfig}s across all workflows. + i.e. TriggerConfig.trigger_id.equals(trigger_id) Required. + resourceName: + type: string description: >- - Alert configurations on error rate, warning rate, number of runs, - durations, etc. - incomingEdgeCount: - type: integer - format: int32 - description: The number of edges leading into this TaskConfig. - nextTasksExecutionPolicy: + This field is only required when using Admin Access. The resource + name of target, or the parent resource name. For example: + "projects/*/locations/*/integrations/*" + 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 + requestId: description: >- - 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: - - UNSPECIFIED - - RUN_ALL_MATCH - - RUN_FIRST_MATCH - taskTemplateName: - description: Used to define task-template name if task is of type task-template + 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 - taskExecutionStrategy: - enum: - - WHEN_ALL_SUCCEED - - WHEN_ANY_SUCCEED - - WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED + userGeneratedExecutionId: 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. - taskEntity: - $ref: '#/components/schemas/EnterpriseCrmFrontendsEventbusProtoTaskEntity' - description: Copy of the task entity that this task config is an instance of. - taskNumber: - 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_number`). - creatorEmail: - type: string - description: The creator's email address. Auto-generated from the user's email. - label: - type: string - description: User-provided label that is attached to this TaskConfig in the UI. - 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. - type: string - 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). - lastModifiedTime: - description: Auto-generated. - format: google-datetime - type: string - createTime: - type: string - format: google-datetime - description: Auto-generated. - disableStrictTypeValidation: + 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. + ignoreErrorIfNoActiveWorkflow: 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. + 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 - successPolicy: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuccessPolicy' - description: Determines what action to take upon successful task completion. - taskName: - type: string - description: The name for the task. - 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' - errorCatcherId: - type: string - description: >- - Optional Error catcher id of the error catch flow which will be - executed when execution error happens in the task - description: - type: string - description: >- - User-provided description intended to give more business context - about the task. - synchronousCallFailurePolicy: + priority: 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' - 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 - parameters: - description: The customized parameters the user can pass to this task. - type: object - additionalProperties: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - preconditionLabel: + The request priority this request should be processed at. For + internal users: type: string - description: >- - Optional. User-provided label that is attached to precondition in - the UI. - 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 + - 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. enum: - - TASK - - ASIS_TEMPLATE - - IO_TEMPLATE + - UNSPCIFIED + - SHEDDABLE + - SHEDDABLE_PLUS + - CRITICAL + - CRITICAL_PLUS + testMode: + type: boolean + description: >- + Optional. Sets test mode in {@link + enterprise/crm/eventbus/event_message.proto}. + scheduledTime: type: string - position: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCoordinate' + format: int64 description: >- - Optional. Informs the front-end application where to draw this task - config on the UI. - rollbackStrategy: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoRollbackStrategy + Optional. Time in milliseconds since epoch when the given event + would be scheduled. + quotaRetryCount: + type: integer + format: int32 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). - failurePolicy: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' + Optional. This is a field to see the quota retry count for + integration execution + workflowName: 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.). - precondition: + 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 - 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. - id: EnterpriseCrmFrontendsEventbusProtoTaskConfig - EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats: + parameters: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + description: Passed in as parameters to each workflow execution. Optional. + GoogleCloudConnectorsV1DestinationConfig: + description: Define the Connectors target endpoint. + id: GoogleCloudConnectorsV1DestinationConfig + type: object properties: - startTime: - format: int64 - type: string + destinations: + type: array + description: The destinations for the key. + items: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Destination' + key: description: >- - 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. - format: int64 + The key is the destination identifier that is supported by the + Connector. type: string - id: EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats - type: object - GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse: - id: GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse - type: object - description: Response for UploadIntegrationVersion. - properties: - integrationVersion: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - description: The uploaded integration. - GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse: - id: GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse + GoogleCloudIntegrationsV1alphaListConnectionsResponse: type: object + description: Response containing Connections listed by region. properties: - executionId: - description: The id of the execution corresponding to this run of integration. + nextPageToken: type: string - outputParameters: - 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. - additionalProperties: - description: Properties of the object. - type: any - type: object - 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 - parameterEntries: - deprecated: true + description: Next page token. + connections: + description: Connections. 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. + $ref: '#/components/schemas/GoogleCloudConnectorsV1Connection' type: array - description: The response for executing an integration. - EnterpriseCrmFrontendsEventbusProtoStringParameterArray: + id: GoogleCloudIntegrationsV1alphaListConnectionsResponse + EnterpriseCrmEventbusProtoIntArrayFunction: + id: EnterpriseCrmEventbusProtoIntArrayFunction properties: - stringValues: - type: array - items: - type: string - id: EnterpriseCrmFrontendsEventbusProtoStringParameterArray + functionName: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - UNSPECIFIED + - GET + - APPEND + - SIZE + - SUM + - AVG + - MAX + - MIN + - TO_SET + - APPEND_ALL + - TO_JSON + - SET + - REMOVE + - REMOVE_AT + - CONTAINS + - FOR_EACH + - FILTER + type: string type: object - GoogleCloudIntegrationsV1alphaIntParameterArray: - description: This message only contains a field of integer array. + GoogleCloudIntegrationsV1alphaAuthToken: + description: >- + The credentials to authenticate a user agent with a server that is put + in HTTP Authorization request header. + id: GoogleCloudIntegrationsV1alphaAuthToken type: object properties: - intValues: + token: + description: The token for the auth type. + type: string + type: + type: string + description: Authentication type, e.g. "Basic", "Bearer", etc. + EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter: + type: object + id: EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter + properties: + objectValue: + type: string + format: byte + GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse: + id: GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse + properties: + executionFailed: + deprecated: true + description: Is true if any execution in the integration failed. False otherwise. + type: boolean + outputParameters: + type: 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. + additionalProperties: + description: Properties of the object. + type: any + executionId: + type: string + description: The id of the execution corresponding to this run of integration. + parameterEntries: items: - format: int64 - type: string - description: Integer array. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry type: array - id: GoogleCloudIntegrationsV1alphaIntParameterArray - GoogleCloudConnectorsV1ConfigVariable: - id: GoogleCloudConnectorsV1ConfigVariable + 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 + eventParameters: + description: Details for the integration that were executed. + deprecated: true + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters type: object - description: >- - ConfigVariable represents a configuration variable present in a - Connection. or AuthConfig. + description: The response for executing an integration. + GoogleCloudConnectorsV1EventingStatus: properties: - intValue: - description: Value is an integer + state: type: string - format: int64 - stringValue: - description: Value is a string. + description: Output only. State. + readOnly: true + enum: + - STATE_UNSPECIFIED + - ACTIVE + - ERROR + - INGRESS_ENDPOINT_REQUIRED + enumDescriptions: + - Default state. + - Eventing is enabled and ready to receive events. + - Eventing is not active due to an error. + - Ingress endpoint required. + description: + readOnly: true + description: Output only. Description of error if State is set to "ERROR". type: string - key: + id: GoogleCloudConnectorsV1EventingStatus + description: EventingStatus indicates the state of eventing. + type: object + GoogleCloudConnectorsV1ResourceLimits: + type: object + properties: + memory: + type: string + description: Output only. Memory limit. + readOnly: true + cpu: + type: string + description: Output only. CPU limit. + readOnly: true + id: GoogleCloudConnectorsV1ResourceLimits + description: Resource limits defined for connection pods of a given connector type. + GoogleCloudConnectorsV1LogConfig: + id: GoogleCloudConnectorsV1LogConfig + type: object + properties: + level: + enumDescriptions: + - Log level unspecified. + - Only error logs are enabled. + - Info and error logs are enabled. + - Debug and high verbosity logs are enabled. + type: string + enum: + - LOG_LEVEL_UNSPECIFIED + - ERROR + - INFO + - DEBUG + description: Optional. Log configuration level. + enabled: + description: >- + Enabled represents whether logging is enabled or not for a + connection. + type: boolean + description: Log configuration for the connection. + GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration: + type: object + description: Expiration configs for the approval request. + properties: + expireTime: + format: google-datetime + description: >- + Output only. Time after which the suspension expires, if no action + taken. + type: string + readOnly: true + 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. + type: string + format: google-datetime + liftWhenExpired: + description: >- + Whether the suspension will be REJECTED or LIFTED upon expiration. + REJECTED is the default behavior. + type: boolean + id: GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration + EnterpriseCrmEventbusProtoStringFunction: + 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: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + type: string + id: EnterpriseCrmEventbusProtoStringFunction + type: object + EnterpriseCrmEventbusProtoDoubleArray: + properties: + values: + type: array + items: + type: number + format: double + type: object + id: EnterpriseCrmEventbusProtoDoubleArray + 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 + properties: + authUri: + type: string + description: Auth URL for Authorization Code Flow + clientId: + type: string + description: Client ID for user-provided OAuth app. + redirectUri: + description: Redirect URI to be provided during the auth code exchange. + type: string + pkceVerifier: + description: PKCE verifier to be used during the auth code exchange. + type: string + authCode: + description: Authorization code to be exchanged for access and refresh tokens. + type: string + scopes: + items: + type: string + description: >- + Scopes the connection will request when the user performs the auth + code flow. + type: array + enablePkce: + type: boolean + description: Whether to enable PKCE when the user performs the auth code flow. + clientSecret: + description: Client secret for user-provided OAuth app. + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + id: GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow + EnterpriseCrmEventbusProtoSuspensionResolutionInfo: + type: object + id: EnterpriseCrmEventbusProtoSuspensionResolutionInfo + properties: + clientId: + description: The event data user sends as request. + type: string + lastModifiedTimestamp: + type: string + description: Auto-generated. + format: google-datetime + product: + enum: + - UNSPECIFIED_PRODUCT + - IP + - APIGEE + - SECURITY + enumDescriptions: + - '' + - '' + - '' + - '' + type: string + description: >- + Which Google product the suspension belongs to. If not set, the + suspension belongs to Integration Platform by default. + status: + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - PENDING_UNSPECIFIED + - REJECTED + - LIFTED + - CANCELED + type: string + eventExecutionInfoId: + type: string + description: Required. ID of the associated execution. + cloudKmsConfig: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudKmsConfig' + description: KMS info, used by cmek/gmek integration + suspensionId: + type: string + description: Primary key for the SuspensionResolutionInfoTable. + suspensionConfig: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuspensionConfig' + audit: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit + encryptedSuspensionResolutionInfo: + type: string + description: Encrypted SuspensionResolutionInfo + format: byte + wrappedDek: + description: Wrapped dek + format: byte + type: string + externalTraffic: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoExternalTraffic' + description: The origin of the suspension for periodic notifications. + taskNumber: + description: Required. Task number of the associated SuspensionTask. + type: string + workflowName: + type: string + description: Required. The name of the originating workflow. + createdTimestamp: + format: google-datetime + type: string + description: Auto-generated. + GoogleCloudIntegrationsV1alphaRuntimeActionSchema: + description: Metadata of an action, including schemas for its inputs and outputs. + type: object + properties: + outputSchema: + description: Output parameter schema for the action. + type: string + inputSchema: + type: string + description: Input parameter schema for the action. + action: + type: string + description: Name of the action. + id: GoogleCloudIntegrationsV1alphaRuntimeActionSchema + EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo: + type: object + id: EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo + properties: + replayedExecutionInfoIds: + items: + type: string + type: array + description: >- + If this execution has been replayed, then this field contains the + execution ids of the replayed executions. + originalExecutionInfoId: + type: string + description: >- + If this execution is a replay of another execution, then this field + contains the original execution id. + 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 + 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. + id: EnterpriseCrmEventbusProtoTaskMetadataAdmin + properties: + googleGroupEmail: + type: string + userEmail: + type: string + type: object + GoogleCloudIntegrationsV1alphaExecutionSnapshot: + description: Contains the snapshot of the execution for a given checkpoint. + type: object + id: GoogleCloudIntegrationsV1alphaExecutionSnapshot + properties: + executionSnapshotMetadata: + description: Metadata of the execution snapshot. + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata + params: + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + type: object + description: Parameters used during the execution. + taskExecutionDetails: + type: array + description: All of the task execution details at the given point of time. + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaTaskExecutionDetails + checkpointTaskNumber: + type: string + description: >- + Indicates "after which checkpoint task's execution" this snapshot is + taken. + EnterpriseCrmEventbusProtoCustomSuspensionRequest: + properties: + postToQueueWithTriggerIdRequest: + description: Request to fire an event containing the SuspensionInfo message. + $ref: >- + #/components/schemas/GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest + suspensionInfoEventParameterKey: + description: >- + In the fired event, set the SuspensionInfo message as the value for + this key. + type: string + id: EnterpriseCrmEventbusProtoCustomSuspensionRequest + type: object + EnterpriseCrmEventbusProtoBooleanArrayFunction: + id: 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: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + type: object + EnterpriseCrmEventbusProtoStringArrayFunction: + properties: + functionName: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + type: string + enum: + - UNSPECIFIED + - GET + - APPEND + - SIZE + - TO_SET + - APPEND_ALL + - TO_JSON + - SET + - REMOVE + - REMOVE_AT + - CONTAINS + - FOR_EACH + - FILTER + id: EnterpriseCrmEventbusProtoStringArrayFunction + type: object + GoogleCloudConnectorsV1ResourceRequests: + properties: + cpu: + type: string + readOnly: true + description: Output only. CPU request. + memory: + readOnly: true + description: Output only. Memory request. + type: string + id: GoogleCloudConnectorsV1ResourceRequests + description: Resource requests defined for connection pods of a given connector type. + type: object + GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue: + properties: + percentage: + format: int32 + type: integer + description: Percentage threshold. + absolute: + type: string + format: int64 + description: Absolute value threshold. + 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: GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue + GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig: + properties: + 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. + customMessage: + type: string + description: Information to provide for recipients. + description: Configurations for approving the Suspension. + id: GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig + type: object + GoogleCloudIntegrationsV1alphaClientConfig: + type: object + description: The configuration information for the Client + properties: + p4ServiceAccount: + description: The service agent associated with this client + type: string + description: + type: string + description: Description of what the client is used for + billingType: + enumDescriptions: + - Unspecified billing type + - A trial org provisioned through Apigee Provisioning Wizard + - Subscription based users of Apigee + - Consumption based users of IP + enum: + - BILLING_TYPE_UNSPECIFIED + - BILLING_TYPE_APIGEE_TRIALS + - BILLING_TYPE_APIGEE_SUBSCRIPTION + - BILLING_TYPE_PAYG + type: string + description: Indicates the billing type of the client + enableVariableMasking: + description: >- + Optional. True if variable masking feature should be turned on for + this region + type: boolean + region: + description: The region the client is linked to. + type: string + id: + type: string + description: Globally unique ID (project_id + region) + clientState: + enum: + - CLIENT_STATE_UNSPECIFIED + - CLIENT_STATE_ACTIVE + - CLIENT_STATE_DISABLED + type: string + 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 + description: Indicates the activity state the client + runAsServiceAccount: + 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. + type: string + createTime: + type: string + description: The timestamp when the client was first created. + format: google-datetime + projectId: + description: The GCP project id of the client associated with + type: string + cloudKmsConfig: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' + description: Cloud KMS config for Auth Module to encrypt/decrypt credentials. + isGmek: + description: Optional. Indicates the client is provisioned with CMEK or GMEK. + type: boolean + id: GoogleCloudIntegrationsV1alphaClientConfig + GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest: + id: GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest + properties: + 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: + deprecated: true + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + type: array + 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. + 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. + type: boolean + inputParameters: + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + type: object + description: Optional. Input parameters used by integration execution. + parameters: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + description: >- + Optional. Passed in as parameters to each integration execution. + Redacted + deprecated: true + 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. + type: object + description: The request for executing an integration. + GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest: + id: GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest + properties: {} + type: object + description: Request for UnpublishIntegrationVersion. + EnterpriseCrmEventbusProtoTeardown: + id: EnterpriseCrmEventbusProtoTeardown + properties: + teardownTaskConfigs: + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTeardownTaskConfig' + type: array + description: Required. + type: object + EnterpriseCrmEventbusProtoSuspensionExpiration: + type: object + id: EnterpriseCrmEventbusProtoSuspensionExpiration + properties: + expireAfterMs: + description: Milliseconds after which the suspension expires, if no action taken. + type: integer + format: int32 + remindAfterMs: + type: integer + 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. + format: int32 + liftWhenExpired: + type: boolean + description: >- + Whether the suspension will be REJECTED or LIFTED upon expiration. + REJECTED is the default behavior. + GoogleCloudIntegrationsV1alphaCloudKmsConfig: + type: object + id: GoogleCloudIntegrationsV1alphaCloudKmsConfig + description: Configuration information for Client's Cloud KMS information + properties: + kmsProjectId: + type: string + 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: + type: string + description: Required. Location name of the key ring, e.g. "us-west1". + 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: + 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. + type: string + 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. + EnterpriseCrmEventbusProtoNotification: + type: object + properties: + emailAddress: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoAddress' + escalatorQueue: + 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: + type: string + buganizerNotification: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBuganizerNotification' + id: EnterpriseCrmEventbusProtoNotification + EnterpriseCrmEventbusProtoWorkflowAlertConfig: + description: >- + Message to be used to configure custom alerting in the {@code + EventConfig} protos for an event. + id: EnterpriseCrmEventbusProtoWorkflowAlertConfig + type: object + properties: + clientId: + type: string + description: Client associated with this alert configuration. + 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. + thresholdValue: + description: >- + The metric value, above or below which the alert should be + triggered. + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue + 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 + 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. + 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 + aggregationPeriod: + description: >- + For an EXPECTED_MIN threshold, this aggregation_period must be + lesser than 24 hours. + type: string + onlyFinalAttempt: + description: >- + For either events or tasks, depending on the type of alert, count + only final attempts, not retries. + type: boolean + 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. + thresholdType: + 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. + - '' + 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 + warningEnumList: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList + errorEnumList: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList + numAggregationPeriods: + description: >- + For how many contiguous aggregation periods should the expected min + or max be violated for the alert to be fired. + format: int32 + type: integer + playbookUrl: + description: >- + Link to a playbook for resolving the issue that triggered this + alert. + type: string + 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. + EnterpriseCrmFrontendsEventbusProtoTaskConfig: + id: EnterpriseCrmFrontendsEventbusProtoTaskConfig + properties: + taskName: + description: The name for the task. + type: string + label: + description: User-provided label that is attached to this TaskConfig in the UI. + type: string + nextTasksExecutionPolicy: + enumDescriptions: + - Default + - Execute all the tasks that satisfy their associated condition. + - Execute the first task that satisfies the associated condition. + type: string + description: >- + The policy dictating the execution of the next set of tasks for the + current task. + enum: + - UNSPECIFIED + - RUN_ALL_MATCH + - RUN_FIRST_MATCH + position: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCoordinate' + description: >- + Optional. Informs the front-end application where to draw this task + config on the UI. + description: + type: string + description: >- + User-provided description intended to give more business context + about the task. + errorCatcherId: + type: string + description: >- + 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/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. + successPolicy: + description: Determines what action to take upon successful task completion. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuccessPolicy' + lastModifiedTime: + description: Auto-generated. + type: string + format: google-datetime + alertConfigs: + description: >- + Alert configurations on error rate, warning rate, number of runs, + durations, etc. + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskAlertConfig' + type: array + taskNumber: + 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_number`). + taskTemplateName: + description: Used to define task-template name if task is of type task-template + type: string + incomingEdgeCount: + description: The number of edges leading into this TaskConfig. + type: integer + format: int32 + 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 + creatorEmail: + type: string + description: The creator's email address. Auto-generated from the user's email. + taskExecutionStrategy: + 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. + type: string + enum: + - WHEN_ALL_SUCCEED + - WHEN_ANY_SUCCEED + - WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED + disableStrictTypeValidation: + 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 + 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). + parameters: + additionalProperties: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + description: The customized parameters the user can pass to this task. + type: object + 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). + taskSpec: + 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. + taskEntity: + $ref: '#/components/schemas/EnterpriseCrmFrontendsEventbusProtoTaskEntity' + description: Copy of the task entity that this task config is an instance of. + 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' + jsonValidationOption: + 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. + enum: + - UNSPECIFIED_JSON_VALIDATION_OPTION + - SKIP + - PRE_EXECUTION + - POST_EXECUTION + - PRE_POST_EXECUTION + description: >- + If set, overrides the option configured in the Task implementation + class. + taskType: + type: string + 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 + preconditionLabel: + description: >- + Optional. User-provided label that is attached to precondition in + the UI. + 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.). + createTime: + format: google-datetime + description: Auto-generated. + type: string + precondition: + 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. + type: object + description: >- + The task configuration details. This is not the implementation of Task. + There might be multiple TaskConfigs for the same Task. + GoogleCloudIntegrationsV1alphaSuspension: + id: GoogleCloudIntegrationsV1alphaSuspension + properties: + suspensionConfig: + deprecated: true + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuspensionConfig' + description: >- + Controls the notifications and resolver permissions for this + suspension. + approvalConfig: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig + description: >- + Controls the notifications and approval permissions for this + suspension. + state: + description: >- + Required. State of this suspension, indicating what action a + resolver has taken. + enum: + - RESOLUTION_STATE_UNSPECIFIED + - PENDING + - REJECTED + - LIFTED + type: string + enumDescriptions: + - Unset state. + - The suspension has not yet been resolved. + - The resolver has rejected the suspension. + - The resolver has lifted the suspension. + eventExecutionInfoId: + type: string + description: Required. ID of the associated execution. + createTime: + description: Output only. Auto-generated. + readOnly: true + format: google-datetime + type: string + audit: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionAudit' + description: Metadata pertaining to the resolution of this suspension. + lastModifyTime: + readOnly: true + description: Output only. Auto-generated. + format: google-datetime + type: string + integration: + description: Required. The name of the originating integration. + type: string + taskId: + description: Required. Task id of the associated SuspensionTask. + type: string + name: + type: string + description: Resource name for suspensions suspension/{suspension_id} + type: object + description: A record representing a suspension. + EnterpriseCrmEventbusProtoBooleanParameterArray: + properties: + booleanValues: + type: array + items: + type: boolean + id: EnterpriseCrmEventbusProtoBooleanParameterArray + type: object + EnterpriseCrmFrontendsEventbusProtoEventParameters: + 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 + properties: + parameters: + 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. + type: array + type: object + id: EnterpriseCrmFrontendsEventbusProtoEventParameters + EnterpriseCrmEventbusProtoTaskUiConfig: + id: EnterpriseCrmEventbusProtoTaskUiConfig + type: object + properties: + taskUiModuleConfigs: + description: Configurations of included config modules. + type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskUiModuleConfig' + 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: + GoogleCloudIntegrationsV1alphaSfdcInstance: + properties: + createTime: + readOnly: true + description: Output only. Time when the instance is created + format: google-datetime + type: string + description: + type: string + description: A description of the sfdc instance. + sfdcOrgId: + type: string + description: The SFDC Org Id. This is defined in salesforce. + updateTime: + description: Output only. Time when the instance was last updated + readOnly: true + type: string + format: google-datetime + name: + description: >- + Resource name of the SFDC instance + projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}. + type: string + serviceAuthority: + type: string + description: >- + URL used for API calls after authentication (the login authority is + configured within the referenced AuthConfig). + deleteTime: + format: google-datetime + type: string + readOnly: true + description: >- + Output only. Time when the instance was deleted. Empty if not + deleted. + displayName: + type: string + description: User selected unique name/alias to easily reference an instance. + authConfigId: + items: + type: string + description: A list of AuthConfigs that can be tried to open the channel to SFDC + type: array + id: GoogleCloudIntegrationsV1alphaSfdcInstance + description: >- + The SfdcInstance resource use to hold channels and connection config + data. + type: object + EnterpriseCrmEventbusProtoValueType: + properties: + intArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntArray' + booleanValue: + type: boolean + doubleArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleArray' + stringValue: + type: string + stringArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringArray' + protoValue: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + intValue: + format: int64 + type: string + doubleValue: + type: number + format: double + description: >- + Used for define type for values. Currently supported value types include + int, string, double, array, and any proto message. + id: EnterpriseCrmEventbusProtoValueType + type: object + GoogleCloudIntegrationsV1alphaCancelExecutionRequest: + description: Request for cancelling an execution. + id: GoogleCloudIntegrationsV1alphaCancelExecutionRequest + type: object + properties: {} + EnterpriseCrmEventbusProtoEventBusProperties: + type: object + properties: + properties: + description: An unordered list of property entries. + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoPropertyEntry' + type: array + id: EnterpriseCrmEventbusProtoEventBusProperties + description: >- + LINT.IfChange This message is used for storing key value pair properties + for each Event / Task in the EventBus. + EnterpriseCrmFrontendsEventbusProtoIntParameterArray: + id: EnterpriseCrmFrontendsEventbusProtoIntParameterArray + properties: + intValues: + type: array + items: + format: int64 + type: string + type: object + GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials: + properties: + password: + description: The user's password. + 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. + type: string + description: Represent how to pass parameters to fetch access token + enum: + - REQUEST_TYPE_UNSPECIFIED + - REQUEST_BODY + - QUERY_PARAMETERS + - ENCODED_HEADER + clientSecret: + type: string + description: The client's secret. + tokenParams: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' + description: Token parameters for the auth request. + accessToken: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken' + description: Access token fetched from the authorization server. + clientId: + type: string + description: The client's ID. + scope: + description: A space-delimited list of requested scope permissions. + type: string + 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. + username: + description: The user's username. + type: string + id: GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials + 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. + GoogleCloudIntegrationsV1alphaTaskExecutionDetails: + id: GoogleCloudIntegrationsV1alphaTaskExecutionDetails + properties: + taskNumber: + type: string + description: Pointer to the task config it used for execution. + taskAttemptStats: + type: array + description: Status for the current task execution attempt. + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAttemptStats' + taskExecutionState: + 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. + 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. + type: string + description: Contains the details of the execution of this task. + type: object + GoogleCloudIntegrationsV1alphaListAuthConfigsResponse: + id: GoogleCloudIntegrationsV1alphaListAuthConfigsResponse + properties: + nextPageToken: + type: string + description: The token used to retrieve the next page of results. + authConfigs: + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + description: The list of AuthConfigs retrieved. + type: array + type: object + description: Response to list AuthConfigs. + EnterpriseCrmEventbusProtoLogSettings: + properties: + shorteningLimits: + description: >- + Contains the field limits for shortening, such as max string length + and max array length. + $ref: '#/components/schemas/EnterpriseCrmLoggingGwsFieldLimits' + seedPeriod: + type: string + 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 + 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. + 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. + sanitizeOptions: + $ref: '#/components/schemas/EnterpriseCrmLoggingGwsSanitizeOptions' + description: >- + Contains the scrubbing options, such as whether to scrub, obfuscate, + etc. + type: object + id: 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. + CrmlogErrorCode: + type: object + description: >- + Registered ids for errors, as "oneof" enums. Each task or logical + grouping of tasks may share the same enum. + properties: + commonErrorCode: + 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. + - '' + - '' + - '' + - '' + - '' + 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 + 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 + id: CrmlogErrorCode + EnterpriseCrmEventbusProtoTaskUiModuleConfig: + id: EnterpriseCrmEventbusProtoTaskUiModuleConfig + description: Task author would use this type to configure a config module. + 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. type: string - description: Key of the config variable. - boolValue: - type: boolean - description: Value is a bool. - encryptionKeyValue: - $ref: '#/components/schemas/GoogleCloudConnectorsV1EncryptionKey' - description: Value is a Encryption Key. - secretValue: - description: Value is a secret. - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex: + 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. type: object - id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex - description: Rule used to validate strings. + GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest: + description: Request for Creating Cloud Function rpc call. properties: - exclusive: + projectId: + type: string description: >- - Whether the regex matcher is applied exclusively (if true, matching - values will be rejected). - type: boolean - regex: - description: The regex applied to the input value(s). + 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 - GoogleCloudIntegrationsV1alphaGenerateTokenResponse: - id: GoogleCloudIntegrationsV1alphaGenerateTokenResponse - description: Returns success or error message + functionName: + type: string + description: The function name of CF to be created type: object + id: GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest + GoogleCloudIntegrationsV1alphaSuccessPolicy: properties: - message: + finalState: type: string - description: The message that notifies the user if the request succeeded or not. - GoogleCloudIntegrationsV1alphaIntegrationParameter: + description: >- + State to which the execution snapshot status will be set if the task + succeeds. + 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. + enum: + - FINAL_STATE_UNSPECIFIED + - SUCCEEDED + - SUSPENDED 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. + Policy that dictates the behavior for the task after it completes + successfully. + id: GoogleCloudIntegrationsV1alphaSuccessPolicy + type: object + GoogleCloudConnectorsV1Secret: + description: Secret provides a reference to entries in Secret Manager. properties: - 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/GoogleCloudIntegrationsV1alphaValueType' - jsonSchema: - type: string + secretVersion: description: >- - This schema will be used to validate runtime JSON-typed values of - this parameter. - isTransient: - type: boolean - description: Whether this parameter is a transient parameter. - displayName: + The resource name of the secret version in the format, format as: + `projects/*/secrets/*/versions/*`. type: string - 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". - key: + id: GoogleCloudConnectorsV1Secret + type: object + EnterpriseCrmEventbusProtoConnectorsConnection: + type: object + id: EnterpriseCrmEventbusProtoConnectorsConnection + properties: + connectionName: 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. - inputOutputType: - enum: - - IN_OUT_TYPE_UNSPECIFIED - - IN - - OUT - - IN_OUT - description: Specifies the input/output type for the parameter. + Connection name Format: + projects/{project}/locations/{location}/connections/{connection} + connectorVersion: type: string - enumDescriptions: - - Default. - - >- - Input parameters for the integration. EventBus validates that - these parameters exist in the integrations before execution. - - >- - 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. - 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 - containsLargeData: + Connector version Format: + projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version} + serviceName: description: >- - Indicates whether this variable contains large data and need to be - uploaded to Cloud Storage. - type: boolean - masked: - description: True if this parameter should be masked in the logs - type: boolean - searchable: - description: Searchable in the execution log or not. - type: boolean - dataType: - 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). + Service name Format: + projects/{project}/locations/{location}/namespaces/{namespace}/services/{service} 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 - type: object - id: GoogleCloudIntegrationsV1alphaIntegrationParameter - EnterpriseCrmFrontendsEventbusProtoParameterEntry: - id: EnterpriseCrmFrontendsEventbusProtoParameterEntry + GoogleCloudConnectorsV1NodeConfig: 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 - description: Explicitly getting the type of the parameter. + minNodeCount: + description: Minimum number of nodes in the runtime nodes. + format: int32 + type: integer + maxNodeCount: + format: int32 + description: Maximum number of nodes in the runtime nodes. + type: integer + id: GoogleCloudConnectorsV1NodeConfig + type: object + description: Node configuration for the connection. + EnterpriseCrmLoggingGwsSanitizeOptions: + description: >- + Identifies whether a field contains, or may contain, PII or sensitive + data, and how to sanitize the field if it does. If a field's privacy + type cannot be determined then it is sanitized (e.g., scrubbed). The + specific sanitizer implementation is determined by run-time + configuration and environment options (e.g., prod vs. qa). next_id: 5 + properties: + sanitizeType: type: string + enum: + - SANITIZE_TYPE_UNSPECIFIED + - SCRUB + - ANONYMIZE + - ANONYMIZE_LIMITED_REPEATABLE + - OBFUSCATE + - ENCRYPT + - DO_NOT_SANITIZE enumDescriptions: - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' + - Replace value with a scrubbed value (usu. a constant). - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. - - '' - - '' + Transform a value so that it cannot be tracked across events. + However, a given value, is transformed to the same value *within* + an event. E.g., "foo.com" is transformed to "0xabcdef" for event + 1001, and to "0xfedcba" for event 1002. + - >- + Transform values as with ANONYMIZER, but the same transformation + is repeated for a limited time (e.g., 1 day). + - >- + The value is transformed using a well-defined obfuscator (e.g., + D3_CUSTOMER_ID). + - The value is encrypted. + - No sanitization is required. + privacy: + enum: + - PRIVACY_TYPE_UNSPECIFIED + - NOT_PII + - PII + - SPII + - UNSURE + enumDescriptions: - '' - masked: - description: True if this parameter should be masked in the logs - type: boolean - value: - description: >- - Values for the defined keys. Each value can either be string, int, - double or any proto message. - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType - key: + - Field does *NOT* contain PII or sensitive data. + - Field contains PII. + - Field contains Sensitive PII. + - Unsure if field contains PII. type: string + logType: + items: + enum: + - LOG_TYPE_UNSPECIFIED + - GWS + - GTS + - ALL + type: string + enumDescriptions: + - '' + - Limits apply when log detail records are written to GWS. + - >- + Limits apply when log detail records are written to GTS (e.g., + RecordIO files). + - Limits apply to *all* output log types. + type: array + description: To which type(s) of logs the sanitize options apply. + isAlreadySanitized: + type: boolean 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. - description: Key-value pair of EventBus parameters. + If true, the value has already been sanitized and needs no further + sanitization. For instance, a D3 customer id is already an + obfuscated entity and *might not* need further sanitization. type: object - EnterpriseCrmEventbusProtoNotification: + id: EnterpriseCrmLoggingGwsSanitizeOptions + GoogleCloudIntegrationsV1alphaExecuteEventResponse: + id: GoogleCloudIntegrationsV1alphaExecuteEventResponse properties: - 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' - pubsubTopic: - type: string - escalatorQueue: + executionId: type: string - emailAddress: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoAddress' - id: EnterpriseCrmEventbusProtoNotification + description: The id of the execution corresponding to this run of integration. + description: The response for executing an integration. type: object - EnterpriseCrmEventbusProtoFailurePolicy: - id: 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). + GoogleCloudConnectorsV1HPAConfig: type: object + description: Autoscaling config for connector deployment system metrics. properties: - intervalInSeconds: + memoryUtilizationThreshold: + description: >- + Output only. Percent Memory utilization where HPA triggers + autoscaling. + readOnly: true format: int64 type: string + cpuUtilizationThreshold: + type: string + description: Output only. Percent CPU utilization where HPA triggers autoscaling. + format: int64 + readOnly: true + id: GoogleCloudConnectorsV1HPAConfig + EnterpriseCrmFrontendsEventbusProtoTriggerConfig: + properties: + cloudSchedulerConfig: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudSchedulerConfig' + triggerName: description: >- - Required if retry_strategy is FIXED_INTERVAL or - LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines - the initial interval for backoff. - retryStrategy: - enum: - - UNSPECIFIED - - IGNORE - - NONE - - FATAL - - FIXED_INTERVAL - - LINEAR_BACKOFF - - EXPONENTIAL_BACKOFF - - RESTART_WORKFLOW_WITH_BACKOFF + 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. + type: string + errorCatcherId: type: string - 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. - - >- - 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. - maxNumRetries: 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. - format: int32 - type: integer - retryCondition: + Optional Error catcher id of the error catch flow which will be + executed when execution error happens in the task + position: + description: >- + Optional. Informs the front-end application where to draw this + trigger config on the UI. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCoordinate' + 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' + 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' + 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: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' type: string + enabledClients: description: >- - Optional. The retry condition that will be evaluated for this - failure policy with the corresponding retry strategy. - EnterpriseCrmEventbusProtoParamSpecEntryValidationRule: - properties: - stringRegex: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex - doubleRange: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange - intRange: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange - id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRule - type: object - 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. - properties: - clientSecret: + 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 + triggerId: type: string - description: The client's secret. - tokenParams: - description: Token parameters for the auth request. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' - scope: + description: The backend trigger ID. + nextTasksExecutionPolicy: + enumDescriptions: + - Default + - Execute all the tasks that satisfy their associated condition. + - Execute the first task that satisfies the associated condition. type: string - description: A space-delimited list of requested scope permissions. - clientId: - description: The client's ID. + enum: + - UNSPECIFIED + - RUN_ALL_MATCH + - RUN_FIRST_MATCH + description: Dictates how next tasks will be executed. + label: type: string - tokenEndpoint: - description: >- - The token endpoint is used by the client to obtain an access token - by presenting its authorization grant or refresh token. + description: The user created label for a particular trigger. + description: type: string - requestType: - description: Represent how to pass parameters to fetch access token - enum: - - REQUEST_TYPE_UNSPECIFIED - - REQUEST_BODY - - QUERY_PARAMETERS - - ENCODED_HEADER + description: >- + User-provided description intended to give more business context + about the task. + triggerNumber: 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. - accessToken: - description: Access token fetched from the authorization server. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken' + description: >- + Required. A number to uniquely identify each trigger config within + the workflow on UI. + alertConfig: + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoWorkflowAlertConfig' + 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. + 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 + properties: + additionalProperties: + type: string + type: object + 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. + description: 'Configuration detail of a trigger. Next available id: 20' + id: EnterpriseCrmFrontendsEventbusProtoTriggerConfig type: object - id: GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials - GoogleCloudIntegrationsV1alphaResolveSuspensionRequest: + GoogleCloudIntegrationsV1alphaParameterMapEntry: type: object + id: GoogleCloudIntegrationsV1alphaParameterMapEntry properties: - suspension: - description: >- - Suspension, containing the event_execution_info_id, task_id, and - state to set on the corresponding suspension record. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuspension' - description: Request for [Suspensions.ResolveSuspensions]. - id: GoogleCloudIntegrationsV1alphaResolveSuspensionRequest + key: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapField' + description: Key of the map entry. + value: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapField' + description: Value of the map entry. + description: Entry is a pair of key and value. + EnterpriseCrmEventbusProtoNodeIdentifier: + description: 'Represents a node identifier (type + id). Next highest id: 3' + type: object + properties: + 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 + elementIdentifier: + type: string + description: Configuration of the edge. + id: EnterpriseCrmEventbusProtoNodeIdentifier EnterpriseCrmEventbusProtoAttributes: - description: >- - Attributes are additional options that can be associated with each event - property. For more information, see properties: - defaultValue: - description: Used to define defaults. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoValueType' + isRequired: + description: >- + Required for event execution. The validation will be done by the + event bus when the event is triggered. + type: boolean 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. - deprecated: true + readOnly: + description: Used to indicate if the ParameterEntry is a read only field or not. type: boolean + 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 + description: >- + Things like URL, Email, Currency, Timestamp (rather than string, + int64...) + enum: + - DATA_TYPE_UNSPECIFIED + - EMAIL + - URL + - CURRENCY + - TIMESTAMP + - DOMAIN_NAME logSettings: $ref: '#/components/schemas/EnterpriseCrmEventbusProtoLogSettings' description: See 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. + type: string enum: - UNSPECIFIED - 'YES' - 'NO' - type: string + defaultValue: + description: Used to define defaults. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoValueType' + taskVisibility: + items: + type: string + type: array + 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 + description: >- + Attributes are additional options that can be associated with each event + property. For more information, see + id: EnterpriseCrmEventbusProtoAttributes + type: object + EnterpriseCrmEventbusProtoParameterMapEntry: + description: Entry is a pair of key and value. + id: EnterpriseCrmEventbusProtoParameterMapEntry + type: object + properties: + value: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapField' + key: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapField' + GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest: + description: Request for PublishIntegrationVersion. + id: GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest + properties: + configParameters: + additionalProperties: + description: Properties of the object. + type: any + type: object + description: Optional. Config parameters used during integration execution. + type: object + EnterpriseCrmEventbusProtoJsonFunction: + type: object + properties: + functionName: 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. - 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. - taskVisibility: - description: List of tasks that can view this property, if empty then all. - items: - type: string - type: array - isRequired: - description: >- - Required for event execution. The validation will be done by the - event bus when the event is triggered. - type: boolean - dataType: - 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...) - enum: - - DATA_TYPE_UNSPECIFIED - - EMAIL - - URL - - CURRENCY - - TIMESTAMP - - DOMAIN_NAME - type: object - id: EnterpriseCrmEventbusProtoAttributes - GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse: - id: GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse - description: Response to list SfdcInstances. - type: object - properties: - nextPageToken: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - 'next id: 24' type: string - description: The token used to retrieve the next page of results. - sfdcInstances: - type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' - description: The list of SfdcInstances retrieved. - EnterpriseCrmEventbusProtoJsonFunction: - properties: - functionName: enum: - UNSPECIFIED - GET_PROPERTY @@ -6208,161 +6778,26 @@ components: - EQUALS - FOR_EACH - FILTER_ELEMENTS - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - 'next id: 24' - type: string - type: object id: EnterpriseCrmEventbusProtoJsonFunction - GoogleCloudIntegrationsV1alphaReplayExecutionRequest: - properties: - replayReason: - type: string - description: Optional. The user provided reason for replaying the execution. - type: object - id: GoogleCloudIntegrationsV1alphaReplayExecutionRequest - description: 'Request for replaying an execution Next ID: 3' - GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse: - type: object - description: Response for listing RuntimeEntitySchemas for a specific Connection. - id: GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse - properties: - nextPageToken: - type: string - description: Next page token. - runtimeEntitySchemas: - description: Runtime entity schemas. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaRuntimeEntitySchema - EnterpriseCrmFrontendsEventbusProtoIntParameterArray: - id: EnterpriseCrmFrontendsEventbusProtoIntParameterArray - properties: - intValues: - type: array - items: - format: int64 - type: string - type: object - GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse: - description: Response for PublishIntegrationVersion. - id: GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse - properties: {} - type: object - GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer: - type: object - 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. - id: GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer - GoogleCloudIntegrationsV1alphaServiceAccountCredentials: - type: object - id: GoogleCloudIntegrationsV1alphaServiceAccountCredentials - description: >- - Represents the service account which can be used to generate access - token for authenticating the service call. - properties: - scope: - description: A space-delimited list of requested scope permissions. - type: string - serviceAccount: - type: string - description: >- - Name of the service account that has the permission to make the - request. - EnterpriseCrmEventbusProtoField: + EnterpriseCrmEventbusProtoCondition: + deprecated: true + description: Condition that uses `operator` to evaluate the key against the value. + id: EnterpriseCrmEventbusProtoCondition properties: - transformExpression: - 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' - protoDefPath: - 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: - 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. - enum: - - UNSPECIFIED - - OPTIONAL - type: string - fieldType: + value: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoValueType' + description: Value that's checked for the key. + operator: 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. + - UNSET + - EQUALS + - CONTAINS + - LESS_THAN + - GREATER_THAN + - EXISTS + - DOES_NOT_EXIST + - IS_EMPTY + - IS_NOT_EMPTY enumDescriptions: - '' - '' @@ -6373,884 +6808,818 @@ 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 - referenceKey: - type: string - 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: 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' - id: EnterpriseCrmEventbusProtoField - type: object - description: Information about the value and type of the field. - EnterpriseCrmEventbusProtoParameterValueType: - properties: - stringArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringParameterArray' - stringValue: - type: string - intArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntParameterArray' - booleanArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBooleanParameterArray' - intValue: + 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. type: string - format: int64 - doubleValue: - format: double - type: number - protoValue: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - serializedObjectValue: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoSerializedObjectParameter - protoArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoParameterArray' - doubleArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleParameterArray' - booleanValue: - type: boolean - description: >- - LINT.IfChange To support various types of parameter values. Next - available id: 14 - id: EnterpriseCrmEventbusProtoParameterValueType - type: object - 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: - description: Required. Name of the next teardown task. + eventPropertyKey: type: string + 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. type: object - id: EnterpriseCrmEventbusProtoNextTeardownTask - GoogleCloudConnectorsV1AuthConfigSshPublicKey: + GoogleCloudIntegrationsV1alphaTaskConfig: + id: GoogleCloudIntegrationsV1alphaTaskConfig properties: - certType: + description: + description: >- + Optional. User-provided description intended to give additional + business context about the task. type: string - description: Format of SSH Client cert. - 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. + displayName: type: string - type: object - id: GoogleCloudConnectorsV1AuthConfigSshPublicKey - description: Parameters to support Ssh public key Authentication. - GoogleCloudIntegrationsV1alphaListConnectionsResponse: - properties: - nextPageToken: + description: >- + Optional. User-provided label that is attached to this TaskConfig in + the UI. + successPolicy: + description: >- + Optional. Determines what action to take upon successful task + completion. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuccessPolicy' + taskId: type: string - description: Next page token. - connections: - items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Connection' - description: Connections. - type: array - type: object - id: GoogleCloudIntegrationsV1alphaListConnectionsResponse - description: Response containing Connections listed by region. - GoogleCloudIntegrationsV1alphaExecutionDetails: - type: object - id: GoogleCloudIntegrationsV1alphaExecutionDetails - properties: - executionSnapshots: - description: List of snapshots taken during the execution. + 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`). + nextTasks: items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionSnapshot + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask' type: array - state: + 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: + $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. - - Execution is scheduled and awaiting to be triggered. - - Execution is processing. + - Execute all the tasks that satisfy their associated condition. + - Execute the first task that satisfies the associated condition. + 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.). + parameters: + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaEventParameter' + type: object + description: Optional. The customized parameters the user can pass to this task. + taskTemplate: + type: string + description: >- + Optional. Used to define task-template name if task is of type + task-template + jsonValidationOption: + description: >- + Optional. If set, overrides the option configured in the Task + implementation class. + type: string + enum: + - JSON_VALIDATION_OPTION_UNSPECIFIED + - SKIP + - PRE_EXECUTION + - POST_EXECUTION + - PRE_POST_EXECUTION + enumDescriptions: - >- - Execution successfully finished. There's no more change after this - state. - - Execution failed. There's no more change after this state. + 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. - >- - 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. + 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. + position: + description: >- + Optional. Informs the front-end application where to draw this error + catcher config on the UI. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' + externalTaskType: enum: - - STATE_UNSPECIFIED - - PENDING - - PROCESSING - - SUCCEEDED - - FAILED - - CANCELLED - - RETRY_ON_HOLD - - SUSPENDED - type: string - eventExecutionSnapshotsSize: - description: Total size of all event_execution_snapshots for an execution + - 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 - format: int64 - attemptStats: - description: List of Start and end time of the execution attempts. - type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAttemptStats' - description: >- - Contains the details of the execution info: this includes the tasks - execution details plus the event execution statistics. - EnterpriseCrmEventbusProtoConnectorsConnection: - id: EnterpriseCrmEventbusProtoConnectorsConnection - type: object - properties: - connectionName: - description: >- - Connection name Format: - projects/{project}/locations/{location}/connections/{connection} + description: Optional. External task type of the task + errorCatcherId: type: string - serviceName: description: >- - Service name Format: - projects/{project}/locations/{location}/namespaces/{namespace}/services/{service} + Optional. Optional Error catcher id of the error catch flow which + will be executed when execution error happens in the task + task: type: string - connectorVersion: - description: >- - Connector version Format: - projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version} + description: Optional. The name for the task. + taskExecutionStrategy: + 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. type: string - GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest: - id: GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest - description: Request for the SwitchEncryption rpc - properties: - cloudKmsConfig: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' + enum: + - TASK_EXECUTION_STRATEGY_UNSPECIFIED + - WHEN_ALL_SUCCEED + - WHEN_ANY_SUCCEED + - WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED + conditionalFailurePolicies: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaConditionalFailurePolicies description: >- - Required. REQUIRED: Cloud KMS config for AuthModule to - encrypt/decrypt credentials. + Optional. The list of conditional failure policies that will be + applied to the task in order. type: object - 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 - GoogleCloudIntegrationsV1alphaDoubleParameterArray: + The task configuration details. This is not the implementation of Task. + There might be multiple TaskConfigs for the same Task. + EnterpriseCrmEventbusProtoSuspensionAuthPermissions: type: object - description: This message only contains a field of double number array. - properties: - doubleValues: - items: - type: number - format: double - type: array - description: Double number array. - id: GoogleCloudIntegrationsV1alphaDoubleParameterArray - EnterpriseCrmEventbusProtoAddress: properties: - name: + gaiaIdentity: + description: Represents a Gaia identity for a person or service account. + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity + mdbGroup: type: string - email: + loasRole: type: string - description: Required. - tokens: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoToken' - 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. - id: EnterpriseCrmEventbusProtoAddress - type: object - EnterpriseCrmFrontendsEventbusProtoWorkflowParameters: + googleGroup: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity + id: EnterpriseCrmEventbusProtoSuspensionAuthPermissions + description: LINT.IfChange + EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage: properties: parameters: 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. + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParamSpecEntry type: array type: object + id: EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage + EnterpriseCrmEventbusProtoNextTask: 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 - GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse: - id: GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse - description: Response to list SfdcChannels. + The task that is next in line to be executed, if the condition specified + evaluated to true. + type: object + id: EnterpriseCrmEventbusProtoNextTask + properties: + taskConfigId: + type: string + description: ID of the next task. + description: + type: string + description: >- + User-provided description intended to give more business context + about the next task edge or condition. + condition: + description: >- + Standard filter expression for this task to become an eligible next + task. + type: string + taskNumber: + description: Task number of the next task. + type: string + combinedConditions: + type: array + deprecated: true + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCombinedCondition' + 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` + label: + description: User-provided label that is attached to this edge in the UI. + type: string + GoogleCloudIntegrationsV1alphaListExecutionsResponse: properties: nextPageToken: type: string - description: The token used to retrieve the next page of results. - sfdcChannels: - description: The list of SfdcChannels retrieved. + description: The token used to retrieve the next page results. + executions: items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' + type: array + description: The detailed information of requested executions + executionInfos: + description: Required. The detailed information of requested executions. + deprecated: true + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo type: array + id: GoogleCloudIntegrationsV1alphaListExecutionsResponse + description: Response for listing the integration execution data. type: object - GoogleCloudIntegrationsV1alphaSfdcChannel: - description: The SfdcChannel that points to a CDC or Platform Event Channel. - id: GoogleCloudIntegrationsV1alphaSfdcChannel + EnterpriseCrmEventbusProtoLoopMetadata: + id: EnterpriseCrmEventbusProtoLoopMetadata type: object properties: - description: + currentIterationCount: + description: Starting from 1, not 0. + format: int64 type: string - description: The description for this channel - isActive: - type: boolean + currentIterationDetail: 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. - name: + 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 - description: >- - Resource name of the SFDC channel - projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}. - channelTopic: + failureLocation: + enum: + - UNKNOWN + - SUBWORKFLOW + - PARAM_OVERRIDING + - PARAM_AGGREGATING + - SETTING_ITERATION_ELEMENT + - GETTING_LIST_TO_ITERATE + - CONDITION_EVALUATION + - BUILDING_REQUEST + description: Indicates where in the loop logic did it error out. + 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: The Channel topic defined by salesforce once an channel is opened - createTime: - description: Output only. Time when the channel is created + errorMsg: type: string - readOnly: true - format: google-datetime - deleteTime: - description: >- - Output only. Time when the channel was deleted. Empty if not - deleted. - format: google-datetime + description: Add the error message when loops fail. + GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse: + properties: {} + description: Response for PublishIntegrationVersion. + type: object + id: GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse + GoogleCloudIntegrationsV1alphaDownloadExecutionResponse: + description: Response for downloading an execution. + type: object + id: GoogleCloudIntegrationsV1alphaDownloadExecutionResponse + properties: + content: type: string - readOnly: true - updateTime: - description: Output only. Time when the channel was last updated + description: The content of downloaded execution. + GoogleCloudIntegrationsV1alphaListSuspensionsResponse: + description: Response for Suspensions.ListSuspensions. + id: GoogleCloudIntegrationsV1alphaListSuspensionsResponse + 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 - format: google-datetime - readOnly: true - lastReplayId: - description: Last sfdc messsage replay id for channel + type: object + EnterpriseCrmEventbusProtoBaseValue: + type: object + id: EnterpriseCrmEventbusProtoBaseValue + properties: + referenceValue: + description: Start with a reference value to dereference. type: string - displayName: + baseFunction: + description: >- + Start with a function that does not build on existing values. Eg. + CurrentTime, Min, Max, Exists, etc. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFunction' + literalValue: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' + description: Start with a literal value. + GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse: + id: GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse + properties: + triggerUrl: + description: The trigger url that will be returned type: string - description: Client level unique name/alias to easily reference a channel. - GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims: - id: GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims type: object - description: JWT claims used for the jwt-bearer authorization grant. + description: Response for Creating Cloud Function rpc call. + GoogleCloudIntegrationsV1alphaNextTask: properties: - issuer: - description: Value for the "iss" claim. - type: string - audience: + taskConfigId: type: string - description: Value for the "aud" claim. - subject: + description: ID of the next task. + taskId: type: string - description: Value for the "sub" claim. - EnterpriseCrmEventbusProtoProtoArrayFunction: - type: object - id: EnterpriseCrmEventbusProtoProtoArrayFunction - properties: - functionName: - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - UNSPECIFIED - - GET - - APPEND - - SIZE - - TO_SET - - APPEND_ALL - - TO_JSON - - SET - - REMOVE - - REMOVE_AT - - CONTAINS - - FOR_EACH - - FILTER + description: Task number of the next task. + displayName: + description: User-provided label that is attached to this edge in the UI. type: string - GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest: - description: Request for CreateAppsScriptProject rpc call. - properties: - appsScriptProject: - description: The name of the Apps Script project to be created. + condition: type: string - authConfigId: description: >- - The auth config id necessary to fetch the necessary credentials to - create the project for external clients + Standard filter expression for this task to become an eligible next + task. + description: type: string + description: >- + User-provided description intended to give additional business + context about the task. + description: >- + The task that is next in line to be executed, if the condition specified + evaluated to true. + id: GoogleCloudIntegrationsV1alphaNextTask type: object - id: GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest - EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue: + 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. + Eventing runtime data has the details related to eventing managed by the + system. properties: - absolute: + status: + readOnly: true + $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingStatus' + description: Output only. Current status of eventing. + eventsListenerPscSa: type: string - format: int64 - percentage: - type: integer - format: int32 - id: EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue + description: >- + Output only. Events listener PSC Service attachment. The value will + be populated after provisioning the events listener with private + connectivity enabled. + readOnly: true + webhookData: + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1EventingRuntimeDataWebhookData + description: Output only. Webhook data. + readOnly: true + eventsListenerEndpoint: + type: string + description: >- + Output only. Events listener endpoint. The value will populated + after provisioning the events listener. + readOnly: true + id: GoogleCloudConnectorsV1EventingRuntimeData type: object - GoogleCloudConnectorsV1EventingConfig: + GoogleCloudIntegrationsV1alphaCloudLoggingDetails: type: object + id: GoogleCloudIntegrationsV1alphaCloudLoggingDetails properties: - additionalVariables: - type: array - description: Additional eventing related field values - items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' - enrichmentEnabled: + enableCloudLogging: type: boolean - description: Enrichment Enabled. - eventsListenerIngressEndpoint: description: >- - Optional. Ingress endpoint of the event listener. This is used only - when private connectivity is enabled. + Optional. Status of whether Cloud Logging is enabled or not for the + integration version getting executed. + cloudLoggingSeverity: type: string - registrationDestinationConfig: - description: Registration endpoint for auto registration. - $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' - privateConnectivityEnabled: - type: boolean - description: Optional. Private Connectivity Enabled. - deadLetterConfig: - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1EventingConfigDeadLetterConfig - description: Optional. Dead letter configuration for eventing of a connection. - authConfig: - description: Auth details for the webhook adapter. - $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' - listenerAuthConfig: - description: Optional. Auth details for the event listener. - $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' - proxyDestinationConfig: - description: Optional. Proxy for Eventing auto-registration. - $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' - description: Eventing Configuration of a connection - id: GoogleCloudConnectorsV1EventingConfig - GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse: - id: GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse + description: >- + Optional. Severity selected by the customer for the logs to be sent + to Cloud Logging, for the integration version getting executed. + 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: Cloud Logging details for execution info + GoogleCloudIntegrationsV1alphaConditionalFailurePolicies: + id: GoogleCloudIntegrationsV1alphaConditionalFailurePolicies + description: Conditional task failur retry strategies + type: object properties: - content: - type: string - description: String representation of the requested file. - files: + defaultFailurePolicy: + description: >- + The default failure policy to be applied if no conditional failure + policy matches. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' + failurePolicies: type: array - description: List containing String represendation for multiple file with type. + description: >- + The list of failure policies that will be applied to the task in + order. items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSerializedFile' - description: Response for DownloadIntegrationVersion. - type: object - EnterpriseCrmEventbusProtoStringFunction: - id: EnterpriseCrmEventbusProtoStringFunction - type: object + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' + EnterpriseCrmEventbusProtoFunction: properties: - functionName: - type: string - 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: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - EnterpriseCrmEventbusProtoDoubleArray: - id: EnterpriseCrmEventbusProtoDoubleArray + parameters: + description: List of parameters required for the transformation. + type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTransformExpression' + functionType: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFunctionType' + description: The name of the function to perform. + type: object + id: EnterpriseCrmEventbusProtoFunction + GoogleCloudIntegrationsV1alphaOidcToken: + id: GoogleCloudIntegrationsV1alphaOidcToken type: object + description: OIDC Token properties: - values: - type: array - items: - type: number - format: double - GoogleCloudConnectorsV1Secret: - id: GoogleCloudConnectorsV1Secret - properties: - secretVersion: + token: + description: ID token obtained for the service account + type: string + tokenExpireTime: + type: string + description: The approximate time until the token retrieved is valid. + format: google-datetime + audience: 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. - GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials: + Audience to be used when generating OIDC token. The audience claim + identifies the recipients that the JWT is intended for. + serviceAccountEmail: + description: The service account email to be used as the identity for the token. + type: string + GoogleCloudConnectorsV1ConnectionStatus: type: object properties: - clientId: + status: + description: Status provides detailed information for the state. type: string - description: The client identifier. - clientSecret: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - description: Secret version reference containing the client secret. + description: + type: string + description: Description. + state: + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - INACTIVE + - DELETING + - UPDATING + - ERROR + - AUTHORIZATION_REQUIRED + type: string + description: 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: ConnectionStatus indicates the state of the connection. + id: GoogleCloudConnectorsV1ConnectionStatus + EnterpriseCrmEventbusProtoFieldMappingConfig: + id: EnterpriseCrmEventbusProtoFieldMappingConfig 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. - id: GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials - GoogleCloudIntegrationsV1alphaExecutionSnapshot: - type: object + Field Mapping Config to map multiple output fields values from input + fields values. properties: - params: - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - description: Parameters used during the execution. - checkpointTaskNumber: - description: >- - Indicates "after which checkpoint task's execution" this snapshot is - taken. - type: string - taskExecutionDetails: - description: All of the task execution details at the given point of time. + mappedFields: items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTaskExecutionDetails + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoMappedField' type: array - executionSnapshotMetadata: - description: Metadata of the execution snapshot. - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata - description: Contains the snapshot of the execution for a given checkpoint. - id: GoogleCloudIntegrationsV1alphaExecutionSnapshot - EnterpriseCrmEventbusProtoTaskMetadata: type: object - description: >- - TaskMetadata are attributes that are associated to every common Task we - have. - id: EnterpriseCrmEventbusProtoTaskMetadata + EnterpriseCrmEventbusProtoErrorDetail: + description: An error, warning, or information message associated with a workflow. + id: EnterpriseCrmEventbusProtoErrorDetail properties: - externalDocMarkdown: - type: string - description: 'DEPRECATED: Use external_doc_html.' - externalCategory: + severity: 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 + description: 'The severity of the error: ERROR|WARN|INFO.' 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 - 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 - externalDocLink: - type: string - description: Doc link for external-facing documentation (separate from g3doc). - system: + - SEVERITY_UNSPECIFIED + - ERROR + - WARN + - INFO enumDescriptions: - '' - '' - '' - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - type: string - enum: - - UNSPECIFIED_SYSTEM - - GENERIC - - BUGANIZER - - SALESFORCE - - CLOUD_SQL - - PLX - - SHEETS - - GOOGLE_GROUPS - - EMAIL - - SPANNER - - DATA_BRIDGE - standaloneExternalDocHtml: + taskNumber: + type: integer + format: int32 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 + The task try-number, in which, the error occurred. If zero, the + error happened at the event level. + errorMessage: + description: >- + The full text of the error message, including any parameters that + were thrown along with the exception. type: string - isDeprecated: - type: boolean - description: The deprecation status of the current task. Default value is false; - codeSearchLink: - description: The Code Search link to the Task Java file. + errorCode: + $ref: '#/components/schemas/CrmlogErrorCode' + description: The associated error-code, which can be a common or internal code. + type: object + EnterpriseCrmEventbusProtoCoordinate: + type: object + description: Represents two-dimensional positions. + properties: + 'y': + format: int32 + type: integer + x: + format: int32 + type: integer + id: EnterpriseCrmEventbusProtoCoordinate + EnterpriseCrmEventbusProtoTriggerCriteria: + type: object + properties: + condition: type: string - defaultSpec: + 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. + parameters: + description: Optional. To be used in TaskConfig for the implementation class. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + triggerCriteriaTaskImplementationClassName: + description: >- + Optional. Implementation class name. The class should implement the + “TypedTask” interface. type: string + id: EnterpriseCrmEventbusProtoTriggerCriteria + GoogleCloudIntegrationsV1alphaResolveSuspensionRequest: + id: GoogleCloudIntegrationsV1alphaResolveSuspensionRequest + description: Request for [Suspensions.ResolveSuspensions]. + properties: + suspension: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuspension' description: >- - Contains the initial configuration of the task with default values - set. For now, The string should be compatible to an ASCII-proto - format. - externalCategorySequence: + Suspension, containing the event_execution_info_id, task_id, and + state to set on the corresponding suspension record. + type: object + EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex: + type: object + description: Rule used to validate strings. + properties: + regex: + description: The regex applied to the input value(s). + type: string + exclusive: + description: >- + Whether the regex matcher is applied exclusively (if true, matching + values will be rejected). + type: boolean + id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex + EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue: + properties: + absolute: + format: int64 + type: string + percentage: format: int32 - description: >- - Sequence with which the task in specific category to be displayed in - task discovery panel for external users. type: integer - docMarkdown: - description: Snippet of markdown documentation to embed in the RHP for this task. + 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 + EnterpriseCrmEventbusProtoEventExecutionSnapshot: + type: object + properties: + conditionResults: + description: All of the computed conditions that been calculated. + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoConditionResult' + type: array + taskName: + deprecated: true + description: The task name associated with this snapshot. Could be empty. type: string - activeTaskName: + workflowName: + description: Name of the workflow this event execution snapshot belongs to. 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. - category: + clientId: + type: string + description: Client that the execution snapshot is associated to. + eventParams: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + description: The parameters in Event object. + diffParams: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + description: The parameters in Event object that differs from last snapshot. + taskExecutionDetails: + description: All of the task execution details at the given point of time. + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetails + eventExecutionSnapshotId: type: string - 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 - - >- - include connecting to Vector salesforce, CRM Hub Spanner etc. Task - entities that derive from a custom task template. - - Category to show task recommendations - 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") + Auto-generated. Used as primary key for EventExecutionSnapshots + table. + checkpointTaskNumber: type: string - g3DocLink: + description: >- + Indicates "right after which checkpoint task's execution" this + snapshot is taken. + eventExecutionInfoId: type: string - description: URL to the associated G3 Doc for the task if available - description: + description: Points to the event execution info this snapshot belongs to. + eventExecutionSnapshotMetadata: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata + snapshotTime: + format: int64 type: string - description: In a few sentences, describe the purpose and usage of the task. - status: + description: Indicates when this snapshot is taken. + exceedMaxSize: + description: indicate whether snapshot exceeded maximum size before clean up + type: boolean + id: EnterpriseCrmEventbusProtoEventExecutionSnapshot + description: >- + Contains the snapshot of the event execution for a given checkpoint. + Next available id: 15 + GoogleCloudIntegrationsV1alphaSerializedFile: + description: To store string representation of Integration file. + properties: + file: description: >- - Allows author to indicate if the task is ready to use or not. If not - set, then it will default to INACTIVE. + File information like Integration version, Integration Config + variables etc. 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. - enum: - - UNSPECIFIED_STATUS - - DEFAULT_INACTIVE - - ACTIVE - externalDocHtml: - description: External-facing documention embedded in the RHP for this task. - type: string - defaultJsonValidationOption: - type: string + - Default value. + - Integration file. + - Integration Config variables. 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. - tags: - 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. - type: array - items: - type: string - admins: - type: array - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskMetadataAdmin' - iconLink: + - INTEGRATION_FILE_UNSPECIFIED + - INTEGRATION + - INTEGRATION_CONFIG_VARIABLES + content: type: string - 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. - EnterpriseCrmEventbusProtoIntArray: - properties: - values: - type: array - items: - type: string - format: int64 - id: EnterpriseCrmEventbusProtoIntArray + description: String representation of the file content. type: object - EnterpriseCrmEventbusProtoNextTask: - description: >- - The task that is next in line to be executed, if the condition specified - evaluated to true. - id: EnterpriseCrmEventbusProtoNextTask + id: GoogleCloudIntegrationsV1alphaSerializedFile + GoogleCloudConnectorsV1ConnectorVersionInfraConfig: type: object + id: GoogleCloudConnectorsV1ConnectorVersionInfraConfig + description: >- + This cofiguration provides infra configs like rate limit threshold which + need to be configurable for every connector version properties: - taskNumber: + hpaConfig: + $ref: '#/components/schemas/GoogleCloudConnectorsV1HPAConfig' + description: Output only. HPA autoscaling config. + readOnly: true + connectionRatelimitWindowSeconds: + readOnly: true + description: >- + Output only. The window used for ratelimiting runtime requests to + connections. type: string - description: Task number of the next task. - label: - description: User-provided label that is attached to this edge in the UI. + format: int64 + resourceLimits: + readOnly: true + $ref: '#/components/schemas/GoogleCloudConnectorsV1ResourceLimits' + description: Output only. System resource limits. + deploymentModel: + description: Optional. Indicates whether connector is deployed on GKE/CloudRun type: string - taskConfigId: + enum: + - DEPLOYMENT_MODEL_UNSPECIFIED + - GKE_MST + - CLOUD_RUN_MST + enumDescriptions: + - Deployment model is not specified. + - Default model gke mst. + - Cloud run mst. + sharedDeployment: + readOnly: true type: string - description: ID of the next task. - combinedConditions: - type: array - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCombinedCondition' - deprecated: true - 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` - condition: + description: Output only. The name of shared connector deployment. + internalclientRatelimitThreshold: type: string + format: int64 + readOnly: true description: >- - Standard filter expression for this task to become an eligible next - task. - description: + Output only. Max QPS supported for internal requests originating + from Connd. + ratelimitThreshold: + format: int64 type: string + readOnly: true description: >- - User-provided description intended to give more business context - about the next task edge or condition. - EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo: + Output only. Max QPS supported by the connector version before + throttling of requests. + resourceRequests: + description: Output only. System resource requests. + $ref: '#/components/schemas/GoogleCloudConnectorsV1ResourceRequests' + readOnly: true + GoogleCloudConnectorsV1Destination: + type: object properties: - originalExecutionInfoId: + serviceAttachment: type: string + deprecated: true description: >- - If this execution is a replay of another execution, then this field - contains the original execution id. - replayReason: - description: reason for replay + PSC service attachments. Format: + projects/*/regions/*/serviceAttachments/* + host: + description: For publicly routable host. type: string - replayedExecutionInfoIds: + port: description: >- - If this execution has been replayed, then this field contains the - execution ids of the replayed executions. - type: array - items: - type: string - id: EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo - type: object - description: >- - Contains the details of the execution info: this includes the replay - reason and replay tree connecting executions in a parent-child - relationship - GoogleCloudIntegrationsV1alphaStringParameterArray: - description: This message only contains a field of string array. - id: GoogleCloudIntegrationsV1alphaStringParameterArray - type: object - properties: - stringValues: - items: - type: string - type: array - description: String array. - GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse: + The port is the target port number that is accepted by the + destination. + type: integer + format: int32 + id: GoogleCloudConnectorsV1Destination + EnterpriseCrmEventbusProtoToken: + id: EnterpriseCrmEventbusProtoToken type: object - description: Response for ListIntegrationVersions. properties: - noPermission: - type: boolean - description: Whether the user has no permission on the version or not. - integrationVersions: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - description: The integrations which match the request. - 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. - id: GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse - EnterpriseCrmEventbusProtoExecutionTraceInfo: - description: >- - Message that helps aggregate all sub-executions triggered by one - execution and keeps track of child-parent relationships. - id: EnterpriseCrmEventbusProtoExecutionTraceInfo - properties: - traceId: - description: Used to aggregate ExecutionTraceInfo. + value: type: string - parentEventExecutionInfoId: - description: >- - Parent event execution info id that triggers the current execution - through SubWorkflowExecutorTask. + GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest: + id: GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest + properties: + runAsServiceAccount: type: string + description: 'Required. REQUIRED: Run-as service account to be updated' type: object + description: Request for the ReplaceServiceAccount rpc GoogleCloudIntegrationsV1alphaTriggerConfig: + type: object + description: Configuration detail of a trigger. id: GoogleCloudIntegrationsV1alphaTriggerConfig properties: - triggerNumber: - type: string + alertConfig: + type: array description: >- - Required. A number to uniquely identify each trigger config within - the integration on UI. - properties: + 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. + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationAlertConfig + position: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' 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 + Optional. Informs the front-end application where to draw this error + catcher config on the UI. 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 description: Optional. Type of trigger enum: - TRIGGER_TYPE_UNSPECIFIED @@ -7262,51 +7631,63 @@ components: - CLOUD_SCHEDULER - INTEGRATION_CONNECTOR_TRIGGER - PRIVATE_TRIGGER - type: string - position: - description: >- - Optional. Informs the front-end application where to draw this error - catcher config on the UI. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' + 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 triggerId: - type: string description: Optional. The backend trigger ID. - 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 - cloudSchedulerConfig: - description: Optional. Cloud Scheduler Trigger related metadata - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCloudSchedulerConfig - alertConfig: - 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 - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationAlertConfig - description: type: string - description: >- - Optional. User-provided description intended to give additional - business context about the task. trigger: + 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. + description: + description: >- + Optional. User-provided description intended to give additional + business context about the task. type: string - label: + 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 + properties: + additionalProperties: + type: string + type: object + 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. + label: description: Optional. The user created label for a particular trigger. + type: string + nextTasksExecutionPolicy: + enum: + - NEXT_TASKS_EXECUTION_POLICY_UNSPECIFIED + - RUN_ALL_MATCH + - RUN_FIRST_MATCH + 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. + type: string + triggerNumber: + description: >- + Required. A number to uniquely identify each trigger config within + the integration on UI. + type: string startTasks: - type: array items: $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask' description: >- @@ -7315,1303 +7696,1019 @@ components: 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). - nextTasksExecutionPolicy: - enumDescriptions: - - Default. - - Execute all the tasks that satisfy their associated condition. - - Execute the first task that satisfies the associated condition. - description: Optional. Dictates how next tasks will be executed. - type: string - enum: - - NEXT_TASKS_EXECUTION_POLICY_UNSPECIFIED - - RUN_ALL_MATCH - - RUN_FIRST_MATCH - description: Configuration detail of a trigger. - type: object - GoogleCloudConnectorsV1NodeConfig: + type: array + cloudSchedulerConfig: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaCloudSchedulerConfig + description: Optional. Cloud Scheduler Trigger related metadata + EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray: type: object - id: GoogleCloudConnectorsV1NodeConfig - description: Node configuration for the connection. + id: EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray properties: - minNodeCount: - type: integer - description: Minimum number of nodes in the runtime nodes. - format: int32 - maxNodeCount: - type: integer - description: Maximum number of nodes in the runtime nodes. - format: int32 - EnterpriseCrmFrontendsEventbusProtoParameterMap: + doubleValues: + type: array + items: + format: double + type: number + GoogleCloudConnectorsV1ConfigVariable: type: object + id: GoogleCloudConnectorsV1ConfigVariable + description: >- + ConfigVariable represents a configuration variable present in a + Connection. or AuthConfig. + properties: + intValue: + type: string + description: Value is an integer + format: int64 + encryptionKeyValue: + description: Value is a Encryption Key. + $ref: '#/components/schemas/GoogleCloudConnectorsV1EncryptionKey' + stringValue: + type: string + description: Value is a string. + key: + description: Key of the config variable. + type: string + boolValue: + type: boolean + description: Value is a bool. + secretValue: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + description: Value is a secret. + GoogleCloudIntegrationsV1alphaParameterMap: + id: GoogleCloudIntegrationsV1alphaParameterMap description: >- A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. properties: + entries: + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapEntry + type: array + description: A list of parameter map entries. valueType: - 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. - - '' - - '' - - '' + - 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). + 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: - - DATA_TYPE_UNSPECIFIED + - INTEGRATION_PARAMETER_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 + - PROTO_VALUE + - PROTO_ARRAY keyType: - type: string enum: - - DATA_TYPE_UNSPECIFIED + - INTEGRATION_PARAMETER_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: >- - Option to specify key value type for all entries of the map. If - provided then field types for all entries must conform to this. - entries: - type: array - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapEntry - id: EnterpriseCrmFrontendsEventbusProtoParameterMap - EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter: - id: EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter - type: object - properties: - objectValue: - format: byte - type: string - EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats: - properties: - endTime: - description: The end time of the task execution for current attempt. - type: string - format: int64 - 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 - id: EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats - type: object - EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo: - description: >- - Contains all the execution details for a workflow instance. Next - available id: 26 - id: EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo - properties: - workflowName: - description: Name of the workflow. - type: string - createTime: - type: string - description: Auto-generated. - format: int64 - workflowRetryBackoffIntervalSeconds: - description: >- - Time interval in seconds to schedule retry of workflow in manifold - when workflow is already running - format: int64 - type: string - replayInfo: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo - description: Replay info for the execution - cloudLoggingDetails: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudLoggingDetails' - description: Cloud Logging details for execution info - errorCode: - description: Final error-code if event failed. - $ref: '#/components/schemas/CrmlogErrorCode' - eventExecutionDetails: - description: The execution info about this event. - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails - executionTraceInfo: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoExecutionTraceInfo' - description: Execution trace info to aggregate parent-child executions. - responseParams: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - description: Event parameters come out as part of the response. - clientId: - type: string - description: The event data user sends as request. - errors: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoErrorDetail' - description: >- - Errors, warnings, and informationals associated with the - workflow/task. The order in which the errors were added by the - workflow/task is maintained. - type: array - workflowId: - type: string - description: Required. Pointer to the workflow it is executing. - requestParams: - description: Event parameters come in as part of the request. - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - lastModifiedTime: - type: string - format: int64 - description: Auto-generated. - product: - description: >- - Which Google product the execution_info belongs to. If not set, the - execution_info belongs to Integration Platform by default. - type: string - enum: - - UNSPECIFIED_PRODUCT - - IP - - APIGEE - - SECURITY - enumDescriptions: - - '' - - '' - - '' - - '' - eventExecutionInfoId: - type: string - description: Auto-generated primary key. - snapshotNumber: - type: string - description: Workflow snapshot number. - format: int64 - postMethod: - description: The ways user posts this event. - enum: - - UNSPECIFIED - - POST - - POST_TO_QUEUE - - SCHEDULE - - POST_BY_EVENT_CONFIG_ID - - POST_WITH_EVENT_DETAILS - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - type: string - requestId: - description: Optional. This is used to de-dup incoming request. - type: string - 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 - tenant: - description: >- - Tenant this event is created. Used to reschedule the event to - correct tenant. - type: string - type: object - EnterpriseCrmFrontendsEventbusProtoRollbackStrategy: - type: object - description: 'Next available id: 4' - properties: - taskNumbersToRollback: - 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 - type: array - rollbackTaskImplementationClassName: + - PROTO_VALUE + - PROTO_ARRAY type: string description: >- - Required. This is the name of the task that needs to be executed - upon rollback of this task. - parameters: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - description: Optional. The customized parameters the user can pass to this task. - id: EnterpriseCrmFrontendsEventbusProtoRollbackStrategy - GoogleCloudIntegrationsV1alphaBooleanParameterArray: - properties: - booleanValues: - description: Boolean array. - type: array - items: - type: boolean - description: This message only contains a field of boolean array. - type: object - id: GoogleCloudIntegrationsV1alphaBooleanParameterArray - GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest: - properties: {} - id: GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest + Option to specify key type for all entries of the map. If provided + then field types for all entries must conform to this. + 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). type: object - description: Request for TakeoverEditLock. - GoogleCloudIntegrationsV1alphaExecuteEventResponse: - description: The response for executing an integration. - id: GoogleCloudIntegrationsV1alphaExecuteEventResponse + EnterpriseCrmEventbusProtoTaskExecutionDetails: properties: - executionId: - description: The id of the execution corresponding to this run of integration. + 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. + enum: + - UNSPECIFIED + - PENDING_EXECUTION + - IN_PROCESS + - SUCCEED + - FAILED + - FATAL + - RETRY_ON_HOLD + - SKIPPED + - CANCELED + - PENDING_ROLLBACK + - ROLLBACK_IN_PROCESS + - ROLLEDBACK + - SUSPENDED type: string - type: object - GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata: - properties: - entities: + taskNumber: + description: Pointer to the task config it used for execution. + type: string + taskAttemptStats: items: - type: string - type: array - description: List of entity names. - actions: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats type: array - items: - type: string - description: List of actions. - description: Metadata of runtime connection schema. - id: GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata - type: object - EnterpriseCrmFrontendsEventbusProtoParameterMapEntry: - type: object - properties: - value: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapField - key: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapField - id: EnterpriseCrmFrontendsEventbusProtoParameterMapEntry - description: Entry is a pair of key and value. - GoogleCloudIntegrationsV1alphaExecutionReplayInfo: - id: GoogleCloudIntegrationsV1alphaExecutionReplayInfo + id: EnterpriseCrmEventbusProtoTaskExecutionDetails type: object description: >- - Contains the details of the execution info: this includes the replay - reason and replay tree connecting executions in a parent-child - relationship + Contains the details of the execution of this task. Next available id: + 11 + GoogleCloudIntegrationsV1alphaRuntimeEntitySchema: + type: object properties: - replayedExecutionInfoIds: - type: array - description: >- - If this execution has been replayed, then this field contains the - execution ids of the replayed executions. - items: - type: string - replayReason: + arrayFieldSchema: type: string - description: reason for replay - originalExecutionInfoId: + description: The above schema, but for an array of the associated entity. + fieldSchema: + description: List of fields in the entity. type: string - description: >- - If this execution is a replay of another execution, then this field - contains the original execution id. - GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse: - properties: - files: - type: array - description: List containing JSON for multiple file with type information. - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFile' - type: object - description: Response for DownloadJsonPackage. - id: GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse - EnterpriseCrmEventbusProtoDoubleFunction: - id: 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 + entity: type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' + description: Name of the entity. + description: Metadata of an entity, including a schema for its properties. + id: GoogleCloudIntegrationsV1alphaRuntimeEntitySchema + EnterpriseCrmEventbusProtoPropertyEntry: + description: Key-value pair of EventBus property. type: object - GoogleCloudConnectorsV1Connection: properties: - subscriptionType: - type: string - description: >- - Output only. This subscription type enum states the subscription - type of the project. - enum: - - SUBSCRIPTION_TYPE_UNSPECIFIED - - PAY_G - - PAID - enumDescriptions: - - Unspecified subscription type. - - PayG subscription. - - Paid Subscription. - readOnly: true - connectionRevision: + key: type: string - readOnly: true description: >- - Output only. Connection revision. This field is only updated when - the connection is created or updated by User. - format: int64 - destinationConfigs: + 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. + value: description: >- - Optional. Configuration of the Connector's destination. Only - accepted for Connectors that accepts user defined destination(s). - items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' - type: array - billingConfig: - readOnly: true - description: Output only. Billing config for the connection. - $ref: '#/components/schemas/GoogleCloudConnectorsV1BillingConfig' - envoyImageLocation: + Values for the defined keys. Each value can either be string, int, + double or any proto message. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoValueType' + id: EnterpriseCrmEventbusProtoPropertyEntry + GoogleCloudConnectorsV1AuthConfigUserPassword: + id: GoogleCloudConnectorsV1AuthConfigUserPassword + description: Parameters to support Username and Password Authentication. + properties: + username: type: string - readOnly: true - description: >- - Output only. GCR location where the envoy image is stored. formatted - like: gcr.io/{bucketName}/{imageName} - createTime: + description: Username. + password: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + description: Secret version reference containing the password. + type: object + GoogleCloudIntegrationsV1alphaErrorCatcherConfig: + id: GoogleCloudIntegrationsV1alphaErrorCatcherConfig + type: object + description: Configuration detail of a error catch task + properties: + errorCatcherNumber: type: string - description: Output only. Created time. - format: google-datetime - readOnly: true - labels: 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 - type: object + Required. A number to uniquely identify each error catcher config + within the workflow on UI. description: - description: Optional. Description of the resource. type: string - suspended: description: >- - Optional. Suspended indicates if a user has suspended a connection - or not. - type: boolean - status: - readOnly: true - description: Output only. Current status of the connection. - $ref: '#/components/schemas/GoogleCloudConnectorsV1ConnectionStatus' - nodeConfig: - $ref: '#/components/schemas/GoogleCloudConnectorsV1NodeConfig' - description: Optional. Node configuration for the connection. - connectorVersion: + Optional. User-provided description intended to give more business + context about the error catcher config. + startErrorTasks: + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask' 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. + Required. The set of start tasks that are to be executed for the + error catch flow + type: array + label: type: string - lockConfig: - $ref: '#/components/schemas/GoogleCloudConnectorsV1LockConfig' description: >- - Optional. Configuration that indicates whether or not the Connection - can be edited. - connectorVersionInfraConfig: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1ConnectorVersionInfraConfig - description: Output only. Infra configs supported by Connector Version. - isTrustedTester: - description: Output only. Is trusted tester program enabled for the project. - type: boolean - readOnly: true - updateTime: + Optional. The user created label for a particular error catcher. + Optional. + position: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' + description: >- + Optional. Informs the front-end application where to draw this error + catcher config on the UI. + errorCatcherId: + 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 type: string - description: Output only. Updated time. - readOnly: true - format: google-datetime - logConfig: - description: Optional. Log configuration for the connection. - $ref: '#/components/schemas/GoogleCloudConnectorsV1LogConfig' - eventingEnablementType: - enumDescriptions: - - Eventing Enablement Type Unspecifeied. - - Both connection and eventing. - - Only Eventing. + GoogleCloudConnectorsV1SslConfig: + id: GoogleCloudConnectorsV1SslConfig + type: object + description: SSL Configuration of a connection + properties: + type: type: string enum: - - EVENTING_ENABLEMENT_TYPE_UNSPECIFIED - - EVENTING_AND_CONNECTION - - ONLY_EVENTING - description: >- - Optional. Eventing enablement type. Will be nil if eventing is not - enabled. - serviceAccount: + - SSL_TYPE_UNSPECIFIED + - TLS + - MTLS + enumDescriptions: + - No SSL configuration required. + - TLS Handshake + - mutual TLS (MTLS) Handshake + description: Controls the ssl type for the given connector version. + useSsl: + description: Bool for enabling SSL + type: boolean + privateServerCertificate: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' description: >- - Optional. Service account needed for runtime plane to access Google - Cloud resources. + Private Server Certificate. Needs to be specified if trust model is + `PRIVATE`. + clientPrivateKeyPass: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + description: Secret containing the passphrase protecting the Client Private Key + clientCertificate: + description: Client Certificate + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + serverCertType: type: string - authConfig: - description: >- - Optional. Configuration for establishing the connection's - authentication with an external system. - $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' - name: + description: Type of Server Cert (PEM/JKS/.. etc.) + enum: + - CERT_TYPE_UNSPECIFIED + - PEM + enumDescriptions: + - Cert type unspecified. + - Privacy Enhanced Mail (PEM) Type + clientCertType: + enum: + - CERT_TYPE_UNSPECIFIED + - PEM + description: Type of Client Cert (PEM/JKS/.. etc.) + enumDescriptions: + - Cert type unspecified. + - Privacy Enhanced Mail (PEM) Type type: string - description: >- - Output only. Resource name of the Connection. Format: - projects/{project}/locations/{location}/connections/{connection} - readOnly: true - connectorVersionLaunchStage: + trustModel: type: string + description: Trust Model of the SSL connection enumDescriptions: - - LAUNCH_STAGE_UNSPECIFIED. - - PREVIEW. - - GA. - - DEPRECATED. - - PRIVATE_PREVIEW. - readOnly: true - description: Output only. Flag to mark the version indicating the launch stage. + - Public Trust Model. Takes the Default Java trust store. + - Private Trust Model. Takes custom/private trust store. + - Insecure Trust Model. Accept all certificates. enum: - - LAUNCH_STAGE_UNSPECIFIED - - PREVIEW - - GA - - DEPRECATED - - PRIVATE_PREVIEW - imageLocation: + - PUBLIC + - PRIVATE + - INSECURE + additionalVariables: + description: Additional SSL related field values + items: + $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' + type: array + clientPrivateKey: + description: Client Private Key + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + GoogleCloudConnectorsV1AuthConfig: + properties: + oauth2ClientCredentials: + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials + description: Oauth2ClientCredentials. + sshPublicKey: + $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfigSshPublicKey' + description: SSH Public Key. + oauth2JwtBearer: + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer + description: Oauth2JwtBearer. + authType: + 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 + type: string + 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 + userPassword: + description: UserPassword. + $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfigUserPassword' + additionalVariables: + items: + $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' + description: List containing additional auth configs. + type: array + oauth2AuthCodeFlow: + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow + description: Oauth2AuthCodeFlow. + authKey: + type: string + description: Identifier key for auth config + type: object + id: GoogleCloudConnectorsV1AuthConfig + description: AuthConfig defines details of a authentication type. + 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 + type: object + properties: + value: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' description: >- - Output only. GCR location where the runtime image is stored. - formatted like: gcr.io/{bucketName}/{imageName} - readOnly: true + Values for the defined keys. Each value can either be string, int, + double or any proto message. + masked: + type: boolean + description: True if this parameter should be masked in the logs + 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. + id: GoogleCloudIntegrationsV1alphaEventParameter + GoogleCloudIntegrationsV1alphaListIntegrationsResponse: + description: Response for ListIntegrations. + id: GoogleCloudIntegrationsV1alphaListIntegrationsResponse + type: object + properties: + nextPageToken: type: string - eventingConfig: - $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingConfig' - description: Optional. Eventing config of a connection - sslConfig: - description: Optional. Ssl config of a connection - $ref: '#/components/schemas/GoogleCloudConnectorsV1SslConfig' - configVariables: + description: The next page token for the response. + integrations: + description: The integrations which match the request. type: array items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' - description: >- - Optional. Configuration for configuring the connection with an - external system. - serviceDirectory: - 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 + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaIntegration' + GoogleCloudConnectorsV1EventingConfigDeadLetterConfig: + properties: + projectId: + type: string + description: Optional. Project which has the topic given. + topic: + description: Optional. Topic to push events which couldn't be processed. type: string - eventingRuntimeData: - description: Output only. Eventing Runtime Data. - $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingRuntimeData' - readOnly: true - id: GoogleCloudConnectorsV1Connection type: object - description: Connection represents an instance of connector. - GoogleCloudIntegrationsV1alphaTestIntegrationsRequest: - description: The request for testing an integration. - id: GoogleCloudIntegrationsV1alphaTestIntegrationsRequest + id: GoogleCloudConnectorsV1EventingConfigDeadLetterConfig + description: Dead Letter configuration details provided by the user. + GoogleCloudConnectorsV1EncryptionKey: type: object properties: - configParameters: - description: Optional. Config parameters used during integration execution. - additionalProperties: - type: any - description: Properties of the object. - type: object - parameters: - deprecated: true - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - description: Optional. Passed in as parameters to each integration execution. - integrationVersion: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - description: Required. integration config to execute the workflow - triggerId: + type: + description: Type. + enum: + - TYPE_UNSPECIFIED + - GOOGLE_MANAGED + - CUSTOMER_MANAGED 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. - clientId: - description: >- - Required. This is used to identify the client on whose behalf the - event will be executed. + enumDescriptions: + - Value type is not specified. + - Google Managed. + - Customer Managed. + kmsKeyName: type: string - testMode: - 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}. - deadlineSecondsTime: - format: google-datetime - type: string - description: Optional. custom deadline of the rpc - inputParameters: - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - description: Optional. Input parameters used during integration execution. - type: object - GoogleCloudIntegrationsV1alphaConditionalFailurePolicies: - description: Conditional task failur retry strategies - id: GoogleCloudIntegrationsV1alphaConditionalFailurePolicies + 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. + id: GoogleCloudConnectorsV1EncryptionKey + description: Encryption Key value. + GoogleCloudIntegrationsV1alphaValueType: + description: The type of the parameter. type: object + id: GoogleCloudIntegrationsV1alphaValueType properties: - defaultFailurePolicy: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' - description: >- - The default failure policy to be applied if no conditional failure - policy matches. - failurePolicies: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' - description: >- - The list of failure policies that will be applied to the task in - order. - type: array - GoogleCloudIntegrationsV1alphaCancelExecutionRequest: - description: Request for cancelling an execution. - properties: {} - id: GoogleCloudIntegrationsV1alphaCancelExecutionRequest + doubleValue: + type: number + description: Double Number. + format: double + booleanValue: + type: boolean + description: Boolean. + stringArray: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaStringParameterArray + description: String Array. + intValue: + description: Integer. + format: int64 + type: string + doubleArray: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaDoubleParameterArray + description: Double Number Array. + intArray: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaIntParameterArray' + description: Integer Array. + jsonValue: + description: Json. + type: string + stringValue: + type: string + description: String. + booleanArray: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaBooleanParameterArray + description: Boolean Array. + GoogleCloudIntegrationsV1alphaStringParameterArray: type: object - GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse: + description: This message only contains a field of string array. properties: - nextPageToken: - type: string - description: Next page token. - runtimeActionSchemas: - description: Runtime action schemas. + stringValues: items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaRuntimeActionSchema + type: string type: array - description: Response for listing RuntimeActionSchemas for a specific Connection. - id: GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse - type: object - EnterpriseCrmEventbusProtoTaskMetadataAdmin: - type: object - id: EnterpriseCrmEventbusProtoTaskMetadataAdmin + description: String array. + id: GoogleCloudIntegrationsV1alphaStringParameterArray + GoogleCloudIntegrationsV1alphaExecutionReplayInfo: properties: - googleGroupEmail: + originalExecutionInfoId: + description: >- + If this execution is a replay of another execution, then this field + contains the original execution id. type: string - userEmail: + replayReason: + description: reason for replay type: string + replayedExecutionInfoIds: + type: array + description: >- + If this execution has been replayed, then this field contains the + execution ids of the replayed executions. + items: + type: string + id: GoogleCloudIntegrationsV1alphaExecutionReplayInfo 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. - GoogleCloudIntegrationsV1alphaDeprovisionClientRequest: - properties: {} - description: Request for the Deprovision rpc + Contains the details of the execution info: this includes the replay + reason and replay tree connecting executions in a parent-child + relationship type: object - id: GoogleCloudIntegrationsV1alphaDeprovisionClientRequest - GoogleCloudIntegrationsV1alphaProvisionClientRequest: + GoogleCloudConnectorsV1Connection: type: object - description: Request for the Provision rpc + description: Connection represents an instance of connector. properties: - 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 - cloudKmsConfig: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' - description: >- - Optional. OPTIONAL: Cloud KMS config for AuthModule to - encrypt/decrypt credentials. - createSampleWorkflows: + destinationConfigs: + type: array description: >- - Optional. Indicates if sample workflow should be created along with - provisioning + Optional. Configuration of the Connector's destination. Only + accepted for Connectors that accepts user defined destination(s). + items: + $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' + isTrustedTester: + readOnly: true type: boolean - provisionGmek: + description: Output only. Is trusted tester program enabled for the project. + envoyImageLocation: + type: string 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. - type: boolean - deprecated: true - id: GoogleCloudIntegrationsV1alphaProvisionClientRequest - GoogleCloudIntegrationsV1alphaListCertificatesResponse: - type: object - description: Response to list Certificates. - properties: - nextPageToken: + Output only. GCR location where the envoy image is stored. formatted + like: gcr.io/{bucketName}/{imageName} + readOnly: true + eventingConfig: + $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingConfig' + description: Optional. Eventing config of a connection + billingConfig: + $ref: '#/components/schemas/GoogleCloudConnectorsV1BillingConfig' + readOnly: true + description: Output only. Billing config for the connection. + suspended: + type: boolean + description: >- + Optional. Suspended indicates if a user has suspended a connection + or not. + connectorVersion: type: string - description: The token used to retrieve the next page of results. - certificates: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' - description: The list of Certificates retrieved. - type: array - id: GoogleCloudIntegrationsV1alphaListCertificatesResponse - EnterpriseCrmEventbusProtoConditionalFailurePolicies: - id: EnterpriseCrmEventbusProtoConditionalFailurePolicies - properties: - defaultFailurePolicy: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' description: >- - The default failure policy to be applied if no conditional failure - policy matches - failurePolicies: + 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. + updateTime: + readOnly: true + description: Output only. Updated time. + type: string + format: google-datetime + description: + type: string + description: Optional. Description of the resource. + labels: + additionalProperties: + type: string + 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 + type: object + status: + readOnly: true + $ref: '#/components/schemas/GoogleCloudConnectorsV1ConnectionStatus' + description: Output only. Current status of the connection. + configVariables: type: array description: >- - The list of failure policies that will be applied to the task in - order. - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' - type: object - GoogleCloudConnectorsV1SslConfig: - properties: - clientPrivateKey: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - description: Client Private Key - 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: - description: Additional SSL related field values + Optional. Configuration for configuring the connection with an + external system. items: $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' - type: array - clientPrivateKeyPass: - description: Secret containing the passphrase protecting the Client Private Key - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - serverCertType: - type: string - description: Type of Server Cert (PEM/JKS/.. etc.) - enum: - - CERT_TYPE_UNSPECIFIED - - PEM - enumDescriptions: - - Cert type unspecified. - - Privacy Enhanced Mail (PEM) Type - clientCertType: - enum: - - CERT_TYPE_UNSPECIFIED - - PEM - description: Type of Client Cert (PEM/JKS/.. etc.) + authConfig: + description: >- + Optional. Configuration for establishing the connection's + authentication with an external system. + $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' + lockConfig: + $ref: '#/components/schemas/GoogleCloudConnectorsV1LockConfig' + description: >- + Optional. Configuration that indicates whether or not the Connection + can be edited. + logConfig: + description: Optional. Log configuration for the connection. + $ref: '#/components/schemas/GoogleCloudConnectorsV1LogConfig' + createTime: + format: google-datetime type: string + readOnly: true + description: Output only. Created time. + subscriptionType: enumDescriptions: - - Cert type unspecified. - - Privacy Enhanced Mail (PEM) Type - privateServerCertificate: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + - Unspecified subscription type. + - PayG subscription. + - Paid Subscription. description: >- - Private Server Certificate. Needs to be specified if trust model is - `PRIVATE`. - clientCertificate: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - description: Client Certificate - type: - enumDescriptions: - - No SSL configuration required. - - TLS Handshake - - mutual TLS (MTLS) Handshake - description: Controls the ssl type for the given connector version. + Output only. This subscription type enum states the subscription + type of the project. enum: - - SSL_TYPE_UNSPECIFIED - - TLS - - MTLS + - SUBSCRIPTION_TYPE_UNSPECIFIED + - PAY_G + - PAID type: string - useSsl: - type: boolean - description: Bool for enabling SSL - type: object - description: SSL Configuration of a connection - id: GoogleCloudConnectorsV1SslConfig - EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray: - type: object - id: EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray - properties: - booleanValues: - items: - type: boolean - type: array - EnterpriseCrmEventbusProtoLogSettings: - id: EnterpriseCrmEventbusProtoLogSettings - properties: - seedPeriod: + readOnly: true + connectorVersionLaunchStage: enum: - - SEED_PERIOD_UNSPECIFIED - - DAY - - WEEK - - MONTH + - LAUNCH_STAGE_UNSPECIFIED + - PREVIEW + - GA + - DEPRECATED + - PRIVATE_PREVIEW 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. + - LAUNCH_STAGE_UNSPECIFIED. + - PREVIEW. + - GA. + - DEPRECATED. + - PRIVATE_PREVIEW. + type: string + description: Output only. Flag to mark the version indicating the launch stage. + readOnly: true + sslConfig: + $ref: '#/components/schemas/GoogleCloudConnectorsV1SslConfig' + description: Optional. Ssl config of a connection + serviceDirectory: + readOnly: true type: string - shorteningLimits: description: >- - Contains the field limits for shortening, such as max string length - and max array length. - $ref: '#/components/schemas/EnterpriseCrmLoggingGwsFieldLimits' - seedScope: - enum: - - SEED_SCOPE_UNSPECIFIED - - EVENT_NAME - - TIME_PERIOD - - PARAM_NAME + 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" + nodeConfig: + description: Optional. Node configuration for the connection. + $ref: '#/components/schemas/GoogleCloudConnectorsV1NodeConfig' + eventingRuntimeData: + $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingRuntimeData' + readOnly: true + description: Output only. Eventing Runtime Data. + eventingEnablementType: enumDescriptions: - - '' - - Hash computations include the event name. - - Hash computations include a time period. - - Hash computations include the param name. - type: string - logFieldName: + - Eventing Enablement Type Unspecifeied. + - Both connection and eventing. + - Only Eventing. type: string + enum: + - EVENTING_ENABLEMENT_TYPE_UNSPECIFIED + - EVENTING_AND_CONNECTION + - ONLY_EVENTING description: >- - The name of corresponding logging field of the event property. If - omitted, assumes the same name as the event property key. - sanitizeOptions: - $ref: '#/components/schemas/EnterpriseCrmLoggingGwsSanitizeOptions' + Optional. Eventing enablement type. Will be nil if eventing is not + enabled. + serviceAccount: description: >- - Contains the scrubbing options, such as whether to scrub, obfuscate, - etc. - 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 - GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse: - description: Response for CreateAppsScriptProject rpc call. - properties: - projectId: - type: string - description: The created AppsScriptProject ID. - type: object - id: GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse - GoogleCloudIntegrationsV1alphaSuspensionAudit: - id: GoogleCloudIntegrationsV1alphaSuspensionAudit - properties: - resolver: - type: string - description: Email address of the person who resolved this suspension. - resolveTime: - description: Time at which this suspension was resolved. - format: google-datetime - type: string - description: Contains when and by whom the suspension was resolved. - type: object - GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest: - type: object - id: GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest - properties: - projectId: + Optional. Service account needed for runtime plane to access Google + Cloud resources. + type: string + connectorVersionInfraConfig: + description: Output only. Infra configs supported by Connector Version. + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1ConnectorVersionInfraConfig + readOnly: true + imageLocation: description: >- - Indicates the id of the GCP project that the function will be - created in. + Output only. GCR location where the runtime image is stored. + formatted like: gcr.io/{bucketName}/{imageName} type: string - functionName: + readOnly: true + connectionRevision: type: string - description: The function name of CF to be created - functionRegion: - description: The function region of CF to be created + format: int64 + readOnly: true + description: >- + Output only. Connection revision. This field is only updated when + the connection is created or updated by User. + name: + description: >- + Output only. Resource name of the Connection. Format: + projects/{project}/locations/{location}/connections/{connection} type: string - description: Request for Creating Cloud Function rpc call. - EnterpriseCrmEventbusProtoCombinedCondition: - description: >- - This message recursively combines constituent conditions using logical - AND. - deprecated: true - type: object - properties: - conditions: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCondition' - type: array - description: A set of individual constituent conditions. - id: EnterpriseCrmEventbusProtoCombinedCondition - EnterpriseCrmEventbusProtoSuspensionAuthPermissions: - description: LINT.IfChange + readOnly: true + id: GoogleCloudConnectorsV1Connection + EnterpriseCrmEventbusProtoParameterMapField: properties: - gaiaIdentity: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity - description: Represents a Gaia identity for a person or service account. - mdbGroup: - type: string - googleGroup: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity - loasRole: + referenceKey: type: string + description: Referencing one of the WF variables. + literalValue: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' + description: Passing a literal value. + description: Field represents either the key or value in an entry. + id: EnterpriseCrmEventbusProtoParameterMapField type: object - id: EnterpriseCrmEventbusProtoSuspensionAuthPermissions - EnterpriseCrmEventbusStats: - properties: - dimensions: - description: Dimensions that these stats have been aggregated on. - $ref: '#/components/schemas/EnterpriseCrmEventbusStatsDimensions' - errorRate: - type: number - format: double - description: Average error rate. - qps: - format: double - description: Queries per second. - type: number - warningRate: - format: double - description: Average warning rate. - type: number - durationInSeconds: - format: double - type: number - description: Average duration in seconds. - description: >- - Stats for the requested dimensions: QPS, duration, and error/warning - rate - id: EnterpriseCrmEventbusStats + GoogleCloudIntegrationsV1alphaTestIntegrationsRequest: type: object - EnterpriseCrmEventbusProtoPropertyEntry: - description: Key-value pair of EventBus property. - id: EnterpriseCrmEventbusProtoPropertyEntry + description: The request for testing an integration. properties: - key: - type: string + parameters: + deprecated: true + description: Optional. Passed in as parameters to each integration execution. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + triggerId: 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. - value: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoValueType' + 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. + type: string + configParameters: + type: object + additionalProperties: + type: any + description: Properties of the object. + description: Optional. Config parameters used during integration execution. + clientId: description: >- - Values for the defined keys. Each value can either be string, int, - double or any proto message. - type: object - EnterpriseCrmEventbusProtoProtoFunction: - id: EnterpriseCrmEventbusProtoProtoFunction - type: object - properties: - functionName: + Required. This is used to identify the client on whose behalf the + event will be executed. type: string - 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 - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - EnterpriseCrmEventbusProtoFunctionType: - id: EnterpriseCrmEventbusProtoFunctionType - properties: - booleanFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBooleanFunction' - stringArrayFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringArrayFunction' - doubleArrayFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleArrayFunction' - intFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntFunction' - protoArrayFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoArrayFunction' - doubleFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleFunction' - stringFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringFunction' - protoFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoFunction' - booleanArrayFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBooleanArrayFunction' - jsonFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoJsonFunction' + deadlineSecondsTime: + type: string + format: google-datetime + description: Optional. custom deadline of the rpc + testMode: description: >- - LINT.ThenChange(//depot/google3/alkali/apps/integrationplatform/client/workflow_editor/utils/transform_function.ts) - intArrayFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntArrayFunction' - baseFunction: - description: LINT.IfChange - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBaseFunction' - type: object - GoogleCloudIntegrationsV1alphaExecution: - description: >- - The Execution resource contains detailed information of an individual - integration execution. - properties: - requestParameters: - description: Event parameters come in as part of the request. + 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}. + type: boolean + inputParameters: additionalProperties: $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + description: Optional. Input parameters used during integration execution. type: object - name: - type: string - description: Auto-generated primary key. - integrationVersionState: + integrationVersion: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + description: Required. integration config to execute the workflow + id: GoogleCloudIntegrationsV1alphaTestIntegrationsRequest + EnterpriseCrmEventbusAuthconfigAuthConfigTaskParam: + 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. + type: array + items: + 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: + - '' + - 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 + scope: + description: A space-delimited list of requested scope permissions. type: string - readOnly: true - description: Output only. State of the integration version - enumDescriptions: - - Default. - - Draft. - - Active. - - Archived. - - Snapshot. - enum: - - INTEGRATION_STATE_UNSPECIFIED - - DRAFT - - ACTIVE - - ARCHIVED - - SNAPSHOT - snapshotNumber: - description: >- - Output only. An increasing sequence that is set when a new snapshot - is created - readOnly: true + useServiceAccountInContext: + type: boolean + allowedServiceAccountInContext: + type: boolean + authConfigId: + description: UUID of the AuthConfig. type: string - format: int64 - executionDetails: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecutionDetails' - description: Detailed info of this execution. - responseParameters: - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - description: Event parameters returned as part of the response. - type: object - replayInfo: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionReplayInfo - description: Output only. Replay info for the execution - readOnly: true - responseParams: - description: Event parameters come out as part of the response. - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + id: EnterpriseCrmEventbusAuthconfigAuthConfigTaskParam + type: object + EnterpriseCrmEventbusProtoIntParameterArray: + properties: + intValues: type: array - deprecated: true - requestParams: items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + format: int64 + type: string + type: object + id: EnterpriseCrmEventbusProtoIntParameterArray + GoogleCloudIntegrationsV1alphaDeprovisionClientRequest: + type: object + properties: {} + id: GoogleCloudIntegrationsV1alphaDeprovisionClientRequest + description: Request for the Deprovision rpc + GoogleCloudIntegrationsV1alphaBooleanParameterArray: + type: object + properties: + booleanValues: + items: + type: boolean type: array - description: Event parameters come in as part of the request. - deprecated: true - cloudLoggingDetails: - description: Cloud Logging details for the integration version + description: Boolean array. + description: This message only contains a field of boolean array. + id: GoogleCloudIntegrationsV1alphaBooleanParameterArray + EnterpriseCrmFrontendsEventbusProtoParameterMapEntry: + id: EnterpriseCrmFrontendsEventbusProtoParameterMapEntry + properties: + key: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCloudLoggingDetails - eventExecutionDetails: - description: The execution info about this event. - deprecated: true - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetails' - updateTime: - format: google-datetime - readOnly: true - type: string - description: Output only. Last modified time of the execution. - triggerId: + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapField + value: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapField + type: object + description: Entry is a pair of key and value. + GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims: + properties: + subject: type: string - 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. - executionMethod: - enum: - - EXECUTION_METHOD_UNSPECIFIED - - POST - - POST_TO_QUEUE - - SCHEDULE + description: Value for the "sub" claim. + issuer: + description: Value for the "iss" claim. type: string - enumDescriptions: - - Default value. - - Sync post. - - Async post. - - Async post with schedule time. - description: The ways user posts this event. - createTime: + audience: type: string - format: google-datetime - description: Output only. Created time of the execution. - readOnly: true - directSubExecutions: - description: Direct sub executions of the following Execution. - type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' - id: GoogleCloudIntegrationsV1alphaExecution + description: Value for the "aud" claim. + id: GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims type: object - EnterpriseCrmEventbusProtoValueType: + description: JWT claims used for the jwt-bearer authorization grant. + EnterpriseCrmFrontendsEventbusProtoProtoParameterArray: + id: EnterpriseCrmFrontendsEventbusProtoProtoParameterArray type: object - description: >- - Used for define type for values. Currently supported value types include - int, string, double, array, and any proto message. properties: - doubleArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleArray' - doubleValue: - format: double - type: number - intArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntArray' - booleanValue: + protoValues: + type: array + items: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + GoogleCloudIntegrationsV1alphaCancelExecutionResponse: + properties: + isCanceled: type: boolean - protoValue: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - stringArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringArray' - intValue: - type: string - format: int64 - stringValue: - type: string - id: EnterpriseCrmEventbusProtoValueType - GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig: + description: True if cancellation performed successfully type: object - id: GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig + id: GoogleCloudIntegrationsV1alphaCancelExecutionResponse + description: Response for cancelling an execution. + EnterpriseCrmEventbusProtoFailurePolicy: properties: - expiration: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration + maxNumRetries: + format: int32 + type: integer description: >- - Indicates the next steps when no external actions happen on the - suspension. - customMessage: - description: Information to provide for recipients. + 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: + format: int64 + description: >- + Required if retry_strategy is FIXED_INTERVAL or + LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines + the initial interval for backoff. type: string - emailAddresses: - description: Email addresses to send approval request to. - type: array - items: - type: string - description: Configurations for approving the Suspension. - EnterpriseCrmEventbusProtoParameterMapField: - id: EnterpriseCrmEventbusProtoParameterMapField + retryStrategy: + 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. + - >- + 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 + type: string + description: Defines what happens to the task upon failure. + retryCondition: + type: string + description: >- + Optional. The retry condition that will be evaluated for this + failure policy with the corresponding retry strategy. + 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 - description: Field represents either the key or value in an entry. + EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo: properties: - literalValue: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' - description: Passing a literal value. - referenceKey: + requestParams: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + description: Event parameters come in as part of the request. + triggerId: type: string - description: Referencing one of the WF variables. - EnterpriseCrmFrontendsEventbusProtoParameterValueType: - id: EnterpriseCrmFrontendsEventbusProtoParameterValueType - properties: - jsonValue: + 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. + workflowRetryBackoffIntervalSeconds: + format: int64 + description: >- + Time interval in seconds to schedule retry of workflow in manifold + when workflow is already running type: string - stringValue: + workflowId: + description: Required. Pointer to the workflow it is executing. type: string - serializedObjectValue: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter - protoValue: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - stringArray: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoStringParameterArray - intValue: + lastModifiedTime: format: int64 type: string - protoArray: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoProtoParameterArray - booleanValue: - type: boolean - doubleValue: - type: number - format: double - intArray: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoIntParameterArray - booleanArray: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray - doubleArray: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray - description: 'To support various types of parameter values. Next available id: 14' - type: object - EnterpriseCrmFrontendsEventbusProtoProtoParameterArray: - id: EnterpriseCrmFrontendsEventbusProtoProtoParameterArray - properties: - protoValues: - type: array - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - type: object - EnterpriseCrmFrontendsEventbusProtoTriggerConfig: - type: object - description: 'Configuration detail of a trigger. Next available id: 20' - properties: - startTasks: + description: Auto-generated. + errors: items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNextTask' + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoErrorDetail' 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). + Errors, warnings, and informationals associated with the + workflow/task. The order in which the errors were added by the + workflow/task is maintained. type: array - triggerType: + eventExecutionInfoId: + type: string + description: Auto-generated primary key. + errorCode: + description: Final error-code if event failed. + $ref: '#/components/schemas/CrmlogErrorCode' + executionTraceInfo: + description: Execution trace info to aggregate parent-child executions. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoExecutionTraceInfo' + snapshotNumber: + format: int64 + description: Workflow snapshot number. + type: string + eventExecutionDetails: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails + description: The execution info about this event. + clientId: + description: The event data user sends as request. + type: string + cloudLoggingDetails: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudLoggingDetails' + description: Cloud Logging details for execution info + postMethod: 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 + - UNSPECIFIED + - POST + - POST_TO_QUEUE + - SCHEDULE + - POST_BY_EVENT_CONFIG_ID + - POST_WITH_EVENT_DETAILS + description: The ways user posts this event. enumDescriptions: - '' - '' @@ -8619,324 +8716,206 @@ components: - '' - '' - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - type: string - errorCatcherId: - type: string - description: >- - Optional Error catcher id of the error catch flow which will be - executed when execution error happens in the task - properties: - type: object - 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 - position: - description: >- - Optional. Informs the front-end application where to draw this - trigger config on the UI. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCoordinate' - 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. - triggerName: - 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. - type: string - triggerNumber: type: string + tenant: description: >- - Required. A number to uniquely identify each trigger config within - the workflow on UI. - label: + Tenant this event is created. Used to reschedule the event to + correct tenant. type: string - description: The user created label for a particular trigger. - triggerId: - description: The backend trigger ID. + requestId: type: string - enabledClients: - type: array - items: - type: string - 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. - nextTasksExecutionPolicy: + description: Optional. This is used to de-dup incoming request. + responseParams: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + description: Event parameters come out as part of the response. + product: type: string - description: Dictates how next tasks will be executed. enum: - - UNSPECIFIED - - RUN_ALL_MATCH - - RUN_FIRST_MATCH + - UNSPECIFIED_PRODUCT + - IP + - APIGEE + - SECURITY enumDescriptions: - - Default - - Execute all the tasks that satisfy their associated condition. - - Execute the first task that satisfies the associated condition. - cloudSchedulerConfig: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudSchedulerConfig' - 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 - alertConfig: - type: array - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoWorkflowAlertConfig' + - '' + - '' + - '' + - '' 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. - description: + Which Google product the execution_info belongs to. If not set, the + execution_info belongs to Integration Platform by default. + workflowName: + description: Name of the workflow. type: string - description: >- - User-provided description intended to give more business context - about the task. - id: EnterpriseCrmFrontendsEventbusProtoTriggerConfig - GoogleCloudIntegrationsV1alphaNextTask: + replayInfo: + description: Replay info for the execution + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo + createTime: + description: Auto-generated. + type: string + format: int64 + id: EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo + type: object description: >- - The task that is next in line to be executed, if the condition specified - evaluated to true. + Contains all the execution details for a workflow instance. Next + available id: 26 + GoogleCloudIntegrationsV1alphaAccessToken: + id: GoogleCloudIntegrationsV1alphaAccessToken + type: object + description: >- + The access token represents the authorization of a specific application + to access specific parts of a user’s data. properties: - condition: + refreshTokenExpireTime: + format: google-datetime type: string + description: The approximate time until the refresh token retrieved is valid. + refreshToken: description: >- - Standard filter expression for this task to become an eligible next - task. - displayName: - description: User-provided label that is attached to this edge in the UI. + If the access token will expire, use the refresh token to obtain + another access token. type: string - taskConfigId: + accessTokenExpireTime: + description: >- + Required. The approximate time until the access token retrieved is + valid. type: string - description: ID of the next task. - taskId: - description: Task number of the next task. + format: google-datetime + tokenType: type: string - description: description: >- - User-provided description intended to give additional business - context about the task. + Only support "bearer" token in v1 as bearer token is the predominant + type used with OAuth 2.0. + accessToken: type: string + description: >- + The access token encapsulating the security identity of a process or + thread. + GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse: + id: GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse + properties: + integrationVersion: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + description: The uploaded integration. + description: Response for UploadIntegrationVersion. type: object - id: GoogleCloudIntegrationsV1alphaNextTask - EnterpriseCrmFrontendsEventbusProtoParameterMapField: + EnterpriseCrmEventbusProtoExecutionTraceInfo: type: object properties: - referenceKey: + parentEventExecutionInfoId: + description: >- + Parent event execution info id that triggers the current execution + through SubWorkflowExecutorTask. type: string - description: Referencing one of the WF variables. - literalValue: - description: Passing a literal value. - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType - id: EnterpriseCrmFrontendsEventbusProtoParameterMapField - description: Field represents either the key or value in an entry. - EnterpriseCrmEventbusProtoTaskExecutionDetails: + traceId: + type: string + description: Used to aggregate ExecutionTraceInfo. + id: EnterpriseCrmEventbusProtoExecutionTraceInfo description: >- - Contains the details of the execution of this task. Next available id: - 11 + Message that helps aggregate all sub-executions triggered by one + execution and keeps track of child-parent relationships. + EnterpriseCrmEventbusProtoEventExecutionDetails: properties: - taskNumber: - description: Pointer to the task config it used for execution. + eventRetriesFromBeginningCount: + type: integer + format: int32 + description: >- + Indicates the number of times the execution has restarted from the + beginning. + eventExecutionSnapshot: + items: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshot + type: array + nextExecutionTime: + description: >- + Next scheduled execution time in case the execution status was + RETRY_ON_HOLD. + format: int64 type: string - taskExecutionState: + eventExecutionState: enum: - UNSPECIFIED - - PENDING_EXECUTION + - ON_HOLD - IN_PROCESS - - SUCCEED + - SUCCEEDED - FAILED - - FATAL - - RETRY_ON_HOLD - - SKIPPED - CANCELED - - PENDING_ROLLBACK - - ROLLBACK_IN_PROCESS - - ROLLEDBACK + - RETRY_ON_HOLD - SUSPENDED - type: string 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. + Event is received and waiting for the execution. This happens when + firing the event via "postToQueue" or "schedule". + - Event is under processing. - >- - Task is rolled back. This is the state we will set regardless of - rollback succeeding or failing. + Event execution successfully finished. There's no more change + after this state. + - Event execution failed. There's no more change after this state. - >- - Task is a SuspensionTask which has executed once, creating a - pending suspension. - taskAttemptStats: - type: array - items: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats - id: EnterpriseCrmEventbusProtoTaskExecutionDetails - type: object - GoogleCloudIntegrationsV1alphaCloudLoggingDetails: - type: object - properties: - cloudLoggingSeverity: - enum: - - CLOUD_LOGGING_SEVERITY_UNSPECIFIED - - INFO - - ERROR - - WARNING + 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 + ryeLockUnheldCount: + format: int32 + type: integer description: >- - Optional. Severity selected by the customer for the logs to be sent - to Cloud Logging, for the integration version getting executed. - 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. - enableCloudLogging: - type: boolean - description: >- - Optional. Status of whether Cloud Logging is enabled or not for the - integration version getting executed. - description: Cloud Logging details for execution info - id: GoogleCloudIntegrationsV1alphaCloudLoggingDetails - EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList: - properties: - filterType: - enum: - - DEFAULT_INCLUSIVE - - EXCLUSIVE - type: string - enumDescriptions: - - '' - - '' - enumStrings: + 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: items: - type: string + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats type: array - id: EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList - description: List of error enums for alerts. - type: object - GoogleCloudIntegrationsV1alphaOidcToken: - type: object - description: OIDC Token - properties: - token: - type: string - description: ID token obtained for the service account - tokenExpireTime: - description: The approximate time until the token retrieved is valid. - type: string - format: google-datetime - serviceAccountEmail: - type: string - description: The service account email to be used as the identity for the token. - audience: - type: string - description: >- - Audience to be used when generating OIDC token. The audience claim - identifies the recipients that the JWT is intended for. - id: GoogleCloudIntegrationsV1alphaOidcToken - GoogleCloudIntegrationsV1alphaCancelExecutionResponse: - properties: - isCanceled: - description: True if cancellation performed successfully - type: boolean - type: object - description: Response for cancelling an execution. - id: GoogleCloudIntegrationsV1alphaCancelExecutionResponse - EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange: - description: Range used to validate longs and ints. - type: object - properties: - max: - description: The inclusive maximum of the acceptable range. + eventExecutionSnapshotsSize: + description: Total size of all event_execution_snapshots for an execution format: int64 type: string - min: - description: The inclusive minimum of the acceptable range. + networkAddress: type: string - format: int64 - id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange + description: >- + The network address (aka. bns address) that indicates where the + event executor is running. + logFilePath: + description: The log file path (aka. cns address) for this event. + type: string + 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: 11 + id: EnterpriseCrmEventbusProtoEventExecutionDetails + type: object + EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray: + id: EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray + type: object + properties: + booleanValues: + items: + type: boolean + type: array + EnterpriseCrmEventbusProtoTransformExpression: + 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. + type: object + id: EnterpriseCrmEventbusProtoTransformExpression 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' - 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"). + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: upload_protocol + name: uploadType schema: type: string alt: @@ -8949,18 +8928,24 @@ components: - json - media - proto - 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 + 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 in: query @@ -8976,6 +8961,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 + 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 @@ -8985,21 +8982,24 @@ components: name: key schema: type: string - access_token: - description: OAuth access token. + _.xgafv: + description: V1 error format. in: query - name: access_token + name: $.xgafv schema: type: string + enum: + - '1' + - '2' x-stackQL-resources: - callback: - id: integrations.callback - name: callback - title: Callback + connector_platform_regions: + id: google.integrations.connector_platform_regions + name: connector_platform_regions + title: Connector_platform_regions methods: - callback_generate_token: + connector_platform_regions_enumerate: operation: - $ref: '#/paths/~1v1~1callback:generateToken/get' + $ref: '#/paths/~1v1~1connectorPlatformRegions:enumerate/get' response: mediaType: application/json openAPIDocKey: '200' @@ -9008,135 +9008,203 @@ components: insert: [] update: [] delete: [] - clientmetadata: - id: integrations.clientmetadata - name: clientmetadata - title: Clientmetadata + callback: + id: google.integrations.callback + name: callback + title: Callback methods: - projects_get_clientmetadata: + callback_generate_token: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1clientmetadata/get' + $ref: '#/paths/~1v1~1callback:generateToken/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/clientmetadata/methods/projects_get_clientmetadata + select: [] insert: [] update: [] delete: [] - connections_connection_schema_metadata: - id: integrations.connections_connection_schema_metadata - name: connections_connection_schema_metadata - title: Connections_connection_schema_metadata + clients: + id: google.integrations.clients + name: clients + title: Clients methods: - projects_locations_connections_get_connection_schema_metadata: + projects_locations_get_clients: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1connectionSchemaMetadata/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_clients_replace: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:replace/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_clients_deprovision: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:deprovision/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_clients_switch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:switch/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_clients_provision: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:provision/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_clients_switch_variable_masking: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:switchVariableMasking/post 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 + #/components/x-stackQL-resources/clients/methods/projects_locations_get_clients insert: [] update: [] delete: [] - connections: - id: integrations.connections - name: connections - title: Connections + integrations: + id: google.integrations.integrations + name: integrations + title: Integrations methods: - _projects_locations_connections_list: + projects_locations_integrations_schedule: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:schedule/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_integrations_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + _projects_locations_integrations_list: operation: &ref_1 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations/get response: &ref_2 mediaType: application/json openAPIDocKey: '200' - objectKey: $.connections - projects_locations_connections_list: + objectKey: $.integrations + projects_locations_integrations_list: operation: *ref_1 response: *ref_2 - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_list - insert: [] - update: [] - delete: [] - runtime_entity_schemas: - id: integrations.runtime_entity_schemas - name: runtime_entity_schemas - title: Runtime_entity_schemas - methods: - _projects_locations_connections_runtime_entity_schemas_list: + projects_locations_integrations_execute: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:execute/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_integrations_test: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:test/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_products_integrations_test: + operation: + $ref: >- + #/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_integrations_list: operation: &ref_3 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1runtimeEntitySchemas/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations/get response: &ref_4 mediaType: application/json openAPIDocKey: '200' - objectKey: $.runtimeEntitySchemas - projects_locations_connections_runtime_entity_schemas_list: + objectKey: $.integrations + projects_locations_products_integrations_list: operation: *ref_3 response: *ref_4 + projects_locations_products_integrations_schedule: + operation: + $ref: >- + #/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_integrations_execute: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}:execute/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/runtime_entity_schemas/methods/projects_locations_connections_runtime_entity_schemas_list + #/components/x-stackQL-resources/integrations/methods/projects_locations_products_integrations_list + - $ref: >- + #/components/x-stackQL-resources/integrations/methods/projects_locations_integrations_list insert: [] update: [] - delete: [] - runtime_action_schemas: - id: integrations.runtime_action_schemas - name: runtime_action_schemas - title: Runtime_action_schemas + 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_connections_runtime_action_schemas_list: - operation: &ref_5 + projects_locations_integrations_execute_event: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1runtimeActionSchemas/get - response: &ref_6 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:executeEvent/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.runtimeActionSchemas - projects_locations_connections_runtime_action_schemas_list: - operation: *ref_5 - response: *ref_6 sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/runtime_action_schemas/methods/projects_locations_connections_runtime_action_schemas_list + select: [] insert: [] update: [] delete: [] executions: - id: integrations.executions + id: google.integrations.executions name: executions title: Executions methods: - projects_locations_integrations_executions_replay: + projects_locations_integrations_executions_download: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}:replay/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_integrations_executions_list: - operation: &ref_7 + operation: &ref_5 $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions/get - response: &ref_8 + response: &ref_6 mediaType: application/json openAPIDocKey: '200' objectKey: $.executions projects_locations_integrations_executions_list: - operation: *ref_7 - response: *ref_8 + operation: *ref_5 + response: *ref_6 projects_locations_integrations_executions_get: operation: $ref: >- @@ -9144,99 +9212,88 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_executions_download: + projects_locations_integrations_executions_replay: 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}~1integrations~1{integrationsId}~1executions~1{executionsId}:replay/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_executions_get: + projects_locations_products_integrations_executions_download: 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}~1integrations~1{integrationsId}~1executions~1{executionsId}:download/get response: mediaType: application/json openAPIDocKey: '200' _projects_locations_products_integrations_executions_list: - operation: &ref_9 + operation: &ref_7 $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions/get - response: &ref_10 + response: &ref_8 mediaType: application/json openAPIDocKey: '200' objectKey: $.executions projects_locations_products_integrations_executions_list: - operation: *ref_9 - response: *ref_10 - projects_locations_products_integrations_executions_cancel: + operation: *ref_7 + response: *ref_8 + projects_locations_products_integrations_executions_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}:cancel/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_products_integrations_executions_download: + projects_locations_products_integrations_executions_cancel: 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}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/executions/methods/projects_locations_integrations_executions_list + #/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_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: [] delete: [] suspensions: - id: integrations.suspensions + id: google.integrations.suspensions name: suspensions title: Suspensions methods: - projects_locations_integrations_executions_suspensions_resolve: - operation: - $ref: >- - #/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_integrations_executions_suspensions_list: - operation: &ref_11 + operation: &ref_9 $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions/get - response: &ref_12 + response: &ref_10 mediaType: application/json openAPIDocKey: '200' objectKey: $.suspensions projects_locations_integrations_executions_suspensions_list: - operation: *ref_11 - response: *ref_12 - projects_locations_integrations_executions_suspensions_lift: + operation: *ref_9 + response: *ref_10 + projects_locations_integrations_executions_suspensions_resolve: 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}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:resolve/post response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_products_integrations_executions_suspensions_list: - operation: &ref_13 + projects_locations_integrations_executions_suspensions_lift: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions/get - response: &ref_14 + #/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: $.suspensions - projects_locations_products_integrations_executions_suspensions_list: - operation: *ref_13 - response: *ref_14 projects_locations_products_integrations_executions_suspensions_lift: operation: $ref: >- @@ -9244,6 +9301,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' + _projects_locations_products_integrations_executions_suspensions_list: + operation: &ref_11 + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions/get + response: &ref_12 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.suspensions + projects_locations_products_integrations_executions_suspensions_list: + operation: *ref_11 + response: *ref_12 projects_locations_products_integrations_executions_suspensions_resolve: operation: $ref: >- @@ -9253,32 +9321,18 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/suspensions/methods/projects_locations_integrations_executions_suspensions_list - $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: [] delete: [] versions: - id: integrations.versions + id: google.integrations.versions name: versions title: Versions methods: - projects_locations_integrations_versions_unpublish: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:unpublish/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_integrations_versions_download: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:download/get - response: - mediaType: application/json - openAPIDocKey: '200' projects_locations_integrations_versions_publish: operation: $ref: >- @@ -9286,10 +9340,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_delete: + projects_locations_integrations_versions_upload: 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}~1integrations~1{integrationsId}~1versions:upload/post response: mediaType: application/json openAPIDocKey: '200' @@ -9307,28 +9361,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_upload: + projects_locations_integrations_versions_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions:upload/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_integrations_versions_list: - operation: &ref_15 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions/get - response: &ref_16 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.integrationVersions - projects_locations_integrations_versions_list: - operation: *ref_15 - response: *ref_16 - projects_locations_integrations_versions_create: + projects_locations_integrations_versions_download: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:download/get response: mediaType: application/json openAPIDocKey: '200' @@ -9339,242 +9382,185 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_delete: - operation: - $ref: >- - #/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_get: - operation: - $ref: >- - #/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_integrations_versions_patch: - operation: - $ref: >- - #/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_integrations_versions_unpublish: - operation: - $ref: >- - #/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_integrations_versions_create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions/post - response: - mediaType: application/json - openAPIDocKey: '200' - _projects_locations_products_integrations_versions_list: - operation: &ref_17 + _projects_locations_integrations_versions_list: + operation: &ref_13 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions/get - response: &ref_18 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions/get + response: &ref_14 mediaType: application/json openAPIDocKey: '200' objectKey: $.integrationVersions - projects_locations_products_integrations_versions_list: - operation: *ref_17 - response: *ref_18 - 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' - projects_locations_products_integrations_versions_takeover_edit_lock: - operation: - $ref: >- - #/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_integrations_versions_download: + projects_locations_integrations_versions_list: + operation: *ref_13 + response: *ref_14 + projects_locations_integrations_versions_create: 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}~1integrations~1{integrationsId}~1versions/post response: mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_get - - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_list - - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_get - - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_list - insert: - - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_create - - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_create - update: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_delete - - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_delete - skip_this_resource: - id: integrations.skip_this_resource - name: skip_this_resource - title: Skip_this_resource - methods: - projects_locations_integrations_execute_event: + openAPIDocKey: '200' + projects_locations_integrations_versions_unpublish: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:executeEvent/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:unpublish/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - integrations: - id: integrations.integrations - name: integrations - title: Integrations - methods: - projects_locations_integrations_delete: + projects_locations_products_integrations_versions_download: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}/delete + #/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' - projects_locations_integrations_schedule: + projects_locations_products_integrations_versions_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:schedule/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_integrations_test: + projects_locations_products_integrations_versions_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:test/post + #/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_integrations_execute: + projects_locations_products_integrations_versions_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:execute/post + #/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_integrations_list: - operation: &ref_19 + projects_locations_products_integrations_versions_publish: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations/get - response: &ref_20 + #/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' - objectKey: $.integrations - projects_locations_integrations_list: - operation: *ref_19 - response: *ref_20 - _projects_locations_products_integrations_list: - operation: &ref_21 + projects_locations_products_integrations_versions_upload: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations/get - response: &ref_22 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions:upload/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.integrations - projects_locations_products_integrations_list: - operation: *ref_21 - response: *ref_22 - projects_locations_products_integrations_execute: + projects_locations_products_integrations_versions_unpublish: 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}~1integrations~1{integrationsId}~1versions~1{versionsId}:unpublish/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_schedule: + _projects_locations_products_integrations_versions_list: + operation: &ref_15 + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions/get + response: &ref_16 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.integrationVersions + projects_locations_products_integrations_versions_list: + operation: *ref_15 + response: *ref_16 + projects_locations_products_integrations_versions_create: 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}~1integrations~1{integrationsId}~1versions/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_test: + projects_locations_products_integrations_versions_takeover_edit_lock: 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}~1integrations~1{integrationsId}~1versions~1{versionsId}:takeoverEditLock/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/integrations/methods/projects_locations_integrations_list + #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_get - $ref: >- - #/components/x-stackQL-resources/integrations/methods/projects_locations_products_integrations_list - insert: [] - update: [] + #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_get + - $ref: >- + #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_list + - $ref: >- + #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_list + insert: + - $ref: >- + #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_create + - $ref: >- + #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_create + update: + - $ref: >- + #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_patch + - $ref: >- + #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_patch delete: - $ref: >- - #/components/x-stackQL-resources/integrations/methods/projects_locations_integrations_delete + #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_delete + - $ref: >- + #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_delete auth_configs: - id: integrations.auth_configs + id: google.integrations.auth_configs name: auth_configs title: Auth_configs methods: - projects_locations_products_auth_configs_get: + projects_locations_auth_configs_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}~1authConfigs~1{authConfigsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_auth_configs_delete: + projects_locations_auth_configs_patch: 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}~1authConfigs~1{authConfigsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_auth_configs_patch: + projects_locations_auth_configs_delete: 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}~1authConfigs~1{authConfigsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + 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_list: + operation: &ref_17 + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs/get + response: &ref_18 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.authConfigs + projects_locations_auth_configs_list: + operation: *ref_17 + response: *ref_18 _projects_locations_products_auth_configs_list: - operation: &ref_23 + operation: &ref_19 $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs/get - response: &ref_24 + response: &ref_20 mediaType: application/json openAPIDocKey: '200' objectKey: $.authConfigs projects_locations_products_auth_configs_list: - operation: *ref_23 - response: *ref_24 + operation: *ref_19 + response: *ref_20 projects_locations_products_auth_configs_create: operation: $ref: >- @@ -9582,53 +9568,35 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_auth_configs_delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs~1{authConfigsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_auth_configs_get: + projects_locations_products_auth_configs_delete: 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}~1authConfigs~1{authConfigsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_auth_configs_patch: + projects_locations_products_auth_configs_patch: 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}~1authConfigs~1{authConfigsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_auth_configs_create: + projects_locations_products_auth_configs_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs~1{authConfigsId}/get response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_auth_configs_list: - operation: &ref_25 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs/get - response: &ref_26 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.authConfigs - projects_locations_auth_configs_list: - operation: *ref_25 - response: *ref_26 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_products_auth_configs_list - $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: @@ -9636,28 +9604,120 @@ components: #/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: [] + 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 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: [] + delete: [] + connections: + id: google.integrations.connections + name: connections + title: Connections + methods: + _projects_locations_connections_list: + operation: &ref_21 + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get + response: &ref_22 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.connections + projects_locations_connections_list: + operation: *ref_21 + response: *ref_22 + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_list + insert: [] + update: [] + 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_23 + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1runtimeActionSchemas/get + response: &ref_24 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.runtimeActionSchemas + projects_locations_connections_runtime_action_schemas_list: + operation: *ref_23 + response: *ref_24 + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/runtime_action_schemas/methods/projects_locations_connections_runtime_action_schemas_list + insert: [] + update: [] + 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_25 + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1runtimeEntitySchemas/get + response: &ref_26 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.runtimeEntitySchemas + projects_locations_connections_runtime_entity_schemas_list: + operation: *ref_25 + response: *ref_26 + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/runtime_entity_schemas/methods/projects_locations_connections_runtime_entity_schemas_list + insert: [] + update: [] + delete: [] cloud_functions: - id: integrations.cloud_functions + id: google.integrations.cloud_functions name: cloud_functions title: Cloud_functions methods: - projects_locations_products_cloud_functions_create: + projects_locations_cloud_functions_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1cloudFunctions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cloudFunctions/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_cloud_functions_create: + projects_locations_products_cloud_functions_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cloudFunctions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1cloudFunctions/post response: mediaType: application/json openAPIDocKey: '200' @@ -9670,158 +9730,141 @@ components: #/components/x-stackQL-resources/cloud_functions/methods/projects_locations_cloud_functions_create update: [] delete: [] - certificates: - id: integrations.certificates - name: certificates - title: Certificates + sfdc_instances: + id: google.integrations.sfdc_instances + name: sfdc_instances + title: Sfdc_instances methods: - projects_locations_products_certificates_create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates/post - response: - mediaType: application/json - openAPIDocKey: '200' - _projects_locations_products_certificates_list: + _projects_locations_sfdc_instances_list: operation: &ref_27 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances/get response: &ref_28 mediaType: application/json openAPIDocKey: '200' - objectKey: $.certificates - projects_locations_products_certificates_list: + objectKey: $.sfdcInstances + projects_locations_sfdc_instances_list: operation: *ref_27 response: *ref_28 - projects_locations_products_certificates_get: + projects_locations_sfdc_instances_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}~1sfdcInstances/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_certificates_patch: + projects_locations_sfdc_instances_delete: 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}~1sfdcInstances~1{sfdcInstancesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_certificates_delete: + projects_locations_sfdc_instances_patch: 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}~1sfdcInstances~1{sfdcInstancesId}/patch response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_certificates_list: - operation: &ref_29 + projects_locations_sfdc_instances_get: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates/get - response: &ref_30 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.certificates - projects_locations_certificates_list: - operation: *ref_29 - response: *ref_30 - projects_locations_certificates_create: + projects_locations_products_sfdc_instances_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_certificates_delete: + projects_locations_products_sfdc_instances_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}~1sfdcInstances~1{sfdcInstancesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_certificates_get: + projects_locations_products_sfdc_instances_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}~1sfdcInstances~1{sfdcInstancesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_certificates_patch: + _projects_locations_products_sfdc_instances_list: + operation: &ref_29 + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances/get + response: &ref_30 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.sfdcInstances + projects_locations_products_sfdc_instances_list: + operation: *ref_29 + response: *ref_30 + projects_locations_products_sfdc_instances_create: 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}~1sfdcInstances/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/certificates/methods/projects_locations_products_certificates_list + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_get - $ref: >- - #/components/x-stackQL-resources/certificates/methods/projects_locations_products_certificates_get + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_get - $ref: >- - #/components/x-stackQL-resources/certificates/methods/projects_locations_certificates_list + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_list - $ref: >- - #/components/x-stackQL-resources/certificates/methods/projects_locations_certificates_get + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_list insert: - $ref: >- - #/components/x-stackQL-resources/certificates/methods/projects_locations_products_certificates_create + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_create - $ref: >- - #/components/x-stackQL-resources/certificates/methods/projects_locations_certificates_create - update: [] + #/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 delete: - $ref: >- - #/components/x-stackQL-resources/certificates/methods/projects_locations_products_certificates_delete + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_delete - $ref: >- - #/components/x-stackQL-resources/certificates/methods/projects_locations_certificates_delete + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_delete sfdc_channels: - id: integrations.sfdc_channels + id: google.integrations.sfdc_channels name: sfdc_channels title: Sfdc_channels methods: - projects_locations_products_sfdc_instances_sfdc_channels_get: - operation: - $ref: >- - #/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_sfdc_instances_sfdc_channels_delete: - operation: - $ref: >- - #/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_products_sfdc_instances_sfdc_channels_patch: + projects_locations_sfdc_instances_sfdc_channels_create: 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}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/post response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_products_sfdc_instances_sfdc_channels_list: + _projects_locations_sfdc_instances_sfdc_channels_list: operation: &ref_31 $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}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/get response: &ref_32 mediaType: application/json openAPIDocKey: '200' objectKey: $.sfdcChannels - projects_locations_products_sfdc_instances_sfdc_channels_list: + projects_locations_sfdc_instances_sfdc_channels_list: operation: *ref_31 response: *ref_32 - projects_locations_products_sfdc_instances_sfdc_channels_create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_sfdc_instances_sfdc_channels_get: + projects_locations_sfdc_instances_sfdc_channels_delete: 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}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -9832,39 +9875,60 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_sfdc_instances_sfdc_channels_delete: + projects_locations_sfdc_instances_sfdc_channels_get: 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}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_sfdc_instances_sfdc_channels_create: + projects_locations_products_sfdc_instances_sfdc_channels_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/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_sfdc_instances_sfdc_channels_list: + _projects_locations_products_sfdc_instances_sfdc_channels_list: operation: &ref_33 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/get response: &ref_34 mediaType: application/json openAPIDocKey: '200' objectKey: $.sfdcChannels - projects_locations_sfdc_instances_sfdc_channels_list: + projects_locations_products_sfdc_instances_sfdc_channels_list: operation: *ref_33 response: *ref_34 + projects_locations_products_sfdc_instances_sfdc_channels_patch: + operation: + $ref: >- + #/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_products_sfdc_instances_sfdc_channels_get: + operation: + $ref: >- + #/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_sfdc_instances_sfdc_channels_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' 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_products_sfdc_instances_sfdc_channels_list - $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: @@ -9872,232 +9936,319 @@ components: #/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: [] + 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 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: integrations.sfdc_instances - name: sfdc_instances - title: Sfdc_instances + apps_script_projects: + id: google.integrations.apps_script_projects + name: apps_script_projects + title: Apps_script_projects methods: - _projects_locations_products_sfdc_instances_list: - operation: &ref_35 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances/get - response: &ref_36 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.sfdcInstances - projects_locations_products_sfdc_instances_list: - operation: *ref_35 - response: *ref_36 - 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_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_products_sfdc_instances_patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_products_sfdc_instances_delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - 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_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_sfdc_instances_delete: + projects_locations_apps_script_projects_link: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1appsScriptProjects:link/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_sfdc_instances_create: + projects_locations_apps_script_projects_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1appsScriptProjects/post response: - mediaType: application/json - openAPIDocKey: '200' - _projects_locations_sfdc_instances_list: - operation: &ref_37 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances/get - response: &ref_38 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.sfdcInstances - projects_locations_sfdc_instances_list: - operation: *ref_37 - response: *ref_38 + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_list - - $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_sfdc_instances_list + select: [] 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 + #/components/x-stackQL-resources/apps_script_projects/methods/projects_locations_apps_script_projects_create update: [] - 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 - clients: - id: integrations.clients - name: clients - title: Clients + delete: [] + certificates: + id: google.integrations.certificates + name: certificates + title: Certificates methods: - projects_locations_clients_replace: + projects_locations_certificates_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:replace/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates~1{certificatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_clients_switch_variable_masking: + projects_locations_certificates_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:switchVariableMasking/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates~1{certificatesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_clients_switch: + projects_locations_certificates_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:switch/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates~1{certificatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_clients_provision: + _projects_locations_certificates_list: + operation: &ref_35 + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates/get + response: &ref_36 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.certificates + projects_locations_certificates_list: + operation: *ref_35 + response: *ref_36 + projects_locations_certificates_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:provision/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_clients_deprovision: + _projects_locations_products_certificates_list: + operation: &ref_37 + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates/get + response: &ref_38 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.certificates + projects_locations_products_certificates_list: + operation: *ref_37 + response: *ref_38 + projects_locations_products_certificates_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:deprovision/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_get_clients: + projects_locations_products_certificates_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates~1{certificatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/clients/methods/projects_locations_get_clients - insert: [] - update: [] - delete: [] - apps_script_projects: - id: integrations.apps_script_projects - name: apps_script_projects - title: Apps_script_projects - methods: - projects_locations_apps_script_projects_create: + projects_locations_products_certificates_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1appsScriptProjects/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates~1{certificatesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_apps_script_projects_link: + projects_locations_products_certificates_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1appsScriptProjects:link/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates~1{certificatesId}/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + 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 + - $ref: >- + #/components/x-stackQL-resources/certificates/methods/projects_locations_certificates_list insert: - $ref: >- - #/components/x-stackQL-resources/apps_script_projects/methods/projects_locations_apps_script_projects_create - update: [] - delete: [] - connector_platform_regions: - id: integrations.connector_platform_regions - name: connector_platform_regions - title: Connector_platform_regions + #/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 + 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: - connector_platform_regions_enumerate: + projects_get_clientmetadata: operation: - $ref: '#/paths/~1v1~1connectorPlatformRegions:enumerate/get' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1clientmetadata/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/clientmetadata/methods/projects_get_clientmetadata insert: [] update: [] delete: [] paths: - /v1/callback:generateToken: + /v1/connectorPlatformRegions:enumerate: parameters: &ref_39 - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/_.xgafv' + 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/callback:generateToken: + parameters: *ref_39 + 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: code + schema: + type: string + - in: query + name: gcpProjectId + schema: + type: string + - in: query + name: redirectUri + schema: + type: string + - in: query + name: state + schema: + type: string + - in: query + name: product + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/clients: + parameters: *ref_39 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 + 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 + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaGetClientResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/clients:replace: + parameters: *ref_39 + 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 + 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 + /v1/projects/{projectsId}/locations/{locationsId}/clients:deprovision: + parameters: *ref_39 + 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 + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaDeprovisionClientRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10109,34 +10260,100 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaGenerateTokenResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - - in: query - name: code + - in: path + name: projectsId + required: true schema: type: string - - in: query - name: product + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: state + /v1/projects/{projectsId}/locations/{locationsId}/clients:switch: + parameters: *ref_39 + post: + description: Update client from GMEK to CMEK + operationId: integrations.projects.locations.clients.switch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest + security: + - Oauth2: + - https://www.googleapis.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: gcpProjectId + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: redirectUri + /v1/projects/{projectsId}/locations/{locationsId}/clients:provision: + parameters: *ref_39 + 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 + security: + - Oauth2: + - https://www.googleapis.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 - /v1/projects/{projectsId}/clientmetadata: + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/clients:switchVariableMasking: parameters: *ref_39 - get: - description: Gets the metadata info for the requested client - operationId: integrations.projects.getClientmetadata + post: + 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 @@ -10148,19 +10365,31 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaGetClientMetadataResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/connectionSchemaMetadata: + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:schedule: parameters: *ref_39 - get: - description: Lists the available entities and actions associated with a Connection. - operationId: integrations.projects.locations.connections.getConnectionSchemaMetadata + 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 + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10173,7 +10402,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata + #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse parameters: - in: path name: projectsId @@ -10186,15 +10415,18 @@ paths: schema: type: string - in: path - name: connectionsId + name: integrationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/connections: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:executeEvent: parameters: *ref_39 - get: - description: Lists Connections in a given project and location. - operationId: integrations.projects.locations.connections.list + 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 @@ -10207,7 +10439,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListConnectionsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteEventResponse parameters: - in: path name: projectsId @@ -10219,12 +10451,75 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: integrationsId + required: true schema: type: string - in: query - name: orderBy + name: triggerId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}: + parameters: *ref_39 + 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 + 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: integrationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations: + parameters: *ref_39 + get: + 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 + 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 + schema: + type: string + - in: path + name: locationsId + required: true schema: type: string - in: query @@ -10232,17 +10527,36 @@ 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}/connections/{connectionsId}/runtimeEntitySchemas: + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:execute: parameters: *ref_39 - get: + post: description: >- - Lists the JSON schemas for the properties of runtime entities, filtered - by entity name. - operationId: integrations.projects.locations.connections.runtimeEntitySchemas.list + 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/GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10255,7 +10569,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse parameters: - in: path name: projectsId @@ -10268,30 +10582,21 @@ paths: schema: type: string - in: path - name: connectionsId + name: integrationsId 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}/connections/{connectionsId}/runtimeActionSchemas: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:test: parameters: *ref_39 - get: - description: >- - Lists the JSON schemas for the inputs and outputs of actions, filtered - by action name. - operationId: integrations.projects.locations.connections.runtimeActionSchemas.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 @@ -10304,7 +10609,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsResponse parameters: - in: path name: projectsId @@ -10317,36 +10622,15 @@ paths: schema: type: string - in: path - name: connectionsId + name: integrationsId 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}/integrations/{integrationsId}/executions/{executionsId}:replay: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:download: parameters: *ref_39 - post: - description: >- - Re-execute an existing execution, with same request parameters and - execution strategy - operationId: integrations.projects.locations.integrations.executions.replay - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaReplayExecutionRequest + get: + description: Download the execution. + operationId: integrations.projects.locations.integrations.executions.download security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10359,7 +10643,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaReplayExecutionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadExecutionResponse parameters: - in: path name: projectsId @@ -10420,37 +10704,31 @@ paths: schema: type: string - in: query - name: filterParams.startTime + name: filterParams.customFilter schema: type: string - format: int64 - in: query - name: filterParams.parameterKey + name: filterParams.executionId schema: type: string - in: query - name: orderBy + name: filterParams.parameterPairKey schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filterParams.executionId + name: pageToken schema: type: string - in: query - name: filterParams.parameterValue + name: refreshAcl schema: - type: string + type: boolean - in: query name: filterParams.eventStatuses schema: type: string - in: query - name: pageToken + name: filterParams.workflowName schema: type: string - in: query @@ -10463,46 +10741,52 @@ paths: schema: type: string - in: query - name: readMask + name: orderBy schema: type: string - format: google-fieldmask - in: query - name: refreshAcl + name: pageSize schema: - type: boolean + type: integer + format: int32 - in: query - name: filterParams.customFilter + name: readMask schema: type: string + format: google-fieldmask - in: query name: filterParams.parameterPairValue schema: type: string - in: query - name: truncateParams + name: filterParams.parameterKey schema: - type: boolean + type: string - in: query - name: filterParams.taskStatuses + name: filterParams.parameterValue schema: type: string - in: query - name: snapshotMetadataWithoutParams + name: filterParams.startTime schema: - type: boolean + type: string + format: int64 - in: query - name: filterParams.workflowName + name: filter schema: type: string - in: query - name: filterParams.parameterPairKey + name: filterParams.taskStatuses schema: type: string - in: query - name: filter + name: truncateParams schema: - type: string + type: boolean + - in: query + name: snapshotMetadataWithoutParams + schema: + type: boolean /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}: parameters: *ref_39 get: @@ -10541,60 +10825,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:download: - parameters: *ref_39 - get: - description: Download the execution. - operationId: integrations.projects.locations.integrations.executions.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/GoogleCloudIntegrationsV1alphaDownloadExecutionResponse - 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: executionsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:replay: parameters: *ref_39 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 + Re-execute an existing execution, with same request parameters and + execution strategy + operationId: integrations.projects.locations.integrations.executions.replay requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaReplayExecutionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10607,7 +10850,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaReplayExecutionResponse parameters: - in: path name: projectsId @@ -10629,11 +10872,6 @@ paths: required: true schema: type: string - - in: path - name: suspensionsId - required: true - schema: - type: string /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions: parameters: *ref_39 get: @@ -10677,7 +10915,7 @@ paths: schema: type: string - in: query - name: filter + name: orderBy schema: type: string - in: query @@ -10690,78 +10928,24 @@ paths: type: integer format: int32 - in: query - name: orderBy - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift: - parameters: *ref_39 - 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 - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionResponse - 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: executionsId - required: true - schema: - type: string - - in: path - name: suspensionsId - required: true + name: filter schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:unpublish: - parameters: *ref_39 - 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 + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve: + parameters: *ref_39 + 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 requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10773,7 +10957,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionResponse parameters: - in: path name: projectsId @@ -10791,17 +10976,29 @@ paths: schema: type: string - in: path - name: versionsId + name: executionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:download: + - in: path + name: suspensionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift: parameters: *ref_39 - 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.integrations.versions.download + * 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 @@ -10814,7 +11011,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionResponse parameters: - in: path name: projectsId @@ -10832,16 +11029,13 @@ paths: schema: type: string - in: path - name: versionsId + name: executionsId required: true schema: type: string - - in: query - name: fileFormat - schema: - type: string - - in: query - name: files + - in: path + name: suspensionsId + required: true schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:publish: @@ -10895,20 +11089,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions:upload: parameters: *ref_39 - delete: + 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 + 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 @@ -10920,7 +11116,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse parameters: - in: path name: projectsId @@ -10937,11 +11134,8 @@ paths: required: true schema: type: string - - in: path - name: versionsId - required: true - schema: - type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}: + parameters: *ref_39 get: description: Get a integration in the specified project. operationId: integrations.projects.locations.integrations.versions.get @@ -11027,22 +11221,18 @@ paths: schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions:upload: - parameters: *ref_39 - post: + delete: 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/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest + 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 @@ -11054,8 +11244,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11072,11 +11261,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions: + - in: path + name: versionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:download: parameters: *ref_39 get: - description: Returns the list of all integration versions in the specified project. - operationId: integrations.projects.locations.integrations.versions.list + 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 @@ -11089,7 +11285,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse parameters: - in: path name: projectsId @@ -11106,37 +11302,29 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy + - in: path + name: versionsId + required: true schema: type: string - in: query - name: filter + name: fileFormat schema: type: string - in: query - name: fieldMask + name: files 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 + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:downloadJsonPackage: + parameters: *ref_39 + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11149,7 +11337,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse parameters: - in: path name: projectsId @@ -11166,24 +11354,20 @@ paths: required: true schema: type: string - - in: query - name: newIntegration + - in: path + name: versionsId + required: true schema: - type: boolean + type: string - in: query - name: createSampleIntegrations + name: files schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:downloadJsonPackage: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions: parameters: *ref_39 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 + 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 @@ -11196,7 +11380,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse parameters: - in: path name: projectsId @@ -11213,23 +11397,37 @@ paths: required: true schema: type: string - - in: path - name: versionsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: fieldMask schema: type: string + format: google-fieldmask - in: query - name: files + name: pageToken + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:executeEvent: - parameters: *ref_39 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: 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 @@ -11242,7 +11440,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteEventResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion parameters: - in: path name: projectsId @@ -11260,14 +11458,29 @@ paths: schema: type: string - in: query - name: triggerId + name: newIntegration schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}: + type: boolean + - in: query + name: createSampleIntegrations + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:unpublish: parameters: *ref_39 - delete: - description: Delete the selected integration and all versions inside - operationId: integrations.projects.locations.integrations.delete + 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 @@ -11296,19 +11509,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:schedule: + - in: path + name: versionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}: parameters: *ref_39 - post: + get: 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 - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest + 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 @@ -11320,8 +11533,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' parameters: - in: path name: projectsId @@ -11334,21 +11546,23 @@ paths: schema: type: string - in: path - name: integrationsId + name: authConfigsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:test: - parameters: *ref_39 - post: - description: Execute the integration in draft state - operationId: integrations.projects.locations.integrations.test + 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/GoogleCloudIntegrationsV1alphaTestIntegrationsRequest + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11360,8 +11574,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' parameters: - in: path name: projectsId @@ -11374,28 +11587,30 @@ paths: schema: type: string - in: path - name: integrationsId + name: authConfigsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:execute: - parameters: *ref_39 - 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 - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest + - in: query + name: clientCertificate.encryptedPrivateKey + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: clientCertificate.sslCertificate + schema: + type: string + - 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 @@ -11407,8 +11622,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11421,15 +11635,24 @@ paths: schema: type: string - in: path - name: integrationsId + name: authConfigsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations: + /v1/projects/{projectsId}/locations/{locationsId}/authConfigs: parameters: *ref_39 - get: - description: Returns the list of all integrations in the specified project. - operationId: integrations.projects.locations.integrations.list + 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/GoogleCloudIntegrationsV1alphaAuthConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11441,8 +11664,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationsResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' parameters: - in: path name: projectsId @@ -11455,30 +11677,22 @@ paths: schema: type: string - in: query - name: pageToken + name: clientCertificate.encryptedPrivateKey schema: type: string - in: query - name: orderBy + name: clientCertificate.sslCertificate schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + name: clientCertificate.passphrase schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}: - parameters: *ref_39 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 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 @@ -11490,7 +11704,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListAuthConfigsResponse parameters: - in: path name: projectsId @@ -11502,19 +11717,29 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true + - in: query + name: readMask schema: type: string - - in: path - name: authConfigsId - required: true + format: google-fieldmask + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - delete: - description: Deletes an auth config. - operationId: integrations.projects.locations.products.authConfigs.delete + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/connectionSchemaMetadata: + parameters: *ref_39 + 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 @@ -11526,7 +11751,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata parameters: - in: path name: projectsId @@ -11539,28 +11765,15 @@ paths: schema: type: string - in: path - name: productsId - required: true - schema: - type: string - - in: path - name: authConfigsId + name: connectionsId 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.products.authConfigs.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + /v1/projects/{projectsId}/locations/{locationsId}/connections: + parameters: *ref_39 + 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 @@ -11572,7 +11785,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListConnectionsResponse parameters: - in: path name: projectsId @@ -11584,40 +11798,30 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true - schema: - type: string - - in: path - name: authConfigsId - required: true - schema: - type: string - in: query - name: clientCertificate.passphrase + name: pageToken schema: type: string - in: query - name: clientCertificate.encryptedPrivateKey + name: filter schema: type: string - in: query - name: clientCertificate.sslCertificate + name: orderBy schema: type: string - in: query - name: updateMask + name: pageSize schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeActionSchemas: parameters: *ref_39 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 + 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 @@ -11630,7 +11834,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListAuthConfigsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse parameters: - in: path name: projectsId @@ -11643,7 +11847,7 @@ paths: schema: type: string - in: path - name: productsId + name: connectionsId required: true schema: type: string @@ -11651,32 +11855,22 @@ paths: 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 - 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' + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeEntitySchemas: + parameters: *ref_39 + 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 @@ -11688,7 +11882,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse parameters: - in: path name: projectsId @@ -11701,27 +11896,28 @@ paths: schema: type: string - in: path - name: productsId + name: connectionsId required: true schema: type: string - in: query - name: clientCertificate.encryptedPrivateKey + name: pageToken schema: type: string - in: query - name: clientCertificate.sslCertificate + name: filter schema: type: string - in: query - name: clientCertificate.passphrase + name: pageSize schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/cloudFunctions: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/cloudFunctions: parameters: *ref_39 post: description: Creates a cloud function project. - operationId: integrations.projects.locations.products.cloudFunctions.create + operationId: integrations.projects.locations.cloudFunctions.create requestBody: content: application/json: @@ -11752,16 +11948,13 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations: + /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances: parameters: *ref_39 get: - description: Returns the list of all integrations in the specified project. - operationId: integrations.projects.locations.products.integrations.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 @@ -11774,7 +11967,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse parameters: - in: path name: projectsId @@ -11786,13 +11979,12 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true + - in: query + name: filter schema: type: string - in: query - name: orderBy + name: pageToken schema: type: string - in: query @@ -11801,31 +11993,20 @@ paths: type: integer format: int32 - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + name: readMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:execute: - parameters: *ref_39 + format: google-fieldmask 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 + 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/GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11838,7 +12019,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance parameters: - in: path name: projectsId @@ -11850,29 +12031,11 @@ 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}:schedule: + /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}: parameters: *ref_39 - 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 - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest + delete: + description: Deletes an sfdc instance. + operationId: integrations.projects.locations.sfdcInstances.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11884,8 +12047,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11898,26 +12060,20 @@ paths: schema: type: string - in: path - name: productsId - required: true - schema: - type: string - - in: path - name: integrationsId + name: sfdcInstancesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:test: - parameters: *ref_39 - post: - description: Execute the integration in draft state - operationId: integrations.projects.locations.products.integrations.test + 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/GoogleCloudIntegrationsV1alphaTestIntegrationsRequest + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11930,54 +12086,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsResponse - 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 - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}: - parameters: *ref_39 - 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 - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance parameters: - in: path name: projectsId @@ -11990,23 +12099,20 @@ paths: schema: type: string - in: path - name: productsId - required: true - schema: - type: string - - in: path - name: integrationsId + name: sfdcInstancesId required: true schema: type: string - - in: path - name: versionsId - required: true + - 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 + 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 @@ -12019,7 +12125,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance parameters: - in: path name: projectsId @@ -12032,29 +12138,22 @@ paths: 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 + name: sfdcInstancesId 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 + /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels: + parameters: *ref_39 + 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/GoogleCloudIntegrationsV1alphaIntegrationVersion + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12066,8 +12165,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' parameters: - in: path name: projectsId @@ -12080,41 +12178,15 @@ paths: 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 + 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}/versions/{versionsId}:unpublish: - parameters: *ref_39 - post: + get: 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 + 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 @@ -12126,7 +12198,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse parameters: - in: path name: projectsId @@ -12139,31 +12212,33 @@ paths: schema: type: string - in: path - name: productsId + name: sfdcInstancesId required: true schema: type: string - - in: path - name: integrationsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: versionsId - required: true + - in: query + name: readMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions: + format: google-fieldmask + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}: parameters: *ref_39 - 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 + delete: + description: Deletes an sfdc channel. + operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12175,8 +12250,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -12189,26 +12263,25 @@ paths: schema: type: string - in: path - name: productsId + name: sfdcInstancesId required: true schema: type: string - in: path - name: integrationsId + name: sfdcChannelsId required: true schema: 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 + patch: + 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' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12220,8 +12293,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' parameters: - in: path name: projectsId @@ -12234,53 +12306,25 @@ paths: schema: type: string - in: path - name: productsId + name: sfdcInstancesId required: true schema: type: string - in: path - name: integrationsId + name: sfdcChannelsId 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: pageToken - schema: - type: string - - in: query - name: fieldMask + name: updateMask schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions:upload: - parameters: *ref_39 - post: + get: 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/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest + 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 @@ -12292,8 +12336,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' parameters: - in: path name: projectsId @@ -12306,32 +12349,26 @@ paths: schema: type: string - in: path - name: productsId + name: sfdcInstancesId required: true schema: type: string - in: path - name: integrationsId + name: sfdcChannelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:publish: + /v1/projects/{projectsId}/locations/{locationsId}/appsScriptProjects:link: parameters: *ref_39 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 + description: Links a existing Apps Script project. + operationId: integrations.projects.locations.appsScriptProjects.link requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12344,7 +12381,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse parameters: - in: path name: projectsId @@ -12356,45 +12393,17 @@ 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}/integrations/{integrationsId}/versions/{versionsId}:takeoverEditLock: + /v1/projects/{projectsId}/locations/{locationsId}/appsScriptProjects: parameters: *ref_39 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 + description: Creates an Apps Script project. + operationId: integrations.projects.locations.appsScriptProjects.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12407,7 +12416,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse parameters: - in: path name: projectsId @@ -12419,28 +12428,42 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}: + parameters: *ref_39 + delete: + description: Delete a certificate + operationId: integrations.projects.locations.certificates.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: productsId + name: projectsId required: true schema: type: string - in: path - name: integrationsId + name: locationsId required: true schema: type: string - in: path - name: versionsId + name: certificatesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:download: - parameters: *ref_39 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 + description: Get a certificates in the specified project. + operationId: integrations.projects.locations.certificates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12452,8 +12475,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' parameters: - in: path name: projectsId @@ -12466,37 +12488,62 @@ paths: schema: type: string - in: path - name: productsId + 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.certificates.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + security: + - Oauth2: + - https://www.googleapis.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: integrationsId + name: projectsId required: true schema: type: string - in: path - name: versionsId + name: locationsId required: true schema: type: string - - in: query - name: fileFormat + - in: path + name: certificatesId + required: true schema: type: string - in: query - name: files + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions: + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/certificates: parameters: *ref_39 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 + 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 @@ -12509,7 +12556,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListSuspensionsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListCertificatesResponse parameters: - in: path name: projectsId @@ -12521,27 +12568,17 @@ 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 + - in: query + name: readMask schema: type: string + format: google-fieldmask - in: query - name: orderBy + name: filter schema: type: string - in: query - name: filter + name: pageToken schema: type: string - in: query @@ -12549,25 +12586,17 @@ paths: 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_39 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 + 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/GoogleCloudIntegrationsV1alphaLiftSuspensionRequest + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12579,8 +12608,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' parameters: - in: path name: projectsId @@ -12592,41 +12620,13 @@ 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 - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates: parameters: *ref_39 - 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 + 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 @@ -12639,7 +12639,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListCertificatesResponse parameters: - in: path name: projectsId @@ -12656,26 +12656,35 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true + - in: query + name: readMask 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: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}: - parameters: *ref_39 - get: - description: Get an execution in the specified project. - operationId: integrations.projects.locations.products.integrations.executions.get + 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 @@ -12687,7 +12696,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' parameters: - in: path name: projectsId @@ -12704,25 +12713,11 @@ paths: required: true schema: type: string - - 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: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}: parameters: *ref_39 - 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 + delete: + description: Delete a certificate + operationId: integrations.projects.locations.products.certificates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12734,8 +12729,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListExecutionsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -12753,105 +12747,13 @@ paths: schema: type: string - in: path - name: integrationsId + name: certificatesId required: true schema: type: string - - in: query - name: filterParams.parameterValue - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filterParams.parameterType - schema: - type: string - - in: query - name: filterParams.eventStatuses - schema: - type: string - - in: query - name: filterParams.parameterKey - schema: - type: string - - in: query - name: filterParams.workflowName - schema: - type: string - - in: query - name: truncateParams - schema: - type: boolean - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: orderBy - 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: snapshotMetadataWithoutParams - schema: - type: boolean - - in: query - name: filterParams.taskStatuses - schema: - type: string - - in: query - name: refreshAcl - schema: - type: boolean - - in: query - name: filterParams.customFilter - schema: - type: string - - in: query - name: filterParams.executionId - schema: - type: string - - in: query - name: filterParams.parameterPairValue - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filterParams.parameterPairKey - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}:cancel: - parameters: *ref_39 - post: - description: Cancellation of an execution - operationId: integrations.projects.locations.products.integrations.executions.cancel - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCancelExecutionRequest + 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 @@ -12863,8 +12765,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCancelExecutionResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' parameters: - in: path name: projectsId @@ -12877,26 +12778,27 @@ paths: schema: type: string - in: path - name: productsId - required: true - schema: - type: string - - in: path - name: integrationsId + name: productsId required: true schema: type: string - in: path - name: executionsId + name: certificatesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}:download: - parameters: *ref_39 - get: - description: Download the execution. - operationId: >- - integrations.projects.locations.products.integrations.executions.download + 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 @@ -12908,8 +12810,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadExecutionResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' parameters: - in: path name: projectsId @@ -12927,28 +12828,28 @@ paths: schema: type: string - in: path - name: integrationsId + name: certificatesId required: true schema: type: string - - in: path - name: executionsId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates: + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels: parameters: *ref_39 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 @@ -12960,7 +12861,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' parameters: - in: path name: projectsId @@ -12977,11 +12878,16 @@ paths: required: true schema: type: string + - in: path + name: sfdcInstancesId + 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.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 @@ -12994,7 +12900,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListCertificatesResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse parameters: - in: path name: projectsId @@ -13011,29 +12917,42 @@ paths: required: true schema: type: string + - in: path + name: sfdcInstancesId + required: true + schema: + type: string - in: query 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 - in: query - name: filter + name: readMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}: + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}: parameters: *ref_39 - get: - description: Get a certificates in the specified project. - operationId: integrations.projects.locations.products.certificates.get + patch: + description: >- + 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/GoogleCloudIntegrationsV1alphaSfdcChannel' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13045,7 +12964,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' parameters: - in: path name: projectsId @@ -13063,22 +12982,25 @@ paths: schema: type: string - in: path - name: certificatesId + name: sfdcInstancesId required: true schema: type: string - patch: + - in: path + name: sfdcChannelsId + required: true + schema: + type: string + - 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 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 @@ -13090,7 +13012,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' parameters: - in: path name: projectsId @@ -13108,18 +13030,19 @@ paths: schema: type: string - in: path - name: certificatesId + name: sfdcInstancesId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: sfdcChannelsId + required: true schema: type: string - format: google-fieldmask delete: - description: Delete a certificate - operationId: integrations.projects.locations.products.certificates.delete + description: Deletes an sfdc channel. + operationId: >- + integrations.projects.locations.products.sfdcInstances.sfdcChannels.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13149,17 +13072,22 @@ paths: schema: type: string - in: path - name: certificatesId + name: sfdcInstancesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}: + - in: path + name: sfdcChannelsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}: parameters: *ref_39 get: description: >- - Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND + Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown. - operationId: integrations.projects.locations.products.sfdcInstances.sfdcChannels.get + operationId: integrations.projects.locations.products.sfdcInstances.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13171,7 +13099,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance parameters: - in: path name: projectsId @@ -13193,15 +13122,16 @@ paths: required: true schema: type: string - - in: path - name: sfdcChannelsId - required: true - schema: - type: string - delete: - description: Deletes an sfdc channel. - operationId: >- - integrations.projects.locations.products.sfdcInstances.sfdcChannels.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 @@ -13213,7 +13143,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance parameters: - in: path name: projectsId @@ -13235,22 +13166,14 @@ paths: required: true schema: type: string - - in: path - name: sfdcChannelsId - required: true + - in: query + name: updateMask schema: type: string - patch: - description: >- - 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/GoogleCloudIntegrationsV1alphaSfdcChannel' + format: google-fieldmask + delete: + description: Deletes an sfdc instance. + operationId: integrations.projects.locations.products.sfdcInstances.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13262,7 +13185,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -13284,23 +13207,13 @@ paths: required: true schema: type: string - - in: path - name: sfdcChannelsId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances: parameters: *ref_39 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 + 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 @@ -13313,7 +13226,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse parameters: - in: path name: projectsId @@ -13330,11 +13243,6 @@ paths: required: true schema: type: string - - in: path - name: sfdcInstancesId - required: true - schema: - type: string - in: query name: pageToken schema: @@ -13355,15 +13263,54 @@ paths: format: int32 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 + 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' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + 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 + - in: path + name: productsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:test: + parameters: *ref_39 + post: + description: Execute the integration in draft state + operationId: integrations.projects.locations.products.integrations.test requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13375,7 +13322,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsResponse parameters: - in: path name: projectsId @@ -13393,17 +13341,15 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: integrationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations: parameters: *ref_39 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 + 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 @@ -13416,7 +13362,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationsResponse parameters: - in: path name: projectsId @@ -13434,10 +13380,13 @@ paths: schema: type: string - in: query - name: readMask + name: pageToken + schema: + type: string + - in: query + name: orderBy schema: type: string - format: google-fieldmask - in: query name: pageSize schema: @@ -13447,20 +13396,19 @@ paths: name: filter schema: type: string - - in: query - name: pageToken - schema: - type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:schedule: + parameters: *ref_39 post: description: >- - Creates an sfdc instance record. Store the sfdc instance in Spanner. - Returns the sfdc instance. - operationId: integrations.projects.locations.products.sfdcInstances.create + 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/GoogleCloudIntegrationsV1alphaSfdcInstance' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13473,7 +13421,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance + #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse parameters: - in: path name: projectsId @@ -13490,13 +13438,29 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}: + - in: path + name: integrationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:execute: parameters: *ref_39 - get: + 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 + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13509,7 +13473,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance + #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse parameters: - in: path name: projectsId @@ -13527,20 +13491,16 @@ 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.products.sfdcInstances.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}:download: + parameters: *ref_39 + get: + description: Download the execution. + operationId: >- + integrations.projects.locations.products.integrations.executions.download security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13553,7 +13513,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance + #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadExecutionResponse parameters: - in: path name: projectsId @@ -13571,18 +13531,24 @@ 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.products.sfdcInstances.delete + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions: + parameters: *ref_39 + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13594,7 +13560,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListExecutionsResponse parameters: - in: path name: projectsId @@ -13612,15 +13579,99 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: integrationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}: + - in: query + name: truncateParams + schema: + type: boolean + - in: query + name: filterParams.parameterValue + schema: + type: string + - in: query + name: filterParams.executionId + schema: + type: string + - in: query + name: filterParams.workflowName + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: filterParams.parameterKey + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: filterParams.endTime + schema: + type: string + format: int64 + - in: query + name: filterParams.eventStatuses + schema: + type: string + - in: query + name: filterParams.customFilter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - 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: filterParams.parameterPairKey + schema: + type: string + - in: query + name: filterParams.taskStatuses + schema: + type: string + - in: query + name: filterParams.parameterType + schema: + type: string + - in: query + name: refreshAcl + schema: + type: boolean + - in: query + name: snapshotMetadataWithoutParams + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}: parameters: *ref_39 - delete: - description: Deletes an auth config. - operationId: integrations.projects.locations.authConfigs.delete + 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 @@ -13632,7 +13683,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' parameters: - in: path name: projectsId @@ -13645,57 +13696,31 @@ paths: 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.authConfigs.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/GoogleCloudIntegrationsV1alphaAuthConfig' - 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: authConfigsId + name: executionsId 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 + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}:cancel: + parameters: *ref_39 + post: + description: Cancellation of an execution + operationId: integrations.projects.locations.products.integrations.executions.cancel requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaCancelExecutionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13707,7 +13732,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaCancelExecutionResponse parameters: - in: path name: projectsId @@ -13720,41 +13746,35 @@ paths: schema: type: string - in: path - name: authConfigsId + name: productsId required: true schema: type: string - - in: query - name: clientCertificate.passphrase - schema: - type: string - - in: query - name: clientCertificate.sslCertificate - schema: - type: string - - in: query - name: updateMask + - in: path + name: integrationsId + required: true schema: type: string - format: google-fieldmask - - in: query - name: clientCertificate.encryptedPrivateKey + - in: path + name: executionsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/authConfigs: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift: parameters: *ref_39 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 + * 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/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13766,7 +13786,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionResponse parameters: - in: path name: projectsId @@ -13778,23 +13799,35 @@ paths: required: true schema: type: string - - in: query - name: clientCertificate.sslCertificate + - in: path + 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: 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: + parameters: *ref_39 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 + * 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 @@ -13807,7 +13840,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListAuthConfigsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListSuspensionsResponse parameters: - in: path name: projectsId @@ -13819,36 +13852,53 @@ 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: query name: pageSize schema: type: integer format: int32 - in: query - name: readMask + name: filter schema: type: string - format: google-fieldmask - in: query name: pageToken schema: type: string - in: query - name: filter + name: orderBy schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve: parameters: *ref_39 - patch: + post: description: >- - Updates an sfdc instance. Updates the sfdc instance in spanner. Returns - the sfdc instance. - operationId: integrations.projects.locations.sfdcInstances.patch + * 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/GoogleCloudIntegrationsV1alphaSfdcInstance' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13861,7 +13911,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance + #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionResponse parameters: - in: path name: projectsId @@ -13874,20 +13924,32 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: productsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: integrationsId + required: true schema: type: string - format: google-fieldmask + - 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}/versions/{versionsId}:download: + parameters: *ref_39 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 + 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 @@ -13900,7 +13962,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance + #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse parameters: - in: path name: projectsId @@ -13913,53 +13975,39 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: productsId required: true schema: type: string - delete: - description: Deletes an sfdc instance. - operationId: integrations.projects.locations.sfdcInstances.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: integrationsId required: true schema: type: string - in: path - name: locationsId + name: versionsId required: true schema: type: string - - in: path - name: sfdcInstancesId - required: true + - in: query + name: fileFormat schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances: + - in: query + name: files + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}: parameters: *ref_39 - post: - description: >- - Creates an sfdc instance record. Store the sfdc instance in Spanner. - Returns the sfdc instance. - operationId: integrations.projects.locations.sfdcInstances.create + 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/GoogleCloudIntegrationsV1alphaSfdcInstance' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13972,7 +14020,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion parameters: - in: path name: projectsId @@ -13984,60 +14032,38 @@ 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.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 + name: productsId required: true schema: type: string - in: path - name: locationsId + name: integrationsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: versionsId + 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 - /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}: - parameters: *ref_39 - get: + delete: 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 + 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 @@ -14049,7 +14075,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -14062,25 +14088,23 @@ 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: path + name: versionsId required: true schema: type: string - patch: - 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' + 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 @@ -14092,7 +14116,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion parameters: - in: path name: projectsId @@ -14105,23 +14130,37 @@ 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 + - in: path + name: versionsId + required: true schema: type: string - format: google-fieldmask - delete: - description: Deletes an sfdc channel. - operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.delete + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:publish: + parameters: *ref_39 + 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 + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14133,7 +14172,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse parameters: - in: path name: projectsId @@ -14146,27 +14186,36 @@ 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 - /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels: + - in: path + name: versionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions:upload: parameters: *ref_39 post: description: >- - Creates an sfdc channel record. Store the sfdc channel in Spanner. - Returns the sfdc channel. - operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.create + 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/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14178,7 +14227,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse parameters: - in: path name: projectsId @@ -14191,15 +14241,31 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: productsId required: true schema: type: string - get: + - in: path + name: integrationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:unpublish: + parameters: *ref_39 + post: 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 + 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 @@ -14211,8 +14277,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -14225,35 +14290,25 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: productsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: readMask + - in: path + name: integrationsId + required: true schema: type: string - format: google-fieldmask - - in: query - name: pageToken + - in: path + name: versionsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/certificates: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions: parameters: *ref_39 get: - description: >- - List all the certificates that match the filter. Restrict to certificate - of current client only. - operationId: integrations.projects.locations.certificates.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 @@ -14266,7 +14321,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListCertificatesResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse parameters: - in: path name: projectsId @@ -14278,13 +14333,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: query name: pageSize schema: type: integer format: int32 - in: query - name: readMask + name: orderBy + schema: + type: string + - in: query + name: fieldMask schema: type: string format: google-fieldmask @@ -14297,16 +14366,14 @@ paths: schema: 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.certificates.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/GoogleCloudIntegrationsV1alphaCertificate' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14318,7 +14385,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion parameters: - in: path name: projectsId @@ -14330,42 +14398,48 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}: - parameters: *ref_39 - delete: - description: Delete a certificate - operationId: integrations.projects.locations.certificates.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: productsId required: true schema: type: string - in: path - name: locationsId + name: integrationsId required: true schema: type: string - - in: path - name: certificatesId - required: true + - in: query + name: newIntegration schema: - type: string - get: - description: Get a certificates in the specified project. - operationId: integrations.projects.locations.certificates.get + type: boolean + - in: query + name: createSampleIntegrations + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:takeoverEditLock: + parameters: *ref_39 + 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 @@ -14377,7 +14451,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse parameters: - in: path name: projectsId @@ -14390,22 +14465,27 @@ paths: schema: type: string - in: path - name: certificatesId + name: productsId 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + - 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}/authConfigs: + parameters: *ref_39 + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14417,7 +14497,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListAuthConfigsResponse parameters: - in: path name: projectsId @@ -14430,26 +14511,40 @@ paths: schema: type: string - in: path - name: certificatesId + name: productsId required: true schema: type: string - in: query - name: updateMask + name: readMask schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/clients:replace: - parameters: *ref_39 + - 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: Update run-as service account for provisioned client - operationId: integrations.projects.locations.clients.replace + 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/GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14461,7 +14556,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' parameters: - in: path name: projectsId @@ -14473,17 +14568,28 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/clients:switchVariableMasking: + - 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 + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}: parameters: *ref_39 - post: - description: Update variable masking for provisioned client - operationId: integrations.projects.locations.clients.switchVariableMasking - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest + delete: + description: Deletes an auth config. + operationId: integrations.projects.locations.products.authConfigs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14507,54 +14613,29 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/clients:switch: - parameters: *ref_39 - post: - description: Update client from GMEK to CMEK - operationId: integrations.projects.locations.clients.switch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest - security: - - Oauth2: - - https://www.googleapis.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: productsId required: true schema: type: string - in: path - name: locationsId + name: authConfigsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/clients:provision: - parameters: *ref_39 - post: + patch: 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 + 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/GoogleCloudIntegrationsV1alphaProvisionClientRequest + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14566,7 +14647,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' parameters: - in: path name: projectsId @@ -14578,53 +14659,39 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/clients:deprovision: - parameters: *ref_39 - 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 - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDeprovisionClientRequest - security: - - Oauth2: - - https://www.googleapis.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: productsId required: true schema: type: string - in: path - name: locationsId + name: authConfigsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/appsScriptProjects: - parameters: *ref_39 - post: - description: Creates an Apps Script project. - operationId: integrations.projects.locations.appsScriptProjects.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest + - in: query + name: clientCertificate.sslCertificate + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: clientCertificate.passphrase + schema: + type: string + - in: query + name: clientCertificate.encryptedPrivateKey + 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 @@ -14636,8 +14703,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' parameters: - in: path name: projectsId @@ -14649,46 +14715,21 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/appsScriptProjects:link: - parameters: *ref_39 - post: - description: Links a existing Apps Script project. - operationId: integrations.projects.locations.appsScriptProjects.link - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse - parameters: - in: path - name: projectsId + name: productsId required: true schema: type: string - in: path - name: locationsId + name: authConfigsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/cloudFunctions: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/cloudFunctions: parameters: *ref_39 post: description: Creates a cloud function project. - operationId: integrations.projects.locations.cloudFunctions.create + operationId: integrations.projects.locations.products.cloudFunctions.create requestBody: content: application/json: @@ -14719,13 +14760,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/clients: + - in: path + name: productsId + required: true + schema: + type: string + /v1/projects/{projectsId}/clientmetadata: parameters: *ref_39 get: - description: >- - Gets the client configuration for the given project and location - resource name - operationId: integrations.projects.locations.getClients + description: Gets the metadata info for the requested client + operationId: integrations.projects.getClientmetadata security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14738,34 +14782,10 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaGetClientResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaGetClientMetadataResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true - schema: - type: string - /v1/connectorPlatformRegions:enumerate: - parameters: *ref_39 - 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 829b9a3f..67469dd5 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/jobs.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/jobs.yaml @@ -10,7 +10,7 @@ info: delete job postings, as well as search jobs based on keywords and filters. version: v4 x-discovery-doc-revision: '20240404' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/talent-solution/job-search/docs/ servers: @@ -3075,7 +3075,7 @@ components: - '2' x-stackQL-resources: operations: - id: jobs.operations + id: google.jobs.operations name: operations title: Operations methods: @@ -3093,7 +3093,7 @@ components: update: [] delete: [] tenants: - id: jobs.tenants + id: google.jobs.tenants name: tenants title: Tenants methods: @@ -3140,15 +3140,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/tenants/methods/list' - $ref: '#/components/x-stackQL-resources/tenants/methods/get' + - $ref: '#/components/x-stackQL-resources/tenants/methods/list' insert: - $ref: '#/components/x-stackQL-resources/tenants/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/tenants/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/tenants/methods/delete' companies: - id: jobs.companies + id: google.jobs.companies name: companies title: Companies methods: @@ -3193,15 +3194,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/companies/methods/list' - $ref: '#/components/x-stackQL-resources/companies/methods/get' + - $ref: '#/components/x-stackQL-resources/companies/methods/list' insert: - $ref: '#/components/x-stackQL-resources/companies/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/companies/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/companies/methods/delete' client_events: - id: jobs.client_events + id: google.jobs.client_events name: client_events title: Client_events methods: @@ -3219,7 +3221,7 @@ components: update: [] delete: [] jobs: - id: jobs.jobs + id: google.jobs.jobs name: jobs title: Jobs methods: @@ -3299,11 +3301,12 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/jobs/methods/list' - $ref: '#/components/x-stackQL-resources/jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/jobs/methods/list' insert: - $ref: '#/components/x-stackQL-resources/jobs/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/jobs/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/jobs/methods/delete' paths: 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 a6499204..64815059 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: '20240526' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/kms/ servers: @@ -34,71 +34,228 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse: - description: Response message for KeyTrackingService.SearchProtectedResources. + 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 - id: GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse + id: GoogleCloudKmsV1KeyOperationAttestationCertificateChains properties: - nextPageToken: + googlePartitionCerts: + items: + type: string + description: Google partition certificate chain corresponding to the attestation. + type: array + googleCardCerts: + type: array + description: Google card certificate chain corresponding to the attestation. + items: + type: string + caviumCerts: + description: Cavium certificate chain corresponding to the attestation. + type: array + items: + type: string + GoogleCloudKmsInventoryV1ProtectedResource: + type: object + properties: + 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. + projectId: + type: string + description: The ID of the project that owns the resource. + cryptoKeyVersions: + type: array + 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 + cloudProduct: + description: 'The Cloud product that owns the resource. Example: `compute`' + type: string + name: + description: >- + The full resource name of the resource. Example: + `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. + type: string + location: + type: string + description: >- + Location can be `global`, regional like `us-east1`, or zonal like + `us-west1-b`. + resourceType: + description: 'Example: `compute.googleapis.com/Disk`' 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 + project: + description: 'Format: `projects/{PROJECT_NUMBER}`.' + type: string + labels: + description: A key-value pair of the resource's labels (v1) to their values. + type: object + additionalProperties: + type: string + description: Metadata about a resource protected by a Cloud KMS key. + id: GoogleCloudKmsInventoryV1ProtectedResource + GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse: + 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 protectedResources: description: Protected resources for this page. items: $ref: '#/components/schemas/GoogleCloudKmsInventoryV1ProtectedResource' type: array - GoogleCloudKmsV1CryptoKeyVersion: - id: GoogleCloudKmsV1CryptoKeyVersion + description: Response message for KeyTrackingService.SearchProtectedResources. + id: GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse + type: object + GoogleCloudKmsV1KeyOperationAttestation: 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. + 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: - externalProtectionLevelOptions: + format: + enum: + - ATTESTATION_FORMAT_UNSPECIFIED + - CAVIUM_V1_COMPRESSED + - CAVIUM_V2_COMPRESSED + readOnly: true + description: Output only. The format of the attestation data. + 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 + readOnly: true 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' - generationFailureReason: + Output only. The certificate chains needed to validate the + attestation + content: readOnly: true + format: byte + description: >- + Output only. The attestation data provided by the HSM when the key + operation was performed. type: string + type: object + GoogleCloudKmsInventoryV1ProtectedResourcesSummary: + id: GoogleCloudKmsInventoryV1ProtectedResourcesSummary + properties: + resourceTypes: + type: object + additionalProperties: + type: string + format: int64 description: >- - Output only. The root cause of the most recent generation failure. - Only present if state is GENERATION_FAILED. - importJob: + The number of resources protected by the key grouped by resource + type. + resourceCount: + format: int64 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. + The total number of protected resources in the same Cloud + organization as the key. + type: string + name: + description: >- + The full name of the ProtectedResourcesSummary resource. Example: + projects/test-project/locations/us/keyRings/test-keyring/cryptoKeys/test-key/protectedResourcesSummary + type: string + cloudProducts: + description: >- + The number of resources protected by the key grouped by Cloud + product. + additionalProperties: + format: int64 + type: string + type: object + 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. + type: integer + locations: + description: The number of resources protected by the key grouped by region. + additionalProperties: + format: int64 + type: string + type: object + description: >- + Aggregate information about the resources protected by a Cloud KMS key + in the same Cloud organization as the key. + type: object + GoogleCloudKmsV1CryptoKeyVersion: + type: object + properties: + destroyTime: + format: google-datetime + readOnly: true + description: >- + Output only. The time this CryptoKeyVersion's key material is + scheduled for destruction. Only present if state is + DESTROY_SCHEDULED. type: string + reimportEligible: + type: boolean readOnly: true + description: >- + Output only. Whether or not this key version is eligible for + reimport, by being specified as a target in + ImportCryptoKeyVersionRequest.crypto_key_version. + 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' importFailureReason: + type: string + readOnly: true description: >- Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. - type: string - readOnly: true importTime: format: google-datetime + type: string + readOnly: true description: >- Output only. The time at which this CryptoKeyVersion's key material was most recently imported. - readOnly: true - type: string - createTime: - readOnly: true - description: Output only. The time at which this CryptoKeyVersion was created. - format: google-datetime - type: string state: description: The current state of the CryptoKeyVersion. - type: string enum: - CRYPTO_KEY_VERSION_STATE_UNSPECIFIED - PENDING_GENERATION @@ -154,68 +311,64 @@ components: key material residing in an external key manager was destroyed. Additional details can be found in CryptoKeyVersion.external_destruction_failure_reason. - protectionLevel: - 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. type: string - enum: - - PROTECTION_LEVEL_UNSPECIFIED - - SOFTWARE - - HSM - - EXTERNAL - - EXTERNAL_VPC - generateTime: + name: description: >- - Output only. The time this CryptoKeyVersion's key material was - generated. - readOnly: true - type: string - format: google-datetime - externalDestructionFailureReason: + Output only. The resource name for this CryptoKeyVersion in the + format + `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. 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 - destroyEventTime: - readOnly: true - description: >- - Output only. The time this CryptoKeyVersion's key material was - destroyed. Only present if state is DESTROYED. - type: string - format: google-datetime - reimportEligible: - 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. - readOnly: true - name: - readOnly: true - description: >- - Output only. The resource name for this CryptoKeyVersion in the - format - `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. - type: string 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. + readOnly: true + $ref: '#/components/schemas/GoogleCloudKmsV1KeyOperationAttestation' algorithm: + description: >- + Output only. The CryptoKeyVersionAlgorithm that this + CryptoKeyVersion supports. 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 enumDescriptions: - Not specified. - Creates symmetric encryption keys. @@ -266,290 +419,101 @@ components: Algorithm representing symmetric encryption by an external key manager. readOnly: true - 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 + protectionLevel: + 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: >- - Output only. The CryptoKeyVersionAlgorithm that this - CryptoKeyVersion supports. - destroyTime: + Output only. The ProtectionLevel describing how crypto operations + are performed with this CryptoKeyVersion. + enum: + - PROTECTION_LEVEL_UNSPECIFIED + - SOFTWARE + - HSM + - EXTERNAL + - EXTERNAL_VPC + readOnly: true type: string + createTime: readOnly: true - description: >- - Output only. The time this CryptoKeyVersion's key material is - scheduled for destruction. Only present if state is - DESTROY_SCHEDULED. + description: Output only. The time at which this CryptoKeyVersion was created. format: google-datetime - type: object - GoogleCloudKmsV1KeyOperationAttestationCertificateChains: - properties: - googleCardCerts: - type: array - description: Google card certificate chain corresponding to the attestation. - items: - type: string - googlePartitionCerts: - type: array - items: - type: string - description: Google partition certificate chain corresponding to the attestation. - caviumCerts: - items: - type: string - type: array - description: Cavium certificate chain corresponding to the attestation. - 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 - GoogleCloudKmsInventoryV1ListCryptoKeysResponse: - properties: - nextPageToken: type: string + generationFailureReason: + readOnly: true description: >- - The page token returned from the previous response if the next page - is desired. - cryptoKeys: - type: array - items: - $ref: '#/components/schemas/GoogleCloudKmsV1CryptoKey' - description: The list of CryptoKeys. - id: GoogleCloudKmsInventoryV1ListCryptoKeysResponse - description: Response message for KeyDashboardService.ListCryptoKeys. - type: object - 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. - type: object - id: GoogleCloudKmsV1ExternalProtectionLevelOptions - properties: - externalKeyUri: - description: >- - The URI for an external resource that this CryptoKeyVersion - represents. - type: string - 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. + Output only. The root cause of the most recent generation failure. + Only present if state is GENERATION_FAILED. type: string - GoogleCloudKmsInventoryV1ProtectedResourcesSummary: - properties: - cloudProducts: - additionalProperties: - format: int64 - type: string - type: object - description: >- - The number of resources protected by the key grouped by Cloud - product. - locations: - description: The number of resources protected by the key grouped by region. - type: object - additionalProperties: - type: string - format: int64 - resourceCount: - description: >- - The total number of protected resources in the same Cloud - organization as the key. + destroyEventTime: + readOnly: true + format: google-datetime type: string - format: int64 - projectCount: description: >- - The number of distinct Cloud projects in the same Cloud organization - as the key that have resources protected by the key. - type: integer - format: int32 - name: + Output only. The time this CryptoKeyVersion's key material was + destroyed. Only present if state is DESTROYED. + importJob: description: >- - The full name of the ProtectedResourcesSummary resource. Example: - projects/test-project/locations/us/keyRings/test-keyring/cryptoKeys/test-key/protectedResourcesSummary + 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 - resourceTypes: - description: >- - The number of resources protected by the key grouped by resource - type. - type: object - additionalProperties: - format: int64 - type: string - description: >- - Aggregate information about the resources protected by a Cloud KMS key - in the same Cloud organization as the key. - type: object - id: GoogleCloudKmsInventoryV1ProtectedResourcesSummary - 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 - type: object - properties: - certChains: - description: >- - Output only. The certificate chains needed to validate the - attestation readOnly: true - $ref: >- - #/components/schemas/GoogleCloudKmsV1KeyOperationAttestationCertificateChains - content: + generateTime: readOnly: true type: string + format: google-datetime description: >- - Output only. The attestation data provided by the HSM when the key - operation was performed. - format: byte - format: - enum: - - ATTESTATION_FORMAT_UNSPECIFIED - - CAVIUM_V1_COMPRESSED - - CAVIUM_V2_COMPRESSED - 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. + Output only. The time this CryptoKeyVersion's key material was + generated. + 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 - description: Output only. The format of the attestation data. - GoogleCloudKmsInventoryV1ProtectedResource: + 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. + GoogleCloudKmsInventoryV1ListCryptoKeysResponse: properties: - location: - description: >- - Location can be `global`, regional like `us-east1`, or zonal like - `us-west1-b`. - type: string - cryptoKeyVersions: - 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. + cryptoKeys: + description: The list of CryptoKeys. type: array items: - type: string - cloudProduct: - description: 'The Cloud product that owns the resource. Example: `compute`' - type: string - 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. - labels: - additionalProperties: - type: string - description: A key-value pair of the resource's labels (v1) to their values. - type: object - projectId: - type: string - description: The ID of the project that owns the resource. - project: - description: 'Format: `projects/{PROJECT_NUMBER}`.' - type: string - 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. - name: + $ref: '#/components/schemas/GoogleCloudKmsV1CryptoKey' + nextPageToken: description: >- - The full resource name of the resource. Example: - `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. - type: string - resourceType: + The page token returned from the previous response if the next page + is desired. type: string - description: 'Example: `compute.googleapis.com/Disk`' - description: Metadata about a resource protected by a Cloud KMS key. - id: GoogleCloudKmsInventoryV1ProtectedResource + description: Response message for KeyDashboardService.ListCryptoKeys. + id: GoogleCloudKmsInventoryV1ListCryptoKeysResponse type: object GoogleCloudKmsV1CryptoKey: + 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. properties: - 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' + name: readOnly: true - 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 - destroyScheduledDuration: - type: string - format: google-duration 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 24 hours. - importOnly: - description: Immutable. Whether this key may contain imported versions only. - type: boolean + Output only. The resource name for this CryptoKey in the format + `projects/*/locations/*/keyRings/*/cryptoKeys/*`. purpose: + type: string enum: - CRYPTO_KEY_PURPOSE_UNSPECIFIED - ENCRYPT_DECRYPT @@ -557,7 +521,6 @@ components: - ASYMMETRIC_DECRYPT - RAW_ENCRYPT_DECRYPT - MAC - type: string description: Immutable. The immutable purpose of this CryptoKey. enumDescriptions: - Not specified. @@ -574,19 +537,33 @@ components: symmetric encryption and does not support automatic CryptoKey rotation. - CryptoKeys with this purpose may be used with MacSign. - name: - description: >- - Output only. The resource name for this CryptoKey in the format - `projects/*/locations/*/keyRings/*/cryptoKeys/*`. - type: string - readOnly: true - createTime: + cryptoKeyBackend: type: string - readOnly: true - description: Output only. The time at which this CryptoKey was created. - format: google-datetime + 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. + 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). + 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' nextRotationTime: - format: google-datetime + type: string description: >- At next_rotation_time, the Key Management Service will automatically: 1. Create a new version of this CryptoKey. 2. Mark @@ -594,15 +571,12 @@ 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. - type: string - 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' + format: google-datetime + importOnly: + type: boolean + description: Immutable. Whether this key may contain imported versions only. rotationPeriod: + format: google-duration type: string description: >- next_rotation_time will be advanced by this period when the service @@ -610,24 +584,72 @@ components: 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. + 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 24 hours. + type: string format: google-duration - labels: + createTime: + description: Output only. The time at which this CryptoKey was created. + type: string + readOnly: true + format: google-datetime + primary: + $ref: '#/components/schemas/GoogleCloudKmsV1CryptoKeyVersion' description: >- - Labels with user-defined metadata. For more information, see - [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys). - type: object - additionalProperties: - type: string - type: object - 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. - id: GoogleCloudKmsV1CryptoKey + 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 GoogleCloudKmsV1CryptoKeyVersionTemplate: 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. + 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 enumDescriptions: - Not specified. - Creates symmetric encryption keys. @@ -677,58 +699,17 @@ components: - >- Algorithm representing symmetric encryption by an external key manager. - 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. + type: string protectionLevel: - description: >- - ProtectionLevel to use when creating a CryptoKeyVersion based on - this template. Immutable. Defaults to SOFTWARE. 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. type: string enum: - PROTECTION_LEVEL_UNSPECIFIED @@ -736,56 +717,74 @@ components: - HSM - EXTERNAL - EXTERNAL_VPC + type: object 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. id: GoogleCloudKmsV1CryptoKeyVersionTemplate + GoogleCloudKmsV1ExternalProtectionLevelOptions: + id: GoogleCloudKmsV1ExternalProtectionLevelOptions + properties: + 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. + externalKeyUri: + type: string + description: >- + The URI for an external resource that this CryptoKeyVersion + represents. + 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. type: object parameters: - _.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' access_token: description: OAuth access token. in: query name: access_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 - 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 - 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 + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv schema: type: string enum: - - json - - media - - proto + - '1' + - '2' quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -795,36 +794,37 @@ components: name: quotaUser 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 - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + type: string + enum: + - json + - media + - proto + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: uploadType + 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 - 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 x-stackQL-resources: protected_resources: - id: kmsinventory.protected_resources + id: google.kmsinventory.protected_resources name: protected_resources title: Protected_resources methods: @@ -841,7 +841,7 @@ components: update: [] delete: [] crypto_keys_protected_resources_summary: - id: kmsinventory.crypto_keys_protected_resources_summary + id: google.kmsinventory.crypto_keys_protected_resources_summary name: crypto_keys_protected_resources_summary title: Crypto_keys_protected_resources_summary methods: @@ -860,7 +860,7 @@ components: update: [] delete: [] crypto_keys: - id: kmsinventory.crypto_keys + id: google.kmsinventory.crypto_keys name: crypto_keys title: Crypto_keys methods: @@ -883,17 +883,17 @@ components: paths: /v1/organizations/{organizationsId}/protectedResources:search: parameters: &ref_3 - - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/prettyPrint' get: description: >- Returns metadata about the resources protected by the given Cloud KMS @@ -922,15 +922,15 @@ paths: name: cryptoKey schema: type: string + - in: query + name: resourceTypes + schema: + type: string - in: query name: pageSize 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 993c6982..b48a7789 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: '20240526' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/natural-language/ servers: @@ -40,2719 +40,2190 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - XPSTablesConfidenceMetricsEntry: - id: XPSTablesConfidenceMetricsEntry + ModerateTextRequest: + type: object + id: ModerateTextRequest properties: - trueNegativeCount: + document: + $ref: '#/components/schemas/Document' + description: Required. Input document. + description: The document moderation request message. + XPSVideoObjectTrackingTrainResponse: + properties: + 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 - description: True negative count. - truePositiveCount: - description: True positive count. - type: string - format: int64 - falseNegativeCount: + 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. + id: XPSVideoObjectTrackingTrainResponse + type: object + XPSTimestampStats: + properties: + medianTimestampNanos: type: string format: int64 - description: False negative count. - recall: - type: number - format: double - description: 'Recall = #true positives / (#true positives + #false negatives).' - falsePositiveRate: - description: 'FPR = #false positives / (#false positives + #true negatives)' - type: number - format: double - f1Score: - type: number + commonStats: + $ref: '#/components/schemas/XPSCommonStats' + granularStats: description: >- - The harmonic mean of recall and precision. (2 * precision * recall) - / (precision + recall) - format: double - confidenceThreshold: - description: The confidence threshold value used to compute the metrics. - type: number - format: double - truePositiveRate: - description: 'TPR = #true positives / (#true positives + #false negatvies)' - type: number - format: double - falsePositiveCount: - description: False positive count. - format: int64 - type: string - precision: - format: double - type: number - description: 'Precision = #true positives / (#true positives + #false positives).' + 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 + additionalProperties: + $ref: '#/components/schemas/XPSTimestampStatsGranularStats' + id: XPSTimestampStats + description: The data statistics of a series of TIMESTAMP values. type: object - description: Metrics for a single confidence threshold. - XPSEvaluationMetrics: - id: XPSEvaluationMetrics + XPSVideoActionMetricsEntry: + description: The Evaluation metrics entry given a specific precision_window_length. type: object + id: XPSVideoActionMetricsEntry properties: - imageSegmentationEvalMetrics: - $ref: '#/components/schemas/XPSImageSegmentationEvaluationMetrics' - translationEvalMetrics: - $ref: '#/components/schemas/XPSTranslationEvaluationMetrics' - videoClassificationEvalMetrics: - $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' - videoObjectTrackingEvalMetrics: - $ref: '#/components/schemas/XPSVideoObjectTrackingEvaluationMetrics' - imageClassificationEvalMetrics: - $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' - evaluatedExampleCount: - format: int32 - description: >- - The number of examples used to create this evaluation metrics - instance. - type: integer - textSentimentEvalMetrics: - $ref: '#/components/schemas/XPSTextSentimentEvaluationMetrics' - textExtractionEvalMetrics: - $ref: '#/components/schemas/XPSTextExtractionEvaluationMetrics' - videoActionRecognitionEvalMetrics: - $ref: '#/components/schemas/XPSVideoActionRecognitionEvaluationMetrics' - regressionEvalMetrics: - $ref: '#/components/schemas/XPSRegressionEvaluationMetrics' - textClassificationEvalMetrics: - $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' - tablesClassificationEvalMetrics: - $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' - category: - format: int32 - type: integer + meanAveragePrecision: + type: number + description: The mean average precision. + format: float + confidenceMetricsEntries: + type: array + items: + $ref: >- + #/components/schemas/XPSVideoActionMetricsEntryConfidenceMetricsEntry 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. - label: + 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 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. - imageObjectDetectionEvalMetrics: - $ref: '#/components/schemas/XPSImageObjectDetectionEvaluationMetrics' - annotationSpecIdToken: + 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 + XPSExportModelOutputConfig: + properties: + edgeTpuTfLiteFormat: + $ref: '#/components/schemas/XPSEdgeTpuTfLiteFormat' + exportFirebaseAuxiliaryInfo: 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. + For any model and format: If true, will additionally export + FirebaseExportedModelInfo in a firebase.txt file. + type: boolean + tfLiteFormat: + $ref: '#/components/schemas/XPSTfLiteFormat' + tfSavedModelFormat: + $ref: '#/components/schemas/XPSTfSavedModelFormat' + outputGcsUri: + description: >- + The Google Cloud Storage (GCS) directory where XPS will output the + exported models and related files. Format: gs://bucket/directory type: string - tablesEvalMetrics: - $ref: '#/components/schemas/XPSTablesEvaluationMetrics' - description: >- - Contains xPS-specific model evaluation metrics either for a single - annotation spec (label), or for the model overall. Next tag: 18. - TpuMetric: + tfJsFormat: + $ref: '#/components/schemas/XPSTfJsFormat' + coreMlFormat: + $ref: '#/components/schemas/XPSCoreMlFormat' + 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' type: object - id: TpuMetric + id: XPSExportModelOutputConfig + Document: + type: object + id: Document properties: - tpuSec: + 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: Required. Seconds of TPU usage, e.g. 3600. - format: int64 - tpuType: - description: Required. Type of TPU, e.g. TPU_V2, TPU_V3_POD. + languageCode: + 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. + type: string + type: + 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 + type: string enum: - - UNKNOWN_TPU_TYPE - - TPU_V2_POD - - TPU_V2 - - TPU_V3_POD - - TPU_V3 - - TPU_V5_LITEPOD + - TYPE_UNSPECIFIED + - PLAIN_TEXT + - HTML + content: + description: >- + The content of the input in string format. Cloud audit logging + exempt since it is based on user data. type: string - XPSDataErrors: - id: XPSDataErrors - type: object - description: Different types of errors and the stats associatesd with each error. + description: Represents the input to API methods. + 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. properties: - errorType: - enum: - - 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: string - description: Type of the error. - count: - description: Number of records having errors associated with the enum. - format: int32 - type: integer - EntityMention: + 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. + type: object + id: XPSImageExportModelSpec + XPSSpeechPreprocessResponse: + type: object + id: XPSSpeechPreprocessResponse properties: - type: - enumDescriptions: - - Unknown - - Proper name - - Common noun (or noun compound) - enum: - - TYPE_UNKNOWN - - PROPER - - COMMON - description: The type of the entity mention. + 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. + speechPreprocessStats: + description: Stats associated with the data. + $ref: '#/components/schemas/XPSSpeechPreprocessStats' + cnsTestDataPath: + description: Location od shards of sstables (test data) of DataUtterance protos. + type: string + cnsTrainDataPath: type: string - probability: - format: float - type: number 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. - text: - $ref: '#/components/schemas/TextSpan' - description: The mention text. + Location of shards of sstables (training data) of DataUtterance + protos. + Entity: + id: Entity + properties: + name: + type: string + description: The representative name for the entity. 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 sentiment expressed for this - mention of the entity in the provided document. - id: EntityMention - description: >- - Represents a mention for an entity in the text. Currently, proper noun - mentions are supported. - type: object - XPSStringStats: - type: object - id: XPSStringStats - properties: - topUnigramStats: - type: array + true, this field will contain the aggregate sentiment expressed for + this entity in the provided document. + $ref: '#/components/schemas/Sentiment' + mentions: items: - $ref: '#/components/schemas/XPSStringStatsUnigramStats' - description: >- - The statistics of the top 20 unigrams, ordered by - StringStats.UnigramStats.count. - commonStats: - $ref: '#/components/schemas/XPSCommonStats' - description: The data statistics of a series of STRING values. - XPSImageModelServingSpec: - type: object - description: Serving specification for image models. - properties: - nodeQps: - type: number - format: double + $ref: '#/components/schemas/EntityMention' description: >- - An estimated value of how much traffic a node can serve. Populated - for AutoMl request only. - modelThroughputEstimation: - items: - $ref: >- - #/components/schemas/XPSImageModelServingSpecModelThroughputEstimation - description: Populate under uCAIP request scope. + The mentions of this entity in the input document. The API currently + supports proper noun mentions. type: array - tfRuntimeVersion: - description: >- - ## The fields below are only populated under uCAIP request scope. - https://cloud.google.com/ml-engine/docs/runtime-version-list + type: type: string - id: XPSImageModelServingSpec - XPSExportModelOutputConfig: + description: The entity type. + enum: + - UNKNOWN + - PERSON + - LOCATION + - ORGANIZATION + - EVENT + - WORK_OF_ART + - CONSUMER_GOOD + - OTHER + - PHONE_NUMBER + - ADDRESS + - DATE + - NUMBER + - PRICE + 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`. + metadata: + type: object + additionalProperties: + type: string + description: >- + Metadata associated with the entity. For the metadata associated + with other entity types, see the Type table below. + 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. type: object + XPSEvaluationMetricsSet: + description: Specifies location of model evaluation metrics. + id: XPSEvaluationMetricsSet properties: - tfLiteFormat: - $ref: '#/components/schemas/XPSTfLiteFormat' - tfJsFormat: - $ref: '#/components/schemas/XPSTfJsFormat' - edgeTpuTfLiteFormat: - $ref: '#/components/schemas/XPSEdgeTpuTfLiteFormat' - tfSavedModelFormat: - $ref: '#/components/schemas/XPSTfSavedModelFormat' - coreMlFormat: - $ref: '#/components/schemas/XPSCoreMlFormat' - outputGcsUri: - type: string - description: >- - The Google Cloud Storage (GCS) directory where XPS will output the - exported models and related files. Format: gs://bucket/directory - exportFirebaseAuxiliaryInfo: - type: boolean + fileSpec: + $ref: '#/components/schemas/XPSFileSpec' description: >- - For any model and format: If true, will additionally export - FirebaseExportedModelInfo in a firebase.txt file. - dockerFormat: - $ref: '#/components/schemas/XPSDockerFormat' - outputGcrUri: + File spec containing evaluation metrics of a model, must point to + RecordIO file(s) of intelligence.cloud.automl.xps.EvaluationMetrics + messages. + evaluationMetrics: + type: array 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 - id: XPSExportModelOutputConfig - XPSVideoObjectTrackingTrainResponse: - properties: - exportModelSpec: - description: Populated for AutoML request only. - $ref: '#/components/schemas/XPSVideoExportModelSpec' - modelArtifactSpec: - $ref: '#/components/schemas/XPSVideoModelArtifactSpec' - description: '## The fields below are only populated under uCAIP request scope.' - trainCostNodeSeconds: + Inline EvaluationMetrics - should be relatively small. For passing + large quantities of exhaustive metrics, use file_spec. + items: + $ref: '#/components/schemas/XPSEvaluationMetrics' + numEvaluationMetrics: 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. + Number of the evaluation metrics (usually one per label plus + overall). format: int64 type: object - id: XPSVideoObjectTrackingTrainResponse - XPSVideoObjectTrackingEvaluationMetrics: + XPSVisualization: + id: XPSVisualization + description: Visualization configurations for image explanation. type: object - description: 'Model evaluation metrics for ObjectTracking problems. Next tag: 10.' + deprecated: true properties: - boundingBoxMetricsEntries: - items: - $ref: '#/components/schemas/XPSBoundingBoxMetricsEntry' + type: + 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: >- - 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 - 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 - 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. - type: array - items: - $ref: '#/components/schemas/XPSTrackMetricsEntry' - evaluatedFrameCount: - type: integer - description: The number of video frames used for model evaluation. - format: int32 - trackMeanMismatchRate: + 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 + type: string + polarity: description: >- - Output only. The single metric for tracking consistency evaluation: - the mean_mismatch_rate averaged over all track_metrics_entries. - format: float - type: number - trackMeanBoundingBoxIou: - type: number + Whether to only highlight pixels with positive contributions, + negative or both. Defaults to POSITIVE. + type: string + enum: + - POLARITY_UNSPECIFIED + - POSITIVE + - NEGATIVE + - BOTH + 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. + clipPercentLowerbound: description: >- - Output only. The single metric for tracks bounding box iou - evaluation: the mean_bounding_box_iou averaged over all - track_metrics_entries. - format: float - trackMeanAveragePrecision: + Excludes attributions below the specified percentile, from the + highlighted areas. Defaults to 62. format: float type: number - description: >- - Output only. The single metric for tracks accuracy evaluation: the - mean_average_precision averaged over all track_metrics_entries. - evaluatedTrackCount: - format: int32 - type: integer - description: The number of tracks used for model evaluation. - id: XPSVideoObjectTrackingEvaluationMetrics - XPSVideoActionMetricsEntry: - description: The Evaluation metrics entry given a specific precision_window_length. - id: XPSVideoActionMetricsEntry - properties: - precisionWindowLength: - format: google-duration + overlayType: 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. 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. - confidenceMetricsEntries: - type: array + 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: >- - 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 - meanAveragePrecision: + 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 - description: The mean average precision. type: number - type: object - XPSImageObjectDetectionModelSpec: - type: object - properties: - exportModelSpec: - $ref: '#/components/schemas/XPSImageExportModelSpec' - classCount: - description: Total number of classes. - format: int64 - type: string - modelArtifactSpec: - $ref: '#/components/schemas/XPSImageModelArtifactSpec' - description: '## The fields below are only populated under uCAIP request scope.' - stopReason: + colorMap: type: string + 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: - - '' - - '' - - Model fully converged, can not be resumbed training. + - Should not be used. + - 'Positive: green. Negative: pink.' - >- - Model early converged, can be further trained till full - convergency. + 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: - - TRAIN_STOP_REASON_UNSPECIFIED - - TRAIN_STOP_REASON_BUDGET_REACHED - - TRAIN_STOP_REASON_MODEL_CONVERGED - - TRAIN_STOP_REASON_MODEL_EARLY_STOPPED + - COLOR_MAP_UNSPECIFIED + - PINK_GREEN + - VIRIDIS + - RED + - GREEN + - RED_GREEN + - PINK_WHITE_GREEN + XPSCoreMlFormat: + id: XPSCoreMlFormat + type: object + properties: {} + description: A model format used for iOS mobile devices. + EntityMention: + description: >- + Represents a mention for an entity in the text. Currently, proper noun + mentions are supported. + type: object + properties: + probability: description: >- - Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', - 'MODEL_CONVERGED'. - modelServingSpec: - $ref: '#/components/schemas/XPSImageModelServingSpec' - maxBoundingBoxCount: - format: int64 - description: Max number of bounding box. - type: string - trainCostNodeSeconds: - format: int64 + 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 + type: type: string + description: The type of the entity mention. + enumDescriptions: + - Unknown + - Proper name + - Common noun (or noun compound) + enum: + - TYPE_UNKNOWN + - PROPER + - COMMON + text: + description: The mention text. + $ref: '#/components/schemas/TextSpan' + sentiment: + $ref: '#/components/schemas/Sentiment' 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. - id: XPSImageObjectDetectionModelSpec - XPSTextTrainResponse: - id: XPSTextTrainResponse + 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 + XPSVideoExportModelSpec: properties: - componentModel: + exportModelOutputConfig: type: array - description: Component submodels. items: - $ref: '#/components/schemas/XPSTextComponentModel' - type: object - XPSTfLiteFormat: + $ref: '#/components/schemas/XPSExportModelOutputConfig' + 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. description: >- - LINT.IfChange A model format used for mobile and IoT devices. See - https://www.tensorflow.org/lite. - id: XPSTfLiteFormat + 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. type: object + id: XPSVideoExportModelSpec + XPSTfJsFormat: properties: {} - XPSResponseExplanationParameters: - id: XPSResponseExplanationParameters + description: >- + A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used + in the browser and in Node.js using JavaScript. type: object + id: XPSTfJsFormat + XPSColumnSpecCorrelatedColumn: 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' + correlationStats: + $ref: '#/components/schemas/XPSCorrelationStats' + columnId: + type: integer + format: int32 + type: object + id: XPSColumnSpecCorrelatedColumn + description: >- + Identifies a table's column, and its correlation with the column this + ColumnSpec describes. + XPSTablesModelStructureModelParametersParameter: + id: XPSTablesModelStructureModelParametersParameter + properties: + floatValue: + format: double + description: Float type parameter value. + type: number + stringValue: + description: String type parameter value. + type: string + name: + type: string + description: Parameter name. + intValue: + description: Integer type parameter value. + format: int64 + type: string + type: object + XPSExampleSet: + description: Set of examples or input sources. + properties: + numInputSources: + type: string + description: Number of input sources. + format: int64 + fingerprint: + description: Fingerprint of the example set. + format: int64 + type: string + numExamples: + type: string + format: int64 + description: Number of examples. + fileSpec: + $ref: '#/components/schemas/XPSFileSpec' + description: File spec of the examples or input sources. + id: XPSExampleSet + type: object + XPSBoundingBoxMetricsEntryConfidenceMetricsEntry: + type: object + id: XPSBoundingBoxMetricsEntryConfidenceMetricsEntry + properties: + recall: + type: number + description: Recall for the given confidence threshold. + format: float + f1Score: + format: float + description: The harmonic mean of recall and precision. + type: number + confidenceThreshold: + description: The confidence threshold value used to compute the metrics. + type: number + format: float + precision: + description: Precision for the given confidence threshold. + type: number + format: float + description: Metrics for a single confidence threshold. + XPSTranslationPreprocessResponse: + type: object + id: XPSTranslationPreprocessResponse + description: Translation preprocess response. + properties: + validExampleCount: + type: string + description: Total valid example count. + format: int64 + parsedExampleCount: + type: string + description: Total example count parsed. + format: int64 + XPSTablesRegressionMetrics: + description: Metrics for Tables regression problems. + id: XPSTablesRegressionMetrics + type: object + properties: + rootMeanSquaredError: + type: number + format: double + description: Root mean squared error. + rSquared: + description: R squared. + format: double + type: number + meanAbsoluteError: + type: number + format: double + description: Mean absolute error. + regressionMetricsEntries: 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 - deprecated: true - Status: + A list of actual versus predicted points for the model being + evaluated. + items: + $ref: '#/components/schemas/XPSRegressionMetricsEntry' + type: array + rootMeanSquaredLogError: + format: double + description: Root mean squared log error. + type: number + meanAbsolutePercentageError: + description: >- + Mean absolute percentage error, only set if all of the target + column's values are positive. + type: number + format: double + XPSFloat64Stats: + id: XPSFloat64Stats type: object + description: The data statistics of a series of FLOAT64 values. properties: - message: + mean: + description: The mean of the series. + format: double + type: number + commonStats: + $ref: '#/components/schemas/XPSCommonStats' + histogramBuckets: + items: + $ref: '#/components/schemas/XPSFloat64StatsHistogramBucket' + 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. - type: string - details: + 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"`. + standardDeviation: + type: number + format: double + description: The standard deviation of the series. + quantiles: items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. + 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. + 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 - code: + XPSRegressionMetricsEntry: + 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. + type: number + format: float + type: object + description: A pair of actual & observed values for the model being evaluated. + id: XPSRegressionMetricsEntry + XPSDataErrors: + description: Different types of errors and the stats associatesd with each error. + properties: + errorType: + description: Type of the error. + enum: + - 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: string + count: 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 - 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 - RamMetric: + description: Number of records having errors associated with the enum. + id: XPSDataErrors type: object - id: RamMetric + XPSTextSentimentEvaluationMetrics: + description: Model evaluation metrics for text sentiment problems. properties: - machineSpec: - 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_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. - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - memories: - description: Required. VM memory in gb. - format: double - type: number - gibSec: - description: >- - Required. VM memory in Gigabyte second, e.g. 3600. Using int64 type - to match billing metrics definition. - type: string - format: int64 - 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: - 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: string - description: Required. Type of ram. - Sentiment: - description: >- - Represents the feeling associated with the entire text or entities in - the text. - properties: - magnitude: - format: float - 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 - score: - description: >- - Sentiment score between -1.0 (negative sentiment) and 1.0 (positive - sentiment). - format: float - type: number - id: Sentiment - type: object - XPSVisionErrorAnalysisConfig: - properties: - queryType: - 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 - 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. - exampleCount: - format: int32 - type: integer - description: The number of query examples in error analysis. - id: XPSVisionErrorAnalysisConfig - description: 'The vision model error analysis configuration. Next tag: 3' - type: object - XPSResponseExplanationMetadataOutputMetadata: - description: Metadata of the prediction output to be explained. - id: XPSResponseExplanationMetadataOutputMetadata - properties: - outputTensorName: - description: Name of the output tensor. Only needed in train response. - type: string - type: object - AnnotateTextRequest: - properties: - document: - $ref: '#/components/schemas/Document' - description: Required. Input document. - features: - $ref: '#/components/schemas/AnnotateTextRequestFeatures' - description: Required. The enabled features. - 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. - enum: - - NONE - - UTF8 - - UTF16 - - UTF32 - description: The encoding type used by the API to calculate offsets. - description: >- - The request message for the text annotation API, which can perform - multiple analysis types in one call. - type: object - id: AnnotateTextRequest - XPSCoreMlFormat: - type: object - description: A model format used for iOS mobile devices. - properties: {} - id: XPSCoreMlFormat - XPSFloat64StatsHistogramBucket: - description: A bucket of a histogram. - properties: - min: - type: number - format: double - description: The minimum value of the bucket, inclusive. - max: - format: double - type: number - description: >- - The maximum value of the bucket, exclusive unless max = - `"Infinity"`, in which case it's 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. - id: XPSFloat64StatsHistogramBucket - type: object - XPSVideoActionRecognitionTrainResponse: - type: object - id: XPSVideoActionRecognitionTrainResponse - properties: - modelArtifactSpec: - $ref: '#/components/schemas/XPSVideoModelArtifactSpec' - description: '## The fields below are only populated under uCAIP request scope.' - 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. - type: string - format: int64 - XPSImageModelServingSpecModelThroughputEstimation: - properties: - latencyInMilliseconds: - description: Estimated latency. - type: number - format: double - servomaticPartitionType: - 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 - 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. - - 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 - - TPU_V2 - - TPU_V3 - - TPU_V4_POD - - TPU_V5_LITEPOD - type: string - nodeQps: - type: number - description: The approximate qps a deployed node can serve. - format: double - id: XPSImageModelServingSpecModelThroughputEstimation - type: object - XPSTimestampStats: - properties: - 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). - commonStats: - $ref: '#/components/schemas/XPSCommonStats' - medianTimestampNanos: - type: string - format: int64 - type: object - description: The data statistics of a series of TIMESTAMP values. - id: XPSTimestampStats - XPSCategoryStats: - properties: - commonStats: - $ref: '#/components/schemas/XPSCommonStats' - topCategoryStats: - description: >- - The statistics of the top 20 CATEGORY values, ordered by - CategoryStats.SingleCategoryStats.count. - type: array - items: - $ref: '#/components/schemas/XPSCategoryStatsSingleCategoryStats' - type: object - id: XPSCategoryStats - description: The data statistics of a series of CATEGORY values. - ClassifyTextResponse: - id: ClassifyTextResponse - 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. - categories: - description: Categories representing the input document. - type: array - items: - $ref: '#/components/schemas/ClassificationCategory' - 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 - type: object - description: The document classification response message. - XPSTuningTrial: - id: XPSTuningTrial - type: object - properties: - trainingObjectivePoint: - $ref: '#/components/schemas/XPSTrainingObjectivePoint' - description: The optimization objective evaluation of the eval split data. - modelStructure: - $ref: '#/components/schemas/XPSTablesModelStructure' - description: Model parameters for the trial. - 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. - 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: - type: string - enum: - - GPU_ARCHITECTURE_UNSPECIFIED - - GPU_ARCHITECTURE_NVIDIA - enumDescriptions: - - '' - - '' - description: >- - Optional. Additional gpu information describing the requirements for - the to be exported model files. - cpuArchitecture: - description: >- - Optional. Additional cpu information describing the requirements for - the to be exported model files. - type: string - enumDescriptions: - - '' - - '' - enum: - - CPU_ARCHITECTURE_UNSPECIFIED - - CPU_ARCHITECTURE_X86_64 - type: object - XPSVideoModelArtifactSpec: - properties: - 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. - id: XPSVideoModelArtifactSpec - type: object - XPSVideoTrainingOperationMetadata: - id: XPSVideoTrainingOperationMetadata - type: object - properties: - trainCostMilliNodeHour: - 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 - type: string - XPSCorrelationStats: - type: object - 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. - properties: - cramersV: - description: The correlation value using the Cramer's V measure. - format: double - type: number - id: XPSCorrelationStats - XPSVisualization: - properties: - clipPercentLowerbound: - format: float - type: number - description: >- - Excludes attributions below the specified percentile, from the - highlighted areas. Defaults to 62. - 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. - polarity: - description: >- - Whether to only highlight pixels with positive contributions, - negative or both. Defaults to POSITIVE. - enum: - - POLARITY_UNSPECIFIED - - POSITIVE - - NEGATIVE - - BOTH - 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. - type: - enum: - - TYPE_UNSPECIFIED - - PIXELS - - OUTLINES - type: string - 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: >- - 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. - 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 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. - 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. - type: object - description: Visualization configurations for image explanation. - id: XPSVisualization - deprecated: true - XPSTranslationTrainResponse: - id: XPSTranslationTrainResponse - type: object - description: Train response for translation. - properties: - modelType: - type: string - enumDescriptions: - - Default - - Legacy model. Will be deprecated. - - Current model. - description: Type of the model. - enum: - - MODEL_TYPE_UNSPECIFIED - - LEGACY - - CURRENT - XPSBatchPredictResponse: - 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. - type: object - id: XPSBatchPredictResponse - XPSRow: - properties: - values: - type: array - items: - type: any + recall: + format: float + description: Output only. Recall. + type: number + precision: + description: Output only. Precision. + format: float + type: number + quadraticKappa: + format: float 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. - columnIds: - items: - format: int32 - type: integer + Output only. Quadratic weighted kappa. Only set for the overall + model evaluation, not for evaluation of a single annotation spec. + type: number + meanSquaredError: + type: number + format: float description: >- - The ids of the columns. Note: The below `values` field must match - order of this field, if this field is set. - type: array - type: object - id: XPSRow - XPSTextToSpeechTrainResponse: - type: object - id: XPSTextToSpeechTrainResponse - description: TextToSpeech train response - properties: {} - CpuMetric: - type: object - description: Metric for billing reports. - id: CpuMetric - properties: - coreSec: - format: int64 - description: Required. Total seconds of core usage, e.g. 4. - type: string - 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 - - '' - - '' - - '' - - '' - 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 - type: string - coreNumber: - type: string - description: Required. Number of CPU cores. - format: int64 - machineSpec: - 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_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 + Output only. Mean squared error. Only set for the overall model + evaluation, not for evaluation of a single annotation spec. + meanAbsoluteError: + format: float + description: >- + Output only. Mean absolute error. Only set for the overall model + evaluation, not for evaluation of a single annotation spec. + 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. + f1Score: + type: number + format: float + description: Output only. The harmonic mean of recall and precision. + 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' + type: object + id: XPSTextSentimentEvaluationMetrics + XPSTablesTrainingOperationMetadata: + properties: + trainingObjectivePoints: + 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. + type: array + trainingStartTime: + type: string + description: Timestamp when training process starts. + format: google-datetime + topTrials: + items: + $ref: '#/components/schemas/XPSTuningTrial' + type: array + 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. + createModelStage: + enum: + - CREATE_MODEL_STAGE_UNSPECIFIED + - DATA_PREPROCESSING + - TRAINING + - EVALUATING + - MODEL_POST_PROCESSING + type: string enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - description: Required. Machine spec, e.g. N1_STANDARD_4. - trackingLabels: - additionalProperties: - type: string - type: object + - Unspecified stage. + - Prepare the model training pipeline and run data processing. + - Training model. + - Run evaluation. + - Finalizing model training pipeline. + description: Current stage of creating model. + trainBudgetMilliNodeHours: + format: int64 + type: string + description: Creating model budget. + optimizationObjective: + type: string + description: The optimization objective for model. + id: XPSTablesTrainingOperationMetadata + type: object + XPSClassificationEvaluationMetrics: + properties: + auPrc: + format: float + type: number + description: The Area under precision recall curve metric. + evaluatedExamplesCount: + format: int32 + type: integer + description: The number of examples used for model evaluation. + confidenceMetricsEntries: + description: >- + Metrics that have confidence thresholds. Precision-recall curve can + be derived from it. + type: array + items: + $ref: '#/components/schemas/XPSConfidenceMetricsEntry' + confusionMatrix: + 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. + $ref: '#/components/schemas/XPSConfusionMatrix' + auRoc: 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" - XPSDataStats: + The Area Under Receiver Operating Characteristic curve metric. + Micro-averaged for the overall evaluation. + format: float + type: number + baseAuPrc: + description: The Area under precision recall curve metric based on priors. + type: number + format: float + logLoss: + description: The Log Loss metric. + type: number + format: float + description: >- + Model evaluation metrics for classification problems. It can be used for + image and video classification. Next tag: 9. + id: XPSClassificationEvaluationMetrics + type: object + XPSVideoTrainingOperationMetadata: + id: XPSVideoTrainingOperationMetadata type: object - description: The data statistics of a series of values that share the same DataType. - id: XPSDataStats properties: - timestampStats: - description: The statistics for TIMESTAMP DataType. - $ref: '#/components/schemas/XPSTimestampStats' - arrayStats: - $ref: '#/components/schemas/XPSArrayStats' - description: The statistics for ARRAY DataType. - float64Stats: - $ref: '#/components/schemas/XPSFloat64Stats' - description: The statistics for FLOAT64 DataType. - stringStats: - description: The statistics for STRING DataType. - $ref: '#/components/schemas/XPSStringStats' - structStats: - $ref: '#/components/schemas/XPSStructStats' - description: The statistics for STRUCT DataType. - categoryStats: - description: The statistics for CATEGORY DataType. - $ref: '#/components/schemas/XPSCategoryStats' + trainCostMilliNodeHour: + format: int64 + 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. + type: string + 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' + description: The model binary files in different formats for model export. + type: array + ClassifyTextRequest: + id: ClassifyTextRequest + description: The document classification request message. + properties: + document: + $ref: '#/components/schemas/Document' + description: Required. Input document. + type: object + TextSpan: + id: 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. + format: int32 + type: integer + description: Represents a text span in the input document. + AnalyzeSentimentResponse: + 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: The sentiment for all the sentences in the document. + items: + $ref: '#/components/schemas/Sentence' + type: array + languageSupported: + 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 + documentSentiment: + $ref: '#/components/schemas/Sentiment' + description: The overall sentiment of the input document. + id: AnalyzeSentimentResponse + type: object + description: The sentiment analysis response message. + XPSVideoActionRecognitionEvaluationMetrics: + properties: + evaluatedActionCount: + format: int32 + description: >- + Output only. The number of ground truth actions used to create this + evaluation. + type: integer + videoActionMetricsEntries: + items: + $ref: '#/components/schemas/XPSVideoActionMetricsEntry' + type: array + description: >- + Output only. The metric entries for precision window lengths: + 1s,2s,3s,4s, 5s. + id: XPSVideoActionRecognitionEvaluationMetrics + type: object + description: Model evaluation metrics for video action recognition. + XPSCommonStats: + id: XPSCommonStats + type: object + description: Common statistics for a column with a specified data type. + properties: distinctValueCount: + format: int64 + type: string + validValueCount: type: string format: int64 - description: The number of distinct values. nullValueCount: + format: int64 type: string - description: The number of values that are null. + XPSTablesPreprocessResponse: + properties: + tablesDatasetMetadata: + $ref: '#/components/schemas/XPSTablesDatasetMetadata' + description: >- + The table/column id, column_name and the DataTypes of the columns + will be populated. + id: XPSTablesPreprocessResponse + type: object + XPSTableSpec: + id: XPSTableSpec + type: object + properties: + timeColumnId: + type: integer + format: int32 + description: The id of the time column. + importedDataSizeInBytes: + description: The total size of imported data of the table. + type: string + format: int64 + columnSpecs: + additionalProperties: + $ref: '#/components/schemas/XPSColumnSpec' + type: object + description: Mapping from column id to column spec. + validRowCount: + description: The number of valid rows. + type: string + format: int64 + rowCount: + type: string + format: int64 + description: The number of rows in the table. + XPSTrackMetricsEntryConfidenceMetricsEntry: + type: object + description: 'Metrics for a single confidence threshold. Next tag: 6.' + id: XPSTrackMetricsEntryConfidenceMetricsEntry + properties: + 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). + format: float + type: number + confidenceThreshold: + type: number + format: float + description: >- + Output only. The confidence threshold value used to compute the + metrics. + trackingRecall: + description: Output only. Tracking recall. + format: float + type: number + mismatchRate: + description: >- + Output only. Mismatch rate, which measures the tracking consistency, + i.e. correctness of instance ID continuity. + type: number + format: float + XPSResponseExplanationParameters: + 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: + 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/XPSIntegratedGradientsAttribution' + type: object + deprecated: true + id: XPSResponseExplanationParameters + XPSCategoryStatsSingleCategoryStats: + type: object + properties: + value: + description: The CATEGORY value. + type: string + count: + type: string + format: int64 + description: The number of occurrences of this value in the series. + id: XPSCategoryStatsSingleCategoryStats + description: The statistics of a single CATEGORY value. + XPSVideoClassificationTrainResponse: + id: XPSVideoClassificationTrainResponse + type: object + properties: + trainCostNodeSeconds: + 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 - validValueCount: + modelArtifactSpec: + description: '## The fields below are only populated under uCAIP request scope.' + $ref: '#/components/schemas/XPSVideoModelArtifactSpec' + XPSSpeechModelSpec: + properties: + datasetId: + type: string format: int64 - description: The number of values that are valid. + 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: + type: array + description: Model specs for all submodels contained in this model. + items: + $ref: '#/components/schemas/XPSSpeechModelSpecSubModelSpec' + language: type: string - XPSIntegratedGradientsAttribution: - id: XPSIntegratedGradientsAttribution - deprecated: true - 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: XPSSpeechModelSpec + XPSConfusionMatrixRow: + type: object properties: - stepCount: + count: + type: array + items: + 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 within the desired error range. Valid range of its value - is [1, 100], inclusively. - format: int32 - type: integer + 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). + 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 + description: A row in the confusion matrix. + id: XPSConfusionMatrixRow + XPSEdgeTpuTfLiteFormat: + description: >- + A model format used for [Edge TPU](https://cloud.google.com/edge-tpu/) + devices. type: object - XPSResponseExplanationMetadata: - deprecated: true - id: XPSResponseExplanationMetadata + properties: {} + id: XPSEdgeTpuTfLiteFormat + XPSStringStats: type: object properties: - outputs: - additionalProperties: - $ref: '#/components/schemas/XPSResponseExplanationMetadataOutputMetadata' - description: Metadata of the output. - type: object - inputs: - additionalProperties: - $ref: '#/components/schemas/XPSResponseExplanationMetadataInputMetadata' - description: Metadata of the input. - type: object - XPSRegressionMetricsEntry: + commonStats: + $ref: '#/components/schemas/XPSCommonStats' + topUnigramStats: + description: >- + The statistics of the top 20 unigrams, ordered by + StringStats.UnigramStats.count. + type: array + items: + $ref: '#/components/schemas/XPSStringStatsUnigramStats' + description: The data statistics of a series of STRING values. + id: XPSStringStats + XPSImageModelServingSpecModelThroughputEstimation: type: object - id: XPSRegressionMetricsEntry + id: XPSImageModelServingSpecModelThroughputEstimation properties: - predictedValue: - description: The observed value for a row in the dataset. + latencyInMilliseconds: + description: Estimated latency. + format: double + type: number + nodeQps: + format: double + description: The approximate qps a deployed node can serve. + type: number + 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. + - 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 + - TPU_V2 + - TPU_V3 + - TPU_V4_POD + - TPU_V5_LITEPOD + type: string + 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. + Color: + type: object + 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 - trueValue: - description: The actual target value for a row in the dataset. + red: + type: number + format: float + description: The amount of red in the color as a value in the interval [0, 1]. + green: + description: The amount of green in the color as a value in the interval [0, 1]. format: float type: number - description: A pair of actual & observed values for the model being evaluated. - AnalyzeEntitiesRequest: + blue: + format: float + type: number + description: The amount of blue in the color as a value in the interval [0, 1]. + 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(''); }; // ... + DiskMetric: type: object - description: The entity analysis request message. - id: AnalyzeEntitiesRequest + id: DiskMetric + properties: + gibSec: + format: int64 + type: string + description: Required. Seconds of physical disk usage, e.g. 3600. + diskType: + type: string + enum: + - UNKNOWN_DISK_TYPE + - REGIONAL_SSD + - REGIONAL_STORAGE + - PD_SSD + - PD_STANDARD + - STORAGE_SNAPSHOT + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + description: Required. Type of Disk, e.g. REGIONAL_SSD. + XPSFileSpec: + description: >- + Spec of input and output files, on external file systems (CNS, GCS, + etc). + id: XPSFileSpec properties: - document: - description: Required. Input document. - $ref: '#/components/schemas/Document' - encodingType: + fileFormat: + type: string + enum: + - FILE_FORMAT_UNKNOWN + - FILE_FORMAT_SSTABLE + - FILE_FORMAT_TRANSLATION_RKV + - FILE_FORMAT_RECORDIO + - FILE_FORMAT_RAW_CSV + - FILE_FORMAT_RAW_CAPACITOR + enumDeprecated: + - false + - true + - false + - false + - false + - false 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. + Internal format for parallel text data used by Google Translate. + go/rkvtools + - '' - >- - 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 offsets. - enum: - - NONE - - UTF8 - - UTF16 - - UTF32 - type: string - XPSCategoryStatsSingleCategoryStats: - id: XPSCategoryStatsSingleCategoryStats - description: The statistics of a single CATEGORY value. - properties: - count: - description: The number of occurrences of this value in the series. + Only the lexicographically first file described by the file_spec + contains the header line. + - '' + directoryPath: + deprecated: true type: string - format: int64 - value: + description: Deprecated. Use file_spec. + singleFilePath: type: string - description: The CATEGORY value. - type: object - XPSVideoBatchPredictOperationMetadata: - id: XPSVideoBatchPredictOperationMetadata - properties: - outputExamples: - items: - type: string - type: array + deprecated: true + description: Deprecated. Use file_spec. + fileSpec: 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: object - XPSTablesClassificationMetrics: - description: Metrics for Tables classification problems. + 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 type: object - id: XPSTablesClassificationMetrics - properties: - curveMetrics: - description: Metrics building a curve. - items: - $ref: '#/components/schemas/XPSTablesClassificationMetricsCurveMetrics' - type: array - XPSSpeechModelSpecSubModelSpec: + XPSTablesConfidenceMetricsEntry: + id: XPSTablesConfidenceMetricsEntry + description: Metrics for a single confidence threshold. properties: - contextId: - description: In S3, Recognition ClientContextId.context_id - type: string - isEnhancedModel: - type: boolean + f1Score: description: >- - If true then it means we have an enhanced version of the biasing - models. - clientId: - description: In S3, Recognition ClientContextId.client_id + The harmonic mean of recall and precision. (2 * precision * recall) + / (precision + recall) + type: number + format: double + recall: + type: number + description: 'Recall = #true positives / (#true positives + #false negatives).' + format: double + confidenceThreshold: + format: double + description: The confidence threshold value used to compute the metrics. + type: number + falseNegativeCount: + description: False negative count. type: string - biasingModelType: + format: int64 + trueNegativeCount: + format: int64 + description: True negative count. 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 - type: object - id: XPSSpeechModelSpecSubModelSpec - XPSTablesClassificationMetricsCurveMetrics: - type: object - properties: - logLoss: + falsePositiveRate: format: double + description: 'FPR = #false positives / (#false positives + #true negatives)' type: number - description: The Log loss metric. - confidenceMetricsEntries: - type: array - description: >- - Metrics that have confidence thresholds. Precision-recall curve and - ROC curve can be derived from them. - items: - $ref: '#/components/schemas/XPSTablesConfidenceMetricsEntry' - positionThreshold: - format: int32 - type: integer - description: The position threshold value used to compute the metrics. - value: - description: >- - The CATEGORY row value (for ARRAY unnested) the curve metrics are - for. - type: string - aucRoc: + precision: + description: 'Precision = #true positives / (#true positives + #false positives).' format: double type: number - description: The area under receiver operating characteristic curve. - aucPr: + truePositiveCount: + format: int64 + description: True positive count. + type: string + falsePositiveCount: + type: string + format: int64 + description: False positive count. + truePositiveRate: type: number - description: The area under the precision-recall curve. format: double - description: Metrics curve data point for a single value. - id: XPSTablesClassificationMetricsCurveMetrics - XPSImageSegmentationEvaluationMetrics: - id: XPSImageSegmentationEvaluationMetrics + description: 'TPR = #true positives / (#true positives + #false negatvies)' + type: object + XPSSpeechPreprocessStats: type: object + id: XPSSpeechPreprocessStats properties: - confidenceMetricsEntries: - description: >- - Metrics that have confidence thresholds. Precision-recall curve can - be derived from it. + testSentencesCount: + description: The number of sentences in the test data set. + format: int32 + type: integer + testExamplesCount: + description: The number of examples labelled as TEST by Speech xps server. + type: integer + format: int32 + dataErrors: items: - $ref: >- - #/components/schemas/XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry + $ref: '#/components/schemas/XPSDataErrors' + description: Different types of data errors and the counts associated with them. type: array - description: 'Model evaluation metrics for image segmentation problems. Next tag: 4.' - XPSVisionTrainingOperationMetadata: - deprecated: true - id: XPSVisionTrainingOperationMetadata - type: object - properties: - explanationUsage: - $ref: '#/components/schemas/InfraUsage' - description: >- - Aggregated infra usage within certain time period, for billing - report purpose if XAI is enable in training request. - ClassifyTextRequest: - description: The document classification request message. - id: ClassifyTextRequest - type: object - properties: - document: - $ref: '#/components/schemas/Document' - description: Required. Input document. - XPSTablesModelColumnInfo: - id: XPSTablesModelColumnInfo - properties: - columnId: + testWordsCount: + type: integer + format: int32 + description: The number of words in the test data set. + trainExamplesCount: + description: The number of examples labeled as TRAIN by Speech xps server. + format: int32 + type: integer + numHumanLabeledExamples: + type: integer + description: The number of rows marked HUMAN_LABELLED + format: int32 + numMachineTranscribedExamples: + type: integer + description: The number of rows marked as MACHINE_TRANSCRIBED + format: int32 + trainSentencesCount: type: integer - description: The ID of the column. + description: The number of sentences in the training data set. format: int32 - featureImportance: - type: number + trainWordsCount: + format: int32 + description: The number of words in the training data set. + type: integer + numLogsExamples: + type: integer + description: The number of samples found in the previously recorded logs data. + format: int32 + XPSModelArtifactItem: + description: A single model artifact item. + id: XPSModelArtifactItem + properties: + gcsUri: 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. - format: float - description: >- - An information specific to given column and Tables Model, in context of - the Model and the predictions created by it. + The Google Cloud Storage (GCS) uri that stores the model binary + files. + type: string + artifactFormat: + type: string + description: The model artifact format. + enum: + - ARTIFACT_FORMAT_UNSPECIFIED + - TF_CHECKPOINT + - TF_SAVED_MODEL + - TF_LITE + - EDGE_TPU_TF_LITE + - TF_JS + - CORE_ML + 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: object - XPSClassificationEvaluationMetrics: + XPSTranslationTrainResponse: + properties: + modelType: + enumDescriptions: + - Default + - Legacy model. Will be deprecated. + - Current model. + type: string + enum: + - MODEL_TYPE_UNSPECIFIED + - LEGACY + - CURRENT + description: Type of the model. + description: Train response for translation. type: object + id: XPSTranslationTrainResponse + AnnotateTextRequestFeatures: + id: AnnotateTextRequestFeatures description: >- - Model evaluation metrics for classification problems. It can be used for - image and video classification. Next tag: 9. - id: XPSClassificationEvaluationMetrics + All available features. Setting each one to true will enable that + specific analysis for the input. + type: object properties: - 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. - baseAuPrc: - type: number - description: The Area under precision recall curve metric based on priors. - format: float - auPrc: - format: float - description: The Area under precision recall curve metric. - type: number - logLoss: - type: number - format: float - description: The Log Loss metric. - confidenceMetricsEntries: - type: array - items: - $ref: '#/components/schemas/XPSConfidenceMetricsEntry' - description: >- - Metrics that have confidence thresholds. Precision-recall curve can - be derived from it. - auRoc: + moderateText: + type: boolean description: >- - The Area Under Receiver Operating Characteristic curve metric. - Micro-averaged for the overall evaluation. - type: number - format: float - evaluatedExamplesCount: - type: integer - description: The number of examples used for model evaluation. - format: int32 - AnnotateTextResponse: - id: AnnotateTextResponse - type: object + Optional. Moderate the document for harmful and sensitive + categories. + extractEntities: + type: boolean + description: Optional. Extract entities. + extractDocumentSentiment: + type: boolean + description: Optional. Extract document-level sentiment. + classifyText: + description: Optional. Classify the full document into categories. + type: boolean + XPSImageSegmentationTrainResponse: properties: - sentences: - items: - $ref: '#/components/schemas/Sentence' + modelServingSpec: + $ref: '#/components/schemas/XPSImageModelServingSpec' + exportModelSpec: + description: 'NOTE: These fields are not used/needed in EAP but will be set later.' + $ref: '#/components/schemas/XPSImageExportModelSpec' + trainCostNodeSeconds: + type: string + format: int64 description: >- - Sentences in the input document. Populated if the user enables - AnnotateTextRequest.Features.extract_document_sentiment. - type: array - categories: - items: - $ref: '#/components/schemas/ClassificationCategory' - description: Categories identified in the input document. - type: array - documentSentiment: - $ref: '#/components/schemas/Sentiment' + 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 overall sentiment for the document. Populated if the user - enables AnnotateTextRequest.Features.extract_document_sentiment. - moderationCategories: - description: Harmful and sensitive categories identified in the input document. - items: - $ref: '#/components/schemas/ClassificationCategory' - type: array - languageCode: - type: string + ## The fields below are only populated under uCAIP request scope. + Model artifact spec stores and model gcs pathes and related metadata + stopReason: + enumDescriptions: + - '' + - '' + - Model fully converged, can not be resumbed training. + - >- + Model early converged, can be further trained till full + convergency. 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: + 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 + type: string + colorMaps: + description: Color map of the model. 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. items: - $ref: '#/components/schemas/Entity' - 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. - description: The text annotations response message. - XPSTablesModelStructureModelParameters: - id: XPSTablesModelStructureModelParameters + $ref: '#/components/schemas/XPSColorMap' type: object - description: Model hyper-parameters for a model. + id: XPSImageSegmentationTrainResponse + XPSResponseExplanationMetadataOutputMetadata: + type: object + id: XPSResponseExplanationMetadataOutputMetadata properties: - hyperparameters: - type: array - items: - $ref: >- - #/components/schemas/XPSTablesModelStructureModelParametersParameter - Color: + outputTensorName: + description: Name of the output tensor. Only needed in train response. + type: string + description: Metadata of the prediction output to be explained. + XPSVisionErrorAnalysisConfig: + description: 'The vision model error analysis configuration. Next tag: 3' + id: XPSVisionErrorAnalysisConfig properties: - red: - description: The amount of red in the color as a value in the interval [0, 1]. - type: number - format: float - blue: - type: number - format: float - description: The amount of blue in the color as a value in the interval [0, 1]. - alpha: - format: float - type: number + exampleCount: + format: int32 + type: integer + description: The number of query examples in error analysis. + queryType: + 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. 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]. - format: float - type: number - 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(''); }; // ... - Entity: - id: Entity - 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. + The query type used in retrieval. The enum values are frozen in the + foreseeable future. + type: string type: object + XPSImageModelArtifactSpec: properties: - metadata: - type: object - additionalProperties: - type: string + checkpointArtifact: + $ref: '#/components/schemas/XPSModelArtifactItem' + description: The Tensorflow checkpoint files. e.g. Used for resumable training. + tfLiteMetadataGcsUri: + type: string + description: GCS uri of Tensorflow Lite metadata 'tflite_metadata.json'. + tfJsBinaryGcsPrefix: + type: string description: >- - Metadata associated with the entity. For the metadata associated - with other entity types, see the Type table below. - mentions: - type: array + GCS uri prefix of Tensorflow JavaScript binary files + 'groupX-shardXofX.bin' Deprecated. + 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' + labelGcsUri: + type: string + description: GCS uri of decoded labels file for model export 'dict.txt'. + exportArtifact: items: - $ref: '#/components/schemas/EntityMention' + $ref: '#/components/schemas/XPSModelArtifactItem' + type: array + description: The model binary files in different formats for model export. + description: >- + Stores the locations and related metadata of the model artifacts. + Populated for uCAIP requests only. + type: object + id: XPSImageModelArtifactSpec + XPSTextComponentModel: + type: object + id: XPSTextComponentModel + description: 'Component model. Next ID: 10' + properties: + partition: + enum: + - PARTITION_TYPE_UNSPECIFIED + - PARTITION_ZERO + - PARTITION_REDUCED_HOMING + - PARTITION_JELLYFISH + - PARTITION_CPU + - PARTITION_CUSTOM_STORAGE_CPU + 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. description: >- - The mentions of this entity in the input document. The API currently - supports proper noun mentions. - type: + The partition where the model is deployed. Populated by uCAIP BE as + part of online PredictRequest. + batchPredictionModelGcsUri: + type: string + description: The Cloud Storage resource path to hold batch prediction model. + 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 enumDescriptions: - - Unknown - - Person - - Location - - Organization - - Event - - Artwork - - Consumer product - - Other types of entities + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - Model type for entity extraction. + - Model type for relationship extraction. - >- - 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 + 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. - >- - 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 + Model type used to train default, MA, and ATC models in a single + batch worker pipeline. - >- - 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: - - UNKNOWN - - PERSON - - LOCATION - - ORGANIZATION - - EVENT - - WORK_OF_ART - - CONSUMER_GOOD - - OTHER - - PHONE_NUMBER - - ADDRESS - - DATE - - NUMBER - - PRICE - description: The entity type. + 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. + description: The type of trained NL submodel type: string - sentiment: + servingArtifact: + $ref: '#/components/schemas/XPSModelArtifactItem' 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. - $ref: '#/components/schemas/Sentiment' - name: - description: The representative name for the entity. + The default model binary file used for serving (e.g. online predict, + batch predict) via public Cloud Ai Platform API. + submodelName: type: string - XPSRegressionEvaluationMetrics: - description: >- - Model evaluation metrics for regression problems. It can be used for - Tables. - id: XPSRegressionEvaluationMetrics - properties: - meanAbsolutePercentageError: - type: number + description: The name of the trained NL submodel. + servoModelName: description: >- - Mean absolute percentage error. Only set if all ground truth values - are positive. - format: float - regressionMetricsEntries: - items: - $ref: '#/components/schemas/XPSRegressionMetricsEntry' + The name of servo model. Populated by uCAIP BE as part of online + PredictRequest. + type: string + tfRuntimeVersion: description: >- - A list of actual versus predicted points for the model being - evaluated. - type: array - rootMeanSquaredLogError: - format: float - type: number - description: Root mean squared log error. - rootMeanSquaredError: - type: number - description: Root Mean Squared Error (RMSE). - format: float - rSquared: - description: R squared. - format: float - type: number - meanAbsoluteError: - format: float - description: Mean Absolute Error (MAE). - type: number - type: object - XPSTablesTrainingOperationMetadata: + ## The fields below are only populated under uCAIP request scope. + https://cloud.google.com/ml-engine/docs/runtime-version-list + type: string + versionNumber: + format: int64 + type: string + description: >- + The servomatic model version number. Populated by uCAIP BE as part + of online PredictRequest. + XPSImageClassificationTrainResponse: properties: - createModelStage: + modelArtifactSpec: + $ref: '#/components/schemas/XPSImageModelArtifactSpec' + description: '## The fields below are only populated under uCAIP request scope.' + stopReason: type: string - enum: - - CREATE_MODEL_STAGE_UNSPECIFIED - - DATA_PREPROCESSING - - TRAINING - - EVALUATING - - MODEL_POST_PROCESSING - 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. - trainBudgetMilliNodeHours: - description: Creating model budget. - format: int64 + - '' + - '' + - 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 + description: >- + Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', + 'MODEL_CONVERGED', 'MODEL_EARLY_STOPPED'. + classCount: type: string - trainingObjectivePoints: + format: int64 + description: Total number of classes. + exportModelSpec: + $ref: '#/components/schemas/XPSImageExportModelSpec' 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. - type: array - items: - $ref: '#/components/schemas/XPSTrainingObjectivePoint' - topTrials: - type: array - items: - $ref: '#/components/schemas/XPSTuningTrial' + Information of downloadable models that are pre-generated as part of + training flow and will be persisted in AutoMl backend. Populated for + AutoMl requests. + modelServingSpec: + $ref: '#/components/schemas/XPSImageModelServingSpec' + trainCostNodeSeconds: 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. - trainingStartTime: - description: Timestamp when training process starts. + The actual training cost, expressed in node seconds. Populated for + models trained in node time. + format: int64 type: string - format: google-datetime - optimizationObjective: + trainCostInNodeTime: + format: google-duration type: string - description: The optimization objective for model. + 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. + id: XPSImageClassificationTrainResponse type: object - id: XPSTablesTrainingOperationMetadata - XPSArrayStats: + XPSMetricEntryLabel: + properties: + labelValue: + description: The value of the label. + type: string + labelName: + description: The name of the label. + type: string + id: XPSMetricEntryLabel type: object - description: The data statistics of a series of ARRAY values. + XPSColorMapIntColor: + id: XPSColorMapIntColor + type: object + description: RGB color and each channel is represented by an integer. properties: - commonStats: - $ref: '#/components/schemas/XPSCommonStats' - memberStats: - 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. - $ref: '#/components/schemas/XPSDataStats' - id: XPSArrayStats - XPSTranslationEvaluationMetrics: + green: + type: integer + description: The value should be in range of [0, 255]. + format: int32 + blue: + format: int32 + type: integer + description: The value should be in range of [0, 255]. + red: + description: The value should be in range of [0, 255]. + type: integer + format: int32 + XPSResponseExplanationMetadata: + deprecated: true properties: - bleuScore: - format: double - description: BLEU score. + outputs: + type: object + additionalProperties: + $ref: '#/components/schemas/XPSResponseExplanationMetadataOutputMetadata' + description: Metadata of the output. + inputs: + description: Metadata of the input. + additionalProperties: + $ref: '#/components/schemas/XPSResponseExplanationMetadataInputMetadata' + type: object + id: XPSResponseExplanationMetadata + type: object + XPSBoundingBoxMetricsEntry: + description: >- + Bounding box matching model metrics for a single intersection-over-union + threshold and multiple label match confidence thresholds. + properties: + meanAveragePrecision: type: number - baseBleuScore: + format: float + description: The mean average precision. + iouThreshold: + format: float type: number - format: double - description: BLEU score for base model. + description: >- + The intersection-over-union threshold value used to compute this + metrics entry. + confidenceMetricsEntries: + items: + $ref: >- + #/components/schemas/XPSBoundingBoxMetricsEntryConfidenceMetricsEntry + description: >- + Metrics for each label-match confidence_threshold from + 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + type: array + type: object + id: XPSBoundingBoxMetricsEntry + XPSColumnSpec: type: object - description: Evaluation metrics for the dataset. - id: XPSTranslationEvaluationMetrics - XPSColumnSpecForecastingMetadata: properties: - columnType: - description: The type of the column for FORECASTING model training purposes. + displayName: + description: >- + The display name of the column. It's outputed in Preprocess and a + required input for RefreshTablesStats and Train. 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. - enum: - - COLUMN_TYPE_UNSPECIFIED - - KEY - - KEY_METADATA - - TIME_SERIES_AVAILABLE_PAST_ONLY - - TIME_SERIES_AVAILABLE_PAST_AND_FUTURE + forecastingMetadata: + $ref: '#/components/schemas/XPSColumnSpecForecastingMetadata' + dataStats: + $ref: '#/components/schemas/XPSDataStats' + description: >- + The data stats of the column. It's outputed in RefreshTablesStats + and a required input for Train. + 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: + type: array + items: + $ref: '#/components/schemas/XPSColumnSpecCorrelatedColumn' + description: It's outputed in RefreshTablesStats, and a required input in Train. + columnId: + type: integer + 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. + id: XPSColumnSpec + XPSTfLiteFormat: + properties: {} + id: XPSTfLiteFormat description: >- - =========================================================================== - # The fields below are used exclusively for Forecasting. + LINT.IfChange A model format used for mobile and IoT devices. See + https://www.tensorflow.org/lite. type: object - id: XPSColumnSpecForecastingMetadata - Document: - description: Represents the input to API methods. + XPSReportingMetrics: properties: - languageCode: - type: string + effectiveTrainingDuration: 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. - type: + 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 + format: google-duration type: string + metricEntries: 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 - content: - type: string + One entry per metric name. The values must be aggregated per metric + name. + type: array + items: + $ref: '#/components/schemas/XPSMetricEntry' + id: XPSReportingMetrics + type: object + XPSCategoryStats: + properties: + topCategoryStats: + items: + $ref: '#/components/schemas/XPSCategoryStatsSingleCategoryStats' description: >- - The content of the input in string format. Cloud audit logging - exempt since it is based on user data. - gcsContentUri: + The statistics of the top 20 CATEGORY values, ordered by + CategoryStats.SingleCategoryStats.count. + type: array + commonStats: + $ref: '#/components/schemas/XPSCommonStats' + id: XPSCategoryStats + type: object + description: The data statistics of a series of CATEGORY values. + AnalyzeEntitiesResponse: + description: The entity analysis response message. + id: AnalyzeEntitiesResponse + 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: 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. + 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 + entities: + type: array + description: The recognized entities in the input document. + items: + $ref: '#/components/schemas/Entity' type: object - id: Document - XPSEvaluationMetricsSet: - id: XPSEvaluationMetricsSet - description: Specifies location of model evaluation metrics. + XPSIntegratedGradientsAttribution: properties: - evaluationMetrics: - type: array + stepCount: description: >- - Inline EvaluationMetrics - should be relatively small. For passing - large quantities of exhaustive metrics, use file_spec. + 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 + deprecated: true + id: XPSIntegratedGradientsAttribution + type: object + 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 + XPSMetricEntry: + properties: + systemLabels: + description: Billing system labels for this (metric, value) pair. + type: array items: - $ref: '#/components/schemas/XPSEvaluationMetrics' - numEvaluationMetrics: + $ref: '#/components/schemas/XPSMetricEntryLabel' + int64Value: + description: A signed 64-bit integer value. type: string format: int64 + argentumMetricId: + type: string 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. + 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. + doubleValue: + type: number + format: double + description: A double value. + metricName: + type: string + description: The metric name defined in the service configuration. + id: XPSMetricEntry type: object - XPSTimestampStatsGranularStats: - id: XPSTimestampStatsGranularStats + XPSTextTrainResponse: + id: XPSTextTrainResponse properties: - buckets: - additionalProperties: - type: string - format: int64 - type: object - 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). + componentModel: + items: + $ref: '#/components/schemas/XPSTextComponentModel' + type: array + description: Component submodels. type: object - description: Stats split by a defined in context granularity. - XPSXpsOperationMetadata: + 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. + id: XPSTuningTrial properties: - reportingMetrics: + 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' + XPSResponseExplanationMetadataInputMetadata: + properties: + inputTensorName: + type: string 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. - $ref: '#/components/schemas/XPSReportingMetrics' - tablesTrainingOperationMetadata: - $ref: '#/components/schemas/XPSTablesTrainingOperationMetadata' - videoBatchPredictOperationMetadata: - $ref: '#/components/schemas/XPSVideoBatchPredictOperationMetadata' - exampleCount: + Name of the input tensor for this model. Only needed in train + response. + modality: + type: string description: >- - Optional. XPS server can opt to provide example count of the long - running operation (e.g. training, data importing, batch prediction). + Modality of the feature. Valid values are: numeric, image. Defaults + to numeric. + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - MODALITY_UNSPECIFIED + - NUMERIC + - IMAGE + - CATEGORICAL + visualizationConfig: + description: Visualization configurations for image explanation. + $ref: '#/components/schemas/XPSVisualization' + type: object + id: XPSResponseExplanationMetadataInputMetadata + description: Metadata of the input of a feature. + XPSCorrelationStats: + id: XPSCorrelationStats + type: object + 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. + properties: + cramersV: + type: number + format: double + description: The correlation value using the Cramer's V measure. + XPSResponseExplanationSpec: + id: XPSResponseExplanationSpec + deprecated: true + properties: + parameters: + description: Parameters that configure explaining of the Model's predictions. + $ref: '#/components/schemas/XPSResponseExplanationParameters' + metadata: + $ref: '#/components/schemas/XPSResponseExplanationMetadata' + description: Metadata describing the Model's input and output for explanation. + explanationType: type: string - format: int64 - visionTrainingOperationMetadata: - $ref: '#/components/schemas/XPSVisionTrainingOperationMetadata' - videoTrainingOperationMetadata: - $ref: '#/components/schemas/XPSVideoTrainingOperationMetadata' - id: XPSXpsOperationMetadata - XPSColorMapIntColor: + description: >- + Explanation type. For AutoML Image Classification models, possible + values are: * `image-integrated-gradients` * `image-xrai` + type: object + description: >- + Specification of Model explanation. Feature-based XAI in AutoML Vision + ICN is deprecated, see b/288407203 for context. + XPSTextToSpeechTrainResponse: + type: object + id: XPSTextToSpeechTrainResponse + description: TextToSpeech train response + properties: {} + XPSTablesModelColumnInfo: + id: XPSTablesModelColumnInfo type: object properties: - green: - format: int32 - description: The value should be in range of [0, 255]. - type: integer - red: - type: integer - format: int32 - description: The value should be in range of [0, 255]. - blue: + columnId: format: int32 type: integer - description: The value should be in range of [0, 255]. - description: RGB color and each channel is represented by an integer. - id: XPSColorMapIntColor - XPSVideoExportModelSpec: - id: XPSVideoExportModelSpec + description: The ID of the column. + featureImportance: + 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. + type: number + description: >- + An information specific to given column and Tables Model, in context of + the Model and the predictions created by it. + XPSColumnSpecForecastingMetadata: type: object 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. + columnType: + 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. + type: string 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. + =========================================================================== + # The fields below are used exclusively for Forecasting. + id: XPSColumnSpecForecastingMetadata XPSTrackMetricsEntry: + id: XPSTrackMetricsEntry properties: - meanMismatchRate: - description: Output only. The mean mismatch rate over all confidence thresholds. - type: number - format: float confidenceMetricsEntries: - items: - $ref: '#/components/schemas/XPSTrackMetricsEntryConfidenceMetricsEntry' + type: array 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. - type: array + items: + $ref: '#/components/schemas/XPSTrackMetricsEntryConfidenceMetricsEntry' meanTrackingAveragePrecision: type: number - format: float description: >- Output only. The mean average precision over all confidence thresholds. - iouThreshold: format: float + iouThreshold: description: >- Output only. The intersection-over-union threshold value between bounding boxes across frames used to compute this metric entry. + format: float type: number - meanBoundingBoxIou: + meanMismatchRate: + description: Output only. The mean mismatch rate over all confidence thresholds. format: float + type: number + meanBoundingBoxIou: description: >- Output only. The mean bounding box iou over all confidence thresholds. + format: float type: number + type: object description: >- Track matching model metrics for a single track match threshold and multiple label match confidence thresholds. Next tag: 6. + XPSStructType: type: object - id: XPSTrackMetricsEntry - XPSTablesDatasetMetadata: - id: XPSTablesDatasetMetadata + id: XPSStructType properties: - weightColumnId: - description: >- - Id of the primary table column that should be used as the weight - column. - format: int32 - type: integer - targetColumnCorrelations: + fields: type: object + description: Unordered map of struct field names to their data types. additionalProperties: - $ref: '#/components/schemas/XPSCorrelationStats' - description: '(the column id : its CorrelationStats with target column).' - targetColumnId: - format: int32 - type: integer - description: >- - Id of the primary table column that should be used as the training - label. - mlUseColumnId: - type: integer - description: Id the column to split the table. - format: int32 - primaryTableSpec: - description: Primary table. - $ref: '#/components/schemas/XPSTableSpec' - description: 'Metadata for a dataset used for AutoML Tables. Next ID: 6' - type: object - XPSTrainingObjectivePoint: - type: object - properties: - createTime: - description: The time at which this point was recorded. - type: string - format: google-datetime - value: - type: number - description: The objective value when this point was recorded. - format: float - id: XPSTrainingObjectivePoint - XPSTablesTrainResponse: + $ref: '#/components/schemas/XPSDataType' + description: '`StructType` defines the DataType-s of a STRUCT type.' + XPSSpeechEvaluationMetrics: properties: - predictionSampleRows: - type: array + subModelEvaluationMetrics: items: - $ref: '#/components/schemas/XPSRow' - description: Sample rows from the dataset this model was trained. - modelStructure: - $ref: '#/components/schemas/XPSTablesModelStructure' - tablesModelColumnInfo: + $ref: >- + #/components/schemas/XPSSpeechEvaluationMetricsSubModelEvaluationMetric + description: Evaluation metrics for all submodels contained in this model. type: array - items: - $ref: '#/components/schemas/XPSTablesModelColumnInfo' - description: >- - Output only. Auxiliary information for each of the - input_feature_column_specs, with respect to this particular model. - trainCostMilliNodeHours: - 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 - format: int64 + id: XPSSpeechEvaluationMetrics type: object - id: XPSTablesTrainResponse - ModerateTextResponse: - id: ModerateTextResponse + XPSStringStatsUnigramStats: 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. + count: + description: The number of occurrences of this unigram in the series. + format: int64 type: string - moderationCategories: - description: Harmful and sensitive categories representing the input document. - items: - $ref: '#/components/schemas/ClassificationCategory' - 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. + value: + description: The unigram. + type: string + description: The statistics of a unigram. + type: object + id: XPSStringStatsUnigramStats + XPSTablesClassificationMetricsCurveMetrics: + description: Metrics curve data point for a single value. + id: XPSTablesClassificationMetricsCurveMetrics type: object - description: The document moderation response message. - XPSBoundingBoxMetricsEntryConfidenceMetricsEntry: properties: - recall: - format: float - description: Recall for the given confidence threshold. - type: number - confidenceThreshold: - format: float - type: number - description: The confidence threshold value used to compute the metrics. - precision: + positionThreshold: + format: int32 + type: integer + description: The position threshold value used to compute the metrics. + aucRoc: type: number - format: float - description: Precision for the given confidence threshold. - f1Score: - description: The harmonic mean of recall and precision. + description: The area under receiver operating characteristic curve. + format: double + aucPr: + format: double type: number - format: float - type: object - description: Metrics for a single confidence threshold. - id: XPSBoundingBoxMetricsEntryConfidenceMetricsEntry - XPSTablesModelStructureModelParametersParameter: - properties: - stringValue: - description: String type parameter value. - type: string - name: + description: The area under the precision-recall curve. + value: type: string - description: Parameter name. - floatValue: + description: >- + The CATEGORY row value (for ARRAY unnested) the curve metrics are + for. + confidenceMetricsEntries: + description: >- + Metrics that have confidence thresholds. Precision-recall curve and + ROC curve can be derived from them. + type: array + items: + $ref: '#/components/schemas/XPSTablesConfidenceMetricsEntry' + logLoss: format: double - description: Float type parameter value. + description: The Log loss metric. type: number - intValue: - description: Integer type parameter value. - format: int64 - type: string - type: object - id: XPSTablesModelStructureModelParametersParameter XPSPreprocessResponse: type: object properties: + translationPreprocessResp: + $ref: '#/components/schemas/XPSTranslationPreprocessResponse' + tablesPreprocessResponse: + $ref: '#/components/schemas/XPSTablesPreprocessResponse' speechPreprocessResp: $ref: '#/components/schemas/XPSSpeechPreprocessResponse' outputExampleSet: @@ -2763,589 +2234,349 @@ components: messages. The PreprocessedExample.mvp_training_data-s returned here are later verbatim passed to Train() call in TrainExample.mvp_training_data. - translationPreprocessResp: - $ref: '#/components/schemas/XPSTranslationPreprocessResponse' - tablesPreprocessResponse: - $ref: '#/components/schemas/XPSTablesPreprocessResponse' - description: 'Next ID: 8' id: XPSPreprocessResponse - XPSTrackMetricsEntryConfidenceMetricsEntry: + description: 'Next ID: 8' + Sentence: + description: Represents a sentence in the input document. + id: Sentence properties: - trackingPrecision: - description: Output only. Tracking precision. - format: float - type: number - confidenceThreshold: - format: float - description: >- - Output only. The confidence threshold value used to compute the - metrics. - type: number - mismatchRate: - format: float - description: >- - Output only. Mismatch rate, which measures the tracking consistency, - i.e. correctness of instance ID continuity. - type: number - boundingBoxIou: + sentiment: 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 - trackingRecall: - format: float - description: Output only. Tracking recall. - type: number - description: 'Metrics for a single confidence threshold. Next tag: 6.' + 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' + text: + $ref: '#/components/schemas/TextSpan' + description: The sentence text. type: object - id: XPSTrackMetricsEntryConfidenceMetricsEntry - InfraUsage: - id: InfraUsage + ClassifyTextResponse: type: object + description: The document classification response message. properties: - diskMetrics: - description: Aggregated persistent disk metrics since requested start_time. - items: - $ref: '#/components/schemas/DiskMetric' - type: array - tpuMetrics: - items: - $ref: '#/components/schemas/TpuMetric' - type: array - description: Aggregated tpu metrics since requested start_time. - ramMetrics: - type: array - items: - $ref: '#/components/schemas/RamMetric' - description: Aggregated ram metrics since requested start_time. - cpuMetrics: - items: - $ref: '#/components/schemas/CpuMetric' - description: Aggregated core metrics since requested start_time. - type: array - gpuMetrics: + 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. + categories: items: - $ref: '#/components/schemas/GpuMetric' + $ref: '#/components/schemas/ClassificationCategory' + description: Categories representing the input document. type: array - description: Aggregated gpu metrics since requested start_time. - description: 'Infra Usage of billing metrics. Next ID: 6' - XPSTablesPreprocessResponse: - id: XPSTablesPreprocessResponse - properties: - tablesDatasetMetadata: - $ref: '#/components/schemas/XPSTablesDatasetMetadata' + languageSupported: description: >- - The table/column id, column_name and the DataTypes of the columns - will be populated. - type: object - XPSTextComponentModel: + 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 + id: ClassifyTextResponse + AnalyzeEntitiesRequest: 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. - versionNumber: - format: int64 - description: >- - The servomatic model version number. Populated by uCAIP BE as part - of online PredictRequest. - type: string - servoModelName: - description: >- - The name of servo model. Populated by uCAIP BE as part of online - PredictRequest. - type: string - onlinePredictionModelGcsUri: - type: string - description: The Cloud Storage resource path to hold online prediction model. - submodelType: + encodingType: + enum: + - NONE + - UTF8 + - UTF16 + - UTF32 type: string + description: The encoding type used by the API to calculate offsets. 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. + If `EncodingType` is not specified, encoding-dependent information + (such as `begin_offset`) will be set at `-1`. - >- - Model type used to train default, MA, and ATC models in a single - batch worker pipeline. + 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. - >- - 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. - 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 - tfRuntimeVersion: - description: >- - ## The fields below are only populated under uCAIP request scope. - https://cloud.google.com/ml-engine/docs/runtime-version-list - type: string - batchPredictionModelGcsUri: - type: string - description: The Cloud Storage resource path to hold batch prediction model. - submodelName: + 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. + id: AnalyzeEntitiesRequest + description: The entity analysis request message. + type: object + XPSImageObjectDetectionModelSpec: + properties: + exportModelSpec: + $ref: '#/components/schemas/XPSImageExportModelSpec' + modelArtifactSpec: + $ref: '#/components/schemas/XPSImageModelArtifactSpec' + description: '## The fields below are only populated under uCAIP request scope.' + maxBoundingBoxCount: + description: Max number of bounding box. + format: int64 type: string - description: The name of the trained NL submodel. - partition: + stopReason: description: >- - The partition where the model is deployed. Populated by uCAIP BE as - part of online PredictRequest. - type: string + Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', + 'MODEL_CONVERGED'. enum: - - PARTITION_TYPE_UNSPECIFIED - - PARTITION_ZERO - - PARTITION_REDUCED_HOMING - - PARTITION_JELLYFISH - - PARTITION_CPU - - PARTITION_CUSTOM_STORAGE_CPU + - TRAIN_STOP_REASON_UNSPECIFIED + - TRAIN_STOP_REASON_BUDGET_REACHED + - TRAIN_STOP_REASON_MODEL_CONVERGED + - TRAIN_STOP_REASON_MODEL_EARLY_STOPPED 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. + - '' + - Model fully converged, can not be resumbed training. - >- - 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: 'Component model. Next ID: 10' - id: XPSTextComponentModel + Model early converged, can be further trained till full + convergency. + type: string + modelServingSpec: + $ref: '#/components/schemas/XPSImageModelServingSpec' + trainCostNodeSeconds: + 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 + classCount: + type: string + format: int64 + description: Total number of classes. + id: XPSImageObjectDetectionModelSpec type: object - ClassificationCategory: - id: ClassificationCategory + Sentiment: type: object - description: Represents a category returned from the text classifier. + id: Sentiment properties: - name: - type: string - description: The name of the category representing the document. - confidence: + magnitude: description: >- - The classifier's confidence of the category. Number represents how - certain the classifier is that this category represents the given - text. - format: float + A non-negative number in the [0, +inf) range, which represents the + absolute magnitude of sentiment regardless of score (positive or + negative). type: number - XPSSpeechPreprocessResponse: - 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. - cnsTrainDataPath: + format: float + score: + format: float description: >- - Location of shards of sstables (training data) of DataUtterance - protos. - type: string - cnsTestDataPath: - description: Location od shards of sstables (test data) of DataUtterance protos. - type: string - speechPreprocessStats: - $ref: '#/components/schemas/XPSSpeechPreprocessStats' - description: Stats associated with the data. + Sentiment score between -1.0 (negative sentiment) and 1.0 (positive + sentiment). + type: number + description: >- + Represents the feeling associated with the entire text or entities in + the text. + XPSImageModelServingSpec: + id: XPSImageModelServingSpec type: object - id: XPSSpeechPreprocessResponse - XPSConfusionMatrixRow: properties: - 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: - format: int32 - type: integer - count: + modelThroughputEstimation: items: - type: string - format: int64 + $ref: >- + #/components/schemas/XPSImageModelServingSpecModelThroughputEstimation + description: Populate under uCAIP request scope. type: array + tfRuntimeVersion: + 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: object - id: XPSConfusionMatrixRow - description: A row in the confusion matrix. - XPSBoundingBoxMetricsEntry: - description: >- - Bounding box matching model metrics for a single intersection-over-union - threshold and multiple label match confidence thresholds. - id: XPSBoundingBoxMetricsEntry - properties: - iouThreshold: - format: float + ## The fields below are only populated under uCAIP request scope. + https://cloud.google.com/ml-engine/docs/runtime-version-list + nodeQps: + format: double type: number description: >- - The intersection-over-union threshold value used to compute this - metrics entry. - confidenceMetricsEntries: - type: array - items: - $ref: >- - #/components/schemas/XPSBoundingBoxMetricsEntryConfidenceMetricsEntry + An estimated value of how much traffic a node can serve. Populated + for AutoMl request only. + description: Serving specification for image models. + XPSVisionTrainingOperationMetadata: + id: XPSVisionTrainingOperationMetadata + properties: + explanationUsage: + $ref: '#/components/schemas/InfraUsage' description: >- - Metrics for each label-match confidence_threshold from - 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. - meanAveragePrecision: - description: The mean average precision. - format: float - type: number + Aggregated infra usage within certain time period, for billing + report purpose if XAI is enable in training request. + deprecated: true type: object - XPSSpeechEvaluationMetrics: - properties: - subModelEvaluationMetrics: - description: Evaluation metrics for all submodels contained in this model. - type: array - items: - $ref: >- - #/components/schemas/XPSSpeechEvaluationMetricsSubModelEvaluationMetric + XPSVideoObjectTrackingEvaluationMetrics: type: object - id: XPSSpeechEvaluationMetrics - XPSTablesRegressionMetrics: - description: Metrics for Tables regression problems. + id: XPSVideoObjectTrackingEvaluationMetrics properties: - regressionMetricsEntries: + boundingBoxMetricsEntries: items: - $ref: '#/components/schemas/XPSRegressionMetricsEntry' + $ref: '#/components/schemas/XPSBoundingBoxMetricsEntry' description: >- - A list of actual versus predicted points for the model being - evaluated. + 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 - meanAbsoluteError: - format: double - description: Mean absolute error. - type: number - meanAbsolutePercentageError: - type: number + trackMeanAveragePrecision: description: >- - Mean absolute percentage error, only set if all of the target - column's values are positive. - format: double - rSquared: - type: number - description: R squared. - format: double - rootMeanSquaredLogError: - format: double - description: Root mean squared log error. - type: number - rootMeanSquaredError: - type: number - format: double - description: Root mean squared error. - id: XPSTablesRegressionMetrics - type: object - XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry: - id: XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry - description: Metrics for a single confidence threshold. - properties: - precision: - description: Precision for the given confidence threshold. - format: float + Output only. The single metric for tracks accuracy evaluation: the + mean_average_precision averaged over all track_metrics_entries. type: number - iouScore: format: float - description: IOU score. - type: number - confidenceThreshold: - description: The confidence threshold value used to compute the metrics. + boundingBoxMeanAveragePrecision: type: number format: float - diceScoreCoefficient: - description: 'DSC or the F1 score: The harmonic mean of recall and precision.' + description: >- + Output only. The single metric for bounding boxes evaluation: the + mean_average_precision averaged over all + bounding_box_metrics_entries. + trackMeanMismatchRate: format: float type: number - recall: - type: number - description: Recall for the given confidence threshold. - format: float - confusionMatrix: 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. - $ref: '#/components/schemas/XPSConfusionMatrix' - type: object - XPSTranslationPreprocessResponse: - description: Translation preprocess response. - type: object - id: XPSTranslationPreprocessResponse - properties: - validExampleCount: - type: string - format: int64 - description: Total valid example count. - parsedExampleCount: - type: string - format: int64 - description: Total example count parsed. - XPSTextSentimentEvaluationMetrics: - type: object - description: Model evaluation metrics for text sentiment problems. - properties: - meanAbsoluteError: + Output only. The single metric for tracking consistency evaluation: + the mean_mismatch_rate averaged over all track_metrics_entries. + trackMetricsEntries: + items: + $ref: '#/components/schemas/XPSTrackMetricsEntry' + type: array 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 - precision: - description: Output only. Precision. - type: number - format: float - linearKappa: + 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. + evaluatedTrackCount: + type: integer + format: int32 + description: The number of tracks used for model evaluation. + trackMeanBoundingBoxIou: description: >- - Output only. Linear weighted kappa. Only set for the overall model - evaluation, not for evaluation of a single annotation spec. + Output only. The single metric for tracks bounding box iou + evaluation: the mean_bounding_box_iou averaged over all + track_metrics_entries. format: float type: number - 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. - f1Score: + evaluatedBoundingboxCount: + type: integer + description: The number of bounding boxes used for model evaluation. + format: int32 + evaluatedFrameCount: + description: The number of video frames used for model evaluation. + format: int32 + type: integer + description: 'Model evaluation metrics for ObjectTracking problems. Next tag: 10.' + XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry: + type: object + id: XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry + description: Metrics for a single confidence threshold. + properties: + iouScore: type: number format: float - description: Output only. The harmonic mean of recall and precision. + description: IOU score. recall: - description: Output only. Recall. type: number + description: Recall for the given confidence threshold. format: float - quadraticKappa: - format: float + precision: type: number - description: >- - Output only. Quadratic weighted kappa. Only set for the overall - model evaluation, not for evaluation of a single annotation spec. - meanSquaredError: + description: Precision for the given confidence threshold. + format: float + diceScoreCoefficient: + format: float type: number + description: 'DSC or the F1 score: The harmonic mean of recall and precision.' + confusionMatrix: + $ref: '#/components/schemas/XPSConfusionMatrix' description: >- - Output only. Mean squared error. Only set for the overall model - evaluation, not for evaluation of a single annotation spec. + Confusion matrix of the per confidence_threshold evaluation. Pixel + counts are set here. Only set for model level evaluation, not for + evaluation per label. + confidenceThreshold: format: float - id: XPSTextSentimentEvaluationMetrics - DiskMetric: - id: DiskMetric - properties: - gibSec: - type: string - format: int64 - 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. - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - type: string - type: object - XPSModelArtifactItem: + type: number + description: The confidence threshold value used to compute the metrics. + XPSTimestampStatsGranularStats: + id: XPSTimestampStatsGranularStats + description: Stats split by a defined in context granularity. properties: - gcsUri: + buckets: + additionalProperties: + type: string + format: int64 + type: object description: >- - The Google Cloud Storage (GCS) uri that stores the model binary - files. - type: string - artifactFormat: - type: string - 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 - description: The model artifact format. - enum: - - ARTIFACT_FORMAT_UNSPECIFIED - - TF_CHECKPOINT - - TF_SAVED_MODEL - - TF_LITE - - EDGE_TPU_TF_LITE - - TF_JS - - CORE_ML - description: A single model artifact item. + 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: XPSModelArtifactItem - XPSImageSegmentationTrainResponse: - id: XPSImageSegmentationTrainResponse + XPSTextExtractionEvaluationMetrics: type: object + id: XPSTextExtractionEvaluationMetrics properties: - modelArtifactSpec: - 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' - exportModelSpec: - $ref: '#/components/schemas/XPSImageExportModelSpec' - description: 'NOTE: These fields are not used/needed in EAP but will be set later.' - trainCostNodeSeconds: - 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: string - colorMaps: - items: - $ref: '#/components/schemas/XPSColorMap' + confidenceMetricsEntries: type: array - description: Color map of the model. - 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 + items: + $ref: '#/components/schemas/XPSConfidenceMetricsEntry' description: >- - Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', - 'MODEL_CONVERGED'. - modelServingSpec: - $ref: '#/components/schemas/XPSImageModelServingSpec' - XPSStructStats: - properties: - commonStats: - $ref: '#/components/schemas/XPSCommonStats' - fieldStats: - type: object + 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: + $ref: '#/components/schemas/XPSConfusionMatrix' 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. + Confusion matrix of the model, at the default confidence threshold + (0.0). Only set for whole-model evaluation, not for evaluation per + label. + perLabelConfidenceMetrics: + type: object + deprecated: true additionalProperties: - $ref: '#/components/schemas/XPSDataStats' - id: XPSStructStats - description: The data statistics of a series of STRUCT values. - type: object - XPSReportingMetrics: - id: XPSReportingMetrics - type: object - properties: - effectiveTrainingDuration: + $ref: '#/components/schemas/XPSConfidenceMetricsEntry' + description: Only recall, precision, and f1_score will be set. + bestF1ConfidenceMetrics: + $ref: '#/components/schemas/XPSConfidenceMetricsEntry' 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. - type: string - format: google-duration + 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 - metricEntries: - description: >- - One entry per metric name. The values must be aggregated per metric - name. - items: - $ref: '#/components/schemas/XPSMetricEntry' - type: array - XPSTableSpec: - type: object - id: XPSTableSpec - properties: - timeColumnId: - type: integer - description: The id of the time column. - format: int32 - importedDataSizeInBytes: - format: int64 - description: The total size of imported data of the table. - type: string - columnSpecs: - type: object - description: Mapping from column id to column spec. - additionalProperties: - $ref: '#/components/schemas/XPSColumnSpec' - rowCount: - description: The number of rows in the table. - type: string - format: int64 - validRowCount: - format: int64 - type: string - description: The number of valid rows. - XPSResponseExplanationSpec: + AnnotateTextRequest: type: object - deprecated: true - id: XPSResponseExplanationSpec + id: AnnotateTextRequest properties: - metadata: - description: Metadata describing the Model's input and output for explanation. - $ref: '#/components/schemas/XPSResponseExplanationMetadata' - parameters: - $ref: '#/components/schemas/XPSResponseExplanationParameters' - description: Parameters that configure explaining of the Model's predictions. - explanationType: - description: >- - Explanation type. For AutoML Image Classification models, possible - values are: * `image-integrated-gradients` * `image-xrai` + 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. + document: + $ref: '#/components/schemas/Document' + description: Required. Input document. + features: + $ref: '#/components/schemas/AnnotateTextRequestFeatures' + description: Required. The enabled features. description: >- - Specification of Model explanation. Feature-based XAI in AutoML Vision - ICN is deprecated, see b/288407203 for context. - AnalyzeEntitiesResponse: - description: The entity analysis response message. - id: AnalyzeEntitiesResponse + The request message for the text annotation API, which can perform + multiple analysis types in one call. + ModerateTextResponse: + id: ModerateTextResponse + description: The document moderation response message. + type: object properties: languageCode: type: string @@ -3354,21 +2585,129 @@ components: specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. - entities: - type: array + moderationCategories: items: - $ref: '#/components/schemas/Entity' - description: The recognized entities in the input document. + $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. + XPSEvaluationMetrics: + id: XPSEvaluationMetrics + type: object + properties: + annotationSpecIdToken: + 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. + type: string + imageObjectDetectionEvalMetrics: + $ref: '#/components/schemas/XPSImageObjectDetectionEvaluationMetrics' + textClassificationEvalMetrics: + $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. + videoObjectTrackingEvalMetrics: + $ref: '#/components/schemas/XPSVideoObjectTrackingEvaluationMetrics' + videoActionRecognitionEvalMetrics: + $ref: '#/components/schemas/XPSVideoActionRecognitionEvaluationMetrics' + textSentimentEvalMetrics: + $ref: '#/components/schemas/XPSTextSentimentEvaluationMetrics' + translationEvalMetrics: + $ref: '#/components/schemas/XPSTranslationEvaluationMetrics' + category: + 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. + type: integer + evaluatedExampleCount: + format: int32 + type: integer + description: >- + The number of examples used to create this evaluation metrics + instance. + imageClassificationEvalMetrics: + $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' + textExtractionEvalMetrics: + $ref: '#/components/schemas/XPSTextExtractionEvaluationMetrics' + regressionEvalMetrics: + $ref: '#/components/schemas/XPSRegressionEvaluationMetrics' + tablesEvalMetrics: + $ref: '#/components/schemas/XPSTablesEvaluationMetrics' + videoClassificationEvalMetrics: + $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' + imageSegmentationEvalMetrics: + $ref: '#/components/schemas/XPSImageSegmentationEvaluationMetrics' + tablesClassificationEvalMetrics: + $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' + description: >- + Contains xPS-specific model evaluation metrics either for a single + annotation spec (label), or for the model overall. Next tag: 18. + XPSTablesDatasetMetadata: + id: XPSTablesDatasetMetadata + properties: + primaryTableSpec: + $ref: '#/components/schemas/XPSTableSpec' + description: Primary table. + targetColumnId: + format: int32 + description: >- + Id of the primary table column that should be used as the training + label. + type: integer + targetColumnCorrelations: + additionalProperties: + $ref: '#/components/schemas/XPSCorrelationStats' + description: '(the column id : its CorrelationStats with target column).' + type: object + mlUseColumnId: + format: int32 + description: Id the column to split the table. + type: integer + weightColumnId: + type: integer + description: >- + Id of the primary table column that should be used as the weight + column. + format: int32 + type: object + description: 'Metadata for a dataset used for AutoML Tables. Next ID: 6' + XPSTranslationEvaluationMetrics: + id: XPSTranslationEvaluationMetrics + description: Evaluation metrics for the dataset. + properties: + baseBleuScore: + description: BLEU score for base model. + format: double + type: number + bleuScore: + type: number + format: double + description: BLEU score. type: object XPSConfusionMatrix: type: object description: Confusion matrix of the model running the classification. + id: XPSConfusionMatrix properties: category: description: >- @@ -3377,389 +2716,318 @@ components: annotation_spec_id_token. type: array items: - format: int32 type: integer - annotationSpecIdToken: + format: int32 + row: + items: + $ref: '#/components/schemas/XPSConfusionMatrixRow' 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. + annotationSpecIdToken: items: type: string + type: array 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: + 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. - type: array items: format: int32 type: integer - row: + XPSBatchPredictResponse: + id: XPSBatchPredictResponse + properties: + exampleSet: + $ref: '#/components/schemas/XPSExampleSet' 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. + 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. + type: object + XPSRow: + id: XPSRow + type: object + properties: + values: items: - $ref: '#/components/schemas/XPSConfusionMatrixRow' + 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 - id: XPSConfusionMatrix - XPSConfidenceMetricsEntry: + columnIds: + items: + type: integer + format: int32 + description: >- + The ids of the columns. Note: The below `values` field must match + order of this field, if this field is set. + type: array + XPSColorMap: + properties: + annotationSpecIdToken: + type: string + description: Should be used during training. + intColor: + $ref: '#/components/schemas/XPSColorMapIntColor' + color: + deprecated: true + 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' + displayName: + description: Should be used during preprocessing. + type: string + description: >- + Map from color to display name. Will only be used by Image Segmentation + for uCAIP. + id: XPSColorMap + type: object + XPSXraiAttribution: + deprecated: true + 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). + 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 + id: XPSXraiAttribution + XPSTablesClassificationMetrics: + properties: + curveMetrics: + items: + $ref: '#/components/schemas/XPSTablesClassificationMetricsCurveMetrics' + type: array + description: Metrics building a curve. + type: object + description: Metrics for Tables classification problems. + id: XPSTablesClassificationMetrics + XPSArrayStats: + id: XPSArrayStats + type: object + properties: + 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. + commonStats: + $ref: '#/components/schemas/XPSCommonStats' + description: The data statistics of a series of ARRAY values. + XPSTfSavedModelFormat: + properties: {} + type: object + id: XPSTfSavedModelFormat + description: A tensorflow model format in SavedModel format. + XPSTrainingObjectivePoint: + id: XPSTrainingObjectivePoint type: object - id: XPSConfidenceMetricsEntry properties: - falseNegativeCount: + createTime: + format: google-datetime type: string - format: int64 - description: >- - The number of ground truth labels that are not matched by a model - created label. - precision: - type: number - description: Precision for the given confidence threshold. - format: float - f1Score: - format: float - type: number - description: The harmonic mean of recall and precision. - falsePositiveRate: - type: number - description: False Positive Rate for the given confidence threshold. + description: The time at which this point was recorded. + value: format: float - falsePositiveRateAt1: type: number + description: The objective value when this point was recorded. + XPSDataType: + properties: + nullable: + type: boolean + description: If true, this DataType can also be `null`. + structType: 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. - format: float - falsePositiveCount: - format: int64 + If type_code == STRUCT, then `struct_type` provides type information + for the struct's fields. + $ref: '#/components/schemas/XPSStructType' + listElementType: description: >- - The number of model created labels that do not match a ground truth - label. - type: string - truePositiveCount: - description: The number of model created labels that match a ground truth label. - format: int64 + If type_code == ARRAY, then `list_element_type` is the type of the + elements. + $ref: '#/components/schemas/XPSDataType' + 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 - trueNegativeCount: - 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. + description: Required. The TypeCode for this type. + compatibleDataTypes: + type: array + description: The highly compatible data types to this data type. + items: + $ref: '#/components/schemas/XPSDataType' + timeFormat: type: string - f1ScoreAt1: - format: float - description: The harmonic mean of recall_at1 and precision_at1. - type: number - positionThreshold: - 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. - type: integer - precisionAt1: - description: >- - The precision when only considering the label that has the highest - prediction score and not below the confidence threshold for each - example. - type: number - format: float - 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 example. - recall: - description: Recall (true positive rate) for the given confidence threshold. - format: float - type: number - confidenceThreshold: - type: number description: >- - Metrics are computed with an assumption that the model never return - predictions with score lower than this value. - format: float - description: >- - ConfidenceMetricsEntry includes generic precision, recall, f1 score etc. - Next tag: 16. - XPSStructType: - 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. + 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: object - id: XPSStructType - XPSVideoActionRecognitionEvaluationMetrics: + id: XPSDataType + description: >- + Indicated the type of data that can be stored in a structured data + entity (e.g. a table). + XPSTablesModelStructure: + description: A description of Tables model structure. type: object properties: - videoActionMetricsEntries: + modelParameters: + description: A list of models. type: array - description: >- - Output only. The metric entries for precision window lengths: - 1s,2s,3s,4s, 5s. items: - $ref: '#/components/schemas/XPSVideoActionMetricsEntry' - evaluatedActionCount: - 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. - id: XPSVideoActionRecognitionEvaluationMetrics - XPSVideoActionMetricsEntryConfidenceMetricsEntry: - id: XPSVideoActionMetricsEntryConfidenceMetricsEntry - type: object + $ref: '#/components/schemas/XPSTablesModelStructureModelParameters' + id: XPSTablesModelStructure + XPSStructStats: + description: The data statistics of a series of STRUCT values. + id: XPSStructStats properties: - precision: - format: float - description: Output only. Precision for the given confidence threshold. - type: number - confidenceThreshold: - format: float + commonStats: + $ref: '#/components/schemas/XPSCommonStats' + fieldStats: + type: object + additionalProperties: + $ref: '#/components/schemas/XPSDataStats' description: >- - Output only. The confidence threshold value used to compute the - metrics. - type: number - f1Score: - type: number - format: float - description: Output only. The harmonic mean of recall and precision. - recall: - description: Output only. Recall for the given confidence threshold. - type: number - format: float - description: Metrics for a single confidence threshold. - XPSTfSavedModelFormat: + 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 - properties: {} - description: A tensorflow model format in SavedModel format. - id: XPSTfSavedModelFormat - XPSSpeechModelSpec: - id: XPSSpeechModelSpec + XPSSpeechEvaluationMetricsSubModelEvaluationMetric: + id: XPSSpeechEvaluationMetricsSubModelEvaluationMetric type: object properties: - datasetId: - type: string + wer: + type: number + description: Word error rate (standard error metric used for speech recognition). + format: double + numWords: + format: int32 + type: integer + description: Number of words over which the word error rate was computed. + numInsertions: + format: int32 + type: integer + numSubstitutions: + type: integer + format: int32 + isEnhancedModel: 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. - format: int64 - language: - type: string - subModelSpecs: - items: - $ref: '#/components/schemas/XPSSpeechModelSpecSubModelSpec' - type: array - description: Model specs for all submodels contained in this model. - XPSImageModelArtifactSpec: - id: XPSImageModelArtifactSpec + If true then it means we have an enhanced version of the biasing + models. + type: boolean + numDeletions: + type: integer + format: int32 + numUtterances: + description: Number of utterances used in the wer computation. + format: int32 + type: integer + biasingModelType: + enum: + - BIASING_MODEL_TYPE_UNSPECIFIED + - COMMAND_AND_SEARCH + - PHONE_CALL + - VIDEO + - DEFAULT + description: Type of the biasing model. + 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 + sentenceAccuracy: + type: number + format: double + description: Below fields are used for debugging purposes + XPSTablesModelStructureModelParameters: + description: Model hyper-parameters for a model. + id: XPSTablesModelStructureModelParameters type: object properties: - exportArtifact: + hyperparameters: type: array items: - $ref: '#/components/schemas/XPSModelArtifactItem' - description: The model binary files in different formats for model export. - tfLiteMetadataGcsUri: - description: GCS uri of Tensorflow Lite metadata 'tflite_metadata.json'. - type: string - 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' - labelGcsUri: - type: string - description: GCS uri of decoded labels file for model export 'dict.txt'. - tfJsBinaryGcsPrefix: + $ref: >- + #/components/schemas/XPSTablesModelStructureModelParametersParameter + XPSImageSegmentationEvaluationMetrics: + properties: + confidenceMetricsEntries: 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. + Metrics that have confidence thresholds. Precision-recall curve can + be derived from it. + items: + $ref: >- + #/components/schemas/XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry + type: array + id: XPSImageSegmentationEvaluationMetrics + description: 'Model evaluation metrics for image segmentation problems. Next tag: 4.' + type: object GpuMetric: + type: object + id: GpuMetric properties: machineSpec: - description: Required. Machine spec, e.g. N1_STANDARD_4. - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' type: string + description: Required. Machine spec, e.g. N1_STANDARD_4. enum: - UNKNOWN_MACHINE_SPEC - N1_STANDARD_2 @@ -3919,7 +3187,6 @@ components: - C3_HIGHMEM_44 - C3_HIGHMEM_88 - C3_HIGHMEM_176 - gpuType: enumDescriptions: - '' - '' @@ -3931,858 +3198,1595 @@ components: - '' - '' - '' - description: Required. Type of GPU, e.g. NVIDIA_TESLA_V100. - 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 - type: string - trackingLabels: - type: object - 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" - additionalProperties: - type: string - gpuSec: - description: Required. Seconds of GPU usage, e.g. 3600. - format: int64 - type: string - id: GpuMetric - type: object - XPSSpeechEvaluationMetricsSubModelEvaluationMetric: - id: XPSSpeechEvaluationMetricsSubModelEvaluationMetric - type: object - properties: - wer: - description: Word error rate (standard error metric used for speech recognition). - format: double - type: number - numUtterances: - description: Number of utterances used in the wer computation. - format: int32 - type: integer - sentenceAccuracy: - type: number - format: double - description: Below fields are used for debugging purposes - numInsertions: - format: int32 - type: integer - isEnhancedModel: - type: boolean - description: >- - If true then it means we have an enhanced version of the biasing - models. - 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 - description: Type of the biasing model. - type: string - enum: - - BIASING_MODEL_TYPE_UNSPECIFIED - - COMMAND_AND_SEARCH - - PHONE_CALL - - VIDEO - - DEFAULT - numDeletions: - type: integer - format: int32 - numWords: - description: Number of words over which the word error rate was computed. - type: integer - format: int32 - numSubstitutions: - type: integer - format: int32 - XPSImageObjectDetectionEvaluationMetrics: - type: object - id: XPSImageObjectDetectionEvaluationMetrics - properties: - 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: - description: >- - 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 - boundingBoxMeanAveragePrecision: - description: >- - The single metric for bounding boxes evaluation: the - mean_average_precision averaged over all - bounding_box_metrics_entries. - type: number - format: float - description: >- - Model evaluation metrics for image object detection problems. Evaluates - prediction quality of labeled bounding boxes. - XPSColorMap: - type: object - id: XPSColorMap - properties: - 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: - description: Should be used during preprocessing. - type: string - annotationSpecIdToken: - type: string - description: Should be used during training. - intColor: - $ref: '#/components/schemas/XPSColorMapIntColor' - description: >- - Map from color to display name. Will only be used by Image Segmentation - for uCAIP. - XPSEdgeTpuTfLiteFormat: - id: XPSEdgeTpuTfLiteFormat - description: >- - A model format used for [Edge TPU](https://cloud.google.com/edge-tpu/) - devices. - properties: {} - type: object - TextSpan: - properties: - beginOffset: - type: integer - format: int32 - description: >- - The API calculates the beginning offset of the content in the - original document according to the EncodingType specified in the API - request. - content: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + gpuSec: + description: Required. Seconds of GPU usage, e.g. 3600. type: string - description: The content of the text span, which is a substring of the document. - id: TextSpan - description: Represents a text span in the input document. - type: object - XPSTablesModelStructure: - id: XPSTablesModelStructure - description: A description of Tables model structure. - type: object - properties: - modelParameters: - items: - $ref: '#/components/schemas/XPSTablesModelStructureModelParameters' - description: A list of models. - type: array - XPSVideoClassificationTrainResponse: - type: object - id: XPSVideoClassificationTrainResponse - properties: - modelArtifactSpec: - description: '## The fields below are only populated under uCAIP request scope.' - $ref: '#/components/schemas/XPSVideoModelArtifactSpec' - trainCostNodeSeconds: format: int64 + trackingLabels: + type: object + additionalProperties: + 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. + 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" + gpuType: type: string - AnalyzeSentimentResponse: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + description: Required. Type of GPU, e.g. NVIDIA_TESLA_V100. + 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 + XPSTablesTrainResponse: properties: - documentSentiment: - $ref: '#/components/schemas/Sentiment' - description: The overall sentiment of the input document. - languageSupported: + trainCostMilliNodeHours: + format: int64 + type: string 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 - sentences: + 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. + predictionSampleRows: + description: Sample rows from the dataset this model was trained. + items: + $ref: '#/components/schemas/XPSRow' type: array - description: The sentiment for all the sentences in the document. + tablesModelColumnInfo: items: - $ref: '#/components/schemas/Sentence' - languageCode: - type: string + $ref: '#/components/schemas/XPSTablesModelColumnInfo' + 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. + Output only. Auxiliary information for each of the + input_feature_column_specs, with respect to this particular model. + modelStructure: + $ref: '#/components/schemas/XPSTablesModelStructure' + id: XPSTablesTrainResponse type: object - description: The sentiment analysis response message. - id: AnalyzeSentimentResponse - XPSResponseExplanationMetadataInputMetadata: + TpuMetric: properties: - visualizationConfig: - description: Visualization configurations for image explanation. - $ref: '#/components/schemas/XPSVisualization' - inputTensorName: - type: string - description: >- - Name of the input tensor for this model. Only needed in train - response. - modality: + tpuSec: + description: Required. Seconds of TPU usage, e.g. 3600. + format: int64 type: string + tpuType: enum: - - MODALITY_UNSPECIFIED - - NUMERIC - - IMAGE - - CATEGORICAL - description: >- - Modality of the feature. Valid values are: numeric, image. Defaults - to numeric. + - UNKNOWN_TPU_TYPE + - TPU_V2_POD + - TPU_V2 + - TPU_V3_POD + - TPU_V3 + - TPU_V5_LITEPOD + type: string + description: Required. Type of TPU, e.g. TPU_V2, TPU_V3_POD. enumDescriptions: - '' - '' - '' - '' + - '' + - '' + type: object + id: TpuMetric + XPSDataStats: + id: XPSDataStats type: object - id: XPSResponseExplanationMetadataInputMetadata - description: Metadata of the input of a feature. - XPSTablesEvaluationMetrics: properties: - regressionMetrics: - description: Regression metrics. - $ref: '#/components/schemas/XPSTablesRegressionMetrics' - classificationMetrics: - $ref: '#/components/schemas/XPSTablesClassificationMetrics' - description: Classification metrics. + validValueCount: + description: The number of values that are valid. + format: int64 + type: string + float64Stats: + description: The statistics for FLOAT64 DataType. + $ref: '#/components/schemas/XPSFloat64Stats' + stringStats: + description: The statistics for STRING DataType. + $ref: '#/components/schemas/XPSStringStats' + categoryStats: + description: The statistics for CATEGORY DataType. + $ref: '#/components/schemas/XPSCategoryStats' + distinctValueCount: + format: int64 + type: string + description: The number of distinct values. + structStats: + $ref: '#/components/schemas/XPSStructStats' + description: The statistics for STRUCT DataType. + arrayStats: + $ref: '#/components/schemas/XPSArrayStats' + description: The statistics for ARRAY DataType. + nullValueCount: + description: The number of values that are null. + type: string + format: int64 + timestampStats: + $ref: '#/components/schemas/XPSTimestampStats' + description: The statistics for TIMESTAMP DataType. + description: The data statistics of a series of values that share the same DataType. + ClassificationCategory: type: object - id: XPSTablesEvaluationMetrics - XPSImageClassificationTrainResponse: - id: XPSImageClassificationTrainResponse properties: - 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' - stopReason: - enum: - - TRAIN_STOP_REASON_UNSPECIFIED - - TRAIN_STOP_REASON_BUDGET_REACHED - - TRAIN_STOP_REASON_MODEL_CONVERGED - - TRAIN_STOP_REASON_MODEL_EARLY_STOPPED + confidence: description: >- - Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', - 'MODEL_CONVERGED', 'MODEL_EARLY_STOPPED'. + 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 + name: + description: The name of the category representing the document. type: string + description: Represents a category returned from the text classifier. + id: ClassificationCategory + XPSVideoActionMetricsEntryConfidenceMetricsEntry: + type: object + id: XPSVideoActionMetricsEntryConfidenceMetricsEntry + description: Metrics for a single confidence threshold. + properties: + confidenceThreshold: + format: float + type: number + description: >- + Output only. The confidence threshold value used to compute the + metrics. + recall: + type: number + format: float + description: Output only. Recall for the given confidence threshold. + precision: + description: Output only. Precision for the given confidence threshold. + type: number + format: float + f1Score: + description: Output only. The harmonic mean of recall and precision. + type: number + format: float + XPSDockerFormat: + type: object + 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. + id: XPSDockerFormat + properties: + cpuArchitecture: + enum: + - CPU_ARCHITECTURE_UNSPECIFIED + - CPU_ARCHITECTURE_X86_64 enumDescriptions: - '' - - '' - - Model fully converged, can not be resumbed training. - - >- - Model early converged, can be further trained till full - convergency. - trainCostInNodeTime: - type: string - format: google-duration - 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. - modelServingSpec: - $ref: '#/components/schemas/XPSImageModelServingSpec' - classCount: - type: string - format: int64 - description: Total number of classes. - trainCostNodeSeconds: - format: int64 + - '' + description: >- + Optional. Additional cpu information describing the requirements for + the to be exported model files. type: string + gpuArchitecture: description: >- - The actual training cost, expressed in node seconds. Populated for - models trained in node time. - modelArtifactSpec: - $ref: '#/components/schemas/XPSImageModelArtifactSpec' - description: '## The fields below are only populated under uCAIP request scope.' - type: object - XPSCommonStats: + Optional. Additional gpu information describing the requirements for + the to be exported model files. + enum: + - GPU_ARCHITECTURE_UNSPECIFIED + - GPU_ARCHITECTURE_NVIDIA + type: string + enumDescriptions: + - '' + - '' + XPSTablesEvaluationMetrics: + id: XPSTablesEvaluationMetrics type: object - description: Common statistics for a column with a specified data type. properties: - nullValueCount: - format: int64 - type: string - distinctValueCount: - type: string - format: int64 - validValueCount: - type: string - format: int64 - id: XPSCommonStats - XPSExampleSet: - description: Set of examples or input sources. + regressionMetrics: + $ref: '#/components/schemas/XPSTablesRegressionMetrics' + description: Regression metrics. + classificationMetrics: + description: Classification metrics. + $ref: '#/components/schemas/XPSTablesClassificationMetrics' + XPSSpeechModelSpecSubModelSpec: + id: XPSSpeechModelSpecSubModelSpec properties: - numExamples: + contextId: type: string - format: int64 - description: Number of examples. - numInputSources: - description: Number of input sources. + description: In S3, Recognition ClientContextId.context_id + biasingModelType: type: string - format: int64 - fingerprint: - format: int64 - description: Fingerprint of the example set. + 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 + 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 - fileSpec: - $ref: '#/components/schemas/XPSFileSpec' - description: File spec of the examples or input sources. - type: object - id: XPSExampleSet - XPSTrainResponse: type: object + XPSRegressionEvaluationMetrics: properties: - 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 - textTrainResp: - description: Will only be needed for uCAIP from Beta. - $ref: '#/components/schemas/XPSTextTrainResponse' - videoClassificationTrainResp: - $ref: '#/components/schemas/XPSVideoClassificationTrainResponse' - speechTrainResp: - $ref: '#/components/schemas/XPSSpeechModelSpec' - imageObjectDetectionTrainResp: - $ref: '#/components/schemas/XPSImageObjectDetectionModelSpec' - tablesTrainResp: - $ref: '#/components/schemas/XPSTablesTrainResponse' - deployedModelSizeBytes: - type: string - description: Estimated model size in bytes once deployed. - format: int64 - 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. - videoObjectTrackingTrainResp: - $ref: '#/components/schemas/XPSVideoObjectTrackingTrainResponse' - imageSegmentationTrainResp: - $ref: '#/components/schemas/XPSImageSegmentationTrainResponse' - errorAnalysisConfigs: + rootMeanSquaredError: + type: number + format: float + description: Root Mean Squared Error (RMSE). + rSquared: + type: number + format: float + description: R squared. + meanAbsoluteError: + description: Mean Absolute Error (MAE). + type: number + format: float + rootMeanSquaredLogError: + type: number + description: Root mean squared log error. + format: float + meanAbsolutePercentageError: + type: number 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' - type: array - textToSpeechTrainResp: - $ref: '#/components/schemas/XPSTextToSpeechTrainResponse' - imageClassificationTrainResp: - $ref: '#/components/schemas/XPSImageClassificationTrainResponse' - videoActionRecognitionTrainResp: - $ref: '#/components/schemas/XPSVideoActionRecognitionTrainResponse' - explanationConfigs: + Mean absolute percentage error. Only set if all ground truth values + are positive. + format: float + regressionMetricsEntries: items: - $ref: '#/components/schemas/XPSResponseExplanationSpec' + $ref: '#/components/schemas/XPSRegressionMetricsEntry' description: >- - VisionExplanationConfig for XAI on test set. Optional for when XAI - is enable in training request. - deprecated: true + A list of actual versus predicted points for the model being + evaluated. type: array - evaluationMetricsSet: - description: >- - The trained model evaluation metrics. This can be optionally - returned. - $ref: '#/components/schemas/XPSEvaluationMetricsSet' - translationTrainResp: - $ref: '#/components/schemas/XPSTranslationTrainResponse' - id: XPSTrainResponse - description: 'Next ID: 18' - XPSColumnSpec: + description: >- + Model evaluation metrics for regression problems. It can be used for + Tables. + id: XPSRegressionEvaluationMetrics type: object + InfraUsage: + id: InfraUsage properties: - dataType: - description: >- - The data type of the column. It's outputed in Preprocess rpc and a - required input for RefreshTablesStats and Train. - $ref: '#/components/schemas/XPSDataType' - columnId: - 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 - format: int32 - topCorrelatedColumns: + tpuMetrics: + type: array + description: Aggregated tpu metrics since requested start_time. items: - $ref: '#/components/schemas/XPSColumnSpecCorrelatedColumn' - description: It's outputed in RefreshTablesStats, and a required input in Train. + $ref: '#/components/schemas/TpuMetric' + cpuMetrics: + description: Aggregated core metrics since requested start_time. + items: + $ref: '#/components/schemas/CpuMetric' type: array - displayName: - type: string - description: >- - The display name of the column. It's outputed in Preprocess 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. - forecastingMetadata: - $ref: '#/components/schemas/XPSColumnSpecForecastingMetadata' - id: XPSColumnSpec - XPSStringStatsUnigramStats: - id: XPSStringStatsUnigramStats + ramMetrics: + type: array + description: Aggregated ram metrics since requested start_time. + items: + $ref: '#/components/schemas/RamMetric' + diskMetrics: + type: array + description: Aggregated persistent disk metrics since requested start_time. + items: + $ref: '#/components/schemas/DiskMetric' + gpuMetrics: + items: + $ref: '#/components/schemas/GpuMetric' + description: Aggregated gpu metrics since requested start_time. + type: array + description: 'Infra Usage of billing metrics. Next ID: 6' type: object - description: The statistics of a unigram. + AnnotateTextResponse: + description: The text annotations response message. + id: AnnotateTextResponse properties: - value: - description: The unigram. - type: string - count: - format: int64 + documentSentiment: + description: >- + The overall sentiment for the document. Populated if the user + enables AnnotateTextRequest.Features.extract_document_sentiment. + $ref: '#/components/schemas/Sentiment' + categories: + type: array + items: + $ref: '#/components/schemas/ClassificationCategory' + description: Categories identified in the input document. + languageCode: type: string - description: The number of occurrences of this unigram in the series. - XPSSpeechPreprocessStats: - properties: - dataErrors: + 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. type: array items: - $ref: '#/components/schemas/XPSDataErrors' - description: Different types of data errors and the counts associated with them. - trainSentencesCount: - type: integer - format: int32 - 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 - testSentencesCount: - description: The number of sentences in the test data set. - format: int32 - type: integer - numHumanLabeledExamples: - description: The number of rows marked HUMAN_LABELLED - format: int32 - type: integer - trainWordsCount: - type: integer - description: The number of words in the training data set. - format: int32 - numLogsExamples: - type: integer - description: The number of samples found in the previously recorded logs data. - format: int32 - 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 - testWordsCount: - type: integer - description: The number of words in the test data set. - format: int32 - id: XPSSpeechPreprocessStats + $ref: '#/components/schemas/Sentence' + moderationCategories: + description: Harmful and sensitive categories identified in the input document. + items: + $ref: '#/components/schemas/ClassificationCategory' + type: array + entities: + 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. + 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. type: object - XPSMetricEntry: + XPSFloat64StatsHistogramBucket: + id: XPSFloat64StatsHistogramBucket + description: A bucket of a histogram. properties: - int64Value: - format: int64 - description: A signed 64-bit integer value. - type: string - metricName: - type: string - description: The metric name defined in the service configuration. - doubleValue: + max: + description: >- + The maximum value of the bucket, exclusive unless max = + `"Infinity"`, in which case it's inclusive. type: number format: double - description: A double value. - systemLabels: - type: array - description: Billing system labels for this (metric, value) pair. - items: - $ref: '#/components/schemas/XPSMetricEntryLabel' - argentumMetricId: + min: + format: double + description: The minimum value of the bucket, inclusive. + type: number + count: type: string 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. + The number of data values that are in the bucket, i.e. are between + min and max values. + format: int64 type: object - id: XPSMetricEntry - XPSColumnSpecCorrelatedColumn: - description: >- - Identifies a table's column, and its correlation with the column this - ColumnSpec describes. + XPSImageObjectDetectionEvaluationMetrics: type: object properties: - columnId: + 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/XPSBoundingBoxMetricsEntry' + evaluatedBoundingBoxCount: format: int32 + description: >- + The total number of bounding boxes (i.e. summed over all images) the + ground truth used to create this evaluation had. type: integer - correlationStats: - $ref: '#/components/schemas/XPSCorrelationStats' - id: XPSColumnSpecCorrelatedColumn - XPSMetricEntryLabel: - id: XPSMetricEntryLabel + boundingBoxMeanAveragePrecision: + format: float + description: >- + The single metric for bounding boxes evaluation: the + mean_average_precision averaged over all + bounding_box_metrics_entries. + type: number + description: >- + Model evaluation metrics for image object detection problems. Evaluates + prediction quality of labeled bounding boxes. + id: XPSImageObjectDetectionEvaluationMetrics + RamMetric: properties: - labelValue: + gibSec: + description: >- + Required. VM memory in Gigabyte second, e.g. 3600. Using int64 type + to match billing metrics definition. type: string - description: The value of the label. - labelName: + format: int64 + 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 + memories: + format: double + type: number + description: Required. VM memory in gb. + machineSpec: + type: string + 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_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 + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + ramType: + enum: + - UNKNOWN_RAM_TYPE + - A2 + - A3 + - C2 + - C2D + - CUSTOM + - E2 + - G2 + - C3 + - M2 + - M1 + - N1 + - N2_CUSTOM + - N2 + - N2D type: string - description: The name of the label. + description: Required. Type of ram. + enumDescriptions: + - '' + - '' + - '' + - COMPUTE_OPTIMIZED + - '' + - '' + - '' + - '' + - '' + - MEMORY_OPTIMIZED_UPGRADE_PREMIUM + - MEMORY_OPTIMIZED + - '' + - '' + - '' + - '' type: object - XPSFloat64Stats: + id: RamMetric + XPSTrainResponse: + description: 'Next ID: 18' + type: object + id: XPSTrainResponse properties: - quantiles: + videoClassificationTrainResp: + $ref: '#/components/schemas/XPSVideoClassificationTrainResponse' + errorAnalysisConfigs: 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. + 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: - type: number - format: double + $ref: '#/components/schemas/XPSVisionErrorAnalysisConfig' type: array - mean: - description: The mean of the series. - type: number - format: double - commonStats: - $ref: '#/components/schemas/XPSCommonStats' - standardDeviation: - description: The standard deviation of the series. - format: double - type: number - histogramBuckets: - items: - $ref: '#/components/schemas/XPSFloat64StatsHistogramBucket' + evaluatedExampleSet: 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"`. + 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. + $ref: '#/components/schemas/XPSExampleSet' + translationTrainResp: + $ref: '#/components/schemas/XPSTranslationTrainResponse' + imageSegmentationTrainResp: + $ref: '#/components/schemas/XPSImageSegmentationTrainResponse' + imageClassificationTrainResp: + $ref: '#/components/schemas/XPSImageClassificationTrainResponse' + videoActionRecognitionTrainResp: + $ref: '#/components/schemas/XPSVideoActionRecognitionTrainResponse' + textToSpeechTrainResp: + $ref: '#/components/schemas/XPSTextToSpeechTrainResponse' + explanationConfigs: + description: >- + VisionExplanationConfig for XAI on test set. Optional for when XAI + is enable in training request. + deprecated: true type: array + items: + $ref: '#/components/schemas/XPSResponseExplanationSpec' + speechTrainResp: + $ref: '#/components/schemas/XPSSpeechModelSpec' + videoObjectTrackingTrainResp: + $ref: '#/components/schemas/XPSVideoObjectTrackingTrainResponse' + textTrainResp: + description: Will only be needed for uCAIP from Beta. + $ref: '#/components/schemas/XPSTextTrainResponse' + evaluationMetricsSet: + $ref: '#/components/schemas/XPSEvaluationMetricsSet' + description: >- + The trained model evaluation metrics. This can be optionally + returned. + deployedModelSizeBytes: + description: Estimated model size in bytes once deployed. + format: int64 + type: string + imageObjectDetectionTrainResp: + $ref: '#/components/schemas/XPSImageObjectDetectionModelSpec' + 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 + XPSVideoBatchPredictOperationMetadata: type: object - description: The data statistics of a series of FLOAT64 values. - id: XPSFloat64Stats - XPSImageExportModelSpec: - type: object + id: XPSVideoBatchPredictOperationMetadata properties: - exportModelOutputConfig: + outputExamples: 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. + 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. items: - $ref: '#/components/schemas/XPSExportModelOutputConfig' - 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. - ModerateTextRequest: - description: The document moderation request message. - id: ModerateTextRequest - type: object - properties: - document: - description: Required. Input document. - $ref: '#/components/schemas/Document' - XPSTextExtractionEvaluationMetrics: + type: string + Status: properties: - bestF1ConfidenceMetrics: - 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 - $ref: '#/components/schemas/XPSConfidenceMetricsEntry' - confidenceMetricsEntries: + details: 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. + A list of messages that carry the error details. There is a common + set of message types for APIs to use. type: array items: - $ref: '#/components/schemas/XPSConfidenceMetricsEntry' - perLabelConfidenceMetrics: - description: Only recall, precision, and f1_score will be set. - deprecated: true - additionalProperties: - $ref: '#/components/schemas/XPSConfidenceMetricsEntry' - type: object - confusionMatrix: - $ref: '#/components/schemas/XPSConfusionMatrix' + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + message: + type: string description: >- - Confusion matrix of the model, at the default confidence threshold - (0.0). Only set for whole-model evaluation, not for evaluation per - label. + 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 + 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 - id: XPSTextExtractionEvaluationMetrics - AnalyzeSentimentRequest: - id: AnalyzeSentimentRequest + CpuMetric: properties: - encodingType: + 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" + additionalProperties: + type: string + type: object + coreNumber: + format: int64 + description: Required. Number of CPU cores. + type: string + cpuType: 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. + - '' + - 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. + type: string + enum: + - UNKNOWN_CPU_TYPE + - A2 + - A3 + - C2 + - C2D + - CUSTOM + - E2 + - G2 + - C3 + - M2 + - M1 + - N1 + - N2_CUSTOM + - N2 + - N2D + coreSec: + format: int64 + type: string + description: Required. Total seconds of core usage, e.g. 4. + machineSpec: enum: - - NONE - - UTF8 - - UTF16 - - UTF32 + - 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_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 + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + description: Required. Machine spec, e.g. N1_STANDARD_4. type: string - document: - $ref: '#/components/schemas/Document' - description: Required. Input document. type: object - description: The sentiment analysis request message. - XPSDataType: - description: >- - Indicated the type of data that can be stored in a structured data - entity (e.g. a table). - type: object - id: XPSDataType + id: CpuMetric + description: Metric for billing reports. + XPSConfidenceMetricsEntry: properties: - compatibleDataTypes: - description: The highly compatible data types to this data type. - items: - $ref: '#/components/schemas/XPSDataType' - type: array - structType: - $ref: '#/components/schemas/XPSStructType' + falseNegativeCount: + format: int64 description: >- - If type_code == STRUCT, then `struct_type` provides type information - for the struct's fields. - 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). - description: Required. The TypeCode for this type. + The number of ground truth labels that are not matched by a model + created label. type: string - nullable: - description: If true, this DataType can also be `null`. - type: boolean - timeFormat: + f1Score: + format: float + type: number + description: The harmonic mean of recall and precision. + falsePositiveCount: + format: int64 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. + The number of model created labels that do not match a ground truth + label. type: string - listElementType: + falsePositiveRateAt1: + type: number description: >- - If type_code == ARRAY, then `list_element_type` is the type of the - elements. - $ref: '#/components/schemas/XPSDataType' - XPSTfJsFormat: - id: XPSTfJsFormat - type: object - description: >- - A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used - in the browser and in Node.js using JavaScript. - properties: {} - Sentence: - properties: - sentiment: + The False Positive Rate when only considering the label that has the + highest prediction score and not below the confidence threshold for + each example. + format: float + positionThreshold: 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' - text: - description: The sentence text. - $ref: '#/components/schemas/TextSpan' - id: Sentence - description: Represents a sentence in the input document. - type: object - XPSXraiAttribution: - type: object - id: XPSXraiAttribution - properties: - stepCount: + 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 - 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 - 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). - deprecated: true - AnnotateTextRequestFeatures: - id: AnnotateTextRequestFeatures - description: >- - All available features. Setting each one to true will enable that - specific analysis for the input. - type: object - properties: - moderateText: + confidenceThreshold: description: >- - Optional. Moderate the document for harmful and sensitive - categories. - type: boolean - extractEntities: - description: Optional. Extract entities. - type: boolean - extractDocumentSentiment: - type: boolean - description: Optional. Extract document-level sentiment. - classifyText: - type: boolean - description: Optional. Classify the full document into categories. - XPSFileSpec: + Metrics are computed with an assumption that the model never return + predictions with score lower than this value. + format: float + type: number + precisionAt1: + type: number + 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 + truePositiveCount: + format: int64 + type: string + description: The number of model created labels that match a ground truth label. + falsePositiveRate: + description: False Positive Rate for the given confidence threshold. + type: number + format: float + precision: + format: float + description: Precision for the given confidence threshold. + type: number + recall: + format: float + type: number + description: Recall (true positive rate) for the given confidence threshold. + recallAt1: + 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. + type: number + trueNegativeCount: + type: string + 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 + f1ScoreAt1: + type: number + format: float + description: The harmonic mean of recall_at1 and precision_at1. + type: object description: >- - Spec of input and output files, on external file systems (CNS, GCS, - etc). + ConfidenceMetricsEntry includes generic precision, recall, f1 score etc. + Next tag: 16. + id: XPSConfidenceMetricsEntry + AnalyzeSentimentRequest: + id: AnalyzeSentimentRequest properties: - fileFormat: - enumDeprecated: - - false - - true - - false - - false - - false - - false + encodingType: enum: - - FILE_FORMAT_UNKNOWN - - FILE_FORMAT_SSTABLE - - FILE_FORMAT_TRANSLATION_RKV - - FILE_FORMAT_RECORDIO - - FILE_FORMAT_RAW_CSV - - FILE_FORMAT_RAW_CAPACITOR - type: string + - NONE + - UTF8 + - UTF16 + - UTF32 enumDescriptions: - - '' - - '' - >- - Internal format for parallel text data used by Google Translate. - go/rkvtools - - '' + If `EncodingType` is not specified, encoding-dependent information + (such as `begin_offset`) will be set at `-1`. - >- - Only the lexicographically first file described by the file_spec - contains the header line. - - '' - directoryPath: - description: Deprecated. Use file_spec. - deprecated: true - type: string - singleFilePath: - deprecated: true - description: Deprecated. Use file_spec. - type: string - fileSpec: + 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. type: string + document: + $ref: '#/components/schemas/Document' + description: Required. Input document. + type: object + description: The sentiment analysis request message. + XPSXpsOperationMetadata: + id: XPSXpsOperationMetadata + properties: + reportingMetrics: + $ref: '#/components/schemas/XPSReportingMetrics' 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. + 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: + description: >- + Optional. XPS server can opt to provide example count of the long + running operation (e.g. training, data importing, batch prediction). + type: string + format: int64 + visionTrainingOperationMetadata: + $ref: '#/components/schemas/XPSVisionTrainingOperationMetadata' + videoBatchPredictOperationMetadata: + $ref: '#/components/schemas/XPSVideoBatchPredictOperationMetadata' + videoTrainingOperationMetadata: + $ref: '#/components/schemas/XPSVideoTrainingOperationMetadata' + tablesTrainingOperationMetadata: + $ref: '#/components/schemas/XPSTablesTrainingOperationMetadata' type: object - id: XPSFileSpec + XPSVideoActionRecognitionTrainResponse: + type: object + properties: + 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. + type: string + format: int64 + modelArtifactSpec: + description: '## The fields below are only populated under uCAIP request scope.' + $ref: '#/components/schemas/XPSVideoModelArtifactSpec' + id: XPSVideoActionRecognitionTrainResponse parameters: - 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 - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + enum: + - json + - media + - proto + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: uploadType + name: fields schema: type: string _.xgafv: @@ -4806,32 +4810,37 @@ components: name: callback 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 - 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. + 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 - 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: @@ -4843,48 +4852,39 @@ 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: documents: - id: language.documents + id: google.language.documents name: documents title: Documents methods: - analyze_sentiment: + annotate_text: operation: - $ref: '#/paths/~1v2~1documents:analyzeSentiment/post' + $ref: '#/paths/~1v2~1documents:annotateText/post' response: mediaType: application/json openAPIDocKey: '200' - analyze_entities: + classify_text: operation: - $ref: '#/paths/~1v2~1documents:analyzeEntities/post' + $ref: '#/paths/~1v2~1documents:classifyText/post' response: mediaType: application/json openAPIDocKey: '200' - classify_text: + moderate_text: operation: - $ref: '#/paths/~1v2~1documents:classifyText/post' + $ref: '#/paths/~1v2~1documents:moderateText/post' response: mediaType: application/json openAPIDocKey: '200' - annotate_text: + analyze_sentiment: operation: - $ref: '#/paths/~1v2~1documents:annotateText/post' + $ref: '#/paths/~1v2~1documents:analyzeSentiment/post' response: mediaType: application/json openAPIDocKey: '200' - moderate_text: + analyze_entities: operation: - $ref: '#/paths/~1v2~1documents:moderateText/post' + $ref: '#/paths/~1v2~1documents:analyzeEntities/post' response: mediaType: application/json openAPIDocKey: '200' @@ -4894,27 +4894,27 @@ components: update: [] delete: [] paths: - /v2/documents:analyzeSentiment: + /v2/documents:annotateText: parameters: &ref_1 + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/quotaUser' post: - description: Analyzes the sentiment of the provided text. - operationId: language.documents.analyzeSentiment + description: A convenience method that provides all features in one call. + operationId: language.documents.annotateText requestBody: content: application/json: schema: - $ref: '#/components/schemas/AnalyzeSentimentRequest' + $ref: '#/components/schemas/AnnotateTextRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-language @@ -4930,21 +4930,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AnalyzeSentimentResponse' + $ref: '#/components/schemas/AnnotateTextResponse' parameters: [] - /v2/documents:analyzeEntities: + /v2/documents:classifyText: 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: Classifies a document into categories. + operationId: language.documents.classifyText requestBody: content: application/json: schema: - $ref: '#/components/schemas/AnalyzeEntitiesRequest' + $ref: '#/components/schemas/ClassifyTextRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-language @@ -4960,18 +4957,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AnalyzeEntitiesResponse' + $ref: '#/components/schemas/ClassifyTextResponse' parameters: [] - /v2/documents:classifyText: + /v2/documents:moderateText: parameters: *ref_1 post: - description: Classifies a document into categories. - operationId: language.documents.classifyText + description: Moderates a document for harmful and sensitive categories. + operationId: language.documents.moderateText requestBody: content: application/json: schema: - $ref: '#/components/schemas/ClassifyTextRequest' + $ref: '#/components/schemas/ModerateTextRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-language @@ -4987,18 +4984,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ClassifyTextResponse' + $ref: '#/components/schemas/ModerateTextResponse' parameters: [] - /v2/documents:annotateText: + /v2/documents:analyzeSentiment: parameters: *ref_1 post: - description: A convenience method that provides all features in one call. - operationId: language.documents.annotateText + description: Analyzes the sentiment of the provided text. + operationId: language.documents.analyzeSentiment requestBody: content: application/json: schema: - $ref: '#/components/schemas/AnnotateTextRequest' + $ref: '#/components/schemas/AnalyzeSentimentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-language @@ -5014,18 +5011,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AnnotateTextResponse' + $ref: '#/components/schemas/AnalyzeSentimentResponse' parameters: [] - /v2/documents:moderateText: + /v2/documents:analyzeEntities: parameters: *ref_1 post: - description: Moderates a document for harmful and sensitive categories. - operationId: language.documents.moderateText + 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/ModerateTextRequest' + $ref: '#/components/schemas/AnalyzeEntitiesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-language @@ -5041,5 +5041,5 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ModerateTextResponse' + $ref: '#/components/schemas/AnalyzeEntitiesResponse' 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 e20cc38d..f6e30358 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/libraryagent.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/libraryagent.yaml @@ -8,7 +8,7 @@ info: description: A simple Google Example Library API. version: v1 x-discovery-doc-revision: '20240530' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/docs/quota servers: @@ -34,56 +34,46 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleExampleLibraryagentV1ListBooksResponse: - id: GoogleExampleLibraryagentV1ListBooksResponse + GoogleExampleLibraryagentV1ListShelvesResponse: + id: GoogleExampleLibraryagentV1ListShelvesResponse + description: Response message for LibraryAgent.ListShelves. properties: - books: - description: The list of books. - type: array + shelves: + description: The list of shelves. items: - $ref: '#/components/schemas/GoogleExampleLibraryagentV1Book' + $ref: '#/components/schemas/GoogleExampleLibraryagentV1Shelf' + type: array nextPageToken: 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. + ListShelvesRequest.page_token field in the subsequent call to + `ListShelves` method to retrieve the next page of results. type: string type: object - description: Response message for LibraryAgent.ListBooks. - GoogleExampleLibraryagentV1Shelf: - type: object - 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. - type: string - id: GoogleExampleLibraryagentV1Shelf - GoogleExampleLibraryagentV1ListShelvesResponse: + GoogleExampleLibraryagentV1ListBooksResponse: type: object - description: Response message for LibraryAgent.ListShelves. + description: Response message for LibraryAgent.ListBooks. properties: - shelves: - description: The list of shelves. - items: - $ref: '#/components/schemas/GoogleExampleLibraryagentV1Shelf' + books: + description: The list of books. type: array + items: + $ref: '#/components/schemas/GoogleExampleLibraryagentV1Book' 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. - id: GoogleExampleLibraryagentV1ListShelvesResponse + ListBooksRequest.page_token field in the subsequent call to + `ListBooks` method to retrieve the next page of results. + id: GoogleExampleLibraryagentV1ListBooksResponse GoogleExampleLibraryagentV1Book: type: object + description: A single book in the library. id: GoogleExampleLibraryagentV1Book properties: + title: + description: The title of the book. + type: string name: description: >- The resource name of the book. Book names have the form @@ -91,52 +81,63 @@ components: creating a book. type: string author: - type: string description: The name of the book author. + type: string read: type: boolean description: Value indicating whether the book has been read. - title: + GoogleExampleLibraryagentV1Shelf: + description: A Shelf contains a collection of books with a theme. + properties: + name: type: string - description: The title of the book. - description: A single book in the library. + 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 + id: GoogleExampleLibraryagentV1Shelf + 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. + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: quotaUser + name: prettyPrint schema: - type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + type: boolean + callback: + description: JSONP in: query - name: upload_protocol + name: callback 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 - callback: - description: JSONP + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: callback + name: upload_protocol 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 uploadType: description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query @@ -149,52 +150,51 @@ components: name: fields 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 - alt: - description: Data format for response. + type: string + access_token: + description: OAuth access token. in: query - name: alt + name: access_token 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. + _.xgafv: + description: V1 error format. in: query - name: key + name: $.xgafv schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + 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: oauth_token + name: quotaUser schema: type: string x-stackQL-resources: books: - id: libraryagent.books + id: google.libraryagent.books name: books title: Books methods: - 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' - return: + get: operation: - $ref: '#/paths/~1v1~1shelves~1{shelvesId}~1books~1{booksId}:return/post' + $ref: '#/paths/~1v1~1shelves~1{shelvesId}~1books~1{booksId}/get' response: mediaType: application/json openAPIDocKey: '200' @@ -208,9 +208,9 @@ components: list: operation: *ref_1 response: *ref_2 - borrow: + return: operation: - $ref: '#/paths/~1v1~1shelves~1{shelvesId}~1books~1{booksId}:borrow/post' + $ref: '#/paths/~1v1~1shelves~1{shelvesId}~1books~1{booksId}:return/post' response: mediaType: application/json openAPIDocKey: '200' @@ -222,7 +222,7 @@ components: update: [] delete: [] shelves: - id: libraryagent.shelves + id: google.libraryagent.shelves name: shelves title: Shelves methods: @@ -244,28 +244,32 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/shelves/methods/list' - $ref: '#/components/x-stackQL-resources/shelves/methods/get' + - $ref: '#/components/x-stackQL-resources/shelves/methods/list' insert: [] update: [] delete: [] paths: - /v1/shelves/{shelvesId}/books/{booksId}: + /v1/shelves/{shelvesId}/books/{booksId}:borrow: parameters: &ref_5 - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - get: - description: Gets a book. Returns NOT_FOUND if the book does not exist. - operationId: libraryagent.shelves.books.get + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/quotaUser' + 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 @@ -289,14 +293,11 @@ paths: required: true schema: type: string - /v1/shelves/{shelvesId}/books/{booksId}:return: + /v1/shelves/{shelvesId}/books/{booksId}: parameters: *ref_5 - post: - description: >- - Return a book to the library. Returns the book if it is returned to the - library successfully. Returns error if the book does not belong to the - library or the users didn't borrow before. - operationId: libraryagent.shelves.books.return + 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 @@ -347,24 +348,23 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - /v1/shelves/{shelvesId}/books/{booksId}:borrow: + - in: query + name: pageToken + schema: + type: string + /v1/shelves/{shelvesId}/books/{booksId}:return: parameters: *ref_5 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 + Return a book to the library. Returns the book if it is returned to the + library successfully. Returns error if the book does not belong to the + library or the users didn't borrow before. + operationId: libraryagent.shelves.books.return security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -409,15 +409,15 @@ paths: $ref: >- #/components/schemas/GoogleExampleLibraryagentV1ListShelvesResponse parameters: + - 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}: parameters: *ref_5 get: 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 6f09ee9e..b90c79ac 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/lifesciences.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/lifesciences.yaml @@ -10,7 +10,7 @@ info: processing, and transforming life sciences data. version: v2beta x-discovery-doc-revision: '20240524' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/life-sciences servers: @@ -1239,7 +1239,7 @@ components: - '2' x-stackQL-resources: locations: - id: lifesciences.locations + id: google.lifesciences.locations name: locations title: Locations methods: @@ -1262,13 +1262,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: lifesciences.operations + id: google.lifesciences.operations name: operations title: Operations methods: @@ -1299,13 +1299,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: [] pipelines: - id: lifesciences.pipelines + id: google.lifesciences.pipelines name: pipelines title: Pipelines methods: 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 8362307b..7a6703de 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/logging.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/logging.yaml @@ -8,7 +8,7 @@ info: description: Writes log entries and manages your Cloud Logging configuration. version: v2 x-discovery-doc-revision: '20240523' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/logging/docs/ servers: @@ -3493,7 +3493,7 @@ components: - '2' x-stackQL-resources: locations: - id: logging.locations + id: google.logging.locations name: locations title: Locations methods: @@ -3575,28 +3575,28 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: >- + #/components/x-stackQL-resources/locations/methods/projects_locations_get + - $ref: >- + #/components/x-stackQL-resources/locations/methods/organizations_locations_get + - $ref: >- + #/components/x-stackQL-resources/locations/methods/folders_locations_get + - $ref: >- + #/components/x-stackQL-resources/locations/methods/billing_accounts_locations_get - $ref: '#/components/x-stackQL-resources/locations/methods/locations_list' - $ref: >- #/components/x-stackQL-resources/locations/methods/projects_locations_list - - $ref: >- - #/components/x-stackQL-resources/locations/methods/projects_locations_get - $ref: >- #/components/x-stackQL-resources/locations/methods/organizations_locations_list - - $ref: >- - #/components/x-stackQL-resources/locations/methods/organizations_locations_get - $ref: >- #/components/x-stackQL-resources/locations/methods/folders_locations_list - - $ref: >- - #/components/x-stackQL-resources/locations/methods/folders_locations_get - $ref: >- #/components/x-stackQL-resources/locations/methods/billing_accounts_locations_list - - $ref: >- - #/components/x-stackQL-resources/locations/methods/billing_accounts_locations_get insert: [] update: [] delete: [] exclusions: - id: logging.exclusions + id: google.logging.exclusions name: exclusions title: Exclusions methods: @@ -3784,25 +3784,25 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/exclusions/methods/exclusions_get' - $ref: >- #/components/x-stackQL-resources/exclusions/methods/exclusions_list - - $ref: >- - #/components/x-stackQL-resources/exclusions/methods/projects_exclusions_list - $ref: >- #/components/x-stackQL-resources/exclusions/methods/projects_exclusions_get - - $ref: >- - #/components/x-stackQL-resources/exclusions/methods/organizations_exclusions_list - $ref: >- #/components/x-stackQL-resources/exclusions/methods/organizations_exclusions_get - - $ref: >- - #/components/x-stackQL-resources/exclusions/methods/folders_exclusions_list - $ref: >- #/components/x-stackQL-resources/exclusions/methods/folders_exclusions_get - - $ref: >- - #/components/x-stackQL-resources/exclusions/methods/billing_accounts_exclusions_list - $ref: >- #/components/x-stackQL-resources/exclusions/methods/billing_accounts_exclusions_get + - $ref: '#/components/x-stackQL-resources/exclusions/methods/exclusions_get' + - $ref: >- + #/components/x-stackQL-resources/exclusions/methods/projects_exclusions_list + - $ref: >- + #/components/x-stackQL-resources/exclusions/methods/organizations_exclusions_list + - $ref: >- + #/components/x-stackQL-resources/exclusions/methods/folders_exclusions_list + - $ref: >- + #/components/x-stackQL-resources/exclusions/methods/billing_accounts_exclusions_list insert: - $ref: >- #/components/x-stackQL-resources/exclusions/methods/exclusions_create @@ -3814,10 +3814,18 @@ components: #/components/x-stackQL-resources/exclusions/methods/folders_exclusions_create - $ref: >- #/components/x-stackQL-resources/exclusions/methods/billing_accounts_exclusions_create - update: [] - delete: + update: - $ref: >- - #/components/x-stackQL-resources/exclusions/methods/exclusions_delete + #/components/x-stackQL-resources/exclusions/methods/projects_exclusions_patch + - $ref: >- + #/components/x-stackQL-resources/exclusions/methods/organizations_exclusions_patch + - $ref: >- + #/components/x-stackQL-resources/exclusions/methods/folders_exclusions_patch + - $ref: >- + #/components/x-stackQL-resources/exclusions/methods/billing_accounts_exclusions_patch + - $ref: >- + #/components/x-stackQL-resources/exclusions/methods/exclusions_patch + delete: - $ref: >- #/components/x-stackQL-resources/exclusions/methods/projects_exclusions_delete - $ref: >- @@ -3826,8 +3834,10 @@ components: #/components/x-stackQL-resources/exclusions/methods/folders_exclusions_delete - $ref: >- #/components/x-stackQL-resources/exclusions/methods/billing_accounts_exclusions_delete + - $ref: >- + #/components/x-stackQL-resources/exclusions/methods/exclusions_delete buckets: - id: logging.buckets + id: google.logging.buckets name: buckets title: Buckets methods: @@ -4039,24 +4049,24 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: >- + #/components/x-stackQL-resources/buckets/methods/projects_locations_buckets_get + - $ref: >- + #/components/x-stackQL-resources/buckets/methods/organizations_locations_buckets_get + - $ref: >- + #/components/x-stackQL-resources/buckets/methods/folders_locations_buckets_get + - $ref: >- + #/components/x-stackQL-resources/buckets/methods/billing_accounts_locations_buckets_get - $ref: >- #/components/x-stackQL-resources/buckets/methods/locations_buckets_list - $ref: >- #/components/x-stackQL-resources/buckets/methods/projects_locations_buckets_list - - $ref: >- - #/components/x-stackQL-resources/buckets/methods/projects_locations_buckets_get - $ref: >- #/components/x-stackQL-resources/buckets/methods/organizations_locations_buckets_list - - $ref: >- - #/components/x-stackQL-resources/buckets/methods/organizations_locations_buckets_get - $ref: >- #/components/x-stackQL-resources/buckets/methods/folders_locations_buckets_list - - $ref: >- - #/components/x-stackQL-resources/buckets/methods/folders_locations_buckets_get - $ref: >- #/components/x-stackQL-resources/buckets/methods/billing_accounts_locations_buckets_list - - $ref: >- - #/components/x-stackQL-resources/buckets/methods/billing_accounts_locations_buckets_get insert: - $ref: >- #/components/x-stackQL-resources/buckets/methods/locations_buckets_create @@ -4068,7 +4078,15 @@ components: #/components/x-stackQL-resources/buckets/methods/folders_locations_buckets_create - $ref: >- #/components/x-stackQL-resources/buckets/methods/billing_accounts_locations_buckets_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/buckets/methods/projects_locations_buckets_patch + - $ref: >- + #/components/x-stackQL-resources/buckets/methods/organizations_locations_buckets_patch + - $ref: >- + #/components/x-stackQL-resources/buckets/methods/folders_locations_buckets_patch + - $ref: >- + #/components/x-stackQL-resources/buckets/methods/billing_accounts_locations_buckets_patch delete: - $ref: >- #/components/x-stackQL-resources/buckets/methods/projects_locations_buckets_delete @@ -4079,7 +4097,7 @@ components: - $ref: >- #/components/x-stackQL-resources/buckets/methods/billing_accounts_locations_buckets_delete operations: - id: logging.operations + id: google.logging.operations name: operations title: Operations methods: @@ -4195,27 +4213,27 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/organizations_locations_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/organizations_locations_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/folders_locations_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/folders_locations_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/billing_accounts_locations_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/billing_accounts_locations_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list + - $ref: >- + #/components/x-stackQL-resources/operations/methods/organizations_locations_operations_list + - $ref: >- + #/components/x-stackQL-resources/operations/methods/folders_locations_operations_list + - $ref: >- + #/components/x-stackQL-resources/operations/methods/billing_accounts_locations_operations_list insert: [] update: [] delete: [] views_iam_policies: - id: logging.views_iam_policies + id: google.logging.views_iam_policies name: views_iam_policies title: Views_iam_policies methods: @@ -4312,7 +4330,7 @@ components: update: [] delete: [] views: - id: logging.views + id: google.logging.views name: views title: Views methods: @@ -4491,26 +4509,24 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/views/methods/locations_buckets_views_list + #/components/x-stackQL-resources/views/methods/projects_locations_buckets_views_get - $ref: >- - #/components/x-stackQL-resources/views/methods/projects_locations_buckets_views_list + #/components/x-stackQL-resources/views/methods/organizations_locations_buckets_views_get - $ref: >- - #/components/x-stackQL-resources/views/methods/projects_locations_buckets_views_get + #/components/x-stackQL-resources/views/methods/folders_locations_buckets_views_get - $ref: >- - #/components/x-stackQL-resources/views/methods/organizations_locations_buckets_views_list + #/components/x-stackQL-resources/views/methods/billing_accounts_locations_buckets_views_get - $ref: >- - #/components/x-stackQL-resources/views/methods/organizations_locations_buckets_views_get + #/components/x-stackQL-resources/views/methods/projects_locations_buckets_views_list - $ref: >- - #/components/x-stackQL-resources/views/methods/folders_locations_buckets_views_list + #/components/x-stackQL-resources/views/methods/organizations_locations_buckets_views_list - $ref: >- - #/components/x-stackQL-resources/views/methods/folders_locations_buckets_views_get + #/components/x-stackQL-resources/views/methods/folders_locations_buckets_views_list - $ref: >- #/components/x-stackQL-resources/views/methods/billing_accounts_locations_buckets_views_list - $ref: >- - #/components/x-stackQL-resources/views/methods/billing_accounts_locations_buckets_views_get + #/components/x-stackQL-resources/views/methods/locations_buckets_views_list insert: - - $ref: >- - #/components/x-stackQL-resources/views/methods/locations_buckets_views_create - $ref: >- #/components/x-stackQL-resources/views/methods/projects_locations_buckets_views_create - $ref: >- @@ -4519,7 +4535,17 @@ components: #/components/x-stackQL-resources/views/methods/folders_locations_buckets_views_create - $ref: >- #/components/x-stackQL-resources/views/methods/billing_accounts_locations_buckets_views_create - update: [] + - $ref: >- + #/components/x-stackQL-resources/views/methods/locations_buckets_views_create + update: + - $ref: >- + #/components/x-stackQL-resources/views/methods/projects_locations_buckets_views_patch + - $ref: >- + #/components/x-stackQL-resources/views/methods/organizations_locations_buckets_views_patch + - $ref: >- + #/components/x-stackQL-resources/views/methods/folders_locations_buckets_views_patch + - $ref: >- + #/components/x-stackQL-resources/views/methods/billing_accounts_locations_buckets_views_patch delete: - $ref: >- #/components/x-stackQL-resources/views/methods/projects_locations_buckets_views_delete @@ -4530,7 +4556,7 @@ components: - $ref: >- #/components/x-stackQL-resources/views/methods/billing_accounts_locations_buckets_views_delete links: - id: logging.links + id: google.logging.links name: links title: Links methods: @@ -4681,26 +4707,24 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/links/methods/locations_buckets_links_list + #/components/x-stackQL-resources/links/methods/projects_locations_buckets_links_get - $ref: >- - #/components/x-stackQL-resources/links/methods/projects_locations_buckets_links_list + #/components/x-stackQL-resources/links/methods/organizations_locations_buckets_links_get - $ref: >- - #/components/x-stackQL-resources/links/methods/projects_locations_buckets_links_get + #/components/x-stackQL-resources/links/methods/folders_locations_buckets_links_get - $ref: >- - #/components/x-stackQL-resources/links/methods/organizations_locations_buckets_links_list + #/components/x-stackQL-resources/links/methods/billing_accounts_locations_buckets_links_get - $ref: >- - #/components/x-stackQL-resources/links/methods/organizations_locations_buckets_links_get + #/components/x-stackQL-resources/links/methods/projects_locations_buckets_links_list - $ref: >- - #/components/x-stackQL-resources/links/methods/folders_locations_buckets_links_list + #/components/x-stackQL-resources/links/methods/organizations_locations_buckets_links_list - $ref: >- - #/components/x-stackQL-resources/links/methods/folders_locations_buckets_links_get + #/components/x-stackQL-resources/links/methods/folders_locations_buckets_links_list - $ref: >- #/components/x-stackQL-resources/links/methods/billing_accounts_locations_buckets_links_list - $ref: >- - #/components/x-stackQL-resources/links/methods/billing_accounts_locations_buckets_links_get + #/components/x-stackQL-resources/links/methods/locations_buckets_links_list insert: - - $ref: >- - #/components/x-stackQL-resources/links/methods/locations_buckets_links_create - $ref: >- #/components/x-stackQL-resources/links/methods/projects_locations_buckets_links_create - $ref: >- @@ -4709,6 +4733,8 @@ components: #/components/x-stackQL-resources/links/methods/folders_locations_buckets_links_create - $ref: >- #/components/x-stackQL-resources/links/methods/billing_accounts_locations_buckets_links_create + - $ref: >- + #/components/x-stackQL-resources/links/methods/locations_buckets_links_create update: [] delete: - $ref: >- @@ -4720,7 +4746,7 @@ components: - $ref: >- #/components/x-stackQL-resources/links/methods/billing_accounts_locations_buckets_links_delete sinks: - id: logging.sinks + id: google.logging.sinks name: sinks title: Sinks methods: @@ -4929,19 +4955,19 @@ components: sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/sinks/methods/sinks_list' + - $ref: '#/components/x-stackQL-resources/sinks/methods/projects_sinks_get' + - $ref: >- + #/components/x-stackQL-resources/sinks/methods/organizations_sinks_get + - $ref: '#/components/x-stackQL-resources/sinks/methods/folders_sinks_get' + - $ref: >- + #/components/x-stackQL-resources/sinks/methods/billing_accounts_sinks_get - $ref: '#/components/x-stackQL-resources/sinks/methods/sinks_get' - $ref: '#/components/x-stackQL-resources/sinks/methods/projects_sinks_list' - - $ref: '#/components/x-stackQL-resources/sinks/methods/projects_sinks_get' - $ref: >- #/components/x-stackQL-resources/sinks/methods/organizations_sinks_list - - $ref: >- - #/components/x-stackQL-resources/sinks/methods/organizations_sinks_get - $ref: '#/components/x-stackQL-resources/sinks/methods/folders_sinks_list' - - $ref: '#/components/x-stackQL-resources/sinks/methods/folders_sinks_get' - $ref: >- #/components/x-stackQL-resources/sinks/methods/billing_accounts_sinks_list - - $ref: >- - #/components/x-stackQL-resources/sinks/methods/billing_accounts_sinks_get insert: - $ref: '#/components/x-stackQL-resources/sinks/methods/sinks_create' - $ref: >- @@ -4952,9 +4978,24 @@ components: #/components/x-stackQL-resources/sinks/methods/folders_sinks_create - $ref: >- #/components/x-stackQL-resources/sinks/methods/billing_accounts_sinks_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/sinks/methods/projects_sinks_update + - $ref: >- + #/components/x-stackQL-resources/sinks/methods/projects_sinks_patch + - $ref: >- + #/components/x-stackQL-resources/sinks/methods/organizations_sinks_update + - $ref: >- + #/components/x-stackQL-resources/sinks/methods/organizations_sinks_patch + - $ref: >- + #/components/x-stackQL-resources/sinks/methods/folders_sinks_update + - $ref: '#/components/x-stackQL-resources/sinks/methods/folders_sinks_patch' + - $ref: >- + #/components/x-stackQL-resources/sinks/methods/billing_accounts_sinks_update + - $ref: >- + #/components/x-stackQL-resources/sinks/methods/billing_accounts_sinks_patch + - $ref: '#/components/x-stackQL-resources/sinks/methods/sinks_update' delete: - - $ref: '#/components/x-stackQL-resources/sinks/methods/sinks_delete' - $ref: >- #/components/x-stackQL-resources/sinks/methods/projects_sinks_delete - $ref: >- @@ -4963,8 +5004,9 @@ components: #/components/x-stackQL-resources/sinks/methods/folders_sinks_delete - $ref: >- #/components/x-stackQL-resources/sinks/methods/billing_accounts_sinks_delete + - $ref: '#/components/x-stackQL-resources/sinks/methods/sinks_delete' logging_cmek_settings: - id: logging.logging_cmek_settings + id: google.logging.logging_cmek_settings name: logging_cmek_settings title: Logging_cmek_settings methods: @@ -4988,7 +5030,7 @@ components: update: [] delete: [] logging_settings: - id: logging.logging_settings + id: google.logging.logging_settings name: logging_settings title: Logging_settings methods: @@ -5012,7 +5054,7 @@ components: update: [] delete: [] cmek_settings: - id: logging.cmek_settings + id: google.logging.cmek_settings name: cmek_settings title: Cmek_settings methods: @@ -5052,7 +5094,7 @@ components: update: [] delete: [] settings: - id: logging.settings + id: google.logging.settings name: settings title: Settings methods: @@ -5098,7 +5140,7 @@ components: update: [] delete: [] buckets_async: - id: logging.buckets_async + id: google.logging.buckets_async name: buckets_async title: Buckets_async methods: @@ -5172,7 +5214,7 @@ components: update: [] delete: [] logs: - id: logging.logs + id: google.logging.logs name: logs title: Logs methods: @@ -5306,19 +5348,19 @@ components: select: - $ref: >- #/components/x-stackQL-resources/logs/methods/projects_locations_buckets_views_logs_list - - $ref: '#/components/x-stackQL-resources/logs/methods/projects_logs_list' - $ref: >- #/components/x-stackQL-resources/logs/methods/organizations_locations_buckets_views_logs_list - - $ref: >- - #/components/x-stackQL-resources/logs/methods/organizations_logs_list - $ref: >- #/components/x-stackQL-resources/logs/methods/folders_locations_buckets_views_logs_list - - $ref: '#/components/x-stackQL-resources/logs/methods/folders_logs_list' - $ref: >- #/components/x-stackQL-resources/logs/methods/billing_accounts_locations_buckets_views_logs_list + - $ref: '#/components/x-stackQL-resources/logs/methods/logs_list' + - $ref: '#/components/x-stackQL-resources/logs/methods/projects_logs_list' + - $ref: >- + #/components/x-stackQL-resources/logs/methods/organizations_logs_list + - $ref: '#/components/x-stackQL-resources/logs/methods/folders_logs_list' - $ref: >- #/components/x-stackQL-resources/logs/methods/billing_accounts_logs_list - - $ref: '#/components/x-stackQL-resources/logs/methods/logs_list' insert: [] update: [] delete: @@ -5330,7 +5372,7 @@ components: #/components/x-stackQL-resources/logs/methods/billing_accounts_logs_delete - $ref: '#/components/x-stackQL-resources/logs/methods/logs_delete' saved_queries: - id: logging.saved_queries + id: google.logging.saved_queries name: saved_queries title: Saved_queries methods: @@ -5464,7 +5506,7 @@ components: - $ref: >- #/components/x-stackQL-resources/saved_queries/methods/billing_accounts_locations_saved_queries_delete recent_queries: - id: logging.recent_queries + id: google.logging.recent_queries name: recent_queries title: Recent_queries methods: @@ -5526,7 +5568,7 @@ components: update: [] delete: [] metrics: - id: logging.metrics + id: google.logging.metrics name: metrics title: Metrics methods: @@ -5566,19 +5608,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/metrics/methods/projects_metrics_list - $ref: >- #/components/x-stackQL-resources/metrics/methods/projects_metrics_get + - $ref: >- + #/components/x-stackQL-resources/metrics/methods/projects_metrics_list insert: - $ref: >- #/components/x-stackQL-resources/metrics/methods/projects_metrics_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/metrics/methods/projects_metrics_update delete: - $ref: >- #/components/x-stackQL-resources/metrics/methods/projects_metrics_delete billing_accounts_cmek_settings: - id: logging.billing_accounts_cmek_settings + id: google.logging.billing_accounts_cmek_settings name: billing_accounts_cmek_settings title: Billing_accounts_cmek_settings methods: @@ -5597,7 +5641,7 @@ components: update: [] delete: [] billing_accounts_settings: - id: logging.billing_accounts_settings + id: google.logging.billing_accounts_settings name: billing_accounts_settings title: Billing_accounts_settings methods: @@ -5615,7 +5659,7 @@ components: update: [] delete: [] entries: - id: logging.entries + id: google.logging.entries name: entries title: Entries methods: @@ -5649,7 +5693,7 @@ components: update: [] delete: [] monitored_resource_descriptors: - id: logging.monitored_resource_descriptors + id: google.logging.monitored_resource_descriptors name: monitored_resource_descriptors title: Monitored_resource_descriptors methods: 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 3ef8afad..3c5b23e1 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/looker.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/looker.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1 x-discovery-doc-revision: '20240516' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/looker/docs/reference/rest/ servers: @@ -1124,7 +1124,7 @@ components: - '2' x-stackQL-resources: locations: - id: looker.locations + id: google.looker.locations name: locations title: Locations methods: @@ -1146,13 +1146,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: looker.operations + id: google.looker.operations name: operations title: Operations methods: @@ -1190,14 +1190,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' instances: - id: looker.instances + id: google.looker.instances name: instances title: Instances methods: @@ -1263,15 +1263,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/instances/methods/list' - $ref: '#/components/x-stackQL-resources/instances/methods/get' + - $ref: '#/components/x-stackQL-resources/instances/methods/list' insert: - $ref: '#/components/x-stackQL-resources/instances/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/instances/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/instances/methods/delete' instances_iam_policies: - id: looker.instances_iam_policies + id: google.looker.instances_iam_policies name: instances_iam_policies title: Instances_iam_policies methods: @@ -1308,7 +1309,7 @@ components: update: [] delete: [] backups_iam_policies: - id: looker.backups_iam_policies + id: google.looker.backups_iam_policies name: backups_iam_policies title: Backups_iam_policies methods: 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 f1f5f392..05b04152 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/managedidentities.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/managedidentities.yaml @@ -11,7 +11,7 @@ info: (AD). version: v1 x-discovery-doc-revision: '20240112' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/managed-microsoft-ad/ servers: @@ -2052,7 +2052,7 @@ components: - '2' x-stackQL-resources: locations: - id: managedidentities.locations + id: google.managedidentities.locations name: locations title: Locations methods: @@ -2074,13 +2074,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: managedidentities.operations + id: google.managedidentities.operations name: operations title: Operations methods: @@ -2118,14 +2118,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' domains: - id: managedidentities.domains + id: google.managedidentities.domains name: domains title: Domains methods: @@ -2247,15 +2247,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/domains/methods/list' - $ref: '#/components/x-stackQL-resources/domains/methods/get' + - $ref: '#/components/x-stackQL-resources/domains/methods/list' insert: - $ref: '#/components/x-stackQL-resources/domains/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/domains/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/domains/methods/delete' domains_ldapssettings: - id: managedidentities.domains_ldapssettings + id: google.managedidentities.domains_ldapssettings name: domains_ldapssettings title: Domains_ldapssettings methods: @@ -2281,7 +2282,7 @@ components: update: [] delete: [] domains_iam_policies: - id: managedidentities.domains_iam_policies + id: google.managedidentities.domains_iam_policies name: domains_iam_policies title: Domains_iam_policies methods: @@ -2318,7 +2319,7 @@ components: update: [] delete: [] backups: - id: managedidentities.backups + id: google.managedidentities.backups name: backups title: Backups methods: @@ -2363,15 +2364,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/backups/methods/list' - $ref: '#/components/x-stackQL-resources/backups/methods/get' + - $ref: '#/components/x-stackQL-resources/backups/methods/list' insert: - $ref: '#/components/x-stackQL-resources/backups/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/backups/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/backups/methods/delete' backups_iam_policies: - id: managedidentities.backups_iam_policies + id: google.managedidentities.backups_iam_policies name: backups_iam_policies title: Backups_iam_policies methods: @@ -2408,7 +2410,7 @@ components: update: [] delete: [] sql_integrations: - id: managedidentities.sql_integrations + id: google.managedidentities.sql_integrations name: sql_integrations title: Sql_integrations methods: @@ -2432,13 +2434,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/sql_integrations/methods/list' - $ref: '#/components/x-stackQL-resources/sql_integrations/methods/get' + - $ref: '#/components/x-stackQL-resources/sql_integrations/methods/list' insert: [] update: [] delete: [] peerings: - id: managedidentities.peerings + id: google.managedidentities.peerings name: peerings title: Peerings methods: @@ -2483,15 +2485,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/peerings/methods/list' - $ref: '#/components/x-stackQL-resources/peerings/methods/get' + - $ref: '#/components/x-stackQL-resources/peerings/methods/list' insert: - $ref: '#/components/x-stackQL-resources/peerings/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/peerings/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/peerings/methods/delete' peerings_iam_policies: - id: managedidentities.peerings_iam_policies + id: google.managedidentities.peerings_iam_policies name: peerings_iam_policies title: Peerings_iam_policies methods: 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 a1fa3740..07b87d72 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/memcache.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/memcache.yaml @@ -10,7 +10,7 @@ info: Memcached instances in GCP. version: v1 x-discovery-doc-revision: '20240502' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/memorystore/ servers: @@ -1472,7 +1472,7 @@ components: - '2' x-stackQL-resources: locations: - id: memcache.locations + id: google.memcache.locations name: locations title: Locations methods: @@ -1494,13 +1494,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: memcache.operations + id: google.memcache.operations name: operations title: Operations methods: @@ -1538,14 +1538,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' instances: - id: memcache.instances + id: google.memcache.instances name: instances title: Instances methods: @@ -1611,15 +1611,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/instances/methods/list' - $ref: '#/components/x-stackQL-resources/instances/methods/get' + - $ref: '#/components/x-stackQL-resources/instances/methods/list' insert: - $ref: '#/components/x-stackQL-resources/instances/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/instances/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/instances/methods/delete' instances_parameters: - id: memcache.instances_parameters + id: google.memcache.instances_parameters name: instances_parameters title: Instances_parameters methods: 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 baac7524..1838d620 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/metastore.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/metastore.yaml @@ -10,7 +10,7 @@ info: of metastore services. version: v1 x-discovery-doc-revision: '20240516' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/dataproc-metastore/docs servers: @@ -1899,7 +1899,7 @@ components: - '2' x-stackQL-resources: locations: - id: metastore.locations + id: google.metastore.locations name: locations title: Locations methods: @@ -1921,13 +1921,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: metastore.operations + id: google.metastore.operations name: operations title: Operations methods: @@ -1965,14 +1965,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' federations: - id: metastore.federations + id: google.metastore.federations name: federations title: Federations methods: @@ -2017,15 +2017,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/federations/methods/list' - $ref: '#/components/x-stackQL-resources/federations/methods/get' + - $ref: '#/components/x-stackQL-resources/federations/methods/list' insert: - $ref: '#/components/x-stackQL-resources/federations/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/federations/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/federations/methods/delete' federations_iam_policies: - id: metastore.federations_iam_policies + id: google.metastore.federations_iam_policies name: federations_iam_policies title: Federations_iam_policies methods: @@ -2062,7 +2063,7 @@ components: update: [] delete: [] services: - id: metastore.services + id: google.metastore.services name: services title: Services methods: @@ -2149,15 +2150,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/services/methods/list' - $ref: '#/components/x-stackQL-resources/services/methods/get' + - $ref: '#/components/x-stackQL-resources/services/methods/list' insert: - $ref: '#/components/x-stackQL-resources/services/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/services/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/services/methods/delete' services_iam_policies: - id: metastore.services_iam_policies + id: google.metastore.services_iam_policies name: services_iam_policies title: Services_iam_policies methods: @@ -2194,7 +2196,7 @@ components: update: [] delete: [] metadata_imports: - id: metastore.metadata_imports + id: google.metastore.metadata_imports name: metadata_imports title: Metadata_imports methods: @@ -2232,14 +2234,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/metadata_imports/methods/list' - $ref: '#/components/x-stackQL-resources/metadata_imports/methods/get' + - $ref: '#/components/x-stackQL-resources/metadata_imports/methods/list' insert: - $ref: '#/components/x-stackQL-resources/metadata_imports/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/metadata_imports/methods/patch' delete: [] backups: - id: metastore.backups + id: google.metastore.backups name: backups title: Backups methods: @@ -2277,15 +2280,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/backups/methods/list' - $ref: '#/components/x-stackQL-resources/backups/methods/get' + - $ref: '#/components/x-stackQL-resources/backups/methods/list' insert: - $ref: '#/components/x-stackQL-resources/backups/methods/create' update: [] delete: - $ref: '#/components/x-stackQL-resources/backups/methods/delete' backups_iam_policies: - id: metastore.backups_iam_policies + id: google.metastore.backups_iam_policies name: backups_iam_policies title: Backups_iam_policies methods: @@ -2315,7 +2318,7 @@ components: update: [] delete: [] databases_iam_policies: - id: metastore.databases_iam_policies + id: google.metastore.databases_iam_policies name: databases_iam_policies title: Databases_iam_policies methods: @@ -2345,7 +2348,7 @@ components: update: [] delete: [] tables_iam_policies: - id: metastore.tables_iam_policies + id: google.metastore.tables_iam_policies name: tables_iam_policies title: Tables_iam_policies methods: 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 a0892bda..5cf4e633 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: '20240523' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/migration-center servers: @@ -3480,7 +3480,7 @@ components: - '2' x-stackQL-resources: settings: - id: migrationcenter.settings + id: google.migrationcenter.settings name: settings title: Settings methods: @@ -3505,7 +3505,7 @@ components: update: [] delete: [] locations: - id: migrationcenter.locations + id: google.migrationcenter.locations name: locations title: Locations methods: @@ -3527,13 +3527,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: migrationcenter.operations + id: google.migrationcenter.operations name: operations title: Operations methods: @@ -3571,14 +3571,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' assets: - id: migrationcenter.assets + id: google.migrationcenter.assets name: assets title: Assets methods: @@ -3644,14 +3644,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/assets/methods/list' - $ref: '#/components/x-stackQL-resources/assets/methods/get' + - $ref: '#/components/x-stackQL-resources/assets/methods/list' insert: [] - update: [] + update: + - $ref: '#/components/x-stackQL-resources/assets/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/assets/methods/delete' import_jobs: - id: migrationcenter.import_jobs + id: google.migrationcenter.import_jobs name: import_jobs title: Import_jobs methods: @@ -3710,15 +3711,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/import_jobs/methods/list' - $ref: '#/components/x-stackQL-resources/import_jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/import_jobs/methods/list' insert: - $ref: '#/components/x-stackQL-resources/import_jobs/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/import_jobs/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/import_jobs/methods/delete' import_data_files: - id: migrationcenter.import_data_files + id: google.migrationcenter.import_data_files name: import_data_files title: Import_data_files methods: @@ -3764,7 +3766,7 @@ components: delete: - $ref: '#/components/x-stackQL-resources/import_data_files/methods/delete' groups: - id: migrationcenter.groups + id: google.migrationcenter.groups name: groups title: Groups methods: @@ -3809,15 +3811,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/groups/methods/list' - $ref: '#/components/x-stackQL-resources/groups/methods/get' + - $ref: '#/components/x-stackQL-resources/groups/methods/list' insert: - $ref: '#/components/x-stackQL-resources/groups/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/groups/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/groups/methods/delete' groups_assets: - id: migrationcenter.groups_assets + id: google.migrationcenter.groups_assets name: groups_assets title: Groups_assets methods: @@ -3841,7 +3844,7 @@ components: update: [] delete: [] sources: - id: migrationcenter.sources + id: google.migrationcenter.sources name: sources title: Sources methods: @@ -3886,15 +3889,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/sources/methods/list' - $ref: '#/components/x-stackQL-resources/sources/methods/get' + - $ref: '#/components/x-stackQL-resources/sources/methods/list' insert: - $ref: '#/components/x-stackQL-resources/sources/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/sources/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/sources/methods/delete' error_frames: - id: migrationcenter.error_frames + id: google.migrationcenter.error_frames name: error_frames title: Error_frames methods: @@ -3918,13 +3922,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/error_frames/methods/list' - $ref: '#/components/x-stackQL-resources/error_frames/methods/get' + - $ref: '#/components/x-stackQL-resources/error_frames/methods/list' insert: [] update: [] delete: [] preference_sets: - id: migrationcenter.preference_sets + id: google.migrationcenter.preference_sets name: preference_sets title: Preference_sets methods: @@ -3969,15 +3973,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/preference_sets/methods/list' - $ref: '#/components/x-stackQL-resources/preference_sets/methods/get' + - $ref: '#/components/x-stackQL-resources/preference_sets/methods/list' insert: - $ref: '#/components/x-stackQL-resources/preference_sets/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/preference_sets/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/preference_sets/methods/delete' report_configs: - id: migrationcenter.report_configs + id: google.migrationcenter.report_configs name: report_configs title: Report_configs methods: @@ -4015,15 +4020,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/report_configs/methods/list' - $ref: '#/components/x-stackQL-resources/report_configs/methods/get' + - $ref: '#/components/x-stackQL-resources/report_configs/methods/list' insert: - $ref: '#/components/x-stackQL-resources/report_configs/methods/create' update: [] delete: - $ref: '#/components/x-stackQL-resources/report_configs/methods/delete' reports: - id: migrationcenter.reports + id: google.migrationcenter.reports name: reports title: Reports methods: @@ -4061,15 +4066,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/reports/methods/list' - $ref: '#/components/x-stackQL-resources/reports/methods/get' + - $ref: '#/components/x-stackQL-resources/reports/methods/list' insert: - $ref: '#/components/x-stackQL-resources/reports/methods/create' update: [] delete: - $ref: '#/components/x-stackQL-resources/reports/methods/delete' discovery_clients: - id: migrationcenter.discovery_clients + id: google.migrationcenter.discovery_clients name: discovery_clients title: Discovery_clients methods: @@ -4121,11 +4126,12 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/discovery_clients/methods/list' - $ref: '#/components/x-stackQL-resources/discovery_clients/methods/get' + - $ref: '#/components/x-stackQL-resources/discovery_clients/methods/list' insert: - $ref: '#/components/x-stackQL-resources/discovery_clients/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/discovery_clients/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/discovery_clients/methods/delete' paths: 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 519f6a29..48e38b62 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: '20240427' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/ml/ servers: @@ -3327,7 +3327,7 @@ components: - '2' x-stackQL-resources: projects: - id: ml.projects + id: google.ml.projects name: projects title: Projects methods: @@ -3349,7 +3349,7 @@ components: update: [] delete: [] config: - id: ml.config + id: google.ml.config name: config title: Config methods: @@ -3367,7 +3367,7 @@ components: update: [] delete: [] jobs: - id: ml.jobs + id: google.ml.jobs name: jobs title: Jobs methods: @@ -3407,14 +3407,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/jobs/methods/projects_jobs_list' - $ref: '#/components/x-stackQL-resources/jobs/methods/projects_jobs_get' + - $ref: '#/components/x-stackQL-resources/jobs/methods/projects_jobs_list' insert: - $ref: '#/components/x-stackQL-resources/jobs/methods/projects_jobs_create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/jobs/methods/projects_jobs_patch' delete: [] jobs_iam_policies: - id: ml.jobs_iam_policies + id: google.ml.jobs_iam_policies name: jobs_iam_policies title: Jobs_iam_policies methods: @@ -3451,7 +3452,7 @@ components: update: [] delete: [] locations: - id: ml.locations + id: google.ml.locations name: locations title: Locations methods: @@ -3481,7 +3482,7 @@ components: update: [] delete: [] operations: - id: ml.operations + id: google.ml.operations name: operations title: Operations methods: @@ -3527,15 +3528,15 @@ components: select: - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_operations_list insert: [] update: [] delete: [] studies: - id: ml.studies + id: google.ml.studies name: studies title: Studies methods: @@ -3569,10 +3570,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/studies/methods/projects_locations_studies_list - $ref: >- #/components/x-stackQL-resources/studies/methods/projects_locations_studies_get + - $ref: >- + #/components/x-stackQL-resources/studies/methods/projects_locations_studies_list insert: - $ref: >- #/components/x-stackQL-resources/studies/methods/projects_locations_studies_create @@ -3581,7 +3582,7 @@ components: - $ref: >- #/components/x-stackQL-resources/studies/methods/projects_locations_studies_delete trials: - id: ml.trials + id: google.ml.trials name: trials title: Trials methods: @@ -3643,10 +3644,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/trials/methods/projects_locations_studies_trials_list - $ref: >- #/components/x-stackQL-resources/trials/methods/projects_locations_studies_trials_get + - $ref: >- + #/components/x-stackQL-resources/trials/methods/projects_locations_studies_trials_list insert: - $ref: >- #/components/x-stackQL-resources/trials/methods/projects_locations_studies_trials_create @@ -3655,7 +3656,7 @@ components: - $ref: >- #/components/x-stackQL-resources/trials/methods/projects_locations_studies_trials_delete trials_measurement: - id: ml.trials_measurement + id: google.ml.trials_measurement name: trials_measurement title: Trials_measurement methods: @@ -3672,7 +3673,7 @@ components: update: [] delete: [] trials_optimal_trials: - id: ml.trials_optimal_trials + id: google.ml.trials_optimal_trials name: trials_optimal_trials title: Trials_optimal_trials methods: @@ -3689,7 +3690,7 @@ components: update: [] delete: [] models: - id: ml.models + id: google.ml.models name: models title: Models methods: @@ -3729,19 +3730,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/models/methods/projects_models_list - $ref: >- #/components/x-stackQL-resources/models/methods/projects_models_get + - $ref: >- + #/components/x-stackQL-resources/models/methods/projects_models_list insert: - $ref: >- #/components/x-stackQL-resources/models/methods/projects_models_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/models/methods/projects_models_patch delete: - $ref: >- #/components/x-stackQL-resources/models/methods/projects_models_delete models_iam_policies: - id: ml.models_iam_policies + id: google.ml.models_iam_policies name: models_iam_policies title: Models_iam_policies methods: @@ -3778,7 +3781,7 @@ components: update: [] delete: [] versions: - id: ml.versions + id: google.ml.versions name: versions title: Versions methods: @@ -3830,14 +3833,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_models_versions_list - $ref: >- #/components/x-stackQL-resources/versions/methods/projects_models_versions_get + - $ref: >- + #/components/x-stackQL-resources/versions/methods/projects_models_versions_list insert: - $ref: >- #/components/x-stackQL-resources/versions/methods/projects_models_versions_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/versions/methods/projects_models_versions_patch delete: - $ref: >- #/components/x-stackQL-resources/versions/methods/projects_models_versions_delete 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 c74a4c1c..926c080b 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/monitoring.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/monitoring.yaml @@ -8,7 +8,7 @@ info: description: Manages your Cloud Monitoring data and configurations. version: v3 x-discovery-doc-revision: '20240526' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/monitoring/api/ servers: @@ -4708,7 +4708,7 @@ components: - '2' x-stackQL-resources: monitored_resource_descriptors: - id: monitoring.monitored_resource_descriptors + id: google.monitoring.monitored_resource_descriptors name: monitored_resource_descriptors title: Monitored_resource_descriptors methods: @@ -4732,15 +4732,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/monitored_resource_descriptors/methods/projects_monitored_resource_descriptors_list - $ref: >- #/components/x-stackQL-resources/monitored_resource_descriptors/methods/projects_monitored_resource_descriptors_get + - $ref: >- + #/components/x-stackQL-resources/monitored_resource_descriptors/methods/projects_monitored_resource_descriptors_list insert: [] update: [] delete: [] metric_descriptors: - id: monitoring.metric_descriptors + id: google.monitoring.metric_descriptors name: metric_descriptors title: Metric_descriptors methods: @@ -4776,10 +4776,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/metric_descriptors/methods/projects_metric_descriptors_list - $ref: >- #/components/x-stackQL-resources/metric_descriptors/methods/projects_metric_descriptors_get + - $ref: >- + #/components/x-stackQL-resources/metric_descriptors/methods/projects_metric_descriptors_list insert: - $ref: >- #/components/x-stackQL-resources/metric_descriptors/methods/projects_metric_descriptors_create @@ -4788,7 +4788,7 @@ components: - $ref: >- #/components/x-stackQL-resources/metric_descriptors/methods/projects_metric_descriptors_delete time_series: - id: monitoring.time_series + id: google.monitoring.time_series name: time_series title: Time_series methods: @@ -4848,7 +4848,7 @@ components: update: [] delete: [] time_series_service: - id: monitoring.time_series_service + id: google.monitoring.time_series_service name: time_series_service title: Time_series_service methods: @@ -4867,7 +4867,7 @@ components: update: [] delete: [] collectd_time_series: - id: monitoring.collectd_time_series + id: google.monitoring.collectd_time_series name: collectd_time_series title: Collectd_time_series methods: @@ -4885,7 +4885,7 @@ components: update: [] delete: [] alert_policies: - id: monitoring.alert_policies + id: google.monitoring.alert_policies name: alert_policies title: Alert_policies methods: @@ -4928,19 +4928,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/alert_policies/methods/projects_alert_policies_list - $ref: >- #/components/x-stackQL-resources/alert_policies/methods/projects_alert_policies_get + - $ref: >- + #/components/x-stackQL-resources/alert_policies/methods/projects_alert_policies_list insert: - $ref: >- #/components/x-stackQL-resources/alert_policies/methods/projects_alert_policies_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/alert_policies/methods/projects_alert_policies_patch delete: - $ref: >- #/components/x-stackQL-resources/alert_policies/methods/projects_alert_policies_delete groups: - id: monitoring.groups + id: google.monitoring.groups name: groups title: Groups methods: @@ -4980,19 +4982,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/groups/methods/projects_groups_list - $ref: >- #/components/x-stackQL-resources/groups/methods/projects_groups_get + - $ref: >- + #/components/x-stackQL-resources/groups/methods/projects_groups_list insert: - $ref: >- #/components/x-stackQL-resources/groups/methods/projects_groups_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/groups/methods/projects_groups_update delete: - $ref: >- #/components/x-stackQL-resources/groups/methods/projects_groups_delete members: - id: monitoring.members + id: google.monitoring.members name: members title: Members methods: @@ -5015,7 +5019,7 @@ components: update: [] delete: [] notification_channel_descriptors: - id: monitoring.notification_channel_descriptors + id: google.monitoring.notification_channel_descriptors name: notification_channel_descriptors title: Notification_channel_descriptors methods: @@ -5039,15 +5043,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/notification_channel_descriptors/methods/projects_notification_channel_descriptors_list - $ref: >- #/components/x-stackQL-resources/notification_channel_descriptors/methods/projects_notification_channel_descriptors_get + - $ref: >- + #/components/x-stackQL-resources/notification_channel_descriptors/methods/projects_notification_channel_descriptors_list insert: [] update: [] delete: [] notification_channels: - id: monitoring.notification_channels + id: google.monitoring.notification_channels name: notification_channels title: Notification_channels methods: @@ -5104,19 +5108,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/notification_channels/methods/projects_notification_channels_list - $ref: >- #/components/x-stackQL-resources/notification_channels/methods/projects_notification_channels_get + - $ref: >- + #/components/x-stackQL-resources/notification_channels/methods/projects_notification_channels_list insert: - $ref: >- #/components/x-stackQL-resources/notification_channels/methods/projects_notification_channels_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/notification_channels/methods/projects_notification_channels_patch delete: - $ref: >- #/components/x-stackQL-resources/notification_channels/methods/projects_notification_channels_delete notification_channels_verification_code: - id: monitoring.notification_channels_verification_code + id: google.monitoring.notification_channels_verification_code name: notification_channels_verification_code title: Notification_channels_verification_code methods: @@ -5133,7 +5139,7 @@ components: update: [] delete: [] snoozes: - id: monitoring.snoozes + id: google.monitoring.snoozes name: snoozes title: Snoozes methods: @@ -5167,17 +5173,19 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/snoozes/methods/projects_snoozes_list - $ref: >- #/components/x-stackQL-resources/snoozes/methods/projects_snoozes_get + - $ref: >- + #/components/x-stackQL-resources/snoozes/methods/projects_snoozes_list insert: - $ref: >- #/components/x-stackQL-resources/snoozes/methods/projects_snoozes_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/snoozes/methods/projects_snoozes_patch delete: [] uptime_check_configs: - id: monitoring.uptime_check_configs + id: google.monitoring.uptime_check_configs name: uptime_check_configs title: Uptime_check_configs methods: @@ -5220,19 +5228,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/uptime_check_configs/methods/projects_uptime_check_configs_list - $ref: >- #/components/x-stackQL-resources/uptime_check_configs/methods/projects_uptime_check_configs_get + - $ref: >- + #/components/x-stackQL-resources/uptime_check_configs/methods/projects_uptime_check_configs_list insert: - $ref: >- #/components/x-stackQL-resources/uptime_check_configs/methods/projects_uptime_check_configs_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/uptime_check_configs/methods/projects_uptime_check_configs_patch delete: - $ref: >- #/components/x-stackQL-resources/uptime_check_configs/methods/projects_uptime_check_configs_delete services: - id: monitoring.services + id: google.monitoring.services name: services title: Services methods: @@ -5260,7 +5270,7 @@ components: update: [] delete: [] service_level_objectives: - id: monitoring.service_level_objectives + id: google.monitoring.service_level_objectives name: service_level_objectives title: Service_level_objectives methods: @@ -5300,19 +5310,21 @@ components: response: *ref_28 sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/service_level_objectives/methods/services_service_level_objectives_get - $ref: >- #/components/x-stackQL-resources/service_level_objectives/methods/services_service_level_objectives_list + - $ref: >- + #/components/x-stackQL-resources/service_level_objectives/methods/services_service_level_objectives_get insert: - $ref: >- #/components/x-stackQL-resources/service_level_objectives/methods/services_service_level_objectives_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/service_level_objectives/methods/services_service_level_objectives_patch delete: - $ref: >- #/components/x-stackQL-resources/service_level_objectives/methods/services_service_level_objectives_delete uptime_check_ips: - id: monitoring.uptime_check_ips + id: google.monitoring.uptime_check_ips name: uptime_check_ips title: Uptime_check_ips methods: 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 91baad48..1b3e4946 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: '20240508' - x-generated-date: '2024-06-02' + x-discovery-doc-revision: '20240523' + x-generated-date: '2024-06-03' externalDocs: url: >- https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest @@ -305,6 +305,15 @@ components: producerInstanceId: description: Immutable. An immutable identifier for the producer instance. type: string + serviceAttachmentIpAddressMap: + description: >- + Output only. A map to store mapping between customer vip and target + service attachment. Only service attachment with producer specified + ip addresses are stored here. + readOnly: true + type: object + additionalProperties: + type: string ConsumerPscConnection: id: ConsumerPscConnection description: PSC connection details on consumer side. @@ -1525,10 +1534,15 @@ components: - >- The route leads to a destination within the secondary address range of the VPC network's subnet. + - >- + The route leads to a destination in a dynamic route. Dynamic + routes are derived from Border Gateway Protocol (BGP) + advertisements received from an NCC hybrid spoke. enum: - ROUTE_TYPE_UNSPECIFIED - VPC_PRIMARY_SUBNET - VPC_SECONDARY_SUBNET + - DYNAMIC_ROUTE nextHopVpcNetwork: description: Immutable. The destination VPC network for packets on this route. $ref: '#/components/schemas/NextHopVpcNetwork' @@ -1589,6 +1603,25 @@ components: projects/1234/locations/us-central1 readOnly: true type: string + priority: + description: >- + Output only. The priority of this route. Priority is used to break + ties in cases where a destination matches more than one route. In + these cases the route with the lowest-numbered priority value wins. + readOnly: true + type: string + format: int64 + nextHopVpnTunnel: + description: Immutable. The next-hop VPN tunnel for packets on this route. + $ref: '#/components/schemas/NextHopVPNTunnel' + nextHopRouterApplianceInstance: + description: >- + Immutable. The next-hop Router appliance instance for packets on + this route. + $ref: '#/components/schemas/NextHopRouterApplianceInstance' + nextHopInterconnectAttachment: + description: Immutable. The next-hop VLAN attachment for packets on this route. + $ref: '#/components/schemas/NextHopInterconnectAttachment' NextHopVpcNetwork: id: NextHopVpcNetwork type: object @@ -1596,6 +1629,59 @@ components: uri: description: The URI of the VPC network resource type: string + NextHopVPNTunnel: + id: NextHopVPNTunnel + description: A route next hop that leads to a VPN tunnel resource. + type: object + properties: + uri: + description: The URI of the VPN tunnel resource. + type: string + vpcNetwork: + description: The VPC network where this VPN tunnel is located. + type: string + siteToSiteDataTransfer: + description: >- + Indicates whether site-to-site data transfer is allowed for this VPN + tunnel resource. Data transfer is available only in [supported + locations](https://cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/locations). + type: boolean + NextHopRouterApplianceInstance: + id: NextHopRouterApplianceInstance + description: A route next hop that leads to a Router appliance instance. + type: object + properties: + uri: + description: The URI of the Router appliance instance. + type: string + vpcNetwork: + description: The VPC network where this VM is located. + type: string + siteToSiteDataTransfer: + description: >- + Indicates whether site-to-site data transfer is allowed for this + Router appliance instance resource. Data transfer is available only + in [supported + locations](https://cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/locations). + type: boolean + NextHopInterconnectAttachment: + id: NextHopInterconnectAttachment + description: A route next hop that leads to an interconnect attachment resource. + type: object + properties: + uri: + description: The URI of the interconnect attachment resource. + type: string + vpcNetwork: + description: The VPC network where this interconnect attachment is located. + type: string + siteToSiteDataTransfer: + description: >- + Indicates whether site-to-site data transfer is allowed for this + interconnect attachment resource. Data transfer is available only in + [supported + locations](https://cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/locations). + type: boolean ListRoutesResponse: id: ListRoutesResponse description: Response for HubService.ListRoutes method. @@ -1950,11 +2036,11 @@ components: Policy-based routes route L4 network traffic based on not just destination IP address, but also source IP address, protocol, and more. If a policy-based route conflicts with other types of routes, the - policy-based route always take precedence. + policy-based route always takes precedence. type: object properties: virtualMachine: - description: Optional. VM instances to which this policy-based route applies to. + description: Optional. VM instances that this policy-based route applies to. $ref: '#/components/schemas/VirtualMachine' interconnectAttachment: description: >- @@ -1977,8 +2063,8 @@ components: - >- Use the routes from the default routing tables (system-generated routes, custom routes, peering route) to determine the next hop. - This will effectively exclude matching packets being applied on - other PBRs with a lower priority. + This effectively excludes matching packets being applied on other + PBRs with a lower priority. enum: - OTHER_ROUTES_UNSPECIFIED - DEFAULT_ROUTING @@ -2046,14 +2132,14 @@ components: type: string VirtualMachine: id: VirtualMachine - description: VM instances to which this policy-based route applies to. + description: VM instances that this policy-based route applies to. type: object properties: tags: description: >- - Optional. A list of VM instance tags the this policy-based route - applies to. VM instances that have ANY of tags specified here will - install this PBR. + Optional. A list of VM instance tags that this policy-based route + applies to. VM instances that have ANY of tags specified here + installs this PBR. type: array items: type: string @@ -2093,7 +2179,8 @@ components: protocolVersion: description: >- Required. Internet protocol versions this policy-based route applies - to. For this version, only IPV4 is supported. + to. For this version, only IPV4 is supported. IPV6 is supported in + preview. type: string enumDescriptions: - Default value. @@ -2114,7 +2201,7 @@ components: - Default value. - >- The policy-based route is not active and functioning. Common - causes are the dependent network was deleted or the resource + causes are that the dependent network was deleted or the resource project was turned off. - >- The policy-based route is being modified (e.g. created/deleted) at @@ -2783,7 +2870,7 @@ components: - '2' x-stackQL-resources: locations: - id: networkconnectivity.locations + id: google.networkconnectivity.locations name: locations title: Locations methods: @@ -2805,13 +2892,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: networkconnectivity.operations + id: google.networkconnectivity.operations name: operations title: Operations methods: @@ -2849,14 +2936,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' service_connection_maps: - id: networkconnectivity.service_connection_maps + id: google.networkconnectivity.service_connection_maps name: service_connection_maps title: Service_connection_maps methods: @@ -2901,19 +2988,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/service_connection_maps/methods/list - $ref: >- #/components/x-stackQL-resources/service_connection_maps/methods/get + - $ref: >- + #/components/x-stackQL-resources/service_connection_maps/methods/list insert: - $ref: >- #/components/x-stackQL-resources/service_connection_maps/methods/create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/service_connection_maps/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/service_connection_maps/methods/delete service_connection_maps_iam_policies: - id: networkconnectivity.service_connection_maps_iam_policies + id: google.networkconnectivity.service_connection_maps_iam_policies name: service_connection_maps_iam_policies title: Service_connection_maps_iam_policies methods: @@ -2950,7 +3039,7 @@ components: update: [] delete: [] service_connection_policies: - id: networkconnectivity.service_connection_policies + id: google.networkconnectivity.service_connection_policies name: service_connection_policies title: Service_connection_policies methods: @@ -2995,19 +3084,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/service_connection_policies/methods/list - $ref: >- #/components/x-stackQL-resources/service_connection_policies/methods/get + - $ref: >- + #/components/x-stackQL-resources/service_connection_policies/methods/list insert: - $ref: >- #/components/x-stackQL-resources/service_connection_policies/methods/create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/service_connection_policies/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/service_connection_policies/methods/delete service_connection_policies_iam_policies: - id: networkconnectivity.service_connection_policies_iam_policies + id: google.networkconnectivity.service_connection_policies_iam_policies name: service_connection_policies_iam_policies title: Service_connection_policies_iam_policies methods: @@ -3044,7 +3135,7 @@ components: update: [] delete: [] service_classes: - id: networkconnectivity.service_classes + id: google.networkconnectivity.service_classes name: service_classes title: Service_classes methods: @@ -3082,14 +3173,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/service_classes/methods/list' - $ref: '#/components/x-stackQL-resources/service_classes/methods/get' + - $ref: '#/components/x-stackQL-resources/service_classes/methods/list' insert: [] - update: [] + update: + - $ref: '#/components/x-stackQL-resources/service_classes/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/service_classes/methods/delete' service_classes_iam_policies: - id: networkconnectivity.service_classes_iam_policies + id: google.networkconnectivity.service_classes_iam_policies name: service_classes_iam_policies title: Service_classes_iam_policies methods: @@ -3126,7 +3218,7 @@ components: update: [] delete: [] service_connection_tokens: - id: networkconnectivity.service_connection_tokens + id: google.networkconnectivity.service_connection_tokens name: service_connection_tokens title: Service_connection_tokens methods: @@ -3176,7 +3268,7 @@ components: - $ref: >- #/components/x-stackQL-resources/service_connection_tokens/methods/delete hubs: - id: networkconnectivity.hubs + id: google.networkconnectivity.hubs name: hubs title: Hubs methods: @@ -3233,15 +3325,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/hubs/methods/list' - $ref: '#/components/x-stackQL-resources/hubs/methods/get' + - $ref: '#/components/x-stackQL-resources/hubs/methods/list' insert: - $ref: '#/components/x-stackQL-resources/hubs/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/hubs/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/hubs/methods/delete' spokes: - id: networkconnectivity.spokes + id: google.networkconnectivity.spokes name: spokes title: Spokes methods: @@ -3297,16 +3390,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/spokes/methods/get' - $ref: '#/components/x-stackQL-resources/spokes/methods/list_spokes' - $ref: '#/components/x-stackQL-resources/spokes/methods/list' - - $ref: '#/components/x-stackQL-resources/spokes/methods/get' insert: - $ref: '#/components/x-stackQL-resources/spokes/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/spokes/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/spokes/methods/delete' hubs_iam_policies: - id: networkconnectivity.hubs_iam_policies + id: google.networkconnectivity.hubs_iam_policies name: hubs_iam_policies title: Hubs_iam_policies methods: @@ -3343,7 +3437,7 @@ components: update: [] delete: [] route_tables: - id: networkconnectivity.route_tables + id: google.networkconnectivity.route_tables name: route_tables title: Route_tables methods: @@ -3373,7 +3467,7 @@ components: update: [] delete: [] routes: - id: networkconnectivity.routes + id: google.networkconnectivity.routes name: routes title: Routes methods: @@ -3403,7 +3497,7 @@ components: update: [] delete: [] groups: - id: networkconnectivity.groups + id: google.networkconnectivity.groups name: groups title: Groups methods: @@ -3437,10 +3531,11 @@ components: - $ref: '#/components/x-stackQL-resources/groups/methods/get' - $ref: '#/components/x-stackQL-resources/groups/methods/list' insert: [] - update: [] + update: + - $ref: '#/components/x-stackQL-resources/groups/methods/patch' delete: [] groups_iam_policies: - id: networkconnectivity.groups_iam_policies + id: google.networkconnectivity.groups_iam_policies name: groups_iam_policies title: Groups_iam_policies methods: @@ -3477,7 +3572,7 @@ components: update: [] delete: [] policy_based_routes: - id: networkconnectivity.policy_based_routes + id: google.networkconnectivity.policy_based_routes name: policy_based_routes title: Policy_based_routes methods: @@ -3515,8 +3610,8 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/policy_based_routes/methods/list' - $ref: '#/components/x-stackQL-resources/policy_based_routes/methods/get' + - $ref: '#/components/x-stackQL-resources/policy_based_routes/methods/list' insert: - $ref: >- #/components/x-stackQL-resources/policy_based_routes/methods/create @@ -3525,7 +3620,7 @@ components: - $ref: >- #/components/x-stackQL-resources/policy_based_routes/methods/delete policy_based_routes_iam_policies: - id: networkconnectivity.policy_based_routes_iam_policies + id: google.networkconnectivity.policy_based_routes_iam_policies name: policy_based_routes_iam_policies title: Policy_based_routes_iam_policies methods: @@ -3562,7 +3657,7 @@ components: update: [] delete: [] spokes_iam_policies: - id: networkconnectivity.spokes_iam_policies + id: google.networkconnectivity.spokes_iam_policies name: spokes_iam_policies title: Spokes_iam_policies methods: @@ -3599,7 +3694,7 @@ components: update: [] delete: [] internal_ranges: - id: networkconnectivity.internal_ranges + id: google.networkconnectivity.internal_ranges name: internal_ranges title: Internal_ranges methods: @@ -3644,15 +3739,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/internal_ranges/methods/list' - $ref: '#/components/x-stackQL-resources/internal_ranges/methods/get' + - $ref: '#/components/x-stackQL-resources/internal_ranges/methods/list' insert: - $ref: '#/components/x-stackQL-resources/internal_ranges/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/internal_ranges/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/internal_ranges/methods/delete' regional_endpoints: - id: networkconnectivity.regional_endpoints + id: google.networkconnectivity.regional_endpoints name: regional_endpoints title: Regional_endpoints methods: @@ -3690,8 +3786,8 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/regional_endpoints/methods/list' - $ref: '#/components/x-stackQL-resources/regional_endpoints/methods/get' + - $ref: '#/components/x-stackQL-resources/regional_endpoints/methods/list' insert: - $ref: '#/components/x-stackQL-resources/regional_endpoints/methods/create' update: [] 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 115c271a..6a3234ff 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: '20240515' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/ servers: @@ -2830,7 +2830,7 @@ components: - '2' x-stackQL-resources: locations: - id: networkmanagement.locations + id: google.networkmanagement.locations name: locations title: Locations methods: @@ -2852,13 +2852,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: networkmanagement.operations + id: google.networkmanagement.operations name: operations title: Operations methods: @@ -2896,14 +2896,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' connectivity_tests: - id: networkmanagement.connectivity_tests + id: google.networkmanagement.connectivity_tests name: connectivity_tests title: Connectivity_tests methods: @@ -2955,15 +2955,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/connectivity_tests/methods/list' - $ref: '#/components/x-stackQL-resources/connectivity_tests/methods/get' + - $ref: '#/components/x-stackQL-resources/connectivity_tests/methods/list' insert: - $ref: '#/components/x-stackQL-resources/connectivity_tests/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/connectivity_tests/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/connectivity_tests/methods/delete' connectivity_tests_iam_policies: - id: networkmanagement.connectivity_tests_iam_policies + id: google.networkmanagement.connectivity_tests_iam_policies name: connectivity_tests_iam_policies title: Connectivity_tests_iam_policies methods: 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 d80be931..65b46e24 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: '20240510' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/networking servers: @@ -2086,7 +2086,7 @@ components: - '2' x-stackQL-resources: locations: - id: networksecurity.locations + id: google.networksecurity.locations name: locations title: Locations methods: @@ -2108,15 +2108,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/locations/methods/projects_locations_list - $ref: >- #/components/x-stackQL-resources/locations/methods/projects_locations_get + - $ref: >- + #/components/x-stackQL-resources/locations/methods/projects_locations_list insert: [] update: [] delete: [] operations: - id: networksecurity.operations + id: google.networksecurity.operations name: operations title: Operations methods: @@ -2186,14 +2186,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/organizations_locations_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/organizations_locations_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list + - $ref: >- + #/components/x-stackQL-resources/operations/methods/organizations_locations_operations_list insert: [] update: [] delete: @@ -2202,7 +2202,7 @@ components: - $ref: >- #/components/x-stackQL-resources/operations/methods/organizations_locations_operations_delete address_groups: - id: networksecurity.address_groups + id: google.networksecurity.address_groups name: address_groups title: Address_groups methods: @@ -2300,27 +2300,31 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/address_groups/methods/projects_locations_address_groups_list - $ref: >- #/components/x-stackQL-resources/address_groups/methods/projects_locations_address_groups_get - - $ref: >- - #/components/x-stackQL-resources/address_groups/methods/organizations_locations_address_groups_list - $ref: >- #/components/x-stackQL-resources/address_groups/methods/organizations_locations_address_groups_get + - $ref: >- + #/components/x-stackQL-resources/address_groups/methods/projects_locations_address_groups_list + - $ref: >- + #/components/x-stackQL-resources/address_groups/methods/organizations_locations_address_groups_list insert: - $ref: >- #/components/x-stackQL-resources/address_groups/methods/projects_locations_address_groups_create - $ref: >- #/components/x-stackQL-resources/address_groups/methods/organizations_locations_address_groups_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/address_groups/methods/projects_locations_address_groups_patch + - $ref: >- + #/components/x-stackQL-resources/address_groups/methods/organizations_locations_address_groups_patch delete: - $ref: >- #/components/x-stackQL-resources/address_groups/methods/projects_locations_address_groups_delete - $ref: >- #/components/x-stackQL-resources/address_groups/methods/organizations_locations_address_groups_delete address_groups_items: - id: networksecurity.address_groups_items + id: google.networksecurity.address_groups_items name: address_groups_items title: Address_groups_items methods: @@ -2358,7 +2362,7 @@ components: update: [] delete: [] address_groups_references: - id: networksecurity.address_groups_references + id: google.networksecurity.address_groups_references name: address_groups_references title: Address_groups_references methods: @@ -2394,7 +2398,7 @@ components: update: [] delete: [] address_groups_iam_policies: - id: networksecurity.address_groups_iam_policies + id: google.networksecurity.address_groups_iam_policies name: address_groups_iam_policies title: Address_groups_iam_policies methods: @@ -2431,7 +2435,7 @@ components: update: [] delete: [] firewall_endpoint_associations: - id: networksecurity.firewall_endpoint_associations + id: google.networksecurity.firewall_endpoint_associations name: firewall_endpoint_associations title: Firewall_endpoint_associations methods: @@ -2476,19 +2480,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/firewall_endpoint_associations/methods/projects_locations_firewall_endpoint_associations_list - $ref: >- #/components/x-stackQL-resources/firewall_endpoint_associations/methods/projects_locations_firewall_endpoint_associations_get + - $ref: >- + #/components/x-stackQL-resources/firewall_endpoint_associations/methods/projects_locations_firewall_endpoint_associations_list insert: - $ref: >- #/components/x-stackQL-resources/firewall_endpoint_associations/methods/projects_locations_firewall_endpoint_associations_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/firewall_endpoint_associations/methods/projects_locations_firewall_endpoint_associations_patch delete: - $ref: >- #/components/x-stackQL-resources/firewall_endpoint_associations/methods/projects_locations_firewall_endpoint_associations_delete authorization_policies: - id: networksecurity.authorization_policies + id: google.networksecurity.authorization_policies name: authorization_policies title: Authorization_policies methods: @@ -2533,19 +2539,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/authorization_policies/methods/projects_locations_authorization_policies_list - $ref: >- #/components/x-stackQL-resources/authorization_policies/methods/projects_locations_authorization_policies_get + - $ref: >- + #/components/x-stackQL-resources/authorization_policies/methods/projects_locations_authorization_policies_list insert: - $ref: >- #/components/x-stackQL-resources/authorization_policies/methods/projects_locations_authorization_policies_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/authorization_policies/methods/projects_locations_authorization_policies_patch delete: - $ref: >- #/components/x-stackQL-resources/authorization_policies/methods/projects_locations_authorization_policies_delete authorization_policies_iam_policies: - id: networksecurity.authorization_policies_iam_policies + id: google.networksecurity.authorization_policies_iam_policies name: authorization_policies_iam_policies title: Authorization_policies_iam_policies methods: @@ -2582,7 +2590,7 @@ components: update: [] delete: [] server_tls_policies: - id: networksecurity.server_tls_policies + id: google.networksecurity.server_tls_policies name: server_tls_policies title: Server_tls_policies methods: @@ -2627,19 +2635,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/server_tls_policies/methods/projects_locations_server_tls_policies_list - $ref: >- #/components/x-stackQL-resources/server_tls_policies/methods/projects_locations_server_tls_policies_get + - $ref: >- + #/components/x-stackQL-resources/server_tls_policies/methods/projects_locations_server_tls_policies_list insert: - $ref: >- #/components/x-stackQL-resources/server_tls_policies/methods/projects_locations_server_tls_policies_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/server_tls_policies/methods/projects_locations_server_tls_policies_patch delete: - $ref: >- #/components/x-stackQL-resources/server_tls_policies/methods/projects_locations_server_tls_policies_delete server_tls_policies_iam_policies: - id: networksecurity.server_tls_policies_iam_policies + id: google.networksecurity.server_tls_policies_iam_policies name: server_tls_policies_iam_policies title: Server_tls_policies_iam_policies methods: @@ -2676,7 +2686,7 @@ components: update: [] delete: [] client_tls_policies: - id: networksecurity.client_tls_policies + id: google.networksecurity.client_tls_policies name: client_tls_policies title: Client_tls_policies methods: @@ -2721,19 +2731,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/client_tls_policies/methods/projects_locations_client_tls_policies_list - $ref: >- #/components/x-stackQL-resources/client_tls_policies/methods/projects_locations_client_tls_policies_get + - $ref: >- + #/components/x-stackQL-resources/client_tls_policies/methods/projects_locations_client_tls_policies_list insert: - $ref: >- #/components/x-stackQL-resources/client_tls_policies/methods/projects_locations_client_tls_policies_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/client_tls_policies/methods/projects_locations_client_tls_policies_patch delete: - $ref: >- #/components/x-stackQL-resources/client_tls_policies/methods/projects_locations_client_tls_policies_delete client_tls_policies_iam_policies: - id: networksecurity.client_tls_policies_iam_policies + id: google.networksecurity.client_tls_policies_iam_policies name: client_tls_policies_iam_policies title: Client_tls_policies_iam_policies methods: @@ -2770,7 +2782,7 @@ components: update: [] delete: [] gateway_security_policies: - id: networksecurity.gateway_security_policies + id: google.networksecurity.gateway_security_policies name: gateway_security_policies title: Gateway_security_policies methods: @@ -2815,19 +2827,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/gateway_security_policies/methods/projects_locations_gateway_security_policies_list - $ref: >- #/components/x-stackQL-resources/gateway_security_policies/methods/projects_locations_gateway_security_policies_get + - $ref: >- + #/components/x-stackQL-resources/gateway_security_policies/methods/projects_locations_gateway_security_policies_list insert: - $ref: >- #/components/x-stackQL-resources/gateway_security_policies/methods/projects_locations_gateway_security_policies_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/gateway_security_policies/methods/projects_locations_gateway_security_policies_patch delete: - $ref: >- #/components/x-stackQL-resources/gateway_security_policies/methods/projects_locations_gateway_security_policies_delete rules: - id: networksecurity.rules + id: google.networksecurity.rules name: rules title: Rules methods: @@ -2872,19 +2886,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/rules/methods/projects_locations_gateway_security_policies_rules_list - $ref: >- #/components/x-stackQL-resources/rules/methods/projects_locations_gateway_security_policies_rules_get + - $ref: >- + #/components/x-stackQL-resources/rules/methods/projects_locations_gateway_security_policies_rules_list insert: - $ref: >- #/components/x-stackQL-resources/rules/methods/projects_locations_gateway_security_policies_rules_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/rules/methods/projects_locations_gateway_security_policies_rules_patch delete: - $ref: >- #/components/x-stackQL-resources/rules/methods/projects_locations_gateway_security_policies_rules_delete url_lists: - id: networksecurity.url_lists + id: google.networksecurity.url_lists name: url_lists title: Url_lists methods: @@ -2929,19 +2945,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/url_lists/methods/projects_locations_url_lists_list - $ref: >- #/components/x-stackQL-resources/url_lists/methods/projects_locations_url_lists_get + - $ref: >- + #/components/x-stackQL-resources/url_lists/methods/projects_locations_url_lists_list insert: - $ref: >- #/components/x-stackQL-resources/url_lists/methods/projects_locations_url_lists_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/url_lists/methods/projects_locations_url_lists_patch delete: - $ref: >- #/components/x-stackQL-resources/url_lists/methods/projects_locations_url_lists_delete tls_inspection_policies: - id: networksecurity.tls_inspection_policies + id: google.networksecurity.tls_inspection_policies name: tls_inspection_policies title: Tls_inspection_policies methods: @@ -2986,19 +3004,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/tls_inspection_policies/methods/projects_locations_tls_inspection_policies_list - $ref: >- #/components/x-stackQL-resources/tls_inspection_policies/methods/projects_locations_tls_inspection_policies_get + - $ref: >- + #/components/x-stackQL-resources/tls_inspection_policies/methods/projects_locations_tls_inspection_policies_list insert: - $ref: >- #/components/x-stackQL-resources/tls_inspection_policies/methods/projects_locations_tls_inspection_policies_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/tls_inspection_policies/methods/projects_locations_tls_inspection_policies_patch delete: - $ref: >- #/components/x-stackQL-resources/tls_inspection_policies/methods/projects_locations_tls_inspection_policies_delete firewall_endpoints: - id: networksecurity.firewall_endpoints + id: google.networksecurity.firewall_endpoints name: firewall_endpoints title: Firewall_endpoints methods: @@ -3043,19 +3063,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/firewall_endpoints/methods/organizations_locations_firewall_endpoints_list - $ref: >- #/components/x-stackQL-resources/firewall_endpoints/methods/organizations_locations_firewall_endpoints_get + - $ref: >- + #/components/x-stackQL-resources/firewall_endpoints/methods/organizations_locations_firewall_endpoints_list insert: - $ref: >- #/components/x-stackQL-resources/firewall_endpoints/methods/organizations_locations_firewall_endpoints_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/firewall_endpoints/methods/organizations_locations_firewall_endpoints_patch delete: - $ref: >- #/components/x-stackQL-resources/firewall_endpoints/methods/organizations_locations_firewall_endpoints_delete security_profile_groups: - id: networksecurity.security_profile_groups + id: google.networksecurity.security_profile_groups name: security_profile_groups title: Security_profile_groups methods: @@ -3100,19 +3122,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/security_profile_groups/methods/organizations_locations_security_profile_groups_list - $ref: >- #/components/x-stackQL-resources/security_profile_groups/methods/organizations_locations_security_profile_groups_get + - $ref: >- + #/components/x-stackQL-resources/security_profile_groups/methods/organizations_locations_security_profile_groups_list insert: - $ref: >- #/components/x-stackQL-resources/security_profile_groups/methods/organizations_locations_security_profile_groups_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/security_profile_groups/methods/organizations_locations_security_profile_groups_patch delete: - $ref: >- #/components/x-stackQL-resources/security_profile_groups/methods/organizations_locations_security_profile_groups_delete security_profiles: - id: networksecurity.security_profiles + id: google.networksecurity.security_profiles name: security_profiles title: Security_profiles methods: @@ -3157,14 +3181,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/security_profiles/methods/organizations_locations_security_profiles_list - $ref: >- #/components/x-stackQL-resources/security_profiles/methods/organizations_locations_security_profiles_get + - $ref: >- + #/components/x-stackQL-resources/security_profiles/methods/organizations_locations_security_profiles_list insert: - $ref: >- #/components/x-stackQL-resources/security_profiles/methods/organizations_locations_security_profiles_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/security_profiles/methods/organizations_locations_security_profiles_patch delete: - $ref: >- #/components/x-stackQL-resources/security_profiles/methods/organizations_locations_security_profiles_delete 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 ff7b82f6..1dc0e967 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/networkservices.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/networkservices.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1 x-discovery-doc-revision: '20240515' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/networking servers: @@ -3020,7 +3020,7 @@ components: - '2' x-stackQL-resources: locations: - id: networkservices.locations + id: google.networkservices.locations name: locations title: Locations methods: @@ -3042,13 +3042,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: networkservices.operations + id: google.networkservices.operations name: operations title: Operations methods: @@ -3086,14 +3086,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' lb_traffic_extensions: - id: networkservices.lb_traffic_extensions + id: google.networkservices.lb_traffic_extensions name: lb_traffic_extensions title: Lb_traffic_extensions methods: @@ -3138,18 +3138,20 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/lb_traffic_extensions/methods/get' - $ref: >- #/components/x-stackQL-resources/lb_traffic_extensions/methods/list - - $ref: '#/components/x-stackQL-resources/lb_traffic_extensions/methods/get' insert: - $ref: >- #/components/x-stackQL-resources/lb_traffic_extensions/methods/create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/lb_traffic_extensions/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/lb_traffic_extensions/methods/delete lb_route_extensions: - id: networkservices.lb_route_extensions + id: google.networkservices.lb_route_extensions name: lb_route_extensions title: Lb_route_extensions methods: @@ -3194,17 +3196,18 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/lb_route_extensions/methods/list' - $ref: '#/components/x-stackQL-resources/lb_route_extensions/methods/get' + - $ref: '#/components/x-stackQL-resources/lb_route_extensions/methods/list' insert: - $ref: >- #/components/x-stackQL-resources/lb_route_extensions/methods/create - update: [] + update: + - $ref: '#/components/x-stackQL-resources/lb_route_extensions/methods/patch' delete: - $ref: >- #/components/x-stackQL-resources/lb_route_extensions/methods/delete endpoint_policies: - id: networkservices.endpoint_policies + id: google.networkservices.endpoint_policies name: endpoint_policies title: Endpoint_policies methods: @@ -3249,15 +3252,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/endpoint_policies/methods/list' - $ref: '#/components/x-stackQL-resources/endpoint_policies/methods/get' + - $ref: '#/components/x-stackQL-resources/endpoint_policies/methods/list' insert: - $ref: '#/components/x-stackQL-resources/endpoint_policies/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/endpoint_policies/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/endpoint_policies/methods/delete' endpoint_policies_iam_policies: - id: networkservices.endpoint_policies_iam_policies + id: google.networkservices.endpoint_policies_iam_policies name: endpoint_policies_iam_policies title: Endpoint_policies_iam_policies methods: @@ -3294,7 +3298,7 @@ components: update: [] delete: [] gateways: - id: networkservices.gateways + id: google.networkservices.gateways name: gateways title: Gateways methods: @@ -3339,15 +3343,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/gateways/methods/list' - $ref: '#/components/x-stackQL-resources/gateways/methods/get' + - $ref: '#/components/x-stackQL-resources/gateways/methods/list' insert: - $ref: '#/components/x-stackQL-resources/gateways/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/gateways/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/gateways/methods/delete' gateways_iam_policies: - id: networkservices.gateways_iam_policies + id: google.networkservices.gateways_iam_policies name: gateways_iam_policies title: Gateways_iam_policies methods: @@ -3384,7 +3389,7 @@ components: update: [] delete: [] grpc_routes: - id: networkservices.grpc_routes + id: google.networkservices.grpc_routes name: grpc_routes title: Grpc_routes methods: @@ -3429,15 +3434,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/grpc_routes/methods/list' - $ref: '#/components/x-stackQL-resources/grpc_routes/methods/get' + - $ref: '#/components/x-stackQL-resources/grpc_routes/methods/list' insert: - $ref: '#/components/x-stackQL-resources/grpc_routes/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/grpc_routes/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/grpc_routes/methods/delete' http_routes: - id: networkservices.http_routes + id: google.networkservices.http_routes name: http_routes title: Http_routes methods: @@ -3482,15 +3488,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/http_routes/methods/list' - $ref: '#/components/x-stackQL-resources/http_routes/methods/get' + - $ref: '#/components/x-stackQL-resources/http_routes/methods/list' insert: - $ref: '#/components/x-stackQL-resources/http_routes/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/http_routes/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/http_routes/methods/delete' tcp_routes: - id: networkservices.tcp_routes + id: google.networkservices.tcp_routes name: tcp_routes title: Tcp_routes methods: @@ -3535,15 +3542,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/tcp_routes/methods/list' - $ref: '#/components/x-stackQL-resources/tcp_routes/methods/get' + - $ref: '#/components/x-stackQL-resources/tcp_routes/methods/list' insert: - $ref: '#/components/x-stackQL-resources/tcp_routes/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/tcp_routes/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/tcp_routes/methods/delete' tls_routes: - id: networkservices.tls_routes + id: google.networkservices.tls_routes name: tls_routes title: Tls_routes methods: @@ -3588,15 +3596,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/tls_routes/methods/list' - $ref: '#/components/x-stackQL-resources/tls_routes/methods/get' + - $ref: '#/components/x-stackQL-resources/tls_routes/methods/list' insert: - $ref: '#/components/x-stackQL-resources/tls_routes/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/tls_routes/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/tls_routes/methods/delete' service_bindings: - id: networkservices.service_bindings + id: google.networkservices.service_bindings name: service_bindings title: Service_bindings methods: @@ -3634,15 +3643,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/service_bindings/methods/list' - $ref: '#/components/x-stackQL-resources/service_bindings/methods/get' + - $ref: '#/components/x-stackQL-resources/service_bindings/methods/list' insert: - $ref: '#/components/x-stackQL-resources/service_bindings/methods/create' update: [] delete: - $ref: '#/components/x-stackQL-resources/service_bindings/methods/delete' service_bindings_iam_policies: - id: networkservices.service_bindings_iam_policies + id: google.networkservices.service_bindings_iam_policies name: service_bindings_iam_policies title: Service_bindings_iam_policies methods: @@ -3679,7 +3688,7 @@ components: update: [] delete: [] meshes: - id: networkservices.meshes + id: google.networkservices.meshes name: meshes title: Meshes methods: @@ -3724,15 +3733,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/meshes/methods/list' - $ref: '#/components/x-stackQL-resources/meshes/methods/get' + - $ref: '#/components/x-stackQL-resources/meshes/methods/list' insert: - $ref: '#/components/x-stackQL-resources/meshes/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/meshes/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/meshes/methods/delete' meshes_iam_policies: - id: networkservices.meshes_iam_policies + id: google.networkservices.meshes_iam_policies name: meshes_iam_policies title: Meshes_iam_policies methods: @@ -3769,7 +3779,7 @@ components: update: [] delete: [] service_lb_policies: - id: networkservices.service_lb_policies + id: google.networkservices.service_lb_policies name: service_lb_policies title: Service_lb_policies methods: @@ -3814,17 +3824,18 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/service_lb_policies/methods/list' - $ref: '#/components/x-stackQL-resources/service_lb_policies/methods/get' + - $ref: '#/components/x-stackQL-resources/service_lb_policies/methods/list' insert: - $ref: >- #/components/x-stackQL-resources/service_lb_policies/methods/create - update: [] + update: + - $ref: '#/components/x-stackQL-resources/service_lb_policies/methods/patch' delete: - $ref: >- #/components/x-stackQL-resources/service_lb_policies/methods/delete service_lb_policies_iam_policies: - id: networkservices.service_lb_policies_iam_policies + id: google.networkservices.service_lb_policies_iam_policies name: service_lb_policies_iam_policies title: Service_lb_policies_iam_policies methods: @@ -3861,7 +3872,7 @@ components: update: [] delete: [] edge_cache_keysets_iam_policies: - id: networkservices.edge_cache_keysets_iam_policies + id: google.networkservices.edge_cache_keysets_iam_policies name: edge_cache_keysets_iam_policies title: Edge_cache_keysets_iam_policies methods: @@ -3898,7 +3909,7 @@ components: update: [] delete: [] edge_cache_origins_iam_policies: - id: networkservices.edge_cache_origins_iam_policies + id: google.networkservices.edge_cache_origins_iam_policies name: edge_cache_origins_iam_policies title: Edge_cache_origins_iam_policies methods: @@ -3935,7 +3946,7 @@ components: update: [] delete: [] edge_cache_services_iam_policies: - id: networkservices.edge_cache_services_iam_policies + id: google.networkservices.edge_cache_services_iam_policies name: edge_cache_services_iam_policies title: Edge_cache_services_iam_policies methods: 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 c4cfbe82..5887babe 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: '20240422' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/notebooks/docs/ servers: @@ -1387,7 +1387,7 @@ components: - '2' x-stackQL-resources: locations: - id: notebooks.locations + id: google.notebooks.locations name: locations title: Locations methods: @@ -1409,13 +1409,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: notebooks.operations + id: google.notebooks.operations name: operations title: Operations methods: @@ -1453,14 +1453,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' instances: - id: notebooks.instances + id: google.notebooks.instances name: instances title: Instances methods: @@ -1575,15 +1575,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/instances/methods/list' - $ref: '#/components/x-stackQL-resources/instances/methods/get' + - $ref: '#/components/x-stackQL-resources/instances/methods/list' insert: - $ref: '#/components/x-stackQL-resources/instances/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/instances/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/instances/methods/delete' instances_config: - id: notebooks.instances_config + id: google.notebooks.instances_config name: instances_config title: Instances_config methods: @@ -1602,7 +1603,7 @@ components: update: [] delete: [] instances_iam_policies: - id: notebooks.instances_iam_policies + id: google.notebooks.instances_iam_policies name: instances_iam_policies title: Instances_iam_policies methods: 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 ef604802..be3f93ca 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: '20240527' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/container-analysis/docs/on-demand-scanning/ servers: @@ -2680,7 +2680,7 @@ components: - '2' x-stackQL-resources: operations: - id: ondemandscanning.operations + id: google.ondemandscanning.operations name: operations title: Operations methods: @@ -2725,14 +2725,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' scans: - id: ondemandscanning.scans + id: google.ondemandscanning.scans name: scans title: Scans methods: @@ -2749,7 +2749,7 @@ components: update: [] delete: [] vulnerabilities: - id: ondemandscanning.vulnerabilities + id: google.ondemandscanning.vulnerabilities name: vulnerabilities title: Vulnerabilities methods: 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 04109815..744ff61e 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/orgpolicy.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/orgpolicy.yaml @@ -10,7 +10,7 @@ info: their Google Cloud resources across the resource hierarchy. version: v2 x-discovery-doc-revision: '20240524' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/orgpolicy/docs/reference/rest/index.html servers: @@ -36,147 +36,15 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudOrgpolicyV2ConstraintListConstraint: - id: GoogleCloudOrgpolicyV2ConstraintListConstraint - type: object - properties: - 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 - supportsUnder: - 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. - 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. - GoogleCloudOrgpolicyV2PolicySpec: - properties: - updateTime: - readOnly: true - type: string - 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. - 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: >- - 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. - 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 - 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 - `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: object - id: GoogleCloudOrgpolicyV2PolicySpec - description: >- - Defines a Google Cloud policy specification which is used to specify - constraints for configurations of Google Cloud resources. - 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. - id: GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues - properties: - allowedValues: - items: - type: string - description: List of values allowed at this resource. - type: array - deniedValues: - description: List of values denied at this resource. - items: - type: string - type: array - type: object 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 - type: object - properties: {} - 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 GoogleTypeExpr: - properties: - expression: - description: >- - Textual representation of an expression in Common Expression - Language syntax. - 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. - 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. type: object description: >- Represents a textual expression in the Common Expression Language (CEL) @@ -196,59 +64,29 @@ components: be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. id: GoogleTypeExpr - GoogleCloudOrgpolicyV2ListPoliciesResponse: - id: GoogleCloudOrgpolicyV2ListPoliciesResponse - type: object - description: >- - The response returned from the ListPolicies method. It will be empty if - no policies are set on the resource. properties: - policies: - type: array - items: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + expression: description: >- - All policies that exist on the resource. It will be empty if no - policies are set. - nextPageToken: + Textual representation of an expression in Common Expression + Language syntax. type: string + location: 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. - GoogleCloudOrgpolicyV2ListConstraintsResponse: - type: object - description: The response returned from the ListConstraints method. - properties: - nextPageToken: + 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: >- - Page token used to retrieve the next page. This is currently not - used. + 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 - constraints: description: >- - The collection of constraints that are available on the targeted - resource. - items: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Constraint' - type: array - id: GoogleCloudOrgpolicyV2ListConstraintsResponse + 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. GoogleCloudOrgpolicyV2Constraint: - id: GoogleCloudOrgpolicyV2Constraint - type: object - 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. properties: supportsDryRun: description: Shows if dry run is supported for this constraint or not. @@ -258,10 +96,6 @@ components: - CONSTRAINT_DEFAULT_UNSPECIFIED - ALLOW - DENY - description: >- - The evaluation behavior of this constraint in the absence of a - policy. - type: string enumDescriptions: - >- This is only used for distinguishing unset values and should never @@ -272,10 +106,19 @@ components: - >- Indicate that all values are denied for list constraints. Indicate that enforcement is on for boolean constraints. - displayName: + description: >- + The evaluation behavior of this constraint in the absence of a + policy. type: string - description: The human readable name. Mutable. + listConstraint: + description: Defines this constraint as being a ListConstraint. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2ConstraintListConstraint' + booleanConstraint: + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2ConstraintBooleanConstraint + description: Defines this constraint as being a BooleanConstraint. name: + type: string description: >- Immutable. The resource name of the constraint. Must be in one of the following forms: * @@ -284,42 +127,97 @@ components: `organizations/{organization_id}/constraints/{constraint_name}` For example, "/projects/123/constraints/compute.disableSerialPortAccess". - type: string - booleanConstraint: - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ConstraintBooleanConstraint - description: Defines this constraint as being a BooleanConstraint. - listConstraint: - description: Defines this constraint as being a ListConstraint. - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2ConstraintListConstraint' description: description: >- Detailed description of what this constraint controls as well as how and where it is enforced. Mutable. type: string - GoogleCloudOrgpolicyV2AlternatePolicySpec: + displayName: + type: string + description: The human readable name. Mutable. + type: object + id: 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. + GoogleCloudOrgpolicyV2ConstraintListConstraint: properties: - launch: + 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. + id: GoogleCloudOrgpolicyV2ConstraintListConstraint + type: object + 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: >- - Reference to the launch that will be used while audit logging and to - control the launch. Should be set only in the alternate policy. - spec: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' - description: Specify constraint for configurations of Google Cloud resources. + 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. description: >- - Similar to PolicySpec but with an extra 'launch' field for launch - reference. The PolicySpec here is specific for dry-run/darklaunch. - id: GoogleCloudOrgpolicyV2AlternatePolicySpec + The response returned from the ListCustomConstraints method. It will be + empty if no custom constraints are set on the organization resource. type: object - GoogleCloudOrgpolicyV2Policy: + id: GoogleCloudOrgpolicyV2ListCustomConstraintsResponse + GoogleCloudOrgpolicyV2ListPoliciesResponse: + description: >- + The response returned from the ListPolicies method. It will be empty if + no policies are set on the resource. + properties: + policies: + type: array + description: >- + All policies that exist on the resource. It will be empty if no + policies are set. + 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 + id: GoogleCloudOrgpolicyV2ListPoliciesResponse type: object + GoogleCloudOrgpolicyV2Policy: 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. 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 @@ -331,15 +229,7 @@ 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. - 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. - spec: - description: Basic information about the Organization Policy. - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' + type: string etag: description: >- Optional. An opaque tag indicating the current state of the policy, @@ -349,13 +239,61 @@ components: proceeding. type: string alternate: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2AlternatePolicySpec' - deprecated: true 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. id: GoogleCloudOrgpolicyV2Policy + type: object + GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues: + properties: + deniedValues: + description: List of values denied at this resource. + items: + type: string + type: array + allowedValues: + type: array + description: List of values allowed at this resource. + 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 + 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 + type: object GoogleCloudOrgpolicyV2PolicySpecPolicyRule: - id: GoogleCloudOrgpolicyV2PolicySpecPolicyRule + type: object + description: A rule used to express this policy. properties: + values: + 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 + 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: >- @@ -366,12 +304,6 @@ components: description: >- Setting this to true means that all values are denied. 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. condition: $ref: '#/components/schemas/GoogleTypeExpr' description: >- @@ -385,63 +317,107 @@ 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')". - values: - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues + id: GoogleCloudOrgpolicyV2PolicySpecPolicyRule + GoogleCloudOrgpolicyV2PolicySpec: + id: GoogleCloudOrgpolicyV2PolicySpec + properties: + rules: description: >- - List of values to be used for this policy rule. This field can be - set only in policies for list constraints. + 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. + items: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRule' + type: array + 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: + 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 + updateTime: + readOnly: true + format: google-datetime + 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. + 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 + description: >- + Defines a Google Cloud policy specification which is used to specify + constraints for configurations of Google Cloud resources. type: object - description: A rule used to express this policy. - GoogleCloudOrgpolicyV2ListCustomConstraintsResponse: + GoogleCloudOrgpolicyV2AlternatePolicySpec: properties: - nextPageToken: + spec: + description: Specify constraint for configurations of Google Cloud resources. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' + launch: 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. + 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 - 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. - id: GoogleCloudOrgpolicyV2ListCustomConstraintsResponse type: object + id: GoogleCloudOrgpolicyV2AlternatePolicySpec description: >- - The response returned from the ListCustomConstraints method. It will be - empty if no custom constraints are set on the organization resource. + Similar to PolicySpec but with an extra 'launch' field for launch + reference. The PolicySpec here is specific for dry-run/darklaunch. 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: - 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 - 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. + displayName: type: string - description: description: >- - Detailed information about this custom policy constraint. The max - length of the description is 2000 characters. + One line display name for the UI. The max length of the display_name + is 200 characters. + actionType: + enum: + - ACTION_TYPE_UNSPECIFIED + - ALLOW + - DENY + description: Allow or deny type. + type: string + enumDescriptions: + - Unspecified. Results in an error. + - Allowed action type. + - Deny action type. + updateTime: 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 + format: google-datetime + readOnly: true name: type: string description: >- @@ -453,22 +429,30 @@ components: max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/` is not counted. - displayName: + 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 + description: type: string description: >- - One line display name for the UI. The max length of the display_name - is 200 characters. + Detailed information about this custom policy constraint. The max + length of the description is 2000 characters. + resourceTypes: + 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 methodTypes: type: array + 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. @@ -478,39 +462,43 @@ components: yet. - Constraint applied when removing an IAM grant. - Constraint applied when enforcing forced tagging. - description: All the operations being applied for this constraint. - 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 - updateTime: - format: google-datetime + enum: + - METHOD_TYPE_UNSPECIFIED + - CREATE + - UPDATE + - DELETE + - REMOVE_GRANT + - GOVERN_TAGS + type: string + id: GoogleCloudOrgpolicyV2CustomConstraint + type: object + 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); } + GoogleCloudOrgpolicyV2ListConstraintsResponse: + type: object + properties: + nextPageToken: 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 + Page token used to retrieve the next page. This is currently not + used. type: string + constraints: + description: >- + The collection of constraints that are available on the targeted + resource. + type: array + items: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Constraint' + id: GoogleCloudOrgpolicyV2ListConstraintsResponse + description: The response returned from the ListConstraints method. 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 @@ -520,150 +508,117 @@ components: name: quotaUser schema: type: string - 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 - 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 - _.xgafv: - description: V1 error format. + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: $.xgafv + name: prettyPrint schema: - type: string - enum: - - '1' - - '2' + 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"). - 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 - x-stackQL-resources: - constraints: - id: orgpolicy.constraints - name: constraints - title: Constraints - methods: - _folders_constraints_list: - operation: &ref_1 - $ref: '#/paths/~1v2~1folders~1{foldersId}~1constraints/get' - response: &ref_2 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.constraints - folders_constraints_list: - operation: *ref_1 - response: *ref_2 - _organizations_constraints_list: - operation: &ref_3 - $ref: '#/paths/~1v2~1organizations~1{organizationsId}~1constraints/get' - response: &ref_4 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.constraints - organizations_constraints_list: - operation: *ref_3 - response: *ref_4 - _projects_constraints_list: - operation: &ref_5 - $ref: '#/paths/~1v2~1projects~1{projectsId}~1constraints/get' - response: &ref_6 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.constraints - projects_constraints_list: - operation: *ref_5 - response: *ref_6 - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/constraints/methods/folders_constraints_list - - $ref: >- - #/components/x-stackQL-resources/constraints/methods/organizations_constraints_list - - $ref: >- - #/components/x-stackQL-resources/constraints/methods/projects_constraints_list - insert: [] - update: [] - delete: [] + 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 + 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 + 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: policies: - id: orgpolicy.policies + id: google.orgpolicy.policies name: policies title: Policies methods: - folders_policies_create: + projects_policies_delete: operation: - $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies/post' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/delete response: mediaType: application/json openAPIDocKey: '200' - _folders_policies_list: - operation: &ref_7 - $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies/get' - response: &ref_8 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.policies - folders_policies_list: - operation: *ref_7 - response: *ref_8 - folders_policies_delete: + projects_policies_get: operation: - $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}/delete' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/get' response: mediaType: application/json openAPIDocKey: '200' - folders_policies_get: + projects_policies_patch: operation: - $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}/get' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/patch' response: mediaType: application/json openAPIDocKey: '200' - folders_policies_patch: + projects_policies_create: operation: - $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}/patch' + $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies/post' response: mediaType: application/json openAPIDocKey: '200' + _projects_policies_list: + operation: &ref_1 + $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies/get' + response: &ref_2 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.policies + projects_policies_list: + operation: *ref_1 + response: *ref_2 organizations_policies_get: operation: $ref: >- @@ -692,88 +647,93 @@ components: mediaType: application/json openAPIDocKey: '200' _organizations_policies_list: - operation: &ref_9 + operation: &ref_3 $ref: '#/paths/~1v2~1organizations~1{organizationsId}~1policies/get' - response: &ref_10 + response: &ref_4 mediaType: application/json openAPIDocKey: '200' objectKey: $.policies organizations_policies_list: - operation: *ref_9 - response: *ref_10 - projects_policies_get: + operation: *ref_3 + response: *ref_4 + folders_policies_patch: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/get' + $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}/patch' response: mediaType: application/json openAPIDocKey: '200' - projects_policies_patch: + folders_policies_get: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/patch' + $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}/get' response: mediaType: application/json openAPIDocKey: '200' - projects_policies_delete: + folders_policies_delete: operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/delete + $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}/delete' response: mediaType: application/json openAPIDocKey: '200' - projects_policies_create: + folders_policies_create: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies/post' + $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies/post' response: mediaType: application/json openAPIDocKey: '200' - _projects_policies_list: - operation: &ref_11 - $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies/get' - response: &ref_12 + _folders_policies_list: + operation: &ref_5 + $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies/get' + response: &ref_6 mediaType: application/json openAPIDocKey: '200' objectKey: $.policies - projects_policies_list: - operation: *ref_11 - response: *ref_12 + folders_policies_list: + operation: *ref_5 + response: *ref_6 sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/policies/methods/folders_policies_list + #/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_get - $ref: >- - #/components/x-stackQL-resources/policies/methods/organizations_policies_get + #/components/x-stackQL-resources/policies/methods/projects_policies_list - $ref: >- #/components/x-stackQL-resources/policies/methods/organizations_policies_list - $ref: >- - #/components/x-stackQL-resources/policies/methods/projects_policies_get - - $ref: >- - #/components/x-stackQL-resources/policies/methods/projects_policies_list + #/components/x-stackQL-resources/policies/methods/folders_policies_list insert: - $ref: >- - #/components/x-stackQL-resources/policies/methods/folders_policies_create + #/components/x-stackQL-resources/policies/methods/projects_policies_create - $ref: >- #/components/x-stackQL-resources/policies/methods/organizations_policies_create - $ref: >- - #/components/x-stackQL-resources/policies/methods/projects_policies_create - update: [] + #/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 delete: - $ref: >- - #/components/x-stackQL-resources/policies/methods/folders_policies_delete + #/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/projects_policies_delete + #/components/x-stackQL-resources/policies/methods/folders_policies_delete policies_effective_policy: - id: orgpolicy.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' @@ -784,26 +744,72 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_policies_get_effective_policy: + folders_policies_get_effective_policy: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~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 + #/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/projects_policies_get_effective_policy + #/components/x-stackQL-resources/policies_effective_policy/methods/folders_policies_get_effective_policy + insert: [] + update: [] + delete: [] + constraints: + id: google.orgpolicy.constraints + name: constraints + title: Constraints + methods: + _projects_constraints_list: + operation: &ref_7 + $ref: '#/paths/~1v2~1projects~1{projectsId}~1constraints/get' + response: &ref_8 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.constraints + projects_constraints_list: + operation: *ref_7 + response: *ref_8 + _organizations_constraints_list: + operation: &ref_9 + $ref: '#/paths/~1v2~1organizations~1{organizationsId}~1constraints/get' + response: &ref_10 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.constraints + organizations_constraints_list: + operation: *ref_9 + response: *ref_10 + _folders_constraints_list: + operation: &ref_11 + $ref: '#/paths/~1v2~1folders~1{foldersId}~1constraints/get' + response: &ref_12 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.constraints + folders_constraints_list: + operation: *ref_11 + response: *ref_12 + 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: [] delete: [] custom_constraints: - id: orgpolicy.custom_constraints + id: google.orgpolicy.custom_constraints name: custom_constraints title: Custom_constraints methods: @@ -814,13 +820,6 @@ components: 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: >- @@ -828,10 +827,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - organizations_custom_constraints_create: + organizations_custom_constraints_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints/post + #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints~1{customConstraintsId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -846,6 +845,13 @@ components: organizations_custom_constraints_list: operation: *ref_13 response: *ref_14 + organizations_custom_constraints_create: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: >- @@ -855,27 +861,65 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_patch delete: - $ref: >- #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_delete paths: - /v2/folders/{foldersId}/constraints: + /v2/projects/{projectsId}/policies/{policiesId}: parameters: &ref_15 - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/upload_protocol' - - $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.projects.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: projectsId + required: true + schema: + type: string + - in: path + name: policiesId + required: true + schema: + type: string + - in: query + name: etag + schema: + type: string get: - description: Lists constraints that could be applied on the specified resource. - operationId: orgpolicy.folders.constraints.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.projects.policies.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -887,24 +931,61 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ListConstraintsResponse + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string - - in: query - name: pageSize + - in: path + name: policiesId + required: true schema: - type: integer - format: int32 + 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' + security: + - Oauth2: + - https://www.googleapis.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 - in: query - name: pageToken + name: updateMask schema: type: string - /v2/folders/{foldersId}/policies: + format: google-fieldmask + /v2/projects/{projectsId}/policies: parameters: *ref_15 post: description: >- @@ -912,7 +993,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: @@ -932,13 +1013,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 @@ -954,20 +1035,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 - - in: query - name: pageToken - schema: - type: string - /v2/folders/{foldersId}/policies/{policiesId}:getEffectivePolicy: + /v2/projects/{projectsId}/policies/{policiesId}:getEffectivePolicy: parameters: *ref_15 get: description: >- @@ -976,7 +1057,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 @@ -991,7 +1072,7 @@ paths: $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string @@ -1000,14 +1081,11 @@ paths: required: true schema: type: string - /v2/folders/{foldersId}/policies/{policiesId}: + /v2/projects/{projectsId}/constraints: parameters: *ref_15 - 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 + get: + description: Lists constraints that could be applied on the specified resource. + operationId: orgpolicy.projects.constraints.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1019,28 +1097,64 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2ListConstraintsResponse 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/organizations/{organizationsId}/constraints: + parameters: *ref_15 + 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 + 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: policiesId + name: organizationsId required: true schema: type: string - in: query - name: etag + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string + /v2/organizations/{organizationsId}/policies/{policiesId}: + parameters: *ref_15 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 + operationId: orgpolicy.organizations.policies.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1055,7 +1169,7 @@ paths: $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -1072,7 +1186,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.organizations.policies.patch requestBody: content: application/json: @@ -1092,7 +1206,7 @@ paths: $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -1106,41 +1220,12 @@ paths: schema: type: string format: google-fieldmask - /v2/organizations/{organizationsId}/customConstraints/{customConstraintsId}: - parameters: *ref_15 - 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 + 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 @@ -1160,58 +1245,28 @@ paths: 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 + name: policiesId required: true schema: type: string - - in: path - name: customConstraintsId - required: true + - in: query + name: etag schema: type: string - /v2/organizations/{organizationsId}/customConstraints: + /v2/organizations/{organizationsId}/policies: parameters: *ref_15 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 @@ -1223,7 +1278,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path name: organizationsId @@ -1231,10 +1286,8 @@ paths: schema: type: string get: - description: >- - Retrieves all of the custom constraints that exist on a particular - organization resource. - operationId: orgpolicy.organizations.customConstraints.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 @@ -1247,7 +1300,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ListCustomConstraintsResponse + #/components/schemas/GoogleCloudOrgpolicyV2ListPoliciesResponse parameters: - in: path name: organizationsId @@ -1263,14 +1316,16 @@ paths: name: pageToken schema: type: string - /v2/organizations/{organizationsId}/policies/{policiesId}: + /v2/organizations/{organizationsId}/policies/{policiesId}:getEffectivePolicy: parameters: *ref_15 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 + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1294,20 +1349,13 @@ paths: required: true schema: type: string - patch: + /v2/organizations/{organizationsId}/customConstraints/{customConstraintsId}: + parameters: *ref_15 + 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.organizations.policies.patch - 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 @@ -1319,7 +1367,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' parameters: - in: path name: organizationsId @@ -1327,21 +1375,21 @@ paths: schema: type: string - in: path - name: policiesId + name: customConstraintsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: + patch: 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 + 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 @@ -1353,7 +1401,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' parameters: - in: path name: organizationsId @@ -1361,28 +1409,15 @@ paths: schema: type: string - in: path - name: policiesId + name: customConstraintsId required: true schema: type: string - - in: query - name: etag - schema: - type: string - /v2/organizations/{organizationsId}/policies: - parameters: *ref_15 - post: + 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 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 @@ -1394,16 +1429,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: '#/components/schemas/GoogleProtobufEmpty' 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_15 get: - description: Retrieves all of the policies that exist on a particular resource. - operationId: orgpolicy.organizations.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 @@ -1416,7 +1460,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ListPoliciesResponse + #/components/schemas/GoogleCloudOrgpolicyV2ListCustomConstraintsResponse parameters: - in: path name: organizationsId @@ -1432,16 +1476,18 @@ paths: name: pageToken schema: type: string - /v2/organizations/{organizationsId}/policies/{policiesId}:getEffectivePolicy: - parameters: *ref_15 - 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.organizations.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 @@ -1453,23 +1499,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: policiesId - required: true - schema: - type: string - /v2/organizations/{organizationsId}/constraints: + /v2/folders/{foldersId}/constraints: parameters: *ref_15 get: description: Lists constraints that could be applied on the specified resource. - operationId: orgpolicy.organizations.constraints.list + operationId: orgpolicy.folders.constraints.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1485,7 +1526,7 @@ paths: #/components/schemas/GoogleCloudOrgpolicyV2ListConstraintsResponse parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string @@ -1498,11 +1539,22 @@ paths: name: pageToken schema: type: string - /v2/projects/{projectsId}/constraints: + /v2/folders/{foldersId}/policies/{policiesId}: parameters: *ref_15 - get: - description: Lists constraints that could be applied on the specified resource. - operationId: orgpolicy.projects.constraints.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 @@ -1514,31 +1566,29 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ListConstraintsResponse + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: projectsId + name: foldersId 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 - /v2/projects/{projectsId}/policies/{policiesId}: - parameters: *ref_15 + format: google-fieldmask 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 + operationId: orgpolicy.folders.policies.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1553,7 +1603,7 @@ paths: $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -1562,20 +1612,12 @@ paths: required: true schema: type: string - patch: + delete: 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' + 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 @@ -1587,10 +1629,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -1600,16 +1642,19 @@ paths: schema: type: string - in: query - name: updateMask + name: etag schema: type: string - format: google-fieldmask - delete: + /v2/folders/{foldersId}/policies/{policiesId}:getEffectivePolicy: + parameters: *ref_15 + 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 + 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 @@ -1621,10 +1666,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -1633,11 +1678,7 @@ paths: required: true schema: type: string - - in: query - name: etag - schema: - type: string - /v2/projects/{projectsId}/policies: + /v2/folders/{foldersId}/policies: parameters: *ref_15 post: description: >- @@ -1645,7 +1686,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.projects.policies.create + operationId: orgpolicy.folders.policies.create requestBody: content: application/json: @@ -1665,13 +1706,13 @@ paths: $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string get: description: Retrieves all of the policies that exist on a particular resource. - operationId: orgpolicy.projects.policies.list + operationId: orgpolicy.folders.policies.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1687,7 +1728,7 @@ paths: #/components/schemas/GoogleCloudOrgpolicyV2ListPoliciesResponse parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -1700,36 +1741,3 @@ paths: name: pageToken schema: type: string - /v2/projects/{projectsId}/policies/{policiesId}:getEffectivePolicy: - parameters: *ref_15 - 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.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 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 16fb10fc..7f660cac 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/osconfig.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/osconfig.yaml @@ -10,7 +10,7 @@ info: and configuration management on VM instances. version: v1 x-discovery-doc-revision: '20240526' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/compute/docs/osconfig/rest servers: @@ -3063,7 +3063,7 @@ components: - '2' x-stackQL-resources: global_project_feature_settings: - id: osconfig.global_project_feature_settings + id: google.osconfig.global_project_feature_settings name: global_project_feature_settings title: Global_project_feature_settings methods: @@ -3089,7 +3089,7 @@ components: update: [] delete: [] os_policy_assignments: - id: osconfig.os_policy_assignments + id: google.osconfig.os_policy_assignments name: os_policy_assignments title: Os_policy_assignments methods: @@ -3134,18 +3134,20 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/os_policy_assignments/methods/get' - $ref: >- #/components/x-stackQL-resources/os_policy_assignments/methods/list - - $ref: '#/components/x-stackQL-resources/os_policy_assignments/methods/get' insert: - $ref: >- #/components/x-stackQL-resources/os_policy_assignments/methods/create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/os_policy_assignments/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/os_policy_assignments/methods/delete os_policy_assignments_revisions: - id: osconfig.os_policy_assignments_revisions + id: google.osconfig.os_policy_assignments_revisions name: os_policy_assignments_revisions title: Os_policy_assignments_revisions methods: @@ -3168,7 +3170,7 @@ components: update: [] delete: [] operations: - id: osconfig.operations + id: google.osconfig.operations name: operations title: Operations methods: @@ -3193,7 +3195,7 @@ components: update: [] delete: [] report: - id: osconfig.report + id: google.osconfig.report name: report title: Report methods: @@ -3211,7 +3213,7 @@ components: update: [] delete: [] reports: - id: osconfig.reports + id: google.osconfig.reports name: reports title: Reports methods: @@ -3233,7 +3235,7 @@ components: update: [] delete: [] inventory: - id: osconfig.inventory + id: google.osconfig.inventory name: inventory title: Inventory methods: @@ -3250,7 +3252,7 @@ components: update: [] delete: [] inventories: - id: osconfig.inventories + id: google.osconfig.inventories name: inventories title: Inventories methods: @@ -3272,7 +3274,7 @@ components: update: [] delete: [] vulnerability_report: - id: osconfig.vulnerability_report + id: google.osconfig.vulnerability_report name: vulnerability_report title: Vulnerability_report methods: @@ -3290,7 +3292,7 @@ components: update: [] delete: [] vulnerability_reports: - id: osconfig.vulnerability_reports + id: google.osconfig.vulnerability_reports name: vulnerability_reports title: Vulnerability_reports methods: @@ -3313,7 +3315,7 @@ components: update: [] delete: [] patch_jobs: - id: osconfig.patch_jobs + id: google.osconfig.patch_jobs name: patch_jobs title: Patch_jobs methods: @@ -3354,7 +3356,7 @@ components: update: [] delete: [] instance_details: - id: osconfig.instance_details + id: google.osconfig.instance_details name: instance_details title: Instance_details methods: @@ -3376,7 +3378,7 @@ components: update: [] delete: [] patch_deployments: - id: osconfig.patch_deployments + id: google.osconfig.patch_deployments name: patch_deployments title: Patch_deployments methods: @@ -3433,11 +3435,12 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/patch_deployments/methods/list' - $ref: '#/components/x-stackQL-resources/patch_deployments/methods/get' + - $ref: '#/components/x-stackQL-resources/patch_deployments/methods/list' insert: - $ref: '#/components/x-stackQL-resources/patch_deployments/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/patch_deployments/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/patch_deployments/methods/delete' paths: 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 99ff3164..0f15515f 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: '20240519' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/compute/docs/oslogin/ servers: @@ -235,7 +235,7 @@ components: - '2' x-stackQL-resources: users_login_profile: - id: oslogin.users_login_profile + id: google.oslogin.users_login_profile name: users_login_profile title: Users_login_profile methods: @@ -253,7 +253,7 @@ components: update: [] delete: [] users: - id: oslogin.users + id: google.oslogin.users name: users title: Users methods: @@ -269,7 +269,7 @@ components: update: [] delete: [] ssh_public_keys: - id: oslogin.ssh_public_keys + id: google.oslogin.ssh_public_keys name: ssh_public_keys title: Ssh_public_keys methods: @@ -305,11 +305,12 @@ components: - $ref: '#/components/x-stackQL-resources/ssh_public_keys/methods/get' insert: - $ref: '#/components/x-stackQL-resources/ssh_public_keys/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/ssh_public_keys/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/ssh_public_keys/methods/delete' projects: - id: oslogin.projects + id: google.oslogin.projects name: projects title: Projects methods: 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 e5b07cdc..5ae56801 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/places.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/places.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1 x-discovery-doc-revision: '20240529' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://mapsplatform.google.com/maps-products/#places-section servers: @@ -28,18 +28,18 @@ components: 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.textsearch: >- + Private Service: + https://www.googleapis.com/auth/maps-platform.places.textsearch 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.textsearch: >- + https://www.googleapis.com/auth/maps-platform.places.nearbysearch: >- Private Service: - https://www.googleapis.com/auth/maps-platform.places.textsearch + https://www.googleapis.com/auth/maps-platform.places.nearbysearch Oauth2c: type: oauth2 description: Oauth 2.0 authorization code authentication @@ -49,277 +49,203 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleMapsPlacesV1ContextualContentJustificationReviewJustification: - type: object - properties: - review: - $ref: '#/components/schemas/GoogleMapsPlacesV1Review' - description: The review that the highlighted text is generated from. - highlightedText: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedText - id: GoogleMapsPlacesV1ContextualContentJustificationReviewJustification - 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. GoogleTypeLocalizedText: + description: Localized variant of a text in a particular language. properties: - text: - description: >- - Localized string in the language corresponding to language_code - below. - type: string languageCode: 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. - type: object + text: + type: string + description: >- + Localized string in the language corresponding to language_code + below. id: GoogleTypeLocalizedText - description: Localized variant of a text in a particular language. - GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedTextHighlightedTextRange: - properties: - endIndex: - type: integer - format: int32 - startIndex: - format: int32 - type: integer - description: The range of highlighted text. type: object - id: >- - GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedTextHighlightedTextRange - GoogleTypeLatLng: + 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' 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: GoogleTypeLatLng + The region to search. The results may be biased around the specified + region. type: object + id: GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias + GoogleMapsPlacesV1SearchNearbyRequestLocationRestriction: + id: GoogleMapsPlacesV1SearchNearbyRequestLocationRestriction properties: - latitude: - type: number - format: double - description: The latitude in degrees. It must be in the range [-90.0, +90.0]. - longitude: - description: The longitude in degrees. It must be in the range [-180.0, +180.0]. - format: double - type: number - GoogleMapsPlacesV1PlaceAttribution: - description: Information about data providers of this place. + circle: + description: A circle defined by center point and radius. + $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' + description: The region to search. type: object - id: GoogleMapsPlacesV1PlaceAttribution + GoogleMapsPlacesV1AuthorAttribution: properties: - providerUri: + uri: type: string - description: URI to the Place's data provider. - provider: - description: Name of the Place's data provider. + description: URI of the author of the Photo or Review. + photoUri: + description: Profile photo URI of the author of the Photo or Review. type: string - GoogleMapsPlacesV1PlacePaymentOptions: - type: object - properties: - acceptsNfc: - type: boolean - description: Place accepts NFC payments. - acceptsCashOnly: - type: boolean - description: >- - Place accepts cash only as payment. Places with this attribute may - still accept other payment methods. - acceptsDebitCards: - description: Place accepts debit cards as payment. - type: boolean - acceptsCreditCards: - type: boolean - description: Place accepts credit cards as payment. - id: GoogleMapsPlacesV1PlacePaymentOptions - description: Payment options the place accepts. - GoogleMapsPlacesV1AutocompletePlacesResponse: + 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 - description: Response proto for AutocompletePlaces. - properties: - suggestions: - description: >- - Contains a list of suggestions, ordered in descending order of - relevance. - items: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion - type: array - id: GoogleMapsPlacesV1AutocompletePlacesResponse - GoogleMapsPlacesV1PlaceAddressComponent: + id: GoogleMapsPlacesV1AuthorAttribution + GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction: + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction type: object - description: >- - The structured components that form the formatted address, if this - information is available. - id: GoogleMapsPlacesV1PlaceAddressComponent + description: Prediction results for a Place Autocomplete prediction. properties: types: - type: array - description: An array indicating the type(s) of the address component. items: type: string - languageCode: + 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 + placeId: type: string - description: The language used to format this components, in CLDR notation. - shortText: + description: >- + The unique identifier of the suggested Place. This identifier can be + used in other APIs that accept Place IDs. + structuredFormat: + 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. + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat + distanceMeters: + 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. + text: + 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`. + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText + place: 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: + The resource name of the suggested Place. This name can be used in + other APIs that accept Place names. + GoogleTypeMoney: + description: Represents an amount of money with its currency type. + 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. + type: integer + format: int32 + currencyCode: + description: The three-letter currency code defined in ISO 4217. type: string + units: 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". + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. + type: string + format: int64 + type: object + id: GoogleTypeMoney 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. id: GoogleMapsPlacesV1EVChargeOptions properties: - connectorCount: - 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. - format: int32 - type: integer connectorAggregation: + type: array description: >- A list of EV charging connector aggregations that contain connectors of the same type and same charge rate. - type: array items: $ref: >- #/components/schemas/GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation - GoogleMapsPlacesV1SearchNearbyRequest: - description: 'Request proto for Search Nearby. ' - id: GoogleMapsPlacesV1SearchNearbyRequest + connectorCount: + 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 + 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. + GoogleMapsPlacesV1SearchTextRequest: type: object + description: 'Request proto for SearchText. ' + id: GoogleMapsPlacesV1SearchTextRequest properties: - 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. - type: string - description: How results will be ranked in the response. - languageCode: - 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. - excludedTypes: - items: - type: string - type: array - 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". - excludedPrimaryTypes: - type: array - description: >- - 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". - items: - type: string - locationRestriction: - description: Required. The region to search. - $ref: >- - #/components/schemas/GoogleMapsPlacesV1SearchNearbyRequestLocationRestriction - includedPrimaryTypes: - 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". + priceLevels: items: type: string - type: array - maxResultCount: - type: integer - format: int32 + 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. 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. - includedTypes: + 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. type: array + 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 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 @@ -328,326 +254,57 @@ 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. - type: string - GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion: - type: object - 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. - GoogleMapsPlacesV1PlaceOpeningHours: - id: GoogleMapsPlacesV1PlaceOpeningHours - type: object - properties: - periods: - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriod' - 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. openNow: description: >- - Is this place open right now? Always present unless we lack - time-of-day or timezone data for these opening hours. + Used to restrict the search to places that are currently open. The + default is false. type: boolean - weekdayDescriptions: - items: - type: string + textQuery: + type: string + description: Required. The text query for textual search. + pageSize: + format: int32 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" - type: array - specialDays: - type: array + 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 + evOptions: + $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextRequestEVOptions' + description: Optional. Set the searchable EV options of a place search request. + locationBias: + $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextRequestLocationBias' 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. - 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 + 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. + pageToken: type: string - description: Information about business hour of the place. - GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction: - type: object - description: Prediction results for a Query Autocomplete prediction. - id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction - properties: - structuredFormat: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat 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. - text: + 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. + locationRestriction: $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`. - GoogleMapsPlacesV1PhotoMedia: - id: GoogleMapsPlacesV1PhotoMedia - description: A photo media from Places API. - type: object - properties: - photoUri: - type: string - description: A short-lived uri that can be used to render the photo. - name: - description: >- - The resource name of a photo media in the format: - `places/{place_id}/photos/{photo_reference}/media`. - type: string - GoogleMapsPlacesV1SearchNearbyResponse: - properties: - places: - type: array - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Place' - description: >- - A list of places that meets user's requirements like places types, - number of places and specific location restriction. - description: 'Response proto for Search Nearby. ' - id: GoogleMapsPlacesV1SearchNearbyResponse - type: object - GoogleMapsPlacesV1ContentBlock: - id: GoogleMapsPlacesV1ContentBlock - type: object - description: A block of content that can be served individually. - 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' - content: - $ref: '#/components/schemas/GoogleTypeLocalizedText' - description: Content related to the topic. - topic: - description: The topic of the content, for example "overview" or "restaurant". - type: string - GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint: - id: GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint - type: object - properties: - minute: - description: The minute in 2 digits. Ranges from 00 to 59. - type: integer - format: int32 - date: - $ref: '#/components/schemas/GoogleTypeDate' - description: Date in the local timezone for the place. - day: - type: integer - format: int32 - description: >- - A day of the week, as an integer in the range 0-6. 0 is Sunday, 1 is - Monday, etc. - hour: - type: integer - format: int32 - description: The hour in 2 digits. Ranges from 00 to 23. - 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. - description: Status changing points. - GoogleMapsPlacesV1PlaceAreaSummary: - id: GoogleMapsPlacesV1PlaceAreaSummary - properties: - contentBlocks: - description: >- - Content blocks that compose the area summary. Each block has a - separate topic about the area. - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1ContentBlock' - type: array - 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 area that the place is in. - GoogleTypeMoney: - description: Represents an amount of money with its currency type. - id: GoogleTypeMoney - properties: - 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. - format: int64 - type: string - 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 - type: object - GoogleMapsPlacesV1PlaceOpeningHoursSpecialDay: - properties: - date: - description: The date of this special day. - $ref: '#/components/schemas/GoogleTypeDate' - type: object - 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. - GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification: - 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. - id: >- - GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification - properties: - delivery: - type: boolean - description: If a place provides delivery. - dineIn: - type: boolean - description: If a place provides dine-in. - takeout: - description: If a place provides takeout. - type: boolean - type: object - GoogleMapsPlacesV1SearchTextRequest: - type: object - id: GoogleMapsPlacesV1SearchTextRequest - description: 'Request proto for SearchText. ' - properties: - 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' - textQuery: - type: string - description: Required. The text query for textual search. - pageSize: + #/components/schemas/GoogleMapsPlacesV1SearchTextRequestLocationRestriction 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 - format: int32 - evOptions: - description: Optional. Set the searchable EV options of a place search request. - $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextRequestEVOptions' + 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. includedType: 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. type: string - 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. - 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 - locationRestriction: - 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. - $ref: >- - #/components/schemas/GoogleMapsPlacesV1SearchTextRequestLocationRestriction languageCode: type: string description: >- @@ -656,13 +313,26 @@ components: 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. + 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. + maxResultCount: + type: integer + deprecated: true + format: int32 + 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. rankPreference: - type: string - enum: - - RANK_PREFERENCE_UNSPECIFIED - - DISTANCE - - RELEVANCE - description: How results will be ranked in the response. enumDescriptions: - >- For a categorical query such as "Restaurants in New York City", @@ -673,244 +343,24 @@ components: - >- Ranks results by relevance. Sort order determined by normal ranking stack. - priceLevels: - items: - type: string - 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: 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. - maxResultCount: - format: int32 - 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 - deprecated: true - openNow: - type: boolean - description: >- - Used to restrict the search to places that are currently open. The - default is false. - 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. - GoogleMapsPlacesV1AuthorAttribution: - type: object - id: GoogleMapsPlacesV1AuthorAttribution - properties: - displayName: - type: string - description: Name of the author of the Photo or Review. - uri: - type: string - description: URI of the author of the Photo or Review. - photoUri: - description: Profile photo URI of the author of the Photo or Review. - type: string - description: Information about the author of the UGC data. Used in Photo, and Review. - GoogleMapsPlacesV1PlaceParkingOptions: - type: object - description: >- - Information about parking options for the place. A parking lot could - support more than one option at the same time. - id: GoogleMapsPlacesV1PlaceParkingOptions - properties: - freeGarageParking: - type: boolean - description: Place offers free garage parking. - freeParkingLot: - type: boolean - description: Place offers free parking lots. - freeStreetParking: - type: boolean - description: Place offers free street parking. - paidStreetParking: - description: Place offers paid street parking. - type: boolean - paidGarageParking: - description: Place offers paid garage parking. - type: boolean - valetParking: - description: Place offers valet parking. - type: boolean - paidParkingLot: - type: boolean - description: Place offers paid parking lots. - GoogleMapsPlacesV1SearchNearbyRequestLocationRestriction: - properties: - circle: - $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' - description: A circle defined by center point and radius. - type: object - id: GoogleMapsPlacesV1SearchNearbyRequestLocationRestriction - description: The region to search. - 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: - description: Represents the name of the Place or query. - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText - id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat - type: object - 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. - GoogleMapsPlacesV1FuelOptionsFuelPrice: - description: Fuel price information for a given type. - type: object - properties: - updateTime: - description: The time the fuel price was last updated. - format: google-datetime - type: string - type: - description: The type of fuel. - type: string - 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. 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 - price: - description: The price of the fuel. - $ref: '#/components/schemas/GoogleTypeMoney' - id: GoogleMapsPlacesV1FuelOptionsFuelPrice - GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedText: - type: object - 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 - properties: - highlightedTextRanges: - description: The list of the ranges of the highlighted text. - items: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedTextHighlightedTextRange - type: array - text: - type: string - GoogleMapsPlacesV1PlaceSubDestination: - id: GoogleMapsPlacesV1PlaceSubDestination - type: object - properties: - id: - description: The place id of the sub destination. - type: string - name: + - RANK_PREFERENCE_UNSPECIFIED + - DISTANCE + - RELEVANCE + description: How results will be ranked in the response. 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. - GoogleMapsPlacesV1PlacePlusCode: + GoogleMapsPlacesV1SearchTextRequestEVOptions: + id: GoogleMapsPlacesV1SearchTextRequestEVOptions type: object + description: Searchable EV options of a place search request. properties: - 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 - compoundCode: + minimumChargingRateKw: + format: double 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 - 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. - id: GoogleMapsPlacesV1PlacePlusCode - GoogleMapsPlacesV1SearchTextRequestEVOptions: - properties: + Optional. Minimum required charging rate in kilowatts. A place with + a charging rate less than the specified rate is filtered out. + type: number connectorTypes: - type: array items: type: string enumDescriptions: @@ -946,76 +396,59 @@ components: - EV_CONNECTOR_TYPE_TESLA - EV_CONNECTOR_TYPE_UNSPECIFIED_GB_T - EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET + 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. - 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 - description: Searchable EV options of a place search request. - type: object - id: GoogleMapsPlacesV1SearchTextRequestEVOptions - GoogleMapsPlacesV1FuelOptions: + GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction: + id: GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction description: >- - The most recent information about fuel options in a gas station. This - information is updated regularly. - id: GoogleMapsPlacesV1FuelOptions + The region to search. The results will be restricted to the specified + region. type: object properties: - fuelPrices: - type: array + rectangle: + description: A viewport defined by a northeast and a southwest corner. + $ref: '#/components/schemas/GoogleGeoTypeViewport' + circle: + description: A circle defined by a center point and radius. + $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' + GoogleMapsPlacesV1AutocompletePlacesRequest: + description: Request proto for AutocompletePlaces. + properties: + includedRegionCodes: 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. + 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' - GoogleGeoTypeViewport: - id: GoogleGeoTypeViewport - type: object - properties: - low: - $ref: '#/components/schemas/GoogleTypeLatLng' - description: Required. The low point of the viewport. - high: + type: string + type: array + 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. + origin: $ref: '#/components/schemas/GoogleTypeLatLng' - description: Required. The high 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 } } - GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias: - properties: - rectangle: - $ref: '#/components/schemas/GoogleGeoTypeViewport' - description: A viewport defined by a northeast and a southwest corner. - circle: - $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' - description: A circle defined by a center point and radius. - id: GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias - type: object - description: >- - The region to search. The results may be biased around the specified - region. - GoogleMapsPlacesV1AutocompletePlacesRequest: - properties: + 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. includedPrimaryTypes: description: >- Optional. Included primary Place type (for example, "restaurant" or @@ -1024,10 +457,19 @@ components: 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 - type: array + languageCode: + type: string + 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`. 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 @@ -1050,26 +492,17 @@ components: 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. - type: string - input: - type: string - description: Required. The text string on which to search. inputOffset: - format: int32 type: integer + 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`. - regionCode: + input: 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`. + description: Required. The text string on which to search. locationRestriction: $ref: >- #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction @@ -1079,299 +512,242 @@ 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: - $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. - 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. - includedRegionCodes: - items: - type: string - 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. - 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 - description: Request proto for AutocompletePlaces. id: GoogleMapsPlacesV1AutocompletePlacesRequest type: object - GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange: - description: Identifies a substring within a given text. - id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange + GoogleMapsPlacesV1ContextualContentJustificationReviewJustification: + type: object + id: GoogleMapsPlacesV1ContextualContentJustificationReviewJustification + 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. properties: - endOffset: - type: integer - description: Zero-based offset of the last Unicode character (exclusive). - format: int32 - startOffset: - format: int32 - type: integer - description: >- - Zero-based offset of the first Unicode character of the string - (inclusive). + review: + description: The review that the highlighted text is generated from. + $ref: '#/components/schemas/GoogleMapsPlacesV1Review' + highlightedText: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedText + GoogleMapsPlacesV1PlaceOpeningHoursSpecialDay: + properties: + date: + $ref: '#/components/schemas/GoogleTypeDate' + description: The date of this special day. type: object - GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText: + 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. + GoogleMapsPlacesV1PlaceAreaSummary: properties: - text: - description: Text that may be used as is or formatted with `matches`. - type: string - matches: + contentBlocks: 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. - items: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange + Content blocks that compose the area summary. Each block has a + separate topic about the area. type: array - type: object - id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1ContentBlock' description: >- - Text representing a Place or query prediction. The text may be used as - is or formatted. - GoogleMapsPlacesV1PlaceAccessibilityOptions: - description: Information about the accessibility options a place offers. - id: GoogleMapsPlacesV1PlaceAccessibilityOptions + 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 + GoogleMapsPlacesV1AutocompletePlacesResponse: + id: GoogleMapsPlacesV1AutocompletePlacesResponse properties: - wheelchairAccessibleSeating: - type: boolean - description: Place has wheelchair accessible seating. - wheelchairAccessibleEntrance: - description: Places has wheelchair accessible entrance. - type: boolean - wheelchairAccessibleRestroom: - description: Place has wheelchair accessible restroom. - type: boolean - wheelchairAccessibleParking: - type: boolean - description: Place offers wheelchair accessible parking. + suggestions: + items: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion + description: >- + Contains a list of suggestions, ordered in descending order of + relevance. + type: array type: object - GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction: - id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction + description: Response proto for AutocompletePlaces. + GoogleMapsPlacesV1PlaceOpeningHours: + id: GoogleMapsPlacesV1PlaceOpeningHours type: object - description: Prediction results for a Place Autocomplete prediction. properties: - types: + weekdayDescriptions: items: type: string 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. + 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 - placeId: - type: string - description: >- - The unique identifier of the suggested Place. This identifier can be - used in other APIs that accept Place IDs. - 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`. - place: - description: >- - The resource name of the suggested Place. This name can be used in - other APIs that accept Place names. + 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 type: string - structuredFormat: - 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. - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat - distanceMeters: - 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. - format: int32 - 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: - format: int32 - type: integer + description: A type string used to identify the type of secondary hours. + specialDays: + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursSpecialDay' description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - month: + 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. + type: array + openNow: + type: boolean 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 - day: - type: integer - format: int32 + Is this place open right now? Always present unless we lack + time-of-day or timezone data for these opening hours. + periods: 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. - id: GoogleTypeDate - GoogleMapsPlacesV1PlaceGenerativeSummary: + 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' + description: Information about business hour of the place. + GoogleMapsPlacesV1PlaceSubDestination: + id: GoogleMapsPlacesV1PlaceSubDestination 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 + Place resource name and id of sub destinations that relate to the place. + For example, different terminals are different destinations of an + airport. type: object properties: - description: - $ref: '#/components/schemas/GoogleTypeLocalizedText' - description: The detailed description of the place. - references: - $ref: '#/components/schemas/GoogleMapsPlacesV1References' - description: References that are used to generate the summary description. - overview: - $ref: '#/components/schemas/GoogleTypeLocalizedText' - description: The overview of the place. - GoogleMapsPlacesV1Photo: - description: Information about a photo of a place. + id: + type: string + description: The place id of the sub destination. + name: + type: string + description: The resource name of the sub destination. + GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion: + properties: + queryPrediction: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction + description: A prediction for a query. + placePrediction: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction + description: A prediction for a Place. type: object + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion + description: An Autocomplete suggestion result. + GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedTextHighlightedTextRange: + id: >- + GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedTextHighlightedTextRange + description: The range of highlighted text. properties: - heightPx: + endIndex: format: int32 - description: The maximum available height, in pixels. type: integer - authorAttributions: - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1AuthorAttribution' - type: array - description: This photo's authors. - name: - 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}`). - type: string - widthPx: + startIndex: type: integer - description: The maximum available width, in pixels. format: int32 - id: GoogleMapsPlacesV1Photo - GoogleMapsPlacesV1SearchTextResponse: type: object + GoogleMapsPlacesV1FuelOptions: + id: GoogleMapsPlacesV1FuelOptions properties: - places: - type: array - description: A list of places that meet the user's text search criteria. - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Place' - 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. - contextualContents: + fuelPrices: 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 should have as many entries as the list of - places if requested. + 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. items: - $ref: '#/components/schemas/GoogleMapsPlacesV1ContextualContent' + $ref: '#/components/schemas/GoogleMapsPlacesV1FuelOptionsFuelPrice' type: array - id: GoogleMapsPlacesV1SearchTextResponse - description: 'Response proto for SearchText. ' + description: >- + The most recent information about fuel options in a gas station. This + information is updated regularly. + type: object GoogleMapsPlacesV1PlaceOpeningHoursPeriod: type: object properties: - close: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint' - description: The time that the place starts to be closed. open: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint' description: The time that the place starts to be open. + close: $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint' - description: A period the place remains in open_now status. + description: The time that the place starts to be closed. id: GoogleMapsPlacesV1PlaceOpeningHoursPeriod - GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction: - id: GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction + description: A period the place remains in open_now status. + GoogleMapsPlacesV1PlaceAddressComponent: + properties: + types: + items: + type: string + type: array + description: An array indicating the type(s) of the address component. + languageCode: + type: string + description: The language used to format this components, in CLDR notation. + shortText: + 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". + type: string + longText: + 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". + type: string + id: GoogleMapsPlacesV1PlaceAddressComponent type: object description: >- - The region to search. The results will be restricted to the specified - region. + The structured components that form the formatted address, if this + information is available. + GoogleMapsPlacesV1SearchTextRequestLocationRestriction: + id: GoogleMapsPlacesV1SearchTextRequestLocationRestriction + description: >- + The region to search. This location serves as a restriction which means + results outside given location will not be returned. + type: object properties: rectangle: - description: A viewport defined by a northeast and a southwest corner. $ref: '#/components/schemas/GoogleGeoTypeViewport' - circle: - description: A circle defined by a center point and radius. - $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' - GoogleMapsPlacesV1SearchTextRequestLocationBias: - description: >- - The region to search. This location serves as a bias which means results - around given location might be returned. - id: GoogleMapsPlacesV1SearchTextRequestLocationBias - properties: - circle: - $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' - description: A circle defined by center point and radius. - rectangle: description: >- A rectangle box defined by northeast and southwest corner. `rectangle.high()` must be the northeast point of the rectangle @@ -1380,16 +756,32 @@ components: 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' + GoogleMapsPlacesV1ContentBlock: + id: GoogleMapsPlacesV1ContentBlock + description: A block of content that can be served individually. + properties: + topic: + type: string + description: The topic of the content, for example "overview" or "restaurant". + 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' + content: + $ref: '#/components/schemas/GoogleTypeLocalizedText' + description: Content related to the topic. type: object GoogleMapsPlacesV1ContextualContentJustification: - id: GoogleMapsPlacesV1ContextualContentJustification - type: object 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 properties: businessAvailabilityAttributesJustification: description: >- @@ -1405,217 +797,279 @@ components: for more details. $ref: >- #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationReviewJustification - GoogleMapsPlacesV1References: - 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. - properties: - reviews: - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Review' - description: Reviews that serve as references. - type: array - places: - type: array - 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: object - GoogleMapsPlacesV1ContextualContent: + GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint: + id: GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint + description: Status changing points. type: object - id: GoogleMapsPlacesV1ContextualContent properties: - photos: + day: description: >- - Information (including references) about photos of this place, - contexual to the place query. - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Photo' - type: array - reviews: - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Review' - description: List of reviews about this place, contexual to the place query. - type: array - justifications: + 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: + description: The hour in 2 digits. Ranges from 00 to 23. + type: integer + format: int32 + truncated: + type: boolean 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 - 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. - GoogleMapsPlacesV1Place: + 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. + date: + description: Date in the local timezone for the place. + $ref: '#/components/schemas/GoogleTypeDate' + minute: + format: int32 + type: integer + description: The minute in 2 digits. Ranges from 00 to 59. + GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat: properties: - nationalPhoneNumber: - type: string - description: A human-readable phone number for the place, in national format. - 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. - plusCode: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlacePlusCode' - description: Plus code of the place location lat/long. - location: - description: The position of this place. - $ref: '#/components/schemas/GoogleTypeLatLng' - editorialSummary: + secondaryText: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText 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. - $ref: '#/components/schemas/GoogleTypeLocalizedText' - servesBreakfast: - description: Specifies if the place serves breakfast. + Represents additional disambiguating features (such as a city or + region) to further identify the Place or refine the query. + mainText: + description: Represents the name of the Place or query. + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText + 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. + type: object + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat + GoogleMapsPlacesV1PlaceParkingOptions: + properties: + freeParkingLot: type: boolean - goodForChildren: + description: Place offers free parking lots. + valetParking: type: boolean - description: Place is good for children. - regularOpeningHours: - description: The regular hours of operation. - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' - reviews: - type: array + description: Place offers valet parking. + freeStreetParking: + type: boolean + description: Place offers free street parking. + freeGarageParking: + type: boolean + description: Place offers free garage parking. + paidGarageParking: + description: Place offers paid garage parking. + type: boolean + paidStreetParking: + type: boolean + description: Place offers paid street parking. + paidParkingLot: + description: Place offers paid parking lots. + type: boolean + id: GoogleMapsPlacesV1PlaceParkingOptions + type: object + description: >- + Information about parking options for the place. A parking lot could + support more than one option at the same time. + GoogleMapsPlacesV1Review: + id: GoogleMapsPlacesV1Review + properties: + rating: + format: double + type: number + description: A number between 1.0 and 5.0, also called the number of stars. + authorAttribution: + $ref: '#/components/schemas/GoogleMapsPlacesV1AuthorAttribution' + description: This review's author. + relativePublishTimeDescription: + type: string description: >- - List of reviews about this place, sorted by relevance. A maximum of - 5 reviews can be returned. - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Review' - displayName: + A string of formatted recent time, expressing the review time + relative to the current time in a form appropriate for the language + and country. + text: + $ref: '#/components/schemas/GoogleTypeLocalizedText' + description: The localized text of the review. + publishTime: + format: google-datetime + description: Timestamp for the review. + type: string + name: + type: string description: >- - The localized name of the place, suitable as a short human-readable - description. For example, "Google Sydney", "Starbucks", "Pyrmont", - etc. + 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: $ref: '#/components/schemas/GoogleTypeLocalizedText' - types: + description: The review text in its original language. + description: Information about a review of a place. + type: object + GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText: + properties: + matches: type: array - items: - 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 - primaryType: + 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 + text: type: string + description: Text that may be used as is or formatted with `matches`. + type: object + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText + description: >- + Text representing a Place or query prediction. The text may be used as + is or formatted. + GoogleMapsPlacesV1Circle: + properties: + center: + $ref: '#/components/schemas/GoogleTypeLatLng' 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 - subDestinations: - description: A list of sub destinations related to the place. - type: array - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceSubDestination' + 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: + type: number + format: double + description: >- + Required. Radius measured in meters. The radius must be within [0.0, + 50000.0]. + description: Circle with a LatLng as center and radius. + id: GoogleMapsPlacesV1Circle + type: object + GoogleGeoTypeViewport: + id: GoogleGeoTypeViewport + 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. + 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 + GoogleMapsPlacesV1Place: + description: All the information representing a Place. + id: GoogleMapsPlacesV1Place + type: object + properties: + servesDessert: + description: Place serves dessert. + type: boolean + 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. adrFormatAddress: + type: string description: >- The place's address in adr microformat: http://microformats.org/wiki/adr. + 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: type: string - currentOpeningHours: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' + description: A human-readable phone number for the place, in national format. + reviews: + type: array + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1Review' 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. - accessibilityOptions: - description: Information about the accessibility options a place offers. - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAccessibilityOptions' - delivery: + List of reviews about this place, sorted by relevance. A maximum of + 5 reviews can be returned. + userRatingCount: + type: integer + description: The total number of reviews (with or without text) for this place. + format: int32 + utcOffsetMinutes: + 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 + format: int32 + location: + $ref: '#/components/schemas/GoogleTypeLatLng' + description: The position of this place. + servesDinner: type: boolean - description: Specifies if the business supports delivery. - attributions: - description: A set of data provider that must be shown with this result. - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAttribution' - type: array - priceLevel: - description: Price level of the place. - 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 - goodForGroups: - description: Place accommodates groups. + description: Specifies if the place serves dinner. + dineIn: type: boolean - businessStatus: - description: The business status for the place. + description: >- + Specifies if the business supports indoor or outdoor seating + options. + 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 + rating: + type: number + format: double + description: A rating between 1.0 and 5.0, based on user reviews of this place. + 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. - dineIn: - description: >- - Specifies if the business supports indoor or outdoor seating - options. - type: boolean - allowsDogs: + servesCoffee: type: boolean - description: Place allows dogs. - fuelOptions: - $ref: '#/components/schemas/GoogleMapsPlacesV1FuelOptions' + description: Place serves coffee. + displayName: + $ref: '#/components/schemas/GoogleTypeLocalizedText' description: >- - The most recent information about fuel options in a gas station. - This information is updated regularly. - servesDinner: - type: boolean - description: Specifies if the place serves dinner. - curbsidePickup: - type: boolean - description: Specifies if the business supports curbside pickup. - servesDessert: - type: boolean - description: Place serves dessert. - id: - description: The unique identifier of a place. - type: string - menuForChildren: - type: boolean - description: Place has a children's menu. - reservable: - description: Specifies if the place supports reservations. - type: boolean - shortFormattedAddress: - description: A short, human-readable address for this place. - type: string - userRatingCount: - type: integer - description: The total number of reviews (with or without text) for this place. - format: int32 + The localized name of the place, suitable as a short human-readable + description. For example, "Google Sydney", "Starbucks", "Pyrmont", + etc. regularSecondaryOpeningHours: description: >- Contains an array of entries for information about regular secondary @@ -1628,226 +1082,458 @@ components: type: array items: $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' - restroom: - description: Place has restroom. - type: boolean - servesCoffee: - description: Place serves coffee. + regularOpeningHours: + description: The regular hours of operation. + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' + reservable: type: boolean - 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' - viewport: - description: >- - A viewport suitable for displaying the place on an average-sized - map. - $ref: '#/components/schemas/GoogleGeoTypeViewport' - 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. - internationalPhoneNumber: - type: string + description: Specifies if the place supports reservations. + fuelOptions: + $ref: '#/components/schemas/GoogleMapsPlacesV1FuelOptions' description: >- - A human-readable phone number for the place, in international - format. - outdoorSeating: + The most recent information about fuel options in a gas station. + This information is updated regularly. + servesCocktails: type: boolean - description: Place provides outdoor seating. + description: Place serves cocktails. + menuForChildren: + type: boolean + description: Place has a children's menu. name: type: string description: >- This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - formattedAddress: - description: A full, human-readable address for this place. - type: string - generativeSummary: + currentSecondaryOpeningHours: + type: array description: >- - 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' - goodForWatchingSports: - description: Place is suitable for watching sports. - type: boolean - liveMusic: - description: Place provides live music. + 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. + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' + allowsDogs: type: boolean - rating: - format: double - description: A rating between 1.0 and 5.0, based on user reviews of this place. - type: number - servesBeer: - description: Specifies if the place serves beer. + description: Place allows dogs. + outdoorSeating: + description: Place provides outdoor seating. type: boolean + parkingOptions: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceParkingOptions' + description: Options of parking provided by the place. servesLunch: description: Specifies if the place serves lunch. type: boolean - googleMapsUri: - description: A URL providing more information about this place. + servesBreakfast: + type: boolean + description: Specifies if the place serves breakfast. + accessibilityOptions: + description: Information about the accessibility options a place offers. + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAccessibilityOptions' + goodForWatchingSports: + description: Place is suitable for watching sports. + type: boolean + priceLevel: type: string - utcOffsetMinutes: - format: int32 - type: integer + 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. + description: Price level of the place. + enum: + - PRICE_LEVEL_UNSPECIFIED + - PRICE_LEVEL_FREE + - PRICE_LEVEL_INEXPENSIVE + - PRICE_LEVEL_MODERATE + - PRICE_LEVEL_EXPENSIVE + - PRICE_LEVEL_VERY_EXPENSIVE + id: + description: The unique identifier of a place. + type: string + viewport: + $ref: '#/components/schemas/GoogleGeoTypeViewport' 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. - photos: - type: array - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Photo' + A viewport suitable for displaying the place on an average-sized + map. + internationalPhoneNumber: description: >- - Information (including references) about photos of this place. A - maximum of 10 photos can be returned. - servesCocktails: - type: boolean - description: Place serves cocktails. + A human-readable phone number for the place, in international + format. + type: string + 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: type: boolean description: Specifies if the place serves vegetarian food. + liveMusic: + type: boolean + description: Place provides live music. + servesBeer: + type: boolean + description: Specifies if the place serves beer. + plusCode: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlacePlusCode' + description: Plus code of the place location lat/long. + 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 + formattedAddress: + type: string + description: A full, human-readable address for this place. + curbsidePickup: + description: Specifies if the business supports curbside pickup. + type: boolean 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. - iconMaskBaseUri: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAreaSummary' + googleMapsUri: 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"). + description: A URL providing more information about this place. + goodForChildren: + description: Place is good for children. + type: boolean 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. - servesWine: + type: string + delivery: + description: Specifies if the business supports delivery. type: boolean - description: Specifies if the place serves wine. - takeout: + 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. + servesBrunch: type: boolean - description: Specifies if the business supports takeout. + description: Specifies if the place serves brunch. evChargeOptions: $ref: '#/components/schemas/GoogleMapsPlacesV1EVChargeOptions' description: Information of ev charging options. iconBackgroundColor: - type: string description: 'Background color for icon_mask in hex format, e.g. #909CE1.' - servesBrunch: - description: Specifies if the place serves brunch. + type: string + restroom: + description: Place has restroom. type: boolean - parkingOptions: - description: Options of parking provided by the place. - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceParkingOptions' - currentSecondaryOpeningHours: - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' + takeout: + description: Specifies if the business supports takeout. + type: boolean + primaryTypeDisplayName: + $ref: '#/components/schemas/GoogleTypeLocalizedText' 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. + 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 + servesWine: + description: Specifies if the place serves wine. + type: boolean + attributions: type: array - description: All the information representing a Place. - id: GoogleMapsPlacesV1Place - type: object - GoogleMapsPlacesV1Circle: - properties: - 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' - radius: - format: double - type: number + description: A set of data provider that must be shown with this result. + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAttribution' + currentOpeningHours: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' description: >- - Required. Radius measured in meters. The radius must be within [0.0, - 50000.0]. - id: GoogleMapsPlacesV1Circle - type: object - description: Circle with a LatLng as center and radius. - GoogleMapsPlacesV1Review: - type: object - description: Information about a review of a place. - id: GoogleMapsPlacesV1Review - properties: - relativePublishTimeDescription: + 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. + goodForGroups: + type: boolean + description: Place accommodates groups. + subDestinations: + type: array + description: A list of sub destinations related to the place. + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceSubDestination' + iconMaskBaseUri: 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 - publishTime: + A truncated URL to an icon mask. User can access different icon type + by appending type suffix to the end (eg, ".svg" or ".png"). type: string - description: Timestamp for the review. - format: google-datetime - name: + shortFormattedAddress: + description: A short, human-readable address for this place. type: string + photos: + type: array 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}`). - authorAttribution: - $ref: '#/components/schemas/GoogleMapsPlacesV1AuthorAttribution' - description: This review's author. - originalText: - $ref: '#/components/schemas/GoogleTypeLocalizedText' - description: The review text in its original language. - 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. - GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation: - id: GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation + Information (including references) about photos of this place. A + maximum of 10 photos can be returned. + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1Photo' + GoogleMapsPlacesV1Photo: + properties: + heightPx: + description: The maximum available height, in pixels. + type: integer + format: int32 + authorAttributions: + type: array + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1AuthorAttribution' + description: This photo's authors. + 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}`). + widthPx: + format: int32 + description: The maximum available width, in pixels. + type: integer + type: object + id: GoogleMapsPlacesV1Photo + description: Information about a photo of a place. + GoogleMapsPlacesV1ContextualContent: + 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. type: object properties: - maxChargeRateKw: - format: double + reviews: + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1Review' + description: List of reviews about this place, contexual to the place query. + type: array + justifications: + type: array + items: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1ContextualContentJustification description: >- - The static max charging rate in kw of each connector in the - aggregation. + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. Justifications for the place. + photos: + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1Photo' + type: array + description: >- + Information (including references) about photos of this place, + contexual to the place query. + GoogleTypeLatLng: + properties: + longitude: + format: double + description: The longitude in degrees. It must be in the range [-180.0, +180.0]. type: number - availableCount: - format: int32 + 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: GoogleTypeLatLng + type: object + GoogleMapsPlacesV1SearchTextRequestLocationBias: + id: GoogleMapsPlacesV1SearchTextRequestLocationBias + description: >- + The region to search. This location serves as a bias which means results + around given location might be returned. + type: object + 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. + GoogleMapsPlacesV1SearchNearbyRequest: + id: GoogleMapsPlacesV1SearchNearbyRequest + properties: + includedPrimaryTypes: + items: + type: string + type: array + 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". + 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 + excludedTypes: + items: + type: string + type: array + 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". + rankPreference: + enum: + - RANK_PREFERENCE_UNSPECIFIED + - DISTANCE + - POPULARITY + 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. + locationRestriction: + description: Required. The region to search. + $ref: >- + #/components/schemas/GoogleMapsPlacesV1SearchNearbyRequestLocationRestriction + regionCode: + 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 + includedTypes: + 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". + type: array + items: + type: string + excludedPrimaryTypes: + type: array + items: + type: string + description: >- + 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". + maxResultCount: type: integer description: >- - Number of connectors in this aggregation that are currently - available. + 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: object + description: 'Request proto for Search Nearby. ' + GoogleMapsPlacesV1PhotoMedia: + description: A photo media from Places API. + id: GoogleMapsPlacesV1PhotoMedia + type: object + properties: + photoUri: + type: string + description: A short-lived uri that can be used to render the photo. + name: + type: string + description: >- + The resource name of a photo media in the format: + `places/{place_id}/photos/{photo_reference}/media`. + GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation: + properties: type: + description: The connector type of this aggregation. enumDescriptions: - Unspecified connector. - Other connector types. @@ -1870,6 +1556,7 @@ components: GB/T type corresponds to the GB/T standard in China. This type covers all GB_T types. - Unspecified wall outlet. + type: string enum: - EV_CONNECTOR_TYPE_UNSPECIFIED - EV_CONNECTOR_TYPE_OTHER @@ -1881,102 +1568,412 @@ components: - EV_CONNECTOR_TYPE_TESLA - EV_CONNECTOR_TYPE_UNSPECIFIED_GB_T - EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET - description: The connector type of this aggregation. - type: string - outOfServiceCount: + availableCount: format: int32 - type: integer description: >- - Number of connectors in this aggregation that are currently out of - service. - count: + Number of connectors in this aggregation that are currently + available. type: integer - format: int32 - description: Number of connectors in this aggregation. - availabilityLastUpdateTime: + maxChargeRateKw: + format: double + description: >- + The static max charging rate in kw of each connector in the + aggregation. + type: number + count: + type: integer + description: Number of connectors in this aggregation. + format: int32 + availabilityLastUpdateTime: + type: string + format: google-datetime description: >- The timestamp when the connector availability information in this aggregation was last updated. + outOfServiceCount: + description: >- + Number of connectors in this aggregation that are currently out of + service. + format: int32 + type: integer + 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 + 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: + references: + $ref: '#/components/schemas/GoogleMapsPlacesV1References' + description: References that are used to generate the summary description. + overview: + description: The overview of the place. + $ref: '#/components/schemas/GoogleTypeLocalizedText' + description: + $ref: '#/components/schemas/GoogleTypeLocalizedText' + description: The detailed description of the place. + id: GoogleMapsPlacesV1PlaceGenerativeSummary + GoogleMapsPlacesV1References: + id: GoogleMapsPlacesV1References + type: object + properties: + reviews: + type: array + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1Review' + description: Reviews that serve as references. + places: + description: >- + The list of resource names of the referenced places. This name can + be used in other APIs that accept Place resource names. + items: + type: string + type: array + 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. + 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: + 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 + type: integer + description: >- + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + 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. + id: GoogleTypeDate + GoogleMapsPlacesV1PlacePaymentOptions: + properties: + acceptsDebitCards: + description: Place accepts debit cards as payment. + type: boolean + acceptsCreditCards: + type: boolean + description: Place accepts credit cards as payment. + acceptsCashOnly: + type: boolean + description: >- + Place accepts cash only as payment. Places with this attribute may + still accept other payment methods. + acceptsNfc: + type: boolean + description: Place accepts NFC payments. + id: GoogleMapsPlacesV1PlacePaymentOptions + description: Payment options the place accepts. + type: object + GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction: + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction + properties: + structuredFormat: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat + 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. + 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`. + type: object + description: Prediction results for a Query Autocomplete prediction. + 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: + 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. + 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). + id: GoogleMapsPlacesV1PlacePlusCode + type: object + GoogleMapsPlacesV1FuelOptionsFuelPrice: + properties: + updateTime: + description: The time the fuel price was last updated. + type: string + format: google-datetime + 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. + 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 + description: The type of fuel. + type: string + price: + $ref: '#/components/schemas/GoogleTypeMoney' + description: The price of the fuel. + id: GoogleMapsPlacesV1FuelOptionsFuelPrice + type: object + description: Fuel price information for a given type. + GoogleMapsPlacesV1SearchTextResponse: + type: object + id: GoogleMapsPlacesV1SearchTextResponse + properties: + places: + type: array + description: A list of places that meet the user's text search criteria. + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1Place' + 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 + contextualContents: + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1ContextualContent' + type: array + 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 should have as many entries as the list of + places if requested. + description: 'Response proto for SearchText. ' + GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange: + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange + properties: + endOffset: + type: integer + format: int32 + description: Zero-based offset of the last Unicode character (exclusive). + startOffset: + description: >- + Zero-based offset of the first Unicode character of the string + (inclusive). + type: integer + format: int32 + type: object + description: Identifies a substring within a given text. + GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification: + properties: + delivery: + description: If a place provides delivery. + type: boolean + dineIn: + type: boolean + description: If a place provides dine-in. + takeout: + description: If a place provides takeout. + type: boolean + id: >- + GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification + 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. + type: object + GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedText: + type: object + 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 + properties: + highlightedTextRanges: + type: array + description: The list of the ranges of the highlighted text. + items: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedTextHighlightedTextRange + text: type: string - format: google-datetime - 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. - GoogleMapsPlacesV1SearchTextRequestLocationRestriction: - description: >- - The region to search. This location serves as a restriction which means - results outside given location will not be returned. + GoogleMapsPlacesV1PlaceAttribution: + type: object + description: Information about data providers of this place. + id: GoogleMapsPlacesV1PlaceAttribution properties: - rectangle: - 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' - id: GoogleMapsPlacesV1SearchTextRequestLocationRestriction + provider: + description: Name of the Place's data provider. + type: string + providerUri: + type: string + description: URI to the Place's data provider. + GoogleMapsPlacesV1PlaceAccessibilityOptions: + id: GoogleMapsPlacesV1PlaceAccessibilityOptions type: object + description: Information about the accessibility options a place offers. + 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. + GoogleMapsPlacesV1SearchNearbyResponse: + id: GoogleMapsPlacesV1SearchNearbyResponse + description: 'Response proto for Search Nearby. ' + type: object + properties: + places: + 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 parameters: - 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 + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: oauth_token + name: prettyPrint schema: - type: string + type: boolean 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. + access_token: + description: OAuth access token. in: query - name: prettyPrint + name: access_token schema: - type: boolean - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + 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: uploadType + name: key 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. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: $.xgafv + name: uploadType 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. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: key + name: oauth_token schema: type: string upload_protocol: @@ -1985,6 +1982,15 @@ components: name: upload_protocol schema: type: string + _.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 @@ -1994,15 +2000,9 @@ components: name: quotaUser schema: type: string - callback: - description: JSONP - in: query - name: callback - schema: - type: string x-stackQL-resources: photos_media: - id: places.photos_media + id: google.places.photos_media name: photos_media title: Photos_media methods: @@ -2019,25 +2019,19 @@ components: update: [] delete: [] places: - id: places.places + id: google.places.places name: places title: Places methods: - search_text: - operation: - $ref: '#/paths/~1v1~1places:searchText/post' - response: - mediaType: application/json - openAPIDocKey: '200' autocomplete: operation: $ref: '#/paths/~1v1~1places:autocomplete/post' response: mediaType: application/json openAPIDocKey: '200' - search_nearby: + search_text: operation: - $ref: '#/paths/~1v1~1places:searchNearby/post' + $ref: '#/paths/~1v1~1places:searchText/post' response: mediaType: application/json openAPIDocKey: '200' @@ -2047,6 +2041,12 @@ components: response: mediaType: application/json openAPIDocKey: '200' + search_nearby: + operation: + $ref: '#/paths/~1v1~1places:searchNearby/post' + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/places/methods/get' @@ -2056,17 +2056,17 @@ components: paths: /v1/places/{placesId}/photos/{photosId}/media: parameters: &ref_1 - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/callback' get: description: Get a photo media with a photo reference string. operationId: places.places.photos.getMedia @@ -2098,50 +2098,19 @@ paths: schema: type: string - in: query - name: maxWidthPx + name: skipHttpRedirect schema: - type: integer - format: int32 + type: boolean - in: query name: maxHeightPx schema: type: integer format: int32 - in: query - name: skipHttpRedirect + name: maxWidthPx schema: - type: boolean - /v1/places:searchText: - parameters: *ref_1 - 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 - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - 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: [] + type: integer + format: int32 /v1/places:autocomplete: parameters: *ref_1 post: @@ -2174,16 +2143,16 @@ paths: $ref: >- #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponse parameters: [] - /v1/places:searchNearby: + /v1/places:searchText: parameters: *ref_1 post: - description: Search for places near locations. - operationId: places.places.searchNearby + description: Text query based place search. + operationId: places.places.searchText requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleMapsPlacesV1SearchNearbyRequest' + $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2194,16 +2163,16 @@ 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.textsearch Oauth2c: - - https://www.googleapis.com/auth/maps-platform.places.nearbysearch + - https://www.googleapis.com/auth/maps-platform.places.textsearch responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleMapsPlacesV1SearchNearbyResponse' + $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextResponse' parameters: [] /v1/places/{placesId}: parameters: *ref_1 @@ -2243,10 +2212,41 @@ paths: schema: type: string - in: query - name: regionCode + name: languageCode schema: type: string - in: query - name: languageCode + name: regionCode schema: type: string + /v1/places:searchNearby: + parameters: *ref_1 + post: + description: Search for places near locations. + operationId: places.places.searchNearby + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleMapsPlacesV1SearchNearbyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - 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.nearbysearch + Oauth2c: + - https://www.googleapis.com/auth/maps-platform.places.nearbysearch + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleMapsPlacesV1SearchNearbyResponse' + 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 606a42eb..50affe36 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: '20240526' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://www.google.com servers: @@ -34,24 +34,8 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudPolicyanalyzerV1ObservationPeriod: - properties: - startTime: - description: >- - The observation start time. The time in this timestamp is always - `07:00:00Z`. - type: string - format: google-datetime - endTime: - description: >- - The observation end time. The time in this timestamp is always - `07:00:00Z`. - format: google-datetime - type: string - type: object - description: Represents data observation period. - id: GoogleCloudPolicyanalyzerV1ObservationPeriod GoogleCloudPolicyanalyzerV1Activity: + type: object properties: fullResourceName: type: string @@ -59,42 +43,58 @@ components: 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. - observationPeriod: - description: The data observation period to build the activity. - $ref: '#/components/schemas/GoogleCloudPolicyanalyzerV1ObservationPeriod' activity: - type: object additionalProperties: description: Properties of the object. type: any + type: object description: A struct of custom fields to explain the activity. activityType: type: string description: The type of the activity. - type: object + observationPeriod: + description: The data observation period to build the activity. + $ref: '#/components/schemas/GoogleCloudPolicyanalyzerV1ObservationPeriod' id: GoogleCloudPolicyanalyzerV1Activity GoogleCloudPolicyanalyzerV1QueryActivityResponse: - type: object - description: Response to the `QueryActivity` method. properties: + activities: + description: The set of activities that match the filter included in the request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudPolicyanalyzerV1Activity' 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: - items: - $ref: '#/components/schemas/GoogleCloudPolicyanalyzerV1Activity' - type: array - description: The set of activities that match the filter included in the request. + description: Response to the `QueryActivity` method. id: GoogleCloudPolicyanalyzerV1QueryActivityResponse + type: object + GoogleCloudPolicyanalyzerV1ObservationPeriod: + type: object + 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: + description: >- + The observation end time. The time in this timestamp is always + `07:00:00Z`. + type: string + format: google-datetime + id: GoogleCloudPolicyanalyzerV1ObservationPeriod parameters: - 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 upload_protocol: @@ -112,6 +112,21 @@ 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 + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string alt: description: Data format for response. in: query @@ -122,19 +137,22 @@ components: - json - media - proto - callback: - description: JSONP + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: callback + 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 + callback: + description: JSONP + in: query + name: callback schema: type: string key: @@ -146,33 +164,15 @@ components: name: key 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 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 x-stackQL-resources: activities: - id: policyanalyzer.activities + id: google.policyanalyzer.activities name: activities title: Activities methods: @@ -191,17 +191,17 @@ components: paths: /v1/projects/{projectsId}/locations/{locationsId}/activityTypes/{activityTypesId}/activities:query: parameters: - - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/oauth_token' get: description: Queries policy activities on Google Cloud resources. operationId: policyanalyzer.projects.locations.activityTypes.activities.query @@ -235,7 +235,7 @@ paths: schema: type: string - in: query - name: filter + name: pageToken schema: type: string - in: query @@ -244,6 +244,6 @@ paths: type: integer format: int32 - in: query - name: pageToken + name: filter 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 cdc8177d..6fddcdb6 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: '20240526' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/iam/docs/simulating-access servers: @@ -34,629 +34,552 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview: + GoogleCloudPolicysimulatorV1BindingExplanation: + description: >- + Details about how a binding in a policy affects a principal's ability to + use a permission. properties: - violationsCount: + 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: >- - 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 - type: integer - format: int32 - state: - description: Output only. The state of the `OrgPolicyViolationsPreview`. + 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. enum: - - PREVIEW_STATE_UNSPECIFIED - - PREVIEW_PENDING - - PREVIEW_RUNNING - - PREVIEW_SUCCEEDED - - PREVIEW_FAILED + - ACCESS_STATE_UNSPECIFIED + - GRANTED + - NOT_GRANTED + - UNKNOWN_CONDITIONAL + - UNKNOWN_INFO_DENIED + rolePermission: 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. - readOnly: true - resourceCounts: - description: >- - Output only. A summary of the state of all resources scanned for - compliance with the changed OrgPolicy. - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts - readOnly: true - createTime: - format: google-datetime - type: string + - 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 description: >- - Output only. Time when this `OrgPolicyViolationsPreview` was - created. - readOnly: true - name: + Indicates whether the role granted by this binding contains the + specified permission. + rolePermissionRelevance: 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: + 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: >- - 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 - type: array - readOnly: true - overlay: - description: Required. The proposed changes we are previewing violations for. - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay - 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. - id: GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview - type: object - GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts: - id: GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts - properties: - compliant: - type: integer - readOnly: true - format: int32 - description: Output only. Number of scanned resources with zero violations. - errors: + The relevance of the permission's existence, or nonexistence, in the + role to the overall determination for the entire policy. + 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. description: >- - Output only. Number of resources that returned an error when - scanned. - type: integer - format: int32 - readOnly: true - noncompliant: - format: int32 - readOnly: true - type: integer + The relevance of this binding to the overall determination for the + entire policy. + type: string + enum: + - HEURISTIC_RELEVANCE_UNSPECIFIED + - NORMAL + - HIGH + role: + type: string description: >- - Output only. Number of scanned resources with at least one - violation. - scanned: - type: integer + 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. + memberships: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership + type: object description: >- - Output only. Number of resources checked for compliance. Must equal: - unenforced + noncompliant + compliant + error - readOnly: true - format: int32 - unenforced: - format: int32 - readOnly: true - type: integer + 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`. + condition: + $ref: '#/components/schemas/GoogleTypeExpr' description: >- - Output only. Number of resources where the constraint was not - enforced, i.e. the Policy set `enforced: false` for that resource. + 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. type: object + id: GoogleCloudPolicysimulatorV1BindingExplanation + GoogleCloudOrgpolicyV2CustomConstraint: description: >- - A summary of the state of all resources scanned for compliance with the - changed OrgPolicy. - GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay: - type: object + 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: - policy: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' - description: Optional. The new or updated OrgPolicy. - policyParent: + displayName: + type: string description: >- - Optional. The parent of the policy we are attaching to. Example: - "projects/123456" + One line display name for the UI. The max length of the display_name + is 200 characters. + name: type: string - id: GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay - description: A change to an OrgPolicy. - GoogleCloudOrgpolicyV2PolicySpecPolicyRule: - id: GoogleCloudOrgpolicyV2PolicySpecPolicyRule - type: object - properties: + 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. 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')". - enforce: - 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: - $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: + 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 + updateTime: + readOnly: true + type: string + format: google-datetime description: >- - Setting this to true means that all values are denied. This field - can be set only in policies for list constraints. - type: boolean - allowAll: + 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: >- - Setting this to true means that all values are allowed. This field - can be set only in policies for list constraints. - type: boolean - description: A rule used to express this policy. - GoogleLongrunningListOperationsResponse: - properties: - operations: - type: array + Detailed information about this custom policy constraint. The max + length of the description is 2000 characters. + resourceTypes: items: - $ref: '#/components/schemas/GoogleLongrunningOperation' + type: string description: >- - A list of operations that matches the specified filter in the - request. - nextPageToken: + Immutable. The resource instance type on which this policy applies. + Format will be of the form : `/` Example: * + `compute.googleapis.com/Instance`. + type: array + actionType: + enum: + - ACTION_TYPE_UNSPECIFIED + - ALLOW + - DENY type: string - description: The standard List next-page token. - id: GoogleLongrunningListOperationsResponse - description: The response message for Operations.ListOperations. + description: Allow or deny type. + enumDescriptions: + - Unspecified. Results in an error. + - Allowed action type. + - Deny action type. + methodTypes: + 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. + description: All the operations being applied for this constraint. + id: GoogleCloudOrgpolicyV2CustomConstraint type: object - GoogleCloudOrgpolicyV2Policy: - id: GoogleCloudOrgpolicyV2Policy + GoogleIamV1AuditConfig: type: object description: >- - Defines an organization policy which is used to specify constraints for - configurations of Google Cloud resources. + Specifies the audit configuration for a service. The configuration + determines which permission types are logged, and what identities, if + any, are exempted from logging. An AuditConfig must have one or more + AuditLogConfigs. If there are AuditConfigs for both `allServices` and a + specific service, the union of the two AuditConfigs is used for that + service: the log_types specified in each AuditConfig are enabled, and + the exempted_members in each AuditLogConfig are exempted. Example Policy + with multiple AuditConfigs: { "audit_configs": [ { "service": + "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", + "exempted_members": [ "user:jose@example.com" ] }, { "log_type": + "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": + "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": + "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ + "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy + enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts + `jose@example.com` from DATA_READ logging, and `aliya@example.com` from + DATA_WRITE logging. + id: GoogleIamV1AuditConfig properties: - etag: - type: string + auditLogConfigs: + type: array + items: + $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' + description: The configuration for logging of each type of permission. + service: 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' - name: + 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: >- - 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. - alternate: - deprecated: true - description: Deprecated. - $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. - GoogleTypeExpr: + GoogleCloudPolicysimulatorV1ExplainedAccess: + type: object + id: GoogleCloudPolicysimulatorV1ExplainedAccess 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. + Details about how a set of policies, listed in ExplainedPolicy, resulted + in a certain AccessState when replaying an access tuple. properties: - expression: + accessState: description: >- - Textual representation of an expression in Common Expression - Language syntax. - type: string - title: + 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. + - 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: + - ACCESS_STATE_UNSPECIFIED + - GRANTED + - NOT_GRANTED + - UNKNOWN_CONDITIONAL + - UNKNOWN_INFO_DENIED type: string + policies: 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: - 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 + 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 + items: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ExplainedPolicy' + errors: + type: array 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 - GoogleCloudPolicysimulatorV1OrgPolicyViolation: + 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' + GoogleCloudPolicysimulatorV1OrgPolicyOverlay: type: object - id: GoogleCloudPolicysimulatorV1OrgPolicyViolation + description: The proposed changes to OrgPolicy. properties: - customConstraint: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' - description: The custom constraint being violated. - resource: - description: The resource violating the constraint. - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ResourceContext' - error: - description: Any error encountered during the evaluation. - $ref: '#/components/schemas/GoogleRpcStatus' - name: - type: string + policies: description: >- - The name of the `OrgPolicyViolation`. Example: - organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f/orgPolicyViolations/38ce` - description: >- - OrgPolicyViolation is a resource representing a single resource - violating a single OrgPolicy constraint. - 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 - GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata: - id: >- - GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata - properties: - 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. - description: Output only. The current state of the operation. - type: string - enum: - - PREVIEW_STATE_UNSPECIFIED - - PREVIEW_PENDING - - PREVIEW_RUNNING - - PREVIEW_SUCCEEDED - - PREVIEW_FAILED - readOnly: true - resourcesScanned: - type: integer - description: Number of resources already scanned. - format: int32 - resourcesFound: - type: integer - format: int32 - description: >- - Total number of resources that need scanning. Should equal - resource_scanned + resources_pending - resourcesPending: - type: integer - description: Number of resources still to scan. - format: int32 - requestTime: - format: google-datetime - type: string - description: Time when the request was received. - startTime: - type: string - format: google-datetime + 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/GoogleCloudPolicysimulatorV1OrgPolicyOverlayPolicyOverlay + type: array + customConstraints: + items: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyOverlayCustomConstraintOverlay description: >- - Time when the request started processing, i.e., when the state was - set to RUNNING. - description: >- - CreateOrgPolicyViolationsPreviewOperationMetadata is metadata about an - OrgPolicyViolationsPreview generations operation. - type: object - 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. - id: GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview + 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 + id: GoogleCloudPolicysimulatorV1OrgPolicyOverlay + GoogleIamV1Binding: type: object + id: GoogleIamV1Binding properties: - createTime: - description: >- - Output only. Time when this `OrgPolicyViolationsPreview` was - created. - readOnly: true + role: type: string - format: google-datetime - customConstraints: + 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`. type: array items: type: string + condition: + $ref: '#/components/schemas/GoogleTypeExpr' 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 - resourceCounts: + 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). + description: Associates `members`, or principals, with a `role`. + GoogleCloudOrgpolicyV2PolicySpecPolicyRule: + description: A rule used to express this policy. + properties: + values: $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts + #/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues description: >- - Output only. A summary of the state of all resources scanned for - compliance with the changed OrgPolicy. - readOnly: true - violationsCount: - type: integer - format: int32 + 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: >- - 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 - overlay: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay - description: Required. The proposed changes we are previewing violations for. - 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. - type: string - description: Output only. The state of the `OrgPolicyViolationsPreview`. - enum: - - PREVIEW_STATE_UNSPECIFIED - - PREVIEW_PENDING - - PREVIEW_RUNNING - - PREVIEW_SUCCEEDED - - PREVIEW_FAILED - readOnly: true - name: - type: string + Setting this to true means that all values are allowed. This field + can be set only in policies for list constraints. + denyAll: 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 - GoogleCloudPolicysimulatorV1Replay: - description: A resource describing a `Replay`, or simulation. - properties: - state: - 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. - enum: - - STATE_UNSPECIFIED - - PENDING - - RUNNING - - SUCCEEDED - - FAILED - type: string - readOnly: true - description: Output only. The current state of the `Replay`. - config: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ReplayConfig' - description: Required. The configuration used for the `Replay`. - name: - readOnly: true + 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: >- - 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` - type: string - resultsSummary: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1ReplayResultsSummary - description: Output only. Summary statistics about the replayed log entries. - readOnly: true - id: GoogleCloudPolicysimulatorV1Replay + 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')". + id: GoogleCloudOrgpolicyV2PolicySpecPolicyRule type: object - GoogleCloudPolicysimulatorV1betaGenerateOrgPolicyViolationsPreviewOperationMetadata: + GoogleCloudOrgpolicyV2PolicySpec: properties: - requestTime: - description: Time when the request was received. + updateTime: 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. + readOnly: true format: google-datetime - startTime: - format: google-datetime + etag: description: >- - Time when the request started processing, i.e. when the state was - set to RUNNING. - type: string - state: - 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 + 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 - resourcesPending: - type: integer - format: int32 - description: Number of resources still to scan. - resourcesScanned: - description: Number of resources already scanned. - type: integer - format: int32 - resourcesFound: - format: int32 - description: >- - Total number of resources that need scanning. Should equal - resource_scanned + resources_pending - type: integer - description: >- - GenerateOrgPolicyViolationsPreviewOperationMetadata is metadata about an - OrgPolicyViolationsPreview generations operation. - type: object - id: >- - GoogleCloudPolicysimulatorV1betaGenerateOrgPolicyViolationsPreviewOperationMetadata - GoogleCloudPolicysimulatorV1BindingExplanation: - description: >- - Details about how a binding in a policy affects a principal's ability to - use a permission. - id: GoogleCloudPolicysimulatorV1BindingExplanation - properties: - condition: + reset: 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. - $ref: '#/components/schemas/GoogleTypeExpr' - rolePermission: - enum: - - ROLE_PERMISSION_UNSPECIFIED - - ROLE_PERMISSION_INCLUDED - - ROLE_PERMISSION_NOT_INCLUDED - - ROLE_PERMISSION_UNKNOWN_INFO_DENIED - 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. + 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 + inheritFromParent: description: >- - Indicates whether the role granted by this binding contains the - specified permission. - access: - type: string - 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 user who created the Replay does not have access to all of the - policies that Policy Simulator needs to evaluate. + 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 + rules: + type: array 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. - role: - type: string + 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. + items: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRule' + description: >- + Defines a Google Cloud policy specification which is used to specify + constraints for configurations of Google Cloud resources. + id: GoogleCloudOrgpolicyV2PolicySpec + type: object + GoogleCloudPolicysimulatorV1ReplayDiff: + id: GoogleCloudPolicysimulatorV1ReplayDiff + properties: + accessDiff: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1AccessStateDiff' 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. - rolePermissionRelevance: + 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. + 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. + GoogleCloudPolicysimulatorV1ReplayOperationMetadata: + type: object + properties: + startTime: + format: google-datetime + description: Time when the request was received. type: string - enum: - - HEURISTIC_RELEVANCE_UNSPECIFIED - - NORMAL - - HIGH + id: GoogleCloudPolicysimulatorV1ReplayOperationMetadata + description: Metadata about a Replay operation. + GoogleCloudPolicysimulatorV1ExplainedPolicy: + type: object + id: GoogleCloudPolicysimulatorV1ExplainedPolicy + description: Details about how a specific IAM Policy contributed to the access check. + properties: + bindingExplanations: description: >- - The relevance of the permission's existence, or nonexistence, in the - role 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. - memberships: - type: object - additionalProperties: + 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/GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership + #/components/schemas/GoogleCloudPolicysimulatorV1BindingExplanation + fullResourceName: + type: string 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`. + 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. relevance: - type: string enum: - HEURISTIC_RELEVANCE_UNSPECIFIED - NORMAL - HIGH + type: string enumDescriptions: - Default value. This value is unused. - >- @@ -666,128 +589,64 @@ components: 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 this binding to the overall determination for the - entire policy. - type: object - GoogleCloudPolicysimulatorV1AccessStateDiff: - properties: - accessChange: - enum: - - ACCESS_CHANGE_TYPE_UNSPECIFIED - - NO_CHANGE - - UNKNOWN_CHANGE - - ACCESS_REVOKED - - ACCESS_GAINED - - ACCESS_MAYBE_REVOKED - - ACCESS_MAYBE_GAINED + 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. + policy: + $ref: '#/components/schemas/GoogleIamV1Policy' description: >- - How the principal's access, specified in the AccessState field, - changed between the current (baseline) policies and proposed - (simulated) policies. + 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. + 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`). + The user who created the Replay does not have access to all of the + policies that Policy Simulator needs to evaluate. type: string - 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' - 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. - id: GoogleCloudPolicysimulatorV1AccessStateDiff - type: object - 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. - GoogleTypeDate: - id: GoogleTypeDate + 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 + GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay: + description: A change to an OrgPolicy. + id: GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay properties: - 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 - 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 + policy: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + description: Optional. The new or updated OrgPolicy. + policyParent: description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - 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 - GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership: - description: Details about whether the binding includes the principal. - type: object - properties: - 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. + Optional. The parent of the policy we are attaching to. Example: + "projects/123456" type: string - description: >- - The relevance of the principal's status to the overall determination - for the binding. + type: object + GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership: + properties: membership: + 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 enumDescriptions: - Default value. This value is unused. - >- @@ -803,75 +662,36 @@ components: - >- The principal is an unsupported type. Only Google Accounts and service accounts are supported. + relevance: type: string enum: - - MEMBERSHIP_UNSPECIFIED - - MEMBERSHIP_INCLUDED - - MEMBERSHIP_NOT_INCLUDED - - MEMBERSHIP_UNKNOWN_INFO_DENIED - - MEMBERSHIP_UNKNOWN_UNSUPPORTED - description: Indicates whether the binding includes the principal. + - 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. + description: Details about whether the binding includes the principal. id: GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership - GoogleCloudOrgpolicyV2AlternatePolicySpec: - id: GoogleCloudOrgpolicyV2AlternatePolicySpec type: object + GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview: 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: - type: string - 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. - GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay: - description: A change to an OrgPolicy custom constraint. - type: object - properties: - customConstraintParent: - type: string - description: >- - Optional. Resource the constraint is attached to. Example: - "organization/987654" - customConstraint: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' - description: Optional. The new or updated custom constraint. - id: GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay - GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview: - type: object - id: GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview + 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: - overlay: - description: Required. The proposed changes we are previewing violations for. - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyOverlay' - 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` - 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 - format: int32 - readOnly: true customConstraints: - type: array - items: - type: string readOnly: true description: >- Output only. The names of the constraints against which all @@ -883,22 +703,12 @@ components: `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` - resourceCounts: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreviewResourceCounts - description: >- - Output only. A summary of the state of all resources scanned for - compliance with the changed OrgPolicy. - readOnly: true + type: array + items: + type: string state: readOnly: true 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`. enum: - PREVIEW_STATE_UNSPECIFIED @@ -906,155 +716,132 @@ components: - PREVIEW_RUNNING - PREVIEW_SUCCEEDED - PREVIEW_FAILED - createTime: - type: string - readOnly: true - description: >- - Output only. Time when this `OrgPolicyViolationsPreview` was - created. - format: google-datetime - 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. - GoogleCloudPolicysimulatorV1alphaGenerateOrgPolicyViolationsPreviewOperationMetadata: - type: object - properties: - requestTime: - description: Time when the request was received. - format: google-datetime - type: string - resourcesPending: - type: integer - description: Number of resources still to scan. - format: int32 - 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. - description: The current state of the operation. - resourcesScanned: - description: Number of resources already scanned. - type: integer + violationsCount: format: int32 - startTime: - type: string - description: >- - Time when the request started processing, i.e. when the state was - set to RUNNING. - format: google-datetime - resourcesFound: type: integer - format: int32 description: >- - Total number of resources that need scanning. Should equal - resource_scanned + resources_pending - description: >- - GenerateOrgPolicyViolationsPreviewOperationMetadata is metadata about an - OrgPolicyViolationsPreview generations operation. - id: >- - GoogleCloudPolicysimulatorV1alphaGenerateOrgPolicyViolationsPreviewOperationMetadata - GoogleCloudPolicysimulatorV1AccessTuple: - id: GoogleCloudPolicysimulatorV1AccessTuple - type: object - description: Information about the principal, resource, and permission to check. - properties: - permission: - type: string + 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 + resourceCounts: + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts 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. - principal: - type: string + Output only. A summary of the state of all resources scanned for + compliance with the changed OrgPolicy. + name: 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: + 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 + createTime: 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. + Output only. Time when this `OrgPolicyViolationsPreview` was + created. type: string - GoogleCloudPolicysimulatorV1OrgPolicyOverlayCustomConstraintOverlay: + format: google-datetime + readOnly: true + overlay: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay + description: Required. The proposed changes we are previewing violations for. + type: object + id: GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview + GoogleCloudPolicysimulatorV1OrgPolicyViolation: type: object - description: A change to an OrgPolicy custom constraint. - id: GoogleCloudPolicysimulatorV1OrgPolicyOverlayCustomConstraintOverlay properties: + resource: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ResourceContext' + description: The resource violating the constraint. customConstraint: - 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" - GoogleCloudPolicysimulatorV1ExplainedAccess: - properties: - accessState: - 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. - enum: - - ACCESS_STATE_UNSPECIFIED - - GRANTED - - NOT_GRANTED - - UNKNOWN_CONDITIONAL - - UNKNOWN_INFO_DENIED + description: The custom constraint being violated. + name: description: >- - Whether the principal in the access tuple has permission to access - the resource in the access tuple under the given policies. + The name of the `OrgPolicyViolation`. Example: + organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f/orgPolicyViolations/38ce` type: string - errors: + error: + description: Any error encountered during the evaluation. + $ref: '#/components/schemas/GoogleRpcStatus' + id: GoogleCloudPolicysimulatorV1OrgPolicyViolation + description: >- + OrgPolicyViolation is a resource representing a single resource + violating a single OrgPolicy constraint. + GoogleIamV1Policy: + properties: + version: + 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). + type: integer + 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 + 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 + bindings: type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' 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. - policies: + 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/GoogleCloudPolicysimulatorV1ExplainedPolicy' + $ref: '#/components/schemas/GoogleIamV1Binding' + auditConfigs: type: array - 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. - description: >- - Details about how a set of policies, listed in ExplainedPolicy, resulted - in a certain AccessState when replaying an access tuple. - id: GoogleCloudPolicysimulatorV1ExplainedAccess - type: object - GoogleIamV1Policy: + items: + $ref: '#/components/schemas/GoogleIamV1AuditConfig' + description: Specifies cloud audit logging configuration for this policy. + id: GoogleIamV1Policy description: >- An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of @@ -1090,297 +877,448 @@ components: For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). type: object - id: GoogleIamV1Policy + GoogleCloudOrgpolicyV2Policy: + description: >- + Defines an organization policy which is used to specify constraints for + configurations of Google Cloud resources. + 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. + alternate: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2AlternatePolicySpec' + description: Deprecated. + deprecated: true + etag: + 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 + spec: + description: Basic information about the Organization Policy. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' + 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 + 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. + id: GoogleCloudOrgpolicyV2Policy + GoogleTypeExpr: + type: object + id: GoogleTypeExpr + properties: + 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: + 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. + 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. + GoogleCloudPolicysimulatorV1Replay: + 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 + resultsSummary: + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1ReplayResultsSummary + description: Output only. Summary statistics about the replayed log entries. + 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. + description: Output only. The current state of the `Replay`. + readOnly: true + enum: + - STATE_UNSPECIFIED + - PENDING + - RUNNING + - SUCCEEDED + - FAILED + config: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ReplayConfig' + description: Required. The configuration used for the `Replay`. + description: A resource describing a `Replay`, or simulation. + type: object + id: GoogleCloudPolicysimulatorV1Replay + GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata: + properties: + resourcesFound: + format: int32 + description: >- + Total number of resources that need scanning. Should equal + resource_scanned + resources_pending + type: integer + requestTime: + type: string + description: Time when the request was received. + format: google-datetime + resourcesPending: + format: int32 + description: Number of resources still to scan. + type: integer + startTime: + description: >- + Time when the request started processing, i.e., when the state was + set to RUNNING. + type: string + format: google-datetime + resourcesScanned: + format: int32 + description: Number of resources already scanned. + type: integer + state: + type: string + 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 + description: Output only. The current state of the operation. + id: >- + GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata + type: object + description: >- + CreateOrgPolicyViolationsPreviewOperationMetadata is metadata about an + OrgPolicyViolationsPreview generations operation. + GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview: properties: - etag: - format: byte + customConstraints: + readOnly: true 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. + 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 + items: + type: string + 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. type: string - version: + enum: + - PREVIEW_STATE_UNSPECIFIED + - PREVIEW_PENDING + - PREVIEW_RUNNING + - PREVIEW_SUCCEEDED + - PREVIEW_FAILED + description: Output only. The state of the `OrgPolicyViolationsPreview`. + readOnly: true + resourceCounts: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreviewResourceCounts 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). + Output only. A summary of the state of all resources scanned for + compliance with the changed OrgPolicy. + readOnly: true + 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` + violationsCount: type: integer + readOnly: true format: int32 - auditConfigs: - description: Specifies cloud audit logging configuration for this policy. - type: array - items: - $ref: '#/components/schemas/GoogleIamV1AuditConfig' - 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/GoogleIamV1Binding' - GoogleCloudPolicysimulatorV1ReplayDiff: - type: object - properties: - accessDiff: + 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. + overlay: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyOverlay' + description: Required. The proposed changes we are previewing violations for. + createTime: + format: google-datetime + readOnly: true + type: string 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' - id: GoogleCloudPolicysimulatorV1ReplayDiff + Output only. Time when this `OrgPolicyViolationsPreview` was + created. + 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. - GoogleCloudPolicysimulatorV1ReplayResultsSummary: + 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: GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview + 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: - oldestDate: - $ref: '#/components/schemas/GoogleTypeDate' - description: The date of the oldest log entry replayed. - logCount: - format: int32 - type: integer - description: The total number of log entries replayed. - unchangedCount: - format: int32 + resourceCounts: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts description: >- - The number of replayed log entries with no difference between - baseline and simulated policies. - type: integer - newestDate: - $ref: '#/components/schemas/GoogleTypeDate' - description: The date of the newest log entry replayed. - errorCount: + Output only. A summary of the state of all resources scanned for + compliance with the changed OrgPolicy. + readOnly: true + 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. + readOnly: true + enum: + - PREVIEW_STATE_UNSPECIFIED + - PREVIEW_PENDING + - PREVIEW_RUNNING + - PREVIEW_SUCCEEDED + - PREVIEW_FAILED + description: Output only. The state of the `OrgPolicyViolationsPreview`. + type: string + overlay: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay + description: Required. The proposed changes we are previewing violations for. + name: + 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` + type: string + readOnly: true + violationsCount: type: integer - description: The number of log entries that could not be replayed. - format: int32 - differenceCount: format: int32 + readOnly: true description: >- - The number of replayed log entries with a difference between - baseline and simulated policies. - type: integer - type: object - description: Summary statistics about the replayed log entries. - id: GoogleCloudPolicysimulatorV1ReplayResultsSummary - GoogleCloudPolicysimulatorV1ReplayResult: - description: The result of replaying a single access tuple against a simulated state. - id: GoogleCloudPolicysimulatorV1ReplayResult - properties: - lastSeenDate: - $ref: '#/components/schemas/GoogleTypeDate' - description: The latest date this access tuple was seen in the logs. - diff: + 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. + createTime: 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' - parent: + Output only. Time when this `OrgPolicyViolationsPreview` was + created. + readOnly: true + format: google-datetime type: string - description: The Replay that the access tuple was included in. - 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. - error: - $ref: '#/components/schemas/GoogleRpcStatus' + customConstraints: + items: + type: string + type: array + readOnly: true description: >- - The error that caused the access tuple replay to fail. This field is - only included for access tuples that were not replayed successfully. - name: + 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` + GoogleLongrunningListOperationsResponse: + id: GoogleLongrunningListOperationsResponse + properties: + operations: + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' + type: array 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` + A list of operations that matches the specified filter in the + request. + nextPageToken: + description: The standard List next-page token. type: string type: object - GoogleCloudPolicysimulatorV1OrgPolicyOverlayPolicyOverlay: + description: The response message for Operations.ListOperations. + GoogleCloudPolicysimulatorV1alphaGenerateOrgPolicyViolationsPreviewOperationMetadata: type: object - description: A change to an OrgPolicy. + description: >- + GenerateOrgPolicyViolationsPreviewOperationMetadata is metadata about an + OrgPolicyViolationsPreview generations operation. + id: >- + GoogleCloudPolicysimulatorV1alphaGenerateOrgPolicyViolationsPreviewOperationMetadata properties: - policy: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' - description: Optional. The new or updated OrgPolicy. - policyParent: + startTime: type: string description: >- - Optional. The parent of the policy we are attaching to. Example: - "projects/123456" - id: GoogleCloudPolicysimulatorV1OrgPolicyOverlayPolicyOverlay - 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: - exemptedMembers: - type: array + Time when the request started processing, i.e. when the state was + set to RUNNING. + format: google-datetime + resourcesFound: + format: int32 description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. - items: - type: string - logType: - type: string - description: The log type that this config enables. + Total number of resources that need scanning. Should equal + resource_scanned + resources_pending + type: integer + state: 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 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. enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ - GoogleIamV1Binding: - description: Associates `members`, or principals, with a `role`. - type: object - id: GoogleIamV1Binding + - PREVIEW_STATE_UNSPECIFIED + - PREVIEW_PENDING + - PREVIEW_RUNNING + - PREVIEW_SUCCEEDED + - PREVIEW_FAILED + type: string + requestTime: + type: string + format: google-datetime + description: Time when the request was received. + resourcesPending: + format: int32 + type: integer + description: Number of resources still to scan. + resourcesScanned: + format: int32 + description: Number of resources already scanned. + type: integer + GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts: properties: - condition: + scanned: 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: - items: - type: string + Output only. Number of resources checked for compliance. Must equal: + unenforced + noncompliant + compliant + error + type: integer + readOnly: true + format: int32 + noncompliant: + type: integer 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 - role: - type: string + Output only. Number of scanned resources with at least one + violation. + format: int32 + readOnly: true + compliant: + type: integer + description: Output only. Number of scanned resources with zero violations. + readOnly: true + format: int32 + errors: + readOnly: true + type: integer 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). - GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay: - type: object - properties: - customConstraintParent: - type: string + Output only. Number of resources that returned an error when + scanned. + format: int32 + unenforced: + type: integer description: >- - Optional. Resource the constraint is attached to. Example: - "organization/987654" - customConstraint: - description: Optional. The new or updated custom constraint. - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' - id: GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay - description: A change to an OrgPolicy custom constraint. + 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 + id: GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts + type: object + description: >- + A summary of the state of all resources scanned for compliance with the + changed OrgPolicy. GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay: + description: The proposed changes to OrgPolicy. type: object - id: GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay properties: 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 @@ -1390,11 +1328,8 @@ components: 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 @@ -1403,88 +1338,81 @@ components: items: $ref: >- #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay - type: array - description: The proposed changes to OrgPolicy. - GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay: - id: GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay - description: A change to an OrgPolicy. - properties: - policy: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' - description: Optional. The new or updated OrgPolicy. - policyParent: - description: >- - Optional. The parent of the policy we are attaching to. Example: - "projects/123456" - type: string + id: GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay + GoogleCloudPolicysimulatorV1ReplayResultsSummary: + id: GoogleCloudPolicysimulatorV1ReplayResultsSummary type: object - GoogleCloudPolicysimulatorV1ResourceContext: + description: Summary statistics about the replayed log entries. properties: - assetType: - type: string - description: >- - The asset type of the resource as defined by CAIS. Example: - `compute.googleapis.com/Firewall` See [Supported asset - types](https://cloud.google.com/asset-inventory/docs/supported-asset-types) - for more information. - resource: - type: string + differenceCount: + type: integer + format: int32 description: >- - The full name of the resource. Example: - `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1` - See [Resource - names](https://cloud.google.com/apis/design/resource_names#full_resource_name) - for more information. - ancestors: - items: - type: string - type: array + The number of replayed log entries with a difference between + baseline and simulated policies. + newestDate: + description: The date of the newest log entry replayed. + $ref: '#/components/schemas/GoogleTypeDate' + oldestDate: + $ref: '#/components/schemas/GoogleTypeDate' + description: The date of the oldest log entry replayed. + logCount: + description: The total number of log entries replayed. + format: int32 + type: integer + errorCount: + format: int32 + type: integer + description: The number of log entries that could not be replayed. + unchangedCount: + format: int32 description: >- - The ancestry path of the resource in Google Cloud [resource - hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy), - represented as a list of relative resource names. An ancestry path - starts with the closest ancestor in the hierarchy and ends at root. - If the resource is a project, folder, or organization, the ancestry - path starts from the resource itself. Example: - `["projects/123456789", "folders/5432", "organizations/1234"]` - id: GoogleCloudPolicysimulatorV1ResourceContext - type: object + The number of replayed log entries with no difference between + baseline and simulated policies. + type: integer + GoogleIamV1AuditLogConfig: description: >- - ResourceContext provides the context we know about a resource. It is - similar in concept to google.cloud.asset.v1.Resource, but focuses on the - information specifically used by Simulator. - GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsPreviewsResponse: - id: GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsPreviewsResponse - type: object + 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: - nextPageToken: - description: >- - A token that you can use to retrieve the next page of results. If - this field is omitted, there are no subsequent pages. - type: string - orgPolicyViolationsPreviews: + exemptedMembers: type: array items: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview - description: The list of OrgPolicyViolationsPreview - description: >- - ListOrgPolicyViolationsPreviewsResponse is the response message for - OrgPolicyViolationsPreviewService.ListOrgPolicyViolationsPreviews. + type: string + description: >- + Specifies the identities that do not cause logging for this type of + permission. Follows the same format of Binding.members. + 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' + type: object GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues: properties: deniedValues: - type: array 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 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 @@ -1499,322 +1427,442 @@ components: `organizations/` (for example, `organizations/1234`) The `supports_under` field of the associated `Constraint` defines whether ancestry prefixes can be used. - GoogleCloudPolicysimulatorV1alphaCreateOrgPolicyViolationsPreviewOperationMetadata: - description: >- - CreateOrgPolicyViolationsPreviewOperationMetadata is metadata about an - OrgPolicyViolationsPreview generations operation. + type: object + GoogleTypeDate: + id: GoogleTypeDate properties: - resourcesScanned: - description: Number of resources already scanned. + year: format: int32 type: integer - resourcesFound: description: >- - Total number of resources that need scanning. Should equal - resource_scanned + resources_pending + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + 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 + day: format: int32 - startTime: - type: string + type: integer description: >- - Time when the request started processing, i.e., when the state was - set to RUNNING. - format: google-datetime - requestTime: - type: string - format: google-datetime - description: Time when the request was received. - 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. - description: Output only. The current state of the operation. - readOnly: true + 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: >- + 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 + GoogleCloudPolicysimulatorV1ReplayConfig: + properties: + policyOverlay: + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleIamV1Policy' + 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. + logSource: enum: - - PREVIEW_STATE_UNSPECIFIED - - PREVIEW_PENDING - - PREVIEW_RUNNING - - PREVIEW_SUCCEEDED - - PREVIEW_FAILED + - LOG_SOURCE_UNSPECIFIED + - RECENT_ACCESSES type: string - resourcesPending: - description: Number of resources still to scan. - format: int32 - type: integer + description: The logs to use as input for the Replay. + 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. + description: The configuration used for a Replay. + id: GoogleCloudPolicysimulatorV1ReplayConfig type: object - id: >- - GoogleCloudPolicysimulatorV1alphaCreateOrgPolicyViolationsPreviewOperationMetadata - GoogleCloudOrgpolicyV2CustomConstraint: + GoogleCloudPolicysimulatorV1AccessTuple: 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*. properties: - updateTime: - readOnly: true - format: google-datetime + principal: 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 - actionType: - description: Allow or deny type. - type: string - enumDescriptions: - - Unspecified. Results in an error. - - Allowed action type. - - Deny action type. - enum: - - ACTION_TYPE_UNSPECIFIED - - ALLOW - - DENY - condition: + 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: >- - 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: - description: >- - Detailed information about this custom policy constraint. The max - length of the description is 2000 characters. + 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 - 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. + permission: type: string - methodTypes: - description: All the operations being applied for this constraint. - type: array - 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 - 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 - displayName: + 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. + GoogleCloudPolicysimulatorV1OrgPolicyOverlayPolicyOverlay: + description: A change to an OrgPolicy. + properties: + policy: + description: Optional. The new or updated OrgPolicy. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + policyParent: description: >- - One line display name for the UI. The max length of the display_name - is 200 characters. + Optional. The parent of the policy we are attaching to. Example: + "projects/123456" type: string - GoogleCloudPolicysimulatorV1ExplainedPolicy: type: object - id: GoogleCloudPolicysimulatorV1ExplainedPolicy + id: GoogleCloudPolicysimulatorV1OrgPolicyOverlayPolicyOverlay + GoogleCloudPolicysimulatorV1ReplayResult: properties: - relevance: + accessTuple: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1AccessTuple' 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. + The access tuple that was replayed. This field includes information + about the principal, resource, and permission that were involved in + the access attempt. + lastSeenDate: + $ref: '#/components/schemas/GoogleTypeDate' + description: The latest date this access tuple was seen in the logs. + parent: + description: The Replay that the access tuple was included in. type: string - enum: - - HEURISTIC_RELEVANCE_UNSPECIFIED - - NORMAL - - HIGH - access: + 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. + name: 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. 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 - policy: - $ref: '#/components/schemas/GoogleIamV1Policy' + 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` + error: + $ref: '#/components/schemas/GoogleRpcStatus' 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. - bindingExplanations: + 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 + id: GoogleCloudPolicysimulatorV1ReplayResult + description: The result of replaying a single access tuple against a simulated state. + GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsPreviewsResponse: + type: object + properties: + nextPageToken: + type: string 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. + A token that you can use to retrieve the next page of results. If + this field is omitted, there are no subsequent pages. + orgPolicyViolationsPreviews: + description: The list of OrgPolicyViolationsPreview type: array items: $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1BindingExplanation - fullResourceName: - type: string + #/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview + description: >- + ListOrgPolicyViolationsPreviewsResponse is the response message for + OrgPolicyViolationsPreviewService.ListOrgPolicyViolationsPreviews. + id: GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsPreviewsResponse + GoogleCloudPolicysimulatorV1ListReplayResultsResponse: + id: GoogleCloudPolicysimulatorV1ListReplayResultsResponse + properties: + replayResults: + items: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ReplayResult' + type: array + description: The results of running a Replay. + nextPageToken: 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. - description: Details about how a specific IAM Policy contributed to the access check. - GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreviewResourceCounts: + A token that you can use to retrieve the next page of ReplayResult + objects. If this field is omitted, there are no subsequent pages. + type: string + description: Response message for Simulator.ListReplayResults. + type: object + GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts: + id: >- + GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts description: >- A summary of the state of all resources scanned for compliance with the changed OrgPolicy. - type: object - id: GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreviewResourceCounts properties: - noncompliant: + errors: + type: integer description: >- - Output only. Number of scanned resources with at least one - violation. + Output only. Number of resources that returned an error when + scanned. + format: int32 readOnly: true + scanned: + description: >- + Output only. Number of resources checked for compliance. Must equal: + unenforced + noncompliant + compliant + error format: int32 type: integer - scanned: readOnly: true + compliant: + readOnly: true + description: Output only. Number of scanned resources with zero violations. format: int32 type: integer - description: >- - Output only. Number of resources checked for compliance. Must equal: - unenforced + noncompliant + compliant + error unenforced: - readOnly: true + format: int32 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 - errors: - readOnly: true + noncompliant: type: integer - format: int32 - description: >- - Output only. Number of resources that returned an error when - scanned. - compliant: readOnly: true + description: >- + Output only. Number of scanned resources with at least one + violation. format: int32 - type: integer - description: Output only. Number of scanned resources with zero violations. - GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts: - id: >- - GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts + type: object + GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay: + description: A change to an OrgPolicy. + type: object + 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" + id: GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay + GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsResponse: + description: >- + ListOrgPolicyViolationsResponse is the response message for + OrgPolicyViolationsPreviewService.ListOrgPolicyViolations + id: GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsResponse + properties: + nextPageToken: + type: string + description: >- + A token that you can use to retrieve the next page of results. If + this field is omitted, there are no subsequent pages. + orgPolicyViolations: + items: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyViolation + type: array + description: The list of OrgPolicyViolations + type: object + GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreviewResourceCounts: + id: GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreviewResourceCounts + type: object description: >- A summary of the state of all resources scanned for compliance with the changed OrgPolicy. properties: + noncompliant: + format: int32 + type: integer + description: >- + Output only. Number of scanned resources with at least one + violation. + readOnly: true + scanned: + description: >- + Output only. Number of resources checked for compliance. Must equal: + unenforced + noncompliant + compliant + error + type: integer + readOnly: true + 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 - type: integer errors: + readOnly: true + format: int32 type: integer description: >- Output only. Number of resources that returned an error when scanned. - format: int32 - readOnly: true compliant: - type: integer - format: int32 - readOnly: true description: Output only. Number of scanned resources with zero violations. - noncompliant: format: int32 readOnly: true type: integer + GoogleCloudPolicysimulatorV1OrgPolicyOverlayCustomConstraintOverlay: + description: A change to an OrgPolicy custom constraint. + type: object + properties: + customConstraintParent: + type: string description: >- - Output only. Number of scanned resources with at least one - violation. - scanned: - format: int32 - readOnly: true + Optional. Resource the constraint is attached to. Example: + "organization/987654" + customConstraint: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' + description: Optional. The new or updated custom constraint. + id: GoogleCloudPolicysimulatorV1OrgPolicyOverlayCustomConstraintOverlay + GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay: + id: GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay + description: A change to an OrgPolicy custom constraint. + properties: + customConstraint: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' + description: Optional. The new or updated custom constraint. + customConstraintParent: + type: string description: >- - Output only. Number of resources checked for compliance. Must equal: - unenforced + noncompliant + compliant + error - type: integer + Optional. Resource the constraint is attached to. Example: + "organization/987654" + type: object + GoogleCloudPolicysimulatorV1ResourceContext: + id: GoogleCloudPolicysimulatorV1ResourceContext + properties: + ancestors: + items: + type: string + type: array + description: >- + The ancestry path of the resource in Google Cloud [resource + hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy), + represented as a list of relative resource names. An ancestry path + starts with the closest ancestor in the hierarchy and ends at root. + If the resource is a project, folder, or organization, the ancestry + path starts from the resource itself. Example: + `["projects/123456789", "folders/5432", "organizations/1234"]` + assetType: + description: >- + The asset type of the resource as defined by CAIS. Example: + `compute.googleapis.com/Firewall` See [Supported asset + types](https://cloud.google.com/asset-inventory/docs/supported-asset-types) + for more information. + type: string + resource: + type: string + description: >- + The full name of the resource. Example: + `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1` + See [Resource + names](https://cloud.google.com/apis/design/resource_names#full_resource_name) + for more information. + type: object + description: >- + ResourceContext provides the context we know about a resource. It is + similar in concept to google.cloud.asset.v1.Resource, but focuses on the + information specifically used by Simulator. + GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay: + type: object + properties: + 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/GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay + 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. + description: The proposed changes to OrgPolicy. + id: GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay + 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. + 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: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + code: + format: int32 + type: integer + description: The status code, which should be an enum value of google.rpc.Code. GoogleLongrunningOperation: - id: GoogleLongrunningOperation 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 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: + response: 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. + description: Properties of the object. Contains field @type with type URL. 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}`. - response: description: >- The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is @@ -1824,279 +1872,237 @@ 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: - 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. - type: object - description: >- - This resource represents a long-running operation that is the result of - a network API call. - 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. - id: 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: - description: The configuration for logging of each type of permission. - type: array - items: - $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' - GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsResponse: - properties: - nextPageToken: - type: string + metadata: description: >- - A token that you can use to retrieve the next page of results. If - this field is omitted, there are no subsequent pages. - orgPolicyViolations: - items: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyViolation - description: The list of OrgPolicyViolations - type: array + 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. description: >- - ListOrgPolicyViolationsResponse is the response message for - OrgPolicyViolationsPreviewService.ListOrgPolicyViolations - type: object - id: GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsResponse - GoogleCloudPolicysimulatorV1ListReplayResultsResponse: - id: GoogleCloudPolicysimulatorV1ListReplayResultsResponse - description: Response message for Simulator.ListReplayResults. - 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. - GoogleCloudPolicysimulatorV1OrgPolicyOverlay: - id: GoogleCloudPolicysimulatorV1OrgPolicyOverlay - description: The proposed changes to OrgPolicy. + This resource represents a long-running operation that is the result of + a network API call. + id: GoogleLongrunningOperation + type: object + GoogleCloudPolicysimulatorV1betaGenerateOrgPolicyViolationsPreviewOperationMetadata: properties: - policies: - items: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyOverlayPolicyOverlay + resourcesScanned: + description: Number of resources already scanned. + type: integer + format: int32 + 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: + - PREVIEW_STATE_UNSPECIFIED + - PREVIEW_PENDING + - PREVIEW_RUNNING + - PREVIEW_SUCCEEDED + - PREVIEW_FAILED + description: The current state of the operation. + type: string + resourcesFound: + type: integer + format: int32 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: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyOverlayCustomConstraintOverlay + Total number of resources that need scanning. Should equal + resource_scanned + resources_pending + requestTime: + description: Time when the request was received. + type: string + format: google-datetime + startTime: + format: google-datetime + type: string 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. + Time when the request started processing, i.e. when the state was + set to RUNNING. + resourcesPending: + format: int32 + description: Number of resources still to scan. + type: integer + description: >- + GenerateOrgPolicyViolationsPreviewOperationMetadata is metadata about an + OrgPolicyViolationsPreview generations operation. type: object - GoogleCloudOrgpolicyV2PolicySpec: + id: >- + GoogleCloudPolicysimulatorV1betaGenerateOrgPolicyViolationsPreviewOperationMetadata + GoogleCloudPolicysimulatorV1alphaCreateOrgPolicyViolationsPreviewOperationMetadata: + id: >- + GoogleCloudPolicysimulatorV1alphaCreateOrgPolicyViolationsPreviewOperationMetadata type: object description: >- - Defines a Google Cloud policy specification which is used to specify - constraints for configurations of Google Cloud resources. + CreateOrgPolicyViolationsPreviewOperationMetadata is metadata about an + OrgPolicyViolationsPreview generations operation. properties: - inheritFromParent: + resourcesFound: + format: int32 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 - etag: + Total number of resources that need scanning. Should equal + resource_scanned + resources_pending + type: integer + resourcesScanned: + description: Number of resources already scanned. + type: integer + format: int32 + startTime: type: string + format: google-datetime 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. - 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. - updateTime: + Time when the request started processing, i.e., when the state was + set to RUNNING. + resourcesPending: + type: integer + format: int32 + description: Number of resources still to scan. + requestTime: type: string - readOnly: true + description: Time when the request was received. 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. - 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 - id: GoogleCloudOrgpolicyV2PolicySpec - GoogleCloudPolicysimulatorV1ReplayConfig: - id: GoogleCloudPolicysimulatorV1ReplayConfig - description: The configuration used for a Replay. + state: + enum: + - PREVIEW_STATE_UNSPECIFIED + - PREVIEW_PENDING + - PREVIEW_RUNNING + - PREVIEW_SUCCEEDED + - PREVIEW_FAILED + description: Output only. The current state of the operation. + readOnly: true + 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. + GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay: + description: A change to an OrgPolicy custom constraint. + type: object properties: - policyOverlay: - additionalProperties: - $ref: '#/components/schemas/GoogleIamV1Policy' - type: object + customConstraintParent: 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. - logSource: - enum: - - LOG_SOURCE_UNSPECIFIED - - RECENT_ACCESSES - description: The logs to use as input for the Replay. + Optional. Resource the constraint is attached to. Example: + "organization/987654" + type: string + customConstraint: + description: Optional. The new or updated custom constraint. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' + id: GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay + GoogleCloudPolicysimulatorV1AccessStateDiff: + properties: + accessChange: enumDescriptions: + - Default value. This value is unused. - >- - An unspecified log source. If the log source is unspecified, the - Replay defaults to using `RECENT_ACCESSES`. + The principal's access did not change. This includes the case + where both baseline and simulated are UNKNOWN, but the unknown + information is equivalent. - >- - All access logs from the last 90 days. These logs may not include - logs from the most recent 7 days. + 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 - type: object - GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay: - id: GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay - properties: - customConstraints: - items: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay + enum: + - ACCESS_CHANGE_TYPE_UNSPECIFIED + - NO_CHANGE + - UNKNOWN_CHANGE + - ACCESS_REVOKED + - ACCESS_GAINED + - ACCESS_MAYBE_REVOKED + - ACCESS_MAYBE_GAINED 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. - type: array - policies: - items: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay + How the principal's access, specified in the AccessState field, + changed between the current (baseline) policies and proposed + (simulated) policies. + simulated: + 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. + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ExplainedAccess' + baseline: + $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. - type: array + The results of evaluating the access tuple under the current + (baseline) policies. If the AccessState couldn't be fully evaluated, + this field explains why. + 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. type: object - description: The proposed changes to OrgPolicy. - GoogleRpcStatus: - id: GoogleRpcStatus + GoogleCloudOrgpolicyV2AlternatePolicySpec: + id: GoogleCloudOrgpolicyV2AlternatePolicySpec 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. + spec: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' + description: Specify constraint for configurations of Google Cloud resources. + launch: type: string - 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: - type: any - description: Properties of the object. Contains field @type with type URL. - 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). + 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: object + description: >- + Similar to PolicySpec but with an extra 'launch' field for launch + reference. The PolicySpec here is specific for dry-run/darklaunch. 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 - 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: 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"). + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: uploadType + name: upload_protocol schema: type: string fields: @@ -2105,306 +2111,300 @@ components: 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. + 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 - 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 - access_token: - description: OAuth access token. + enum: + - '1' + - '2' + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: access_token + name: oauth_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. + 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 - enum: - - json - - media - - proto x-stackQL-resources: operations: - id: policysimulator.operations + id: google.policysimulator.operations name: operations title: Operations methods: - projects_locations_org_policy_violations_previews_operations_get: + folders_locations_org_policy_violations_previews_operations_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews~1{orgPolicyViolationsPreviewsId}~1operations~1{operationsId}/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews~1{orgPolicyViolationsPreviewsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_replays_operations_list: + _folders_locations_replays_operations_list: operation: &ref_1 $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}~1operations/get response: &ref_2 mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_replays_operations_list: + folders_locations_replays_operations_list: operation: *ref_1 response: *ref_2 - projects_locations_replays_operations_get: + folders_locations_replays_operations_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations~1{operationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - operations_get: - operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}/get' + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - _operations_list: + _organizations_locations_replays_operations_list: operation: &ref_3 - $ref: '#/paths/~1v1~1operations/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations/get response: &ref_4 mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - operations_list: + organizations_locations_replays_operations_list: operation: *ref_3 response: *ref_4 - folders_locations_org_policy_violations_previews_operations_get: + organizations_locations_replays_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}~1replays~1{replaysId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - _folders_locations_replays_operations_list: + organizations_locations_org_policy_violations_previews_operations_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews~1{orgPolicyViolationsPreviewsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_replays_operations_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + _projects_locations_replays_operations_list: operation: &ref_5 $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}~1operations/get response: &ref_6 mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - folders_locations_replays_operations_list: + projects_locations_replays_operations_list: operation: *ref_5 response: *ref_6 - folders_locations_replays_operations_get: + projects_locations_org_policy_violations_previews_operations_get: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~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' - organizations_locations_replays_operations_get: + operations_get: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations~1{operationsId}/get + $ref: '#/paths/~1v1~1operations~1{operationsId}/get' response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_replays_operations_list: + _operations_list: operation: &ref_7 - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations/get + $ref: '#/paths/~1v1~1operations/get' response: &ref_8 mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - organizations_locations_replays_operations_list: + operations_list: operation: *ref_7 response: *ref_8 - organizations_locations_org_policy_violations_previews_operations_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews~1{orgPolicyViolationsPreviewsId}~1operations~1{operationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' sqlVerbs: select: - $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_list + #/components/x-stackQL-resources/operations/methods/folders_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/operations_get' + #/components/x-stackQL-resources/operations/methods/folders_locations_replays_operations_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/operations_list + #/components/x-stackQL-resources/operations/methods/organizations_locations_replays_operations_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/folders_locations_org_policy_violations_previews_operations_get + #/components/x-stackQL-resources/operations/methods/organizations_locations_org_policy_violations_previews_operations_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/folders_locations_replays_operations_list + #/components/x-stackQL-resources/operations/methods/projects_locations_replays_operations_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/folders_locations_replays_operations_get + #/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_get + #/components/x-stackQL-resources/operations/methods/folders_locations_replays_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/organizations_locations_replays_operations_list - $ref: >- - #/components/x-stackQL-resources/operations/methods/organizations_locations_org_policy_violations_previews_operations_get + #/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: [] delete: [] results: - id: policysimulator.results + id: google.policysimulator.results name: results title: Results methods: - _projects_locations_replays_results_list: + _folders_locations_replays_results_list: operation: &ref_9 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays~1{replaysId}~1results/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}~1results/get response: &ref_10 mediaType: application/json openAPIDocKey: '200' objectKey: $.replayResults - projects_locations_replays_results_list: + folders_locations_replays_results_list: operation: *ref_9 response: *ref_10 - _folders_locations_replays_results_list: + _organizations_locations_replays_results_list: operation: &ref_11 $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}~1results/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}~1results/get response: &ref_12 mediaType: application/json openAPIDocKey: '200' objectKey: $.replayResults - folders_locations_replays_results_list: + organizations_locations_replays_results_list: operation: *ref_11 response: *ref_12 - _organizations_locations_replays_results_list: + _projects_locations_replays_results_list: operation: &ref_13 $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}~1results/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays~1{replaysId}~1results/get response: &ref_14 mediaType: application/json openAPIDocKey: '200' objectKey: $.replayResults - organizations_locations_replays_results_list: + projects_locations_replays_results_list: operation: *ref_13 response: *ref_14 sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/results/methods/projects_locations_replays_results_list - $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: [] delete: [] replays: - id: policysimulator.replays + id: google.policysimulator.replays name: replays title: Replays methods: - 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' - folders_locations_replays_get: + organizations_locations_replays_create: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays/post response: mediaType: application/json openAPIDocKey: '200' - folders_locations_replays_create: + organizations_locations_replays_get: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}/get 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' - 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' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/replays/methods/projects_locations_replays_get - $ref: >- #/components/x-stackQL-resources/replays/methods/folders_locations_replays_get - $ref: >- #/components/x-stackQL-resources/replays/methods/organizations_locations_replays_get - insert: - $ref: >- - #/components/x-stackQL-resources/replays/methods/projects_locations_replays_create + #/components/x-stackQL-resources/replays/methods/projects_locations_replays_get + insert: - $ref: >- #/components/x-stackQL-resources/replays/methods/folders_locations_replays_create - $ref: >- #/components/x-stackQL-resources/replays/methods/organizations_locations_replays_create + - $ref: >- + #/components/x-stackQL-resources/replays/methods/projects_locations_replays_create update: [] delete: [] org_policy_violations_previews: - id: policysimulator.org_policy_violations_previews + id: google.policysimulator.org_policy_violations_previews name: org_policy_violations_previews title: Org_policy_violations_previews methods: - organizations_locations_org_policy_violations_previews_get: + organizations_locations_org_policy_violations_previews_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews~1{orgPolicyViolationsPreviewsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews/post response: mediaType: application/json openAPIDocKey: '200' @@ -2419,10 +2419,10 @@ components: organizations_locations_org_policy_violations_previews_list: operation: *ref_15 response: *ref_16 - organizations_locations_org_policy_violations_previews_create: + organizations_locations_org_policy_violations_previews_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews~1{orgPolicyViolationsPreviewsId}/get response: mediaType: application/json openAPIDocKey: '200' @@ -2438,7 +2438,7 @@ components: update: [] delete: [] org_policy_violations: - id: policysimulator.org_policy_violations + id: google.policysimulator.org_policy_violations name: org_policy_violations title: Org_policy_violations methods: @@ -2461,26 +2461,26 @@ components: update: [] delete: [] paths: - /v1/projects/{projectsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}: + /v1/folders/{foldersId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}: parameters: &ref_19 - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/quotaUser' 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.orgPolicyViolationsPreviews.operations.get + policysimulator.folders.locations.orgPolicyViolationsPreviews.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2495,7 +2495,7 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -2514,13 +2514,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/operations: + /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/operations: parameters: *ref_19 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 + operationId: policysimulator.folders.locations.replays.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2535,7 +2535,7 @@ paths: $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -2549,6 +2549,10 @@ paths: required: true schema: type: string + - in: query + name: filter + schema: + type: string - in: query name: pageToken schema: @@ -2558,18 +2562,14 @@ 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}/replays/{replaysId}/operations/{operationsId}: parameters: *ref_19 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 @@ -2584,7 +2584,7 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -2603,11 +2603,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/results: + /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/results: parameters: *ref_19 get: description: Lists the results of running a Replay. - operationId: policysimulator.projects.locations.replays.results.list + operationId: policysimulator.folders.locations.replays.results.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2623,7 +2623,7 @@ paths: #/components/schemas/GoogleCloudPolicysimulatorV1ListReplayResultsResponse parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -2637,20 +2637,20 @@ 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}/replays: + - in: query + name: pageToken + schema: + type: string + /v1/folders/{foldersId}/locations/{locationsId}/replays: parameters: *ref_19 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: @@ -2670,7 +2670,7 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -2679,13 +2679,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}: + /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}: parameters: *ref_19 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 @@ -2700,7 +2700,7 @@ paths: $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -2714,14 +2714,11 @@ paths: required: true schema: type: string - /v1/operations/{operationsId}: + /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/results: parameters: *ref_19 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 + description: Lists the results of running a Replay. + operationId: policysimulator.organizations.locations.replays.results.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2733,20 +2730,40 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1ListReplayResultsResponse parameters: - in: path - name: operationsId + name: organizationsId required: true schema: type: string - /v1/operations: + - in: path + name: locationsId + required: true + schema: + type: string + - 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/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/operations: parameters: *ref_19 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 + operationId: policysimulator.organizations.locations.replays.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2760,8 +2777,23 @@ paths: 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: path + name: replaysId + required: true + schema: + type: string - in: query - name: pageToken + name: filter schema: type: string - in: query @@ -2770,18 +2802,17 @@ paths: type: integer format: int32 - in: query - name: filter + name: pageToken schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}: + /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}: parameters: *ref_19 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.organizations.locations.replays.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2796,7 +2827,7 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -2806,7 +2837,7 @@ paths: schema: type: string - in: path - name: orgPolicyViolationsPreviewsId + name: replaysId required: true schema: type: string @@ -2815,13 +2846,16 @@ paths: required: true schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}: + /v1/organizations/{organizationsId}/locations/{locationsId}/replays: parameters: *ref_19 - get: - description: >- - Gets the specified Replay. Each `Replay` is available for at least 7 - days. - operationId: policysimulator.folders.locations.replays.get + 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 @@ -2833,10 +2867,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -2845,21 +2879,13 @@ paths: required: true schema: type: string - - in: path - name: replaysId - required: true - schema: - type: string - /v1/folders/{foldersId}/locations/{locationsId}/replays: + /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}: parameters: *ref_19 - 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' + get: + 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 @@ -2871,10 +2897,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -2883,11 +2909,28 @@ paths: required: true schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/results: + - in: path + name: replaysId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews: parameters: *ref_19 - get: - description: Lists the results of running a Replay. - operationId: policysimulator.folders.locations.replays.results.list + post: + description: >- + CreateOrgPolicyViolationsPreview creates an OrgPolicyViolationsPreview + for the proposed changes in the provided + OrgPolicyViolationsPreview.OrgPolicyOverlay. The changes to OrgPolicy + are specified by this `OrgPolicyOverlay`. The resources to scan are + inferred from these specified changes. + operationId: >- + policysimulator.organizations.locations.orgPolicyViolationsPreviews.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2899,40 +2942,28 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1ListReplayResultsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string - in: path name: locationsId - required: true - schema: - type: string - - in: path - name: replaysId - required: true - schema: - type: string - - in: query - name: pageToken + required: true schema: type: string - in: query - name: pageSize + name: orgPolicyViolationsPreviewId schema: - type: integer - format: int32 - /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/operations: - parameters: *ref_19 + 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: policysimulator.folders.locations.replays.operations.list + ListOrgPolicyViolationsPreviews lists each OrgPolicyViolationsPreview in + an organization. Each OrgPolicyViolationsPreview is available for at + least 7 days. + operationId: policysimulator.organizations.locations.orgPolicyViolationsPreviews.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2944,10 +2975,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsPreviewsResponse parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -2956,11 +2988,6 @@ paths: required: true schema: type: string - - in: path - name: replaysId - required: true - schema: - type: string - in: query name: pageSize schema: @@ -2970,18 +2997,14 @@ paths: name: pageToken schema: type: string - - in: query - name: filter - schema: - type: string - /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}: + /v1/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}: parameters: *ref_19 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 + GetOrgPolicyViolationsPreview gets the specified + OrgPolicyViolationsPreview. Each OrgPolicyViolationsPreview is available + for at least 7 days. + operationId: policysimulator.organizations.locations.orgPolicyViolationsPreviews.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2993,10 +3016,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -3006,20 +3030,18 @@ paths: schema: type: string - in: path - name: replaysId - required: true - schema: - type: string - - in: path - name: operationsId + name: orgPolicyViolationsPreviewsId required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/results: + /v1/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/orgPolicyViolations: parameters: *ref_19 get: - description: Lists the results of running a Replay. - operationId: policysimulator.organizations.locations.replays.results.list + description: >- + ListOrgPolicyViolations lists the OrgPolicyViolations that are present + in an OrgPolicyViolationsPreview. + operationId: >- + policysimulator.organizations.locations.orgPolicyViolationsPreviews.orgPolicyViolations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3032,7 +3054,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1ListReplayResultsResponse + #/components/schemas/GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsResponse parameters: - in: path name: organizationsId @@ -3045,27 +3067,28 @@ paths: schema: type: string - in: path - name: replaysId + name: orgPolicyViolationsPreviewsId 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/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}: + /v1/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}: parameters: *ref_19 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.organizations.locations.orgPolicyViolationsPreviews.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3090,7 +3113,7 @@ paths: schema: type: string - in: path - name: replaysId + name: orgPolicyViolationsPreviewsId required: true schema: type: string @@ -3099,13 +3122,13 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/operations: + /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}: parameters: *ref_19 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 + 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 @@ -3117,10 +3140,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -3134,24 +3157,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 - /v1/organizations/{organizationsId}/locations/{locationsId}/replays: + /v1/projects/{projectsId}/locations/{locationsId}/replays: parameters: *ref_19 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: @@ -3171,7 +3181,7 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -3180,13 +3190,14 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}: + /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}: parameters: *ref_19 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.projects.locations.replays.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3198,10 +3209,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -3215,14 +3226,18 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/operations: parameters: *ref_19 get: description: >- - GetOrgPolicyViolationsPreview gets the specified - OrgPolicyViolationsPreview. Each OrgPolicyViolationsPreview is available - for at least 7 days. - operationId: policysimulator.organizations.locations.orgPolicyViolationsPreviews.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 @@ -3234,11 +3249,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -3248,18 +3262,28 @@ paths: schema: type: string - in: path - name: orgPolicyViolationsPreviewsId + name: replaysId required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews: + - 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: parameters: *ref_19 get: - description: >- - ListOrgPolicyViolationsPreviews lists each OrgPolicyViolationsPreview in - an organization. Each OrgPolicyViolationsPreview is available for at - least 7 days. - operationId: policysimulator.organizations.locations.orgPolicyViolationsPreviews.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 @@ -3272,10 +3296,10 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsPreviewsResponse + #/components/schemas/GoogleCloudPolicysimulatorV1ListReplayResultsResponse parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -3284,6 +3308,11 @@ paths: required: true schema: type: string + - in: path + name: replaysId + required: true + schema: + type: string - in: query name: pageToken schema: @@ -3293,21 +3322,15 @@ paths: schema: type: integer format: int32 - post: + /v1/projects/{projectsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}: + parameters: *ref_19 + get: description: >- - CreateOrgPolicyViolationsPreview creates an OrgPolicyViolationsPreview - for the proposed changes in the provided - OrgPolicyViolationsPreview.OrgPolicyOverlay. The changes to OrgPolicy - are specified by this `OrgPolicyOverlay`. The resources to scan are - inferred from these specified changes. + Gets the latest 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.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview + policysimulator.projects.locations.orgPolicyViolationsPreviews.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3322,7 +3345,7 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -3331,19 +3354,24 @@ paths: required: true schema: type: string - - in: query - name: orgPolicyViolationsPreviewId + - in: path + 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_19 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 @@ -3357,34 +3385,18 @@ paths: 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: orgPolicyViolationsPreviewsId - required: true - schema: - type: string - in: path name: operationsId required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/orgPolicyViolations: + /v1/operations: parameters: *ref_19 get: description: >- - ListOrgPolicyViolations lists the OrgPolicyViolations that are present - in an OrgPolicyViolationsPreview. - operationId: >- - policysimulator.organizations.locations.orgPolicyViolationsPreviews.orgPolicyViolations.list + 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 @@ -3396,22 +3408,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: orgPolicyViolationsPreviewsId - required: true + - in: query + name: pageToken schema: type: string - in: query @@ -3420,6 +3420,6 @@ paths: type: integer format: int32 - in: query - name: pageToken + name: filter 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 e84fde5b..5a186792 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: '20240526' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/iam/ servers: @@ -34,58 +34,11 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudPolicytroubleshooterV1AccessTuple: - type: object - description: Information about the principal, resource, and permission to check. - id: GoogleCloudPolicytroubleshooterV1AccessTuple - properties: - principal: - 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. - type: string - 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: - 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 - GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyRequest: - id: GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyRequest - properties: - accessTuple: - $ref: '#/components/schemas/GoogleCloudPolicytroubleshooterV1AccessTuple' - description: >- - The information to use for checking whether a principal has a - permission for a resource. + GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership: type: object - description: Request for TroubleshootIamPolicy. - GoogleCloudPolicytroubleshooterV1BindingExplanation: - id: GoogleCloudPolicytroubleshooterV1BindingExplanation + description: Details about whether the binding includes the principal. properties: - rolePermissionRelevance: - enum: - - HEURISTIC_RELEVANCE_UNSPECIFIED - - NORMAL - - HIGH - type: string - description: >- - The relevance of the permission's existence, or nonexistence, in the - role to the overall determination for the entire policy. + relevance: enumDescriptions: - Default value. This value is unused. - >- @@ -94,128 +47,45 @@ components: - >- The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination. - 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 sender of the request does not have access to all of the - policies that Policy Troubleshooter needs to evaluate. enum: - - ACCESS_STATE_UNSPECIFIED - - GRANTED - - NOT_GRANTED - - UNKNOWN_CONDITIONAL - - UNKNOWN_INFO_DENIED - 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. + - HEURISTIC_RELEVANCE_UNSPECIFIED + - NORMAL + - HIGH type: string - 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: - 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. description: >- - Indicates whether the role granted by this binding contains the - specified permission. + The relevance of the principal's status to the overall determination + for the binding. + membership: enum: - - ROLE_PERMISSION_UNSPECIFIED - - ROLE_PERMISSION_INCLUDED - - ROLE_PERMISSION_NOT_INCLUDED - - ROLE_PERMISSION_UNKNOWN_INFO_DENIED - type: string - role: + - MEMBERSHIP_UNSPECIFIED + - MEMBERSHIP_INCLUDED + - MEMBERSHIP_NOT_INCLUDED + - MEMBERSHIP_UNKNOWN_INFO_DENIED + - MEMBERSHIP_UNKNOWN_UNSUPPORTED 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. - relevance: - enum: - - HEURISTIC_RELEVANCE_UNSPECIFIED - - NORMAL - - HIGH + description: Indicates whether the binding includes the principal. 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 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 data point has a strong effect on the result. Changing the - data point is likely to affect the overall determination. - description: >- - The relevance of this binding to the overall determination for the - entire policy. - type: string - 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' - type: object - description: >- - Details about how a binding in a policy affects a principal's ability to - use a permission. + The principal is an unsupported type. Only Google Accounts and + service accounts are supported. + id: GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership GoogleIamV1Binding: + id: GoogleIamV1Binding + description: Associates `members`, or principals, with a `role`. properties: - 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' - 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: type: string - type: array description: >- Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A @@ -275,98 +145,84 @@ 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: object - id: GoogleIamV1Binding - description: Associates `members`, or principals, with a `role`. - 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: - description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. - type: string - title: + condition: 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: + 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' + role: type: string description: >- - Textual representation of an expression in Common Expression - Language syntax. - 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. + 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: object - GoogleRpcStatus: + GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyRequest: type: object + id: GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyRequest + description: Request for TroubleshootIamPolicy. properties: - code: - description: The status code, which should be an enum value of google.rpc.Code. - type: integer - format: int32 - message: + accessTuple: 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. + The information to use for checking whether a principal has a + permission for a resource. + $ref: '#/components/schemas/GoogleCloudPolicytroubleshooterV1AccessTuple' + GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse: + id: GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse + properties: + access: + enum: + - ACCESS_STATE_UNSPECIFIED + - GRANTED + - NOT_GRANTED + - UNKNOWN_CONDITIONAL + - UNKNOWN_INFO_DENIED + description: >- + Indicates whether the principal has the specified permission for the + specified resource, based on evaluating all of the applicable IAM + policies. type: string - details: + 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. + errors: + description: The general errors contained in the troubleshooting response. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + explainedPolicies: description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. + 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: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object + $ref: >- + #/components/schemas/GoogleCloudPolicytroubleshooterV1ExplainedPolicy 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). - id: GoogleRpcStatus - GoogleIamV1AuditConfig: - id: GoogleIamV1AuditConfig + description: Response for TroubleshootIamPolicy. type: object - properties: - auditLogConfigs: - items: - $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' - description: The configuration for logging of each type of permission. - type: array - 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. + GoogleIamV1AuditConfig: description: >- Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if @@ -385,129 +241,164 @@ 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. - GoogleIamV1Policy: + id: GoogleIamV1AuditConfig properties: - version: - 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). - type: integer - 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. + service: type: string - format: byte - auditConfigs: - items: - $ref: '#/components/schemas/GoogleIamV1AuditConfig' - description: Specifies cloud audit logging configuration for this policy. - type: array - 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`. + 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/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/). + $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' type: object - id: GoogleIamV1Policy - GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse: + GoogleCloudPolicytroubleshooterV1AccessTuple: + description: Information about the principal, resource, and permission to check. type: object - id: GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse + id: GoogleCloudPolicytroubleshooterV1AccessTuple properties: - explainedPolicies: + principal: + type: string 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: + 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. + 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 + description: >- + 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 + 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 + 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. + GoogleCloudPolicytroubleshooterV1BindingExplanation: + id: GoogleCloudPolicytroubleshooterV1BindingExplanation + properties: + memberships: + 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`. + additionalProperties: $ref: >- - #/components/schemas/GoogleCloudPolicytroubleshooterV1ExplainedPolicy - type: array - access: + #/components/schemas/GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership + rolePermission: + type: string enum: - - ACCESS_STATE_UNSPECIFIED - - GRANTED - - NOT_GRANTED - - UNKNOWN_CONDITIONAL - - UNKNOWN_INFO_DENIED + - 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. + 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 + - 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 this binding to the overall determination for the + entire policy. type: string + role: description: >- - Indicates whether the principal has the specified permission for the - specified resource, based on evaluating all of the applicable IAM - policies. + 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 + 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. @@ -518,52 +409,23 @@ components: - >- The sender of the request does not have access to all of the policies that Policy Troubleshooter needs to evaluate. - errors: - description: The general errors contained in the troubleshooting response. - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - description: Response for TroubleshootIamPolicy. - 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: - 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' - 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 - type: object - GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership: - id: GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership - type: object - description: Details about whether the binding includes the principal. - properties: - relevance: + - ACCESS_STATE_UNSPECIFIED + - GRANTED + - NOT_GRANTED + - UNKNOWN_CONDITIONAL + - UNKNOWN_INFO_DENIED + condition: description: >- - The relevance of the principal's status to the overall determination - for the binding. - type: string + 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' + rolePermissionRelevance: + description: >- + The relevance of the permission's existence, or nonexistence, in the + role to the overall determination for the entire policy. enumDescriptions: - Default value. This value is unused. - >- @@ -572,41 +434,100 @@ 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 - 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. + description: >- + Details about how a binding in a policy affects a principal's ability to + use a permission. + type: object + 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: + 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 + code: + format: int32 + description: The status code, which should be an enum value of google.rpc.Code. + 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. + 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: + 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: enum: - - MEMBERSHIP_UNSPECIFIED - - MEMBERSHIP_INCLUDED - - MEMBERSHIP_NOT_INCLUDED - - MEMBERSHIP_UNKNOWN_INFO_DENIED - - MEMBERSHIP_UNKNOWN_UNSUPPORTED - GoogleCloudPolicytroubleshooterV1ExplainedPolicy: - description: Details about how a specific IAM Policy contributed to the access check. + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + type: string + 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: object + id: GoogleIamV1AuditLogConfig + GoogleCloudPolicytroubleshooterV1ExplainedPolicy: properties: + 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. + 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 sender of the request does not have access to the policy, this + field is omitted. + items: + $ref: >- + #/components/schemas/GoogleCloudPolicytroubleshooterV1BindingExplanation + type: array relevance: enum: - HEURISTIC_RELEVANCE_UNSPECIFIED - NORMAL - HIGH + type: string enumDescriptions: - Default value. This value is unused. - >- @@ -619,22 +540,6 @@ components: 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 - 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. - 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. - items: - $ref: >- - #/components/schemas/GoogleCloudPolicytroubleshooterV1BindingExplanation access: enumDescriptions: - Default value. This value is unused. @@ -647,6 +552,12 @@ components: 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 description: >- Indicates whether _this policy_ provides the specified permission to the specified principal for the specified resource. This field does @@ -655,14 +566,7 @@ components: 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: - 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`. @@ -670,45 +574,147 @@ 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. + type: string + description: Details about how a specific IAM Policy contributed to the access check. + type: object id: GoogleCloudPolicytroubleshooterV1ExplainedPolicy + GoogleIamV1Policy: + 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/). + properties: + 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: + 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: + items: + $ref: '#/components/schemas/GoogleIamV1AuditConfig' + description: Specifies cloud audit logging configuration for this policy. + type: array + etag: + description: >- + `etag` is used for optimistic concurrency control as a way to help + prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the `etag` + in the read-modify-write cycle to perform policy updates in order to + avoid race conditions: An `etag` is returned in the response to + `getIamPolicy`, and systems are expected to put that etag in the + request to `setIamPolicy` to ensure that their change will be + applied to the same version of the policy. **Important:** If you use + IAM Conditions, you must include the `etag` field whenever you call + `setIamPolicy`. If you omit this field, then IAM allows you to + overwrite a version `3` policy with a version `1` policy, and all of + the conditions in the version `3` policy are lost. + type: string + format: byte + type: object parameters: + _.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 - 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 - 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. + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: fields + name: prettyPrint schema: - type: string - _.xgafv: - description: V1 error format. + type: boolean + alt: + description: Data format for response. in: query - name: $.xgafv + name: alt schema: type: string enum: - - '1' - - '2' + - json + - media + - proto key: description: >- API key. Your API key identifies your project and provides you with API @@ -718,16 +724,10 @@ components: name: key schema: type: string - callback: - description: JSONP - in: query - 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 quotaUser: @@ -739,21 +739,21 @@ components: name: quotaUser 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 - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean x-stackQL-resources: iam: - id: policytroubleshooter.iam + id: google.policytroubleshooter.iam name: iam title: Iam methods: @@ -771,17 +771,17 @@ components: paths: /v1/iam:troubleshoot: parameters: + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/prettyPrint' post: description: >- Checks whether a principal has a specific permission for a specific 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 2b11424a..17a41be2 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/privateca.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/privateca.yaml @@ -12,7 +12,7 @@ info: keys. version: v1 x-discovery-doc-revision: '20240515' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/ servers: @@ -2471,7 +2471,7 @@ components: - '2' x-stackQL-resources: locations: - id: privateca.locations + id: google.privateca.locations name: locations title: Locations methods: @@ -2493,13 +2493,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: privateca.operations + id: google.privateca.operations name: operations title: Operations methods: @@ -2537,14 +2537,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' ca_pools: - id: privateca.ca_pools + id: google.privateca.ca_pools name: ca_pools title: Ca_pools methods: @@ -2589,15 +2589,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/ca_pools/methods/list' - $ref: '#/components/x-stackQL-resources/ca_pools/methods/get' + - $ref: '#/components/x-stackQL-resources/ca_pools/methods/list' insert: - $ref: '#/components/x-stackQL-resources/ca_pools/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/ca_pools/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/ca_pools/methods/delete' ca_pools_ca_certs: - id: privateca.ca_pools_ca_certs + id: google.privateca.ca_pools_ca_certs name: ca_pools_ca_certs title: Ca_pools_ca_certs methods: @@ -2614,7 +2615,7 @@ components: update: [] delete: [] ca_pools_iam_policies: - id: privateca.ca_pools_iam_policies + id: google.privateca.ca_pools_iam_policies name: ca_pools_iam_policies title: Ca_pools_iam_policies methods: @@ -2651,7 +2652,7 @@ components: update: [] delete: [] certificates: - id: privateca.certificates + id: google.privateca.certificates name: certificates title: Certificates methods: @@ -2696,14 +2697,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/certificates/methods/list' - $ref: '#/components/x-stackQL-resources/certificates/methods/get' + - $ref: '#/components/x-stackQL-resources/certificates/methods/list' insert: - $ref: '#/components/x-stackQL-resources/certificates/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/certificates/methods/patch' delete: [] certificate_authorities: - id: privateca.certificate_authorities + id: google.privateca.certificate_authorities name: certificate_authorities title: Certificate_authorities methods: @@ -2783,19 +2785,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/certificate_authorities/methods/list - $ref: >- #/components/x-stackQL-resources/certificate_authorities/methods/get + - $ref: >- + #/components/x-stackQL-resources/certificate_authorities/methods/list insert: - $ref: >- #/components/x-stackQL-resources/certificate_authorities/methods/create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/certificate_authorities/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/certificate_authorities/methods/delete certificate_revocation_lists: - id: privateca.certificate_revocation_lists + id: google.privateca.certificate_revocation_lists name: certificate_revocation_lists title: Certificate_revocation_lists methods: @@ -2831,10 +2835,12 @@ components: - $ref: >- #/components/x-stackQL-resources/certificate_revocation_lists/methods/list insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/certificate_revocation_lists/methods/patch delete: [] certificate_revocation_lists_iam_policies: - id: privateca.certificate_revocation_lists_iam_policies + id: google.privateca.certificate_revocation_lists_iam_policies name: certificate_revocation_lists_iam_policies title: Certificate_revocation_lists_iam_policies methods: @@ -2871,7 +2877,7 @@ components: update: [] delete: [] certificate_templates: - id: privateca.certificate_templates + id: google.privateca.certificate_templates name: certificate_templates title: Certificate_templates methods: @@ -2916,18 +2922,20 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/certificate_templates/methods/get' - $ref: >- #/components/x-stackQL-resources/certificate_templates/methods/list - - $ref: '#/components/x-stackQL-resources/certificate_templates/methods/get' insert: - $ref: >- #/components/x-stackQL-resources/certificate_templates/methods/create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/certificate_templates/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/certificate_templates/methods/delete certificate_templates_iam_policies: - id: privateca.certificate_templates_iam_policies + id: google.privateca.certificate_templates_iam_policies name: certificate_templates_iam_policies title: Certificate_templates_iam_policies methods: 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 66ff6fc0..5606114d 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 @@ -8,7 +8,7 @@ info: description: '' version: v1alpha1 x-discovery-doc-revision: '20240523' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' 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,174 +35,52 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - SasPortalProvisionDeploymentResponse: + SasPortalSignDeviceRequest: properties: - errorMessage: + device: + $ref: '#/components/schemas/SasPortalDevice' description: >- - Optional. Optional error message if the provisioning request is not - successful. - type: string - description: >- - Response for [ProvisionDeployment]. - [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. - id: SasPortalProvisionDeploymentResponse - type: object - SasPortalDeviceConfig: - description: Information about the device configuration. - id: SasPortalDeviceConfig + 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 + description: Request for SignDevice. type: object + SasPortalNode: + id: SasPortalNode properties: - callSign: - type: string - description: The call sign of the device operator. - isSigned: - type: boolean - description: Output only. Whether the configuration has been signed by a CPI. - userId: - type: string - description: The identifier of a device user. - model: - $ref: '#/components/schemas/SasPortalDeviceModel' - description: Information about this device model. - state: - enum: - - DEVICE_CONFIG_STATE_UNSPECIFIED - - DRAFT - - FINAL - enumDescriptions: - - '' - - '' - - '' - type: string - description: State of the configuration. - updateTime: - format: google-datetime - type: string - description: Output only. The last time the device configuration was edited. - airInterface: - $ref: '#/components/schemas/SasPortalDeviceAirInterface' - description: Information about this device's air interface. - installationParams: - $ref: '#/components/schemas/SasPortalInstallationParams' - description: Installation parameters for the device. - measurementCapabilities: - description: Measurement reporting capabilities of the device. + sasUserIds: + description: User ids used by the devices belonging to this node. items: - enum: - - MEASUREMENT_CAPABILITY_UNSPECIFIED - - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT - - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT type: string - enumDescriptions: - - '' - - '' - - '' type: array - category: - enumDescriptions: - - Unspecified device category. - - Category A. - - Category B. - description: FCC category of the device. - enum: - - DEVICE_CATEGORY_UNSPECIFIED - - DEVICE_CATEGORY_A - - DEVICE_CATEGORY_B + name: + description: Output only. Resource name. type: string - SasPortalSetPolicyRequest: - type: object - description: Request message for `SetPolicy` method. - id: SasPortalSetPolicyRequest - properties: - policy: - description: Required. The policy to be applied to the `resource`. - $ref: '#/components/schemas/SasPortalPolicy' - resource: + displayName: type: string - description: >- - Required. The resource for which the policy is being specified. This - policy replaces any existing policy. - disableNotification: - type: boolean - description: >- - Optional. Set the field as `true` to disable the onboarding - notification. - SasPortalDpaMoveList: - id: SasPortalDpaMoveList + description: The node's display name. type: object - description: An entry in a DPA's move list. - properties: - dpaId: - type: string - description: The ID of the DPA. - frequencyRange: - description: The frequency range that the move list affects. - $ref: '#/components/schemas/SasPortalFrequencyRange' - SasPortalMigrateOrganizationMetadata: + description: The Node. + SasPortalListLegacyOrganizationsResponse: type: object description: >- - Long-running operation metadata message returned by the - MigrateOrganization. - id: SasPortalMigrateOrganizationMetadata - properties: - operationState: - readOnly: true - type: string - 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 - SasPortalDeployment: + Response for [ListLegacyOrganizations]. + [spectrum.sas.portal.v1alpha1.Provisioning.ListLegacyOrganizations]. properties: - name: - description: Output only. Resource name. - type: string - readOnly: true - 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. - type: array - displayName: - description: The deployment's display name. - type: string - frns: + organizations: items: - type: string - readOnly: true - description: >- - Output only. The FCC Registration Numbers (FRNs) copied from its - direct parent. + $ref: '#/components/schemas/SasPortalOrganization' + description: Optional. Legacy SAS organizations. type: array - id: SasPortalDeployment - type: object - description: The Deployment. - 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 - id: SasPortalSignDeviceRequest - description: Request for SignDevice. + id: SasPortalListLegacyOrganizationsResponse SasPortalPolicy: + type: object + id: SasPortalPolicy description: Defines an access control policy to the resources. properties: etag: format: byte + type: string description: >- The etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each @@ -213,173 +91,173 @@ components: 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: - type: array description: List of assignments + type: array items: $ref: '#/components/schemas/SasPortalAssignment' - id: SasPortalPolicy - type: object - SasPortalSetupSasAnalyticsRequest: - properties: - userId: - type: string - description: >- - Optional. User id to setup analytics for, if not provided the user - id associated with the project is used. optional - description: Request for the SetupSasAnalytics rpc. - id: SasPortalSetupSasAnalyticsRequest - type: object - SasPortalGenerateSecretRequest: - description: Request for GenerateSecret. - properties: {} - id: SasPortalGenerateSecretRequest - type: object - SasPortalEmpty: - properties: {} - id: SasPortalEmpty + SasPortalDeviceGrant: 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); } - SasPortalNrqzValidation: - id: SasPortalNrqzValidation - description: Information about National Radio Quiet Zone validation. + id: SasPortalDeviceGrant properties: - cpiId: - type: string - description: CPI who signed the validation. - longitude: - format: double - type: number - description: Device longitude that's associated with the validation. state: type: string enumDescriptions: - - Unspecified state. - - Draft state. - - Final state. + - '' + - >- + 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: - - STATE_UNSPECIFIED - - DRAFT - - FINAL - description: State of the NRQZ validation info. - caseId: - type: string - description: Validation case ID. - latitude: - type: number - description: Device latitude that's associated with the validation. + - GRANT_STATE_UNSPECIFIED + - GRANT_STATE_GRANTED + - GRANT_STATE_TERMINATED + - GRANT_STATE_SUSPENDED + - GRANT_STATE_AUTHORIZED + - GRANT_STATE_EXPIRED + description: State of the grant. + frequencyRange: + $ref: '#/components/schemas/SasPortalFrequencyRange' + description: The transmission frequency range. + maxEirp: format: double - type: object - SasPortalMigrateOrganizationResponse: - description: >- - Response for [MigrateOrganization]. - [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. - id: SasPortalMigrateOrganizationResponse - properties: - deploymentAssociation: - items: - $ref: '#/components/schemas/SasPortalDeploymentAssociation' + type: number description: >- - Optional. A list of deployment association that were created for the - migration, or current associations if they already exist. + 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). + lastHeartbeatTransmitExpireTime: + description: The transmit expiration time of the last heartbeat. + format: google-datetime + type: string + grantId: + type: string + description: Grant Id. + moveList: + description: The DPA move lists on which this grant appears. type: array - type: object - SasPortalListLegacyOrganizationsResponse: - id: SasPortalListLegacyOrganizationsResponse - properties: - organizations: items: - $ref: '#/components/schemas/SasPortalOrganization' - description: Optional. Legacy SAS organizations. + $ref: '#/components/schemas/SasPortalDpaMoveList' + expireTime: + type: string + format: google-datetime + description: The expiration time of the grant. + channelType: + type: string + enum: + - CHANNEL_TYPE_UNSPECIFIED + - CHANNEL_TYPE_GAA + - CHANNEL_TYPE_PAL + description: Type of channel used. + enumDescriptions: + - '' + - '' + - '' + suspensionReason: + description: If the grant is suspended, the reason(s) for suspension. type: array + items: + type: string description: >- - Response for [ListLegacyOrganizations]. - [spectrum.sas.portal.v1alpha1.Provisioning.ListLegacyOrganizations]. - type: object - SasPortalSetupSasAnalyticsResponse: - type: object - description: >- - Response returned by the long running operation for the - SetupSasAnalytics rpc. - properties: {} - id: SasPortalSetupSasAnalyticsResponse + 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. SasPortalInstallationParams: - type: object description: Information about the device installation parameters. + type: object properties: - antennaAzimuth: - format: int32 - type: integer + antennaModel: + 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. + If an external antenna is used, the antenna model is optionally + provided in this field. The string has a maximum length of 128 + octets. verticalAccuracy: - type: number - 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. - antennaDowntilt: + type: number + format: double + 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. + antennaBeamwidth: 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 + 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 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. + format: double + type: number indoorDeployment: type: boolean description: >- Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. - cpeCbsdIndication: - description: >- - If present, this parameter specifies whether the CBSD is a CPE-CBSD - or not. - type: boolean antennaGain: - format: double - 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 + type: number 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: integer + horizontalAccuracy: format: double + 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 + cpeCbsdIndication: 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. + If present, this parameter specifies whether the CBSD is a CPE-CBSD + or not. + type: boolean + antennaAzimuth: + 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. + format: int32 + 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. heightType: - description: Specifies how the height is measured. enum: - HEIGHT_TYPE_UNSPECIFIED - HEIGHT_TYPE_AGL @@ -389,39 +267,17 @@ components: - AGL height is measured relative to the ground level. - AMSL height is measured relative to the mean sea level. type: string - 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 - 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 - 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 + description: Specifies how the height is measured. + antennaDowntilt: format: int32 - height: + type: integer 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 + 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. id: SasPortalInstallationParams SasPortalFrequencyRange: - id: SasPortalFrequencyRange - description: Frequency range from `low_frequency` to `high_frequency`. type: object properties: highFrequencyMhz: @@ -429,58 +285,78 @@ components: description: The highest frequency of the frequency range in MHz. type: number lowFrequencyMhz: - format: double - description: The lowest frequency of the frequency range in MHz. type: number + description: The lowest frequency of the frequency range in MHz. + format: double + id: SasPortalFrequencyRange + description: Frequency range from `low_frequency` to `high_frequency`. + SasPortalListDevicesResponse: + description: Response for ListDevices. + properties: + devices: + type: array + description: The devices that match the request. + items: + $ref: '#/components/schemas/SasPortalDevice' + 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 + type: object + id: SasPortalListDevicesResponse SasPortalOrganization: type: object + id: SasPortalOrganization description: Organization details. properties: - id: - description: Id of organization - format: int64 - type: string displayName: type: string description: Name of organization - id: SasPortalOrganization - SasPortalMoveDeploymentRequest: - id: SasPortalMoveDeploymentRequest - description: Request for MoveDeployment. - type: object - properties: - destination: + id: type: string - description: >- - Required. The name of the new parent resource node or customer to - reparent the deployment under. - SasPortalDeviceAirInterface: - description: Information about the device's air interface. + format: int64 + description: Id of organization + SasPortalDeviceMetadata: type: object - id: SasPortalDeviceAirInterface properties: - supportedSpec: + commonChannelGroup: 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. + 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 + nrqzValidation: + $ref: '#/components/schemas/SasPortalNrqzValidation' + readOnly: true + description: Output only. National Radio Quiet Zone validation info. + antennaModel: type: string - radioTechnology: description: >- - Conditional. This field specifies the radio access technology that - is used for the CBSD. + If populated, the Antenna Model Pattern to use. Format is: + `RecordCreatorId:PatternId` + interferenceCoordinationGroup: type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: + 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). + 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 + id: SasPortalDeviceMetadata + description: Device data overridable by both SAS Portal and registration requests. + SasPortalDeviceAirInterface: + properties: + radioTechnology: + enum: - RADIO_TECHNOLOGY_UNSPECIFIED - E_UTRA - CAMBIUM_NETWORKS @@ -490,339 +366,237 @@ components: - CW - REDLINE - TARANA_WIRELESS - SasPortalMigrateOrganizationRequest: + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + description: >- + Conditional. This field specifies the radio access technology that + is used for the CBSD. + supportedSpec: + 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. + type: object + id: SasPortalDeviceAirInterface + SasPortalMigrateOrganizationResponse: + properties: + deploymentAssociation: + type: array + items: + $ref: '#/components/schemas/SasPortalDeploymentAssociation' + description: >- + Optional. A list of deployment association that were created for the + migration, or current associations if they already exist. + type: object + id: SasPortalMigrateOrganizationResponse 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 + Response for [MigrateOrganization]. + [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. + SasPortalTestPermissionsRequest: properties: - organizationId: - description: Required. Id of the SAS organization to be migrated. - format: int64 + 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. + id: SasPortalTestPermissionsRequest type: object + description: Request message for `TestPermissions` method. SasPortalListCustomersResponse: - type: object properties: customers: + type: array + description: The list of customers that match the request. items: $ref: '#/components/schemas/SasPortalCustomer' - description: The list of customers that match the request. - type: array 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. - description: Response for `ListCustomers`. id: SasPortalListCustomersResponse - SasPortalTestPermissionsResponse: - id: SasPortalTestPermissionsResponse - properties: - permissions: - description: A set of permissions that the caller is allowed. - type: array - items: - type: string - description: Response message for `TestPermissions` method. + description: Response for `ListCustomers`. type: object - SasPortalAssignment: - id: SasPortalAssignment - description: Associates `members` with a `role`. + SasPortalChannelWithScore: type: object + description: The channel with score. 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 - SasPortalDeploymentAssociation: + 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 + id: SasPortalChannelWithScore + SasPortalMigrateOrganizationMetadata: + type: object properties: - userId: - type: string - description: User id of the deployment. - gcpProjectId: - description: GCP project id of the associated project. + operationState: + enum: + - OPERATION_STATE_UNSPECIFIED + - OPERATION_STATE_PENDING + - OPERATION_STATE_RUNNING + - OPERATION_STATE_SUCCEEDED + - OPERATION_STATE_FAILED + readOnly: true + enumDescriptions: + - Unspecified. + - Pending (Not started). + - In-progress. + - Done successfully. + - Done with errors. type: string - id: SasPortalDeploymentAssociation - type: object - description: Association between a gcp project and a SAS user id. + description: Output only. Current operation state + id: SasPortalMigrateOrganizationMetadata + description: >- + Long-running operation metadata message returned by the + MigrateOrganization. SasPortalCustomer: - description: Entity representing a SAS customer. type: object + id: SasPortalCustomer + description: Entity representing a SAS customer. properties: sasUserIds: + description: User IDs used by the devices belonging to this customer. type: array 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. 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 - id: SasPortalCustomer - SasPortalUpdateSignedDeviceRequest: - type: object - description: Request for UpdateSignedDevice. - properties: - installerId: - type: string - description: >- - Required. Unique installer ID (CPI ID) from the Certified - Professional Installers database. - 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. - format: byte - type: string - id: SasPortalUpdateSignedDeviceRequest - SasPortalValidateInstallerResponse: - type: object - id: SasPortalValidateInstallerResponse - properties: {} - description: Response for ValidateInstaller. - SasPortalListGcpProjectDeploymentsResponse: - description: Response for [ListGcpProjectDeployments]. - id: SasPortalListGcpProjectDeploymentsResponse + SasPortalGcpProjectDeployment: + id: SasPortalGcpProjectDeployment type: object properties: - deployments: - type: array - items: - $ref: '#/components/schemas/SasPortalGcpProjectDeployment' - description: Optional. Deployments associated with the GCP project - SasPortalListNodesResponse: + deployment: + description: Deployment associated with the GCP project. + $ref: '#/components/schemas/SasPortalDeployment' + hasEnabledAnalytics: + description: Whether SAS analytics has been enabled. + type: boolean + description: >- + Deployment associated with the GCP project. Includes whether SAS + analytics has been enabled or not. + SasPortalGenerateSecretResponse: type: object - id: SasPortalListNodesResponse + description: Response for GenerateSecret. 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. + secret: + description: The secret generated by the string and used by ValidateInstaller. type: string - nodes: - description: The nodes that match the request. - type: array - items: - $ref: '#/components/schemas/SasPortalNode' - description: Response for ListNodes. - SasPortalGetPolicyRequest: - id: SasPortalGetPolicyRequest + id: SasPortalGenerateSecretResponse + SasPortalProvisionDeploymentResponse: + id: SasPortalProvisionDeploymentResponse type: object - description: Request message for `GetPolicy` method. properties: - resource: - description: Required. The resource for which the policy is being requested. + errorMessage: + description: >- + Optional. Optional error message if the provisioning request is not + successful. type: string - 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. + Response for [ProvisionDeployment]. + [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. + SasPortalProvisionDeploymentRequest: properties: - newDeploymentDisplayName: + newOrganizationDisplayName: type: string description: >- - Optional. If this field is set, and a new SAS Portal Deployment + 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. - newOrganizationDisplayName: + newDeploymentDisplayName: type: string description: >- - Optional. If this field is set, and a new SAS Portal Organization + 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 format: int64 + type: string description: >- Optional. If this field is set then a new deployment will be created under the organization specified by this id. - id: SasPortalProvisionDeploymentRequest - SasPortalOperation: description: >- - This resource represents a long-running operation that is the result of - a network API call. - id: SasPortalOperation - type: object - 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: - 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 - 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. - 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 - SasPortalDeviceMetadata: - properties: - nrqzValidation: - description: Output only. National Radio Quiet Zone validation info. - readOnly: true - $ref: '#/components/schemas/SasPortalNrqzValidation' - 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: - deprecated: true - description: >- - Output only. Set to `true` if a CPI has validated that they have - coordinated with the National Quiet Zone office. - readOnly: true - type: boolean - antennaModel: - description: >- - If populated, the Antenna Model Pattern to use. Format is: - `RecordCreatorId:PatternId` - 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 - description: Device data overridable by both SAS Portal and registration requests. + 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 type: object - id: SasPortalDeviceMetadata - SasPortalMoveNodeRequest: - id: SasPortalMoveNodeRequest + SasPortalCreateSignedDeviceRequest: + description: Request for CreateSignedDevice. + id: SasPortalCreateSignedDeviceRequest type: object - description: Request for MoveNode. properties: - destination: + installerId: description: >- - Required. The name of the new parent resource node or customer to - reparent the node under. + Required. Unique installer id (CPI ID) from the Certified + Professional Installers database. type: string - SasPortalValidateInstallerRequest: - id: SasPortalValidateInstallerRequest - properties: - secret: + encodedDevice: type: string - description: Required. Secret returned by the GenerateSecret. - 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 - installerId: - type: string - description: >- - Required. Unique installer id (CPI ID) from the Certified - Professional Installers database. - type: object - description: Request for ValidateInstaller. + must be the JSON encoding of the device. The user_id field must be + set. SasPortalDevice: type: object - id: SasPortalDevice properties: - activeConfig: - description: >- - Output only. Current configuration of the device as registered to - the SAS. - $ref: '#/components/schemas/SasPortalDeviceConfig' name: description: Output only. The resource path name. type: string - serialNumber: + 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: + $ref: '#/components/schemas/SasPortalDeviceConfig' + description: Configuration of the device, as specified via SAS Portal API. + serialNumber: description: A serial number assigned to the device by the device manufacturer. - deviceMetadata: - description: >- - Device parameters that can be overridden by both SAS Portal and SAS - registration requests. - $ref: '#/components/schemas/SasPortalDeviceMetadata' + type: string grantRangeAllowlists: - type: array items: $ref: '#/components/schemas/SasPortalFrequencyRange' + type: array description: >- Only ranges that are within the allowlists are available for new grants. - displayName: - type: string - description: Device display name. - 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: - items: - $ref: '#/components/schemas/SasPortalDeviceGrant' - type: array - description: Output only. Grants held by the device. state: + type: string enum: - DEVICE_STATE_UNSPECIFIED - RESERVED - REGISTERED - DEREGISTERED - description: Output only. Device state. - type: string enumDescriptions: - Unspecified state. - >- @@ -830,16 +604,99 @@ components: SAS. - Device registered with SAS. - Device de-registered with SAS. + description: Output only. Device state. + displayName: + type: string + description: Device display name. + grants: + description: Output only. Grants held by the device. + type: array + items: + $ref: '#/components/schemas/SasPortalDeviceGrant' + deviceMetadata: + $ref: '#/components/schemas/SasPortalDeviceMetadata' + description: >- + Device parameters that can be overridden by both SAS Portal and SAS + registration requests. currentChannels: - description: Output only. Current channels with scores. + readOnly: true + type: array deprecated: true + description: Output only. Current channels with scores. items: $ref: '#/components/schemas/SasPortalChannelWithScore' + activeConfig: + description: >- + Output only. Current configuration of the device as registered to + the SAS. + $ref: '#/components/schemas/SasPortalDeviceConfig' + id: SasPortalDevice + SasPortalDeployment: + properties: + sasUserIds: + type: array + items: + type: string + description: >- + User ID used by the devices belonging to this deployment. Each + deployment should be associated with one unique user ID. + frns: + items: + type: string type: array readOnly: true - preloadedConfig: - $ref: '#/components/schemas/SasPortalDeviceConfig' - description: Configuration of the device, as specified via SAS Portal API. + description: >- + Output only. The FCC Registration Numbers (FRNs) copied from its + direct parent. + name: + description: Output only. Resource name. + readOnly: true + type: string + displayName: + description: The deployment's display name. + type: string + type: object + description: The Deployment. + id: SasPortalDeployment + SasPortalAssignment: + properties: + 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`. + type: array + role: + type: string + description: Required. Role that is assigned to `members`. + description: Associates `members` with a `role`. + type: object + id: SasPortalAssignment + SasPortalMoveNodeRequest: + id: SasPortalMoveNodeRequest + type: object + description: Request for MoveNode. + properties: + destination: + description: >- + Required. The name of the new parent resource node or customer to + reparent the node under. + type: string + SasPortalDpaMoveList: + properties: + frequencyRange: + $ref: '#/components/schemas/SasPortalFrequencyRange' + description: The frequency range that the move list affects. + dpaId: + description: The ID of the DPA. + type: string + type: object + description: An entry in a DPA's move list. + id: SasPortalDpaMoveList SasPortalListDeploymentsResponse: type: object id: SasPortalListDeploymentsResponse @@ -851,123 +708,44 @@ components: that indicates from where listing should continue. If the field is missing or empty, it means there are no more deployments. deployments: - description: The deployments that match the request. - type: array items: $ref: '#/components/schemas/SasPortalDeployment' + description: The deployments that match the request. + type: array description: Response for ListDeployments. - SasPortalDeviceGrant: + SasPortalSetupSasAnalyticsMetadata: + properties: {} + id: SasPortalSetupSasAnalyticsMetadata type: object - id: SasPortalDeviceGrant + description: >- + Metadata returned by the long running operation for the + SetupSasAnalytics rpc. + SasPortalSetupSasAnalyticsRequest: + id: SasPortalSetupSasAnalyticsRequest + type: object + description: Request for the SetupSasAnalytics rpc. properties: - lastHeartbeatTransmitExpireTime: - description: The transmit expiration time of the last heartbeat. - format: google-datetime - type: string - frequencyRange: - description: The transmission frequency range. - $ref: '#/components/schemas/SasPortalFrequencyRange' - channelType: - enumDescriptions: - - '' - - '' - - '' - type: string - description: Type of channel used. - enum: - - CHANNEL_TYPE_UNSPECIFIED - - CHANNEL_TYPE_GAA - - CHANNEL_TYPE_PAL - expireTime: - format: google-datetime - description: The expiration time of the grant. - type: string - moveList: - items: - $ref: '#/components/schemas/SasPortalDpaMoveList' - type: array - description: The DPA move lists on which this grant appears. - maxEirp: + userId: 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 - 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. - description: State of the grant. - enum: - - GRANT_STATE_UNSPECIFIED - - GRANT_STATE_GRANTED - - GRANT_STATE_TERMINATED - - GRANT_STATE_SUSPENDED - - GRANT_STATE_AUTHORIZED - - GRANT_STATE_EXPIRED - grantId: + Optional. User id to setup analytics for, if not provided the user + id associated with the project is used. optional type: string - description: Grant Id. - suspensionReason: - type: array - items: - type: string - description: If the grant is suspended, the reason(s) for suspension. - 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. - SasPortalCreateSignedDeviceRequest: + SasPortalListNodesResponse: properties: - encodedDevice: - format: byte - type: string + nodes: + description: The nodes that match the request. + items: + $ref: '#/components/schemas/SasPortalNode' + type: array + nextPageToken: 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. - installerId: + 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 - description: >- - Required. Unique installer id (CPI ID) from the Certified - Professional Installers database. - id: SasPortalCreateSignedDeviceRequest type: object - description: Request for CreateSignedDevice. - SasPortalGcpProjectDeployment: - type: object - id: SasPortalGcpProjectDeployment - properties: - deployment: - $ref: '#/components/schemas/SasPortalDeployment' - description: Deployment associated with the GCP project. - hasEnabledAnalytics: - description: Whether SAS analytics has been enabled. - type: boolean - description: >- - Deployment associated with the GCP project. Includes whether SAS - analytics has been enabled or not. - SasPortalChannelWithScore: - type: object - description: The channel with score. - id: SasPortalChannelWithScore - 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' + id: SasPortalListNodesResponse + description: Response for ListNodes. SasPortalMoveDeviceRequest: description: Request for MoveDevice. properties: @@ -978,71 +756,30 @@ components: reparent the device under. type: object id: SasPortalMoveDeviceRequest - SasPortalListDevicesResponse: - properties: - devices: - items: - $ref: '#/components/schemas/SasPortalDevice' - type: array - description: The devices that match the request. - 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. - description: Response for ListDevices. - id: SasPortalListDevicesResponse - type: object - SasPortalSetupSasAnalyticsMetadata: - properties: {} - description: >- - Metadata returned by the long running operation for the - SetupSasAnalytics rpc. - type: object - id: SasPortalSetupSasAnalyticsMetadata - SasPortalDeviceModel: - description: Information about the model of the device. - id: SasPortalDeviceModel - type: object - properties: - firmwareVersion: - type: string - description: The firmware version of the device. - hardwareVersion: - description: The hardware version of the device. - type: string - name: - description: The name of the device model. - type: string - softwareVersion: - description: The software version of the device. - type: string - vendor: - type: string - description: The name of the device vendor. SasPortalStatus: 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: - 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: - type: any 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: + type: integer format: int32 description: The status code, which should be an enum value of google.rpc.Code. - type: integer + type: object + id: SasPortalStatus description: >- The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It @@ -1051,82 +788,311 @@ 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). + SasPortalGenerateSecretRequest: + properties: {} type: object - id: SasPortalStatus - SasPortalTestPermissionsRequest: + id: SasPortalGenerateSecretRequest + description: Request for GenerateSecret. + SasPortalOperation: type: object - description: Request message for `TestPermissions` method. + description: >- + This resource represents a long-running operation that is the result of + a network API call. + id: SasPortalOperation properties: - permissions: - description: The set of permissions to check for the `resource`. - items: - type: string - type: array - resource: + metadata: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any description: >- - Required. The resource for which the permissions are being - requested. - type: string - id: SasPortalTestPermissionsRequest - SasPortalNode: - description: The Node. - properties: + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object name: + description: >- + The server-assigned name, which is only unique within the same + service that 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: Output only. Resource name. - displayName: - description: The node's display name. - type: string - sasUserIds: - type: array - items: - type: string - description: User ids used by the devices belonging to this node. - type: object - id: SasPortalNode - SasPortalGenerateSecretResponse: - properties: - secret: - type: string - description: The secret generated by the string and used by ValidateInstaller. - description: Response for GenerateSecret. - type: object - id: SasPortalGenerateSecretResponse - parameters: - 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 - 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 - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/SasPortalStatus' + 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. + 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`. + SasPortalListGcpProjectDeploymentsResponse: + description: Response for [ListGcpProjectDeployments]. + id: SasPortalListGcpProjectDeploymentsResponse + properties: + deployments: + items: + $ref: '#/components/schemas/SasPortalGcpProjectDeployment' + type: array + description: Optional. Deployments associated with the GCP project + type: object + SasPortalUpdateSignedDeviceRequest: + id: SasPortalUpdateSignedDeviceRequest + description: Request for UpdateSignedDevice. + type: object + properties: + installerId: + type: string + description: >- + Required. Unique installer ID (CPI ID) from the Certified + Professional Installers database. + encodedDevice: + format: byte + 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. + 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: + type: string + description: Required. Id of the SAS organization to be migrated. + format: int64 + id: SasPortalMigrateOrganizationRequest + SasPortalEmpty: + id: 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 + SasPortalValidateInstallerRequest: + id: SasPortalValidateInstallerRequest + properties: + secret: + description: Required. Secret returned by the GenerateSecret. + 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. + installerId: + type: string + description: >- + Required. Unique installer id (CPI ID) from the Certified + Professional Installers database. + description: Request for ValidateInstaller. + type: object + SasPortalMoveDeploymentRequest: + properties: + destination: + type: string + description: >- + Required. The name of the new parent resource node or customer to + reparent the deployment under. + description: Request for MoveDeployment. + type: object + id: SasPortalMoveDeploymentRequest + SasPortalSetPolicyRequest: + type: object + id: SasPortalSetPolicyRequest + description: Request message for `SetPolicy` method. + properties: + policy: + $ref: '#/components/schemas/SasPortalPolicy' + description: Required. The policy to be applied to the `resource`. + resource: + description: >- + Required. The resource for which the policy is being specified. This + policy replaces any existing policy. + type: string + disableNotification: + type: boolean + description: >- + Optional. Set the field as `true` to disable the onboarding + notification. + SasPortalGetPolicyRequest: + id: SasPortalGetPolicyRequest + description: Request message for `GetPolicy` method. + type: object + properties: + resource: + type: string + description: Required. The resource for which the policy is being requested. + SasPortalNrqzValidation: + id: SasPortalNrqzValidation + description: Information about National Radio Quiet Zone validation. + properties: + state: + enumDescriptions: + - Unspecified state. + - Draft state. + - Final state. + description: State of the NRQZ validation info. + type: string + enum: + - STATE_UNSPECIFIED + - DRAFT + - FINAL + longitude: + format: double + type: number + description: Device longitude that's associated with the validation. + caseId: + type: string + description: Validation case ID. + latitude: + type: number + format: double + description: Device latitude that's associated with the validation. + cpiId: + description: CPI who signed the validation. + type: string + type: object + SasPortalDeviceModel: + properties: + vendor: + type: string + description: The name of the device vendor. + softwareVersion: + type: string + description: The software version of the device. + name: + description: The name of the device model. + type: string + firmwareVersion: + description: The firmware version of the device. + type: string + hardwareVersion: + type: string + description: The hardware version of the device. + id: SasPortalDeviceModel + description: Information about the model of the device. + type: object + SasPortalValidateInstallerResponse: + description: Response for ValidateInstaller. + type: object + id: SasPortalValidateInstallerResponse + properties: {} + SasPortalSetupSasAnalyticsResponse: + properties: {} + id: SasPortalSetupSasAnalyticsResponse + type: object + description: >- + Response returned by the long running operation for the + SetupSasAnalytics rpc. + SasPortalTestPermissionsResponse: + properties: + permissions: + 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 + SasPortalDeploymentAssociation: + id: SasPortalDeploymentAssociation + type: object + description: Association between a gcp project and a SAS user id. + properties: + userId: + type: string + description: User id of the deployment. + gcpProjectId: + description: GCP project id of the associated project. + type: string + SasPortalDeviceConfig: + properties: + updateTime: + format: google-datetime + description: Output only. The last time the device configuration was edited. + type: string + model: + description: Information about this device model. + $ref: '#/components/schemas/SasPortalDeviceModel' + category: + enum: + - DEVICE_CATEGORY_UNSPECIFIED + - DEVICE_CATEGORY_A + - DEVICE_CATEGORY_B + type: string + enumDescriptions: + - Unspecified device category. + - Category A. + - Category B. + description: FCC category of the device. + callSign: + type: string + description: The call sign of the device operator. + installationParams: + $ref: '#/components/schemas/SasPortalInstallationParams' + description: Installation parameters for the device. + measurementCapabilities: + type: array + items: + enumDescriptions: + - '' + - '' + - '' + type: string + enum: + - MEASUREMENT_CAPABILITY_UNSPECIFIED + - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT + - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT + description: Measurement reporting capabilities of the device. + state: + description: State of the configuration. + enumDescriptions: + - '' + - '' + - '' + enum: + - DEVICE_CONFIG_STATE_UNSPECIFIED + - DRAFT + - FINAL + type: string + isSigned: + type: boolean + description: Output only. Whether the configuration has been signed by a CPI. + userId: + description: The identifier of a device user. + type: string + airInterface: + description: Information about this device's air interface. + $ref: '#/components/schemas/SasPortalDeviceAirInterface' + description: Information about the device configuration. + id: SasPortalDeviceConfig + type: object + parameters: key: description: >- API key. Your API key identifies your project and provides you with API @@ -1142,6 +1108,12 @@ components: name: prettyPrint schema: type: boolean + 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 @@ -1151,10 +1123,16 @@ 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 + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType schema: type: string _.xgafv: @@ -1166,262 +1144,371 @@ components: enum: - '1' - '2' - 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. + 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 + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields schema: type: string x-stackQL-resources: - customer_nodes: - id: prod_tt_sasportal.customer_nodes - name: customer_nodes - title: Customer_nodes + installer: + id: google.prod_tt_sasportal.installer + name: installer + title: Installer methods: - _customers_nodes_nodes_list: - operation: &ref_1 + 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: [] + delete: [] + policies: + id: google.prod_tt_sasportal.policies + name: policies + title: Policies + methods: + policies_test: + operation: + $ref: '#/paths/~1v1alpha1~1policies:test/post' + response: + mediaType: application/json + openAPIDocKey: '200' + 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' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + devices: + id: google.prod_tt_sasportal.devices + name: devices + title: Devices + methods: + nodes_devices_sign_device: + operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/get + #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:signDevice/post + response: + mediaType: application/json + openAPIDocKey: '200' + _nodes_devices_list: + operation: &ref_1 + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/get' response: &ref_2 mediaType: application/json openAPIDocKey: '200' - objectKey: $.nodes - customers_nodes_nodes_list: + objectKey: $.devices + nodes_devices_list: operation: *ref_1 response: *ref_2 - customers_nodes_nodes_create: + nodes_devices_create: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/post + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/post' response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_delete: + nodes_devices_move: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/delete + #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:move/post response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_create: + nodes_devices_get: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/post' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/get' response: mediaType: application/json openAPIDocKey: '200' - _customers_nodes_list: + nodes_devices_patch: + operation: + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + nodes_devices_delete: + operation: + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + _nodes_deployments_devices_list: operation: &ref_3 - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/get' + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/get response: &ref_4 mediaType: application/json openAPIDocKey: '200' - objectKey: $.nodes - customers_nodes_list: + objectKey: $.devices + nodes_deployments_devices_list: operation: *ref_3 response: *ref_4 - 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: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_delete - deployments: - id: prod_tt_sasportal.deployments - name: deployments - title: Deployments - methods: - customers_nodes_deployments_create: + nodes_deployments_devices_create: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - _customers_nodes_deployments_list: + _nodes_nodes_devices_list: operation: &ref_5 $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/get + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/get response: &ref_6 mediaType: application/json openAPIDocKey: '200' - objectKey: $.deployments - customers_nodes_deployments_list: + objectKey: $.devices + nodes_nodes_devices_list: operation: *ref_5 response: *ref_6 - customers_deployments_create: + nodes_nodes_devices_create: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/post' + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - _customers_deployments_list: - operation: &ref_7 - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/get' - response: &ref_8 + deployments_devices_patch: + operation: + $ref: >- + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/patch + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deployments - customers_deployments_list: - operation: *ref_7 - response: *ref_8 - customers_deployments_get: + deployments_devices_delete: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/get + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/delete response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_patch: + deployments_devices_get: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/patch + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/get response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_delete: + deployments_devices_sign_device: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/delete + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:signDevice/post response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_move: + deployments_devices_move: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}:move/post + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:move/post response: mediaType: application/json openAPIDocKey: '200' - deployments_get: + customers_deployments_devices_create: operation: - $ref: '#/paths/~1v1alpha1~1deployments~1{deploymentsId}/get' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_patch: + _customers_deployments_devices_list: + operation: &ref_7 + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/get + response: &ref_8 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.devices + customers_deployments_devices_list: + operation: *ref_7 + response: *ref_8 + customers_devices_move: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/patch + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:move/post response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_get: + customers_devices_get: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/get + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/get response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_delete: + customers_devices_patch: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/delete + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/patch response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_move: + customers_devices_delete: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}:move/post + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/delete response: mediaType: application/json openAPIDocKey: '200' - _nodes_deployments_list: + customers_devices_create: + operation: + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/post' + response: + mediaType: application/json + openAPIDocKey: '200' + _customers_devices_list: operation: &ref_9 - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments/get' + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/get' response: &ref_10 mediaType: application/json openAPIDocKey: '200' - objectKey: $.deployments - nodes_deployments_list: + objectKey: $.devices + customers_devices_list: operation: *ref_9 response: *ref_10 - _nodes_nodes_deployments_list: + customers_devices_sign_device: + operation: + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:signDevice/post + response: + mediaType: application/json + openAPIDocKey: '200' + _customers_nodes_devices_list: operation: &ref_11 $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/get + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/get response: &ref_12 mediaType: application/json openAPIDocKey: '200' - objectKey: $.deployments - nodes_nodes_deployments_list: + objectKey: $.devices + customers_nodes_devices_list: operation: *ref_11 response: *ref_12 - nodes_nodes_deployments_create: + customers_nodes_devices_create: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/post + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: + - $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/customers_deployments_list + #/components/x-stackQL-resources/devices/methods/nodes_nodes_devices_list - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_get + #/components/x-stackQL-resources/devices/methods/deployments_devices_get - $ref: >- - #/components/x-stackQL-resources/deployments/methods/deployments_get + #/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_devices_get - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_deployments_list + #/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_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/nodes_devices_create - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_list - insert: + #/components/x-stackQL-resources/devices/methods/customers_devices_create + update: - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_nodes_deployments_create + #/components/x-stackQL-resources/devices/methods/nodes_devices_patch - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_create + #/components/x-stackQL-resources/devices/methods/deployments_devices_patch - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_create - update: [] + #/components/x-stackQL-resources/devices/methods/customers_devices_patch delete: - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_delete + #/components/x-stackQL-resources/devices/methods/nodes_devices_delete - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_deployments_delete + #/components/x-stackQL-resources/devices/methods/deployments_devices_delete + - $ref: >- + #/components/x-stackQL-resources/devices/methods/customers_devices_delete devices_signed: - id: prod_tt_sasportal.devices_signed + id: google.prod_tt_sasportal.devices_signed name: devices_signed title: Devices_signed methods: - customers_nodes_devices_create_signed: + nodes_devices_update_signed: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices:createSigned/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:updateSigned/patch response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_devices_create_signed: + nodes_devices_create_signed: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices:createSigned/post + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices:createSigned/post' response: mediaType: application/json openAPIDocKey: '200' - customers_devices_create_signed: + nodes_deployments_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices:createSigned/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - customers_devices_update_signed: + nodes_nodes_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:updateSigned/patch + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' @@ -1432,352 +1519,227 @@ components: response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_devices_create_signed: + customers_deployments_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices:createSigned/post + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_devices_create_signed: + customers_devices_update_signed: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices:createSigned/post + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:updateSigned/patch response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_create_signed: + customers_devices_create_signed: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices:createSigned/post' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_update_signed: + customers_nodes_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~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/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/customers_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_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: [] delete: [] - devices: - id: prod_tt_sasportal.devices - name: devices - title: Devices + deployments: + id: google.prod_tt_sasportal.deployments + name: deployments + title: Deployments methods: - _customers_nodes_devices_list: - operation: &ref_13 - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/get - response: &ref_14 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.devices - customers_nodes_devices_list: - operation: *ref_13 - response: *ref_14 - customers_nodes_devices_create: + nodes_deployments_delete: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - _customers_deployments_devices_list: - operation: &ref_15 - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/get - response: &ref_16 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.devices - customers_deployments_devices_list: - operation: *ref_15 - response: *ref_16 - customers_deployments_devices_create: + nodes_deployments_get: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/get response: mediaType: application/json openAPIDocKey: '200' - customers_devices_get: + nodes_deployments_patch: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/get + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/patch response: mediaType: application/json openAPIDocKey: '200' - customers_devices_patch: - operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/patch - response: + _nodes_deployments_list: + operation: &ref_13 + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments/get' + response: &ref_14 mediaType: application/json openAPIDocKey: '200' - customers_devices_delete: + objectKey: $.deployments + nodes_deployments_list: + operation: *ref_13 + response: *ref_14 + nodes_deployments_move: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/delete + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}:move/post response: mediaType: application/json openAPIDocKey: '200' - customers_devices_move: + nodes_nodes_deployments_create: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:move/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/post response: mediaType: application/json openAPIDocKey: '200' - customers_devices_sign_device: - operation: + _nodes_nodes_deployments_list: + operation: &ref_15 $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:signDevice/post - response: + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/get + response: &ref_16 mediaType: application/json openAPIDocKey: '200' - customers_devices_create: + objectKey: $.deployments + nodes_nodes_deployments_list: + operation: *ref_15 + response: *ref_16 + deployments_get: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/post' + $ref: '#/paths/~1v1alpha1~1deployments~1{deploymentsId}/get' response: mediaType: application/json openAPIDocKey: '200' - _customers_devices_list: - operation: &ref_17 - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/get' - response: &ref_18 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.devices - customers_devices_list: - operation: *ref_17 - response: *ref_18 - deployments_devices_patch: + customers_deployments_patch: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/patch + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/patch response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_get: + customers_deployments_get: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/get + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/get response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_delete: + customers_deployments_delete: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/delete + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_move: + _customers_deployments_list: + operation: &ref_17 + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/get' + response: &ref_18 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.deployments + customers_deployments_list: + operation: *ref_17 + response: *ref_18 + customers_deployments_create: operation: - $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:move/post + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/post' response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_sign_device: + customers_deployments_move: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:signDevice/post + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}:move/post response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_devices_create: + customers_nodes_deployments_create: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/post + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/post response: mediaType: application/json openAPIDocKey: '200' - _nodes_deployments_devices_list: + _customers_nodes_deployments_list: operation: &ref_19 $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/get + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/get response: &ref_20 mediaType: application/json openAPIDocKey: '200' - objectKey: $.devices - nodes_deployments_devices_list: + objectKey: $.deployments + customers_nodes_deployments_list: operation: *ref_19 - response: *ref_20 - _nodes_nodes_devices_list: - operation: &ref_21 - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/get - response: &ref_22 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.devices - nodes_nodes_devices_list: - operation: *ref_21 - response: *ref_22 - nodes_nodes_devices_create: - operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/post - response: - mediaType: application/json - openAPIDocKey: '200' - nodes_devices_delete: - operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - nodes_devices_get: - operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - nodes_devices_patch: - operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - nodes_devices_move: - operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:move/post - response: - mediaType: application/json - openAPIDocKey: '200' - _nodes_devices_list: - operation: &ref_23 - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/get' - response: &ref_24 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.devices - nodes_devices_list: - operation: *ref_23 - response: *ref_24 - nodes_devices_create: - operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/post' - response: - mediaType: application/json - openAPIDocKey: '200' - nodes_devices_sign_device: - operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:signDevice/post - response: - mediaType: application/json - openAPIDocKey: '200' + response: *ref_20 sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_nodes_devices_list - - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_deployments_devices_list + #/components/x-stackQL-resources/deployments/methods/nodes_deployments_get - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_devices_get + #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_list - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_devices_list + #/components/x-stackQL-resources/deployments/methods/customers_deployments_get - $ref: >- - #/components/x-stackQL-resources/devices/methods/deployments_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_list - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_nodes_devices_list - - $ref: '#/components/x-stackQL-resources/devices/methods/nodes_devices_get' + #/components/x-stackQL-resources/deployments/methods/deployments_get - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_devices_list + #/components/x-stackQL-resources/deployments/methods/customers_deployments_list insert: - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_nodes_devices_create - - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_deployments_devices_create + #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_create - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_devices_create + #/components/x-stackQL-resources/deployments/methods/customers_nodes_deployments_create - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_deployments_devices_create + #/components/x-stackQL-resources/deployments/methods/customers_deployments_create + update: - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_nodes_devices_create + #/components/x-stackQL-resources/deployments/methods/nodes_deployments_patch - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_devices_create - update: [] + #/components/x-stackQL-resources/deployments/methods/customers_deployments_patch 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 - customer_node: - id: prod_tt_sasportal.customer_node - name: customer_node - title: Customer_node - methods: - customers_nodes_get: - operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: + #/components/x-stackQL-resources/deployments/methods/nodes_deployments_delete - $ref: >- - #/components/x-stackQL-resources/customer_node/methods/customers_nodes_get - insert: [] - update: [] - delete: [] + #/components/x-stackQL-resources/deployments/methods/customers_deployments_delete nodes: - id: prod_tt_sasportal.nodes + id: google.prod_tt_sasportal.nodes name: nodes title: Nodes methods: - customers_nodes_patch: - operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - customers_nodes_move: + nodes_nodes_patch: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}:move/post + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/patch' response: mediaType: application/json openAPIDocKey: '200' - _nodes_nodes_nodes_list: - operation: &ref_25 - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/get' - response: &ref_26 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.nodes - nodes_nodes_nodes_list: - operation: *ref_25 - response: *ref_26 - nodes_nodes_nodes_create: + nodes_nodes_delete: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/post + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/delete' response: mediaType: application/json openAPIDocKey: '200' @@ -1787,31 +1749,50 @@ components: response: mediaType: application/json openAPIDocKey: '200' + _nodes_nodes_list: + operation: &ref_21 + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/get' + response: &ref_22 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.nodes + nodes_nodes_list: + operation: *ref_21 + response: *ref_22 nodes_nodes_create: operation: $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/post' response: mediaType: application/json openAPIDocKey: '200' - _nodes_nodes_list: - operation: &ref_27 - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/get' - response: &ref_28 + _nodes_nodes_nodes_list: + operation: &ref_23 + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/get' + response: &ref_24 mediaType: application/json openAPIDocKey: '200' objectKey: $.nodes - nodes_nodes_list: - operation: *ref_27 - response: *ref_28 - nodes_nodes_delete: + nodes_nodes_nodes_list: + operation: *ref_23 + response: *ref_24 + nodes_nodes_nodes_create: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/delete' + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/post response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_patch: + customers_nodes_patch: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/patch' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/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' @@ -1824,24 +1805,51 @@ components: - $ref: >- #/components/x-stackQL-resources/nodes/methods/nodes_nodes_nodes_create - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_patch' + - $ref: >- + #/components/x-stackQL-resources/nodes/methods/customers_nodes_patch 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: + operation: + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}/get' + 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: [] + delete: [] customers: - id: prod_tt_sasportal.customers + id: google.prod_tt_sasportal.customers name: customers title: Customers methods: _customers_list: - operation: &ref_29 + operation: &ref_25 $ref: '#/paths/~1v1alpha1~1customers/get' - response: &ref_30 + response: &ref_26 mediaType: application/json openAPIDocKey: '200' objectKey: $.customers customers_list: - operation: *ref_29 - response: *ref_30 + operation: *ref_25 + response: *ref_26 customers_patch: operation: $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/patch' @@ -1854,12 +1862,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - customers_migrate_organization: - operation: - $ref: '#/paths/~1v1alpha1~1customers:migrateOrganization/post' - response: - mediaType: application/json - openAPIDocKey: '200' customers_setup_sas_analytics: operation: $ref: '#/paths/~1v1alpha1~1customers:setupSasAnalytics/post' @@ -1872,15 +1874,22 @@ components: response: mediaType: application/json openAPIDocKey: '200' + customers_migrate_organization: + operation: + $ref: '#/paths/~1v1alpha1~1customers:migrateOrganization/post' + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/customers/methods/customers_list' - $ref: '#/components/x-stackQL-resources/customers/methods/customers_get' + - $ref: '#/components/x-stackQL-resources/customers/methods/customers_list' insert: [] - update: [] + update: + - $ref: '#/components/x-stackQL-resources/customers/methods/customers_patch' delete: [] customers_legacy_organizations: - id: prod_tt_sasportal.customers_legacy_organizations + id: google.prod_tt_sasportal.customers_legacy_organizations name: customers_legacy_organizations title: Customers_legacy_organizations methods: @@ -1898,7 +1907,7 @@ components: update: [] delete: [] customers_gcp_project_deployments: - id: prod_tt_sasportal.customers_gcp_project_deployments + id: google.prod_tt_sasportal.customers_gcp_project_deployments name: customers_gcp_project_deployments title: Customers_gcp_project_deployments methods: @@ -1915,342 +1924,134 @@ components: insert: [] update: [] delete: [] - policies: - id: prod_tt_sasportal.policies - name: policies - title: Policies + customer_nodes: + id: google.prod_tt_sasportal.customer_nodes + name: customer_nodes + title: Customer_nodes methods: - policies_test: - operation: - $ref: '#/paths/~1v1alpha1~1policies:test/post' - response: + _customers_nodes_list: + operation: &ref_27 + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/get' + response: &ref_28 mediaType: application/json openAPIDocKey: '200' - policies_set: + objectKey: $.nodes + customers_nodes_list: + operation: *ref_27 + response: *ref_28 + customers_nodes_create: operation: - $ref: '#/paths/~1v1alpha1~1policies:set/post' + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/post' response: mediaType: application/json openAPIDocKey: '200' - policies_get: + customers_nodes_delete: operation: - $ref: '#/paths/~1v1alpha1~1policies:get/post' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - node: - id: prod_tt_sasportal.node - name: node - title: Node - methods: - nodes_nodes_get: + customers_nodes_nodes_create: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/get' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/post response: mediaType: application/json openAPIDocKey: '200' - nodes_get: - operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}/get' - response: + _customers_nodes_nodes_list: + operation: &ref_29 + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/get + response: &ref_30 mediaType: application/json openAPIDocKey: '200' + objectKey: $.nodes + customers_nodes_nodes_list: + operation: *ref_29 + response: *ref_30 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: [] - delete: [] - installer: - id: prod_tt_sasportal.installer - name: installer - title: Installer + delete: + - $ref: >- + #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_delete + customer_node: + id: google.prod_tt_sasportal.customer_node + name: customer_node + title: Customer_node methods: - installer_generate_secret: - operation: - $ref: '#/paths/~1v1alpha1~1installer:generateSecret/post' - response: - mediaType: application/json - openAPIDocKey: '200' - installer_validate: + customers_nodes_get: operation: - $ref: '#/paths/~1v1alpha1~1installer:validate/post' + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/customer_node/methods/customers_nodes_get insert: [] update: [] delete: [] paths: - /v1alpha1/customers/{customersId}/nodes/{nodesId}/nodes: + /v1alpha1/installer:validate: parameters: &ref_31 - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/callback' - get: - description: Lists nodes. - operationId: prod_tt_sasportal.customers.nodes.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 - required: true - schema: - type: string - - 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 - schema: - type: string - 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 - 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 - schema: - type: string - - in: path - name: nodesId - required: true - schema: - type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}/deployments: - parameters: *ref_31 - 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 - 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: 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 - 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: 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/{nodesId}/devices:createSigned: - parameters: *ref_31 + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' post: - description: Creates a signed device under a node or customer. - operationId: prod_tt_sasportal.customers.nodes.devices.createSigned + description: Validates the identity of a Certified Professional Installer (CPI). + operationId: prod_tt_sasportal.installer.validate 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: customersId - required: true - schema: - type: string - - in: path - name: nodesId - required: true - schema: - type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices: - parameters: *ref_31 - 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 - 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: 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: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string + $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_31 post: - description: Creates a device under a node or customer. - operationId: prod_tt_sasportal.customers.nodes.devices.create + description: Generates a secret to be used with the ValidateInstaller. + operationId: prod_tt_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 @@ -2266,23 +2067,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 - /v1alpha1/customers/{customersId}/nodes/{nodesId}: + $ref: '#/components/schemas/SasPortalGenerateSecretResponse' + parameters: [] + /v1alpha1/policies:test: parameters: *ref_31 - get: - description: Returns a requested node. - operationId: prod_tt_sasportal.customers.nodes.get + 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 @@ -2298,21 +2094,20 @@ 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 - delete: - description: Deletes a node. - operationId: prod_tt_sasportal.customers.nodes.delete + $ref: '#/components/schemas/SasPortalTestPermissionsResponse' + parameters: [] + /v1alpha1/policies:get: + parameters: *ref_31 + 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 @@ -2328,26 +2123,20 @@ paths: 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: prod_tt_sasportal.customers.nodes.patch + $ref: '#/components/schemas/SasPortalPolicy' + parameters: [] + /v1alpha1/policies:set: + parameters: *ref_31 + 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/SasPortalNode' + $ref: '#/components/schemas/SasPortalSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2363,33 +2152,18 @@ 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 - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1alpha1/customers/{customersId}/nodes: + $ref: '#/components/schemas/SasPortalPolicy' + parameters: [] + /v1alpha1/nodes/{nodesId}/devices/{devicesId}:signDevice: parameters: *ref_31 post: - description: Creates a new node. - operationId: prod_tt_sasportal.customers.nodes.create + description: Signs a device. + operationId: prod_tt_sasportal.nodes.devices.signDevice requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalSignDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2405,16 +2179,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: customersId + name: nodesId + required: true + schema: + type: string + - in: path + name: devicesId required: true schema: type: string + /v1alpha1/nodes/{nodesId}/devices: + parameters: *ref_31 get: - description: Lists nodes. - operationId: prod_tt_sasportal.customers.nodes.list + description: Lists devices under a node or customer. + operationId: prod_tt_sasportal.nodes.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2430,36 +2211,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path - name: customersId + 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/customers/{customersId}/nodes/{nodesId}:move: - parameters: *ref_31 + type: string post: - description: Moves a node under another node or customer. - operationId: prod_tt_sasportal.customers.nodes.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/SasPortalMoveNodeRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2475,28 +2254,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: nodesId required: true schema: type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices:createSigned: + /v1alpha1/nodes/{nodesId}/devices/{devicesId}:updateSigned: parameters: *ref_31 - post: - description: Creates a signed device under a node or customer. - operationId: prod_tt_sasportal.customers.deployments.devices.createSigned + patch: + description: Updates a signed device. + operationId: prod_tt_sasportal.nodes.devices.updateSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2515,20 +2289,25 @@ paths: $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - in: path - name: deploymentsId + name: devicesId required: true schema: type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices: + /v1alpha1/nodes/{nodesId}/devices/{devicesId}:move: parameters: *ref_31 - get: - description: Lists devices under a node or customer. - operationId: prod_tt_sasportal.customers.deployments.devices.list + 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 @@ -2544,39 +2323,55 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - in: path - name: deploymentsId + 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}/devices:createSigned: + parameters: *ref_31 post: - description: Creates a device under a node or customer. - operationId: prod_tt_sasportal.customers.deployments.devices.create + 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 + 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 + /v1alpha1/nodes/{nodesId}/devices/{devicesId}: + parameters: *ref_31 + get: + description: Gets details about a device. + operationId: prod_tt_sasportal.nodes.devices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2595,25 +2390,23 @@ paths: $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - in: path - name: deploymentsId + name: devicesId required: true schema: type: string - /v1alpha1/customers/{customersId}/deployments: - parameters: *ref_31 - post: - description: Creates a new deployment. - operationId: prod_tt_sasportal.customers.deployments.create + patch: + description: Updates a device. + operationId: prod_tt_sasportal.nodes.devices.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2629,56 +2422,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - get: - description: Lists deployments. - operationId: prod_tt_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: customersId + name: devicesId 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 - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}: - parameters: *ref_31 - get: - description: Returns a requested deployment. - operationId: prod_tt_sasportal.customers.deployments.get + format: google-fieldmask + delete: + description: Deletes a device. + operationId: prod_tt_sasportal.nodes.devices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2694,26 +2457,23 @@ 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: devicesId required: true schema: type: string - patch: - description: Updates an existing deployment. - operationId: prod_tt_sasportal.customers.deployments.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDeployment' + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices: + parameters: *ref_31 + 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 @@ -2729,10 +2489,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string @@ -2742,13 +2502,26 @@ paths: schema: type: string - in: query - name: updateMask + name: pageToken schema: type: string - format: google-fieldmask - delete: - description: Deletes a deployment. - operationId: prod_tt_sasportal.customers.deployments.delete + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + 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 @@ -2764,10 +2537,10 @@ 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 @@ -2776,16 +2549,16 @@ paths: required: true schema: type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}:move: + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices:createSigned: parameters: *ref_31 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.nodes.deployments.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2801,10 +2574,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string @@ -2813,16 +2586,11 @@ paths: required: true schema: type: string - /v1alpha1/customers/{customersId}/devices:createSigned: + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}: parameters: *ref_31 - 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' + delete: + description: Deletes a deployment. + operationId: prod_tt_sasportal.nodes.deployments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2838,18 +2606,21 @@ 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}: - parameters: *ref_31 get: - description: Gets details about a device. - operationId: prod_tt_sasportal.customers.devices.get + description: Returns a requested deployment. + operationId: prod_tt_sasportal.nodes.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2865,26 +2636,26 @@ 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 patch: - description: Updates a device. - operationId: prod_tt_sasportal.customers.devices.patch + description: Updates an existing deployment. + operationId: prod_tt_sasportal.nodes.deployments.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2900,15 +2671,15 @@ 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 @@ -2917,9 +2688,11 @@ paths: schema: type: string format: google-fieldmask - delete: - description: Deletes a device. - operationId: prod_tt_sasportal.customers.devices.delete + /v1alpha1/nodes/{nodesId}/deployments: + parameters: *ref_31 + get: + description: Lists deployments. + operationId: prod_tt_sasportal.nodes.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2935,28 +2708,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - - in: path - name: devicesId - required: true + - in: query + name: pageToken schema: type: string - /v1alpha1/customers/{customersId}/devices/{devicesId}:move: + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}:move: parameters: *ref_31 post: - description: Moves a device under another node or customer. - operationId: prod_tt_sasportal.customers.devices.move + description: Moves a deployment under another node or customer. + operationId: prod_tt_sasportal.nodes.deployments.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeviceRequest' + $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2975,25 +2756,25 @@ paths: $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}:signDevice: + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}: parameters: *ref_31 - post: - description: Signs a device. - operationId: prod_tt_sasportal.customers.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 @@ -3009,28 +2790,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: devicesId + name: nodesId1 required: true schema: type: string - /v1alpha1/customers/{customersId}/devices: - parameters: *ref_31 - 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' + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: Returns a requested node. + operationId: prod_tt_sasportal.nodes.nodes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3046,16 +2825,21 @@ 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 - get: - description: Lists devices under a node or customer. - operationId: prod_tt_sasportal.customers.devices.list + - 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 @@ -3071,36 +2855,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: customersId + 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/customers/{customersId}/devices/{devicesId}:updateSigned: + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}:move: parameters: *ref_31 - patch: - description: Updates a signed device. - operationId: prod_tt_sasportal.customers.devices.updateSigned + 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/SasPortalUpdateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalMoveNodeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3116,23 +2892,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - in: path - name: devicesId + name: nodesId1 required: true schema: type: string - /v1alpha1/customers: + /v1alpha1/nodes/{nodesId}/nodes: parameters: *ref_31 get: - description: Returns a list of requested customers. - operationId: prod_tt_sasportal.customers.list + description: Lists nodes. + operationId: prod_tt_sasportal.nodes.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3148,27 +2924,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListCustomersResponse' + $ref: '#/components/schemas/SasPortalListNodesResponse' parameters: + - 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}: - parameters: *ref_31 - patch: - description: Updates an existing customer. - operationId: prod_tt_sasportal.customers.patch + post: + description: Creates a new node. + operationId: prod_tt_sasportal.nodes.nodes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCustomer' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3184,21 +2967,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCustomer' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path - name: customersId + name: nodesId 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 + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/deployments: + parameters: *ref_31 + 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 @@ -3214,27 +2999,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCustomer' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - /v1alpha1/customers:migrateOrganization: - parameters: *ref_31 - 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' + - 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 @@ -3250,13 +3029,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' - parameters: [] - /v1alpha1/customers:listLegacyOrganizations: + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' + parameters: + - in: path + name: nodesId + required: true + schema: + type: string + - in: path + name: nodesId1 + 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/nodes/{nodesId}/nodes/{nodesId1}/nodes: parameters: *ref_31 get: - description: Returns a list of legacy organizations. - operationId: prod_tt_sasportal.customers.listLegacyOrganizations + description: Lists nodes. + operationId: prod_tt_sasportal.nodes.nodes.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3272,21 +3074,39 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListLegacyOrganizationsResponse' - parameters: [] - /v1alpha1/customers:setupSasAnalytics: - parameters: *ref_31 + $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: >- - 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 + description: Creates a new node. + operationId: prod_tt_sasportal.nodes.nodes.nodes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalSetupSasAnalyticsRequest' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3302,45 +3122,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' - parameters: [] - /v1alpha1/customers:listGcpProjectDeployments: + $ref: '#/components/schemas/SasPortalNode' + parameters: + - in: path + name: nodesId + required: true + schema: + type: string + - in: path + name: nodesId1 + required: true + schema: + type: string + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices: parameters: *ref_31 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:provisionDeployment: - parameters: *ref_31 - 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/SasPortalProvisionDeploymentRequest' + 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 @@ -3356,18 +3154,39 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalProvisionDeploymentResponse' - parameters: [] - /v1alpha1/policies:test: - parameters: *ref_31 + $ref: '#/components/schemas/SasPortalListDevicesResponse' + parameters: + - in: path + name: nodesId + required: true + schema: + 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 + schema: + type: string 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.nodes.nodes.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalTestPermissionsRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3383,20 +3202,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalTestPermissionsResponse' - parameters: [] - /v1alpha1/policies:set: + $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}/devices:createSigned: parameters: *ref_31 post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. - operationId: prod_tt_sasportal.policies.set + 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/SasPortalSetPolicyRequest' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3412,20 +3239,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalPolicy' - parameters: [] - /v1alpha1/policies:get: + $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}: parameters: *ref_31 - 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: Returns a requested node. + operationId: prod_tt_sasportal.nodes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3441,8 +3271,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalPolicy' - parameters: [] + $ref: '#/components/schemas/SasPortalNode' + parameters: + - in: path + name: nodesId + required: true + schema: + type: string /v1alpha1/deployments/{deploymentsId}: parameters: *ref_31 get: @@ -3512,6 +3347,36 @@ paths: 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 + 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: deploymentsId + 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.deployments.devices.get @@ -3542,9 +3407,53 @@ paths: required: true schema: type: string - delete: - description: Deletes a device. - operationId: prod_tt_sasportal.deployments.devices.delete + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:updateSigned: + parameters: *ref_31 + patch: + description: Updates a signed device. + operationId: prod_tt_sasportal.deployments.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: deploymentsId + required: true + schema: + type: string + - in: path + name: devicesId + required: true + schema: + type: string + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:signDevice: + parameters: *ref_31 + 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 @@ -3609,16 +3518,112 @@ paths: required: true schema: type: string - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:updateSigned: + /v1alpha1/customers: + parameters: *ref_31 + get: + description: Returns a list of requested customers. + operationId: prod_tt_sasportal.customers.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/SasPortalListCustomersResponse' + parameters: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1alpha1/customers/{customersId}: parameters: *ref_31 patch: - description: Updates a signed device. - operationId: prod_tt_sasportal.deployments.devices.updateSigned + description: Updates an existing customer. + operationId: prod_tt_sasportal.customers.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalCustomer' + 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 + - 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 + required: true + schema: + type: string + /v1alpha1/customers:setupSasAnalytics: + parameters: *ref_31 + 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/SasPortalUpdateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalSetupSasAnalyticsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3634,28 +3639,13 @@ 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/SasPortalOperation' + parameters: [] + /v1alpha1/customers:listLegacyOrganizations: parameters: *ref_31 - post: - description: Signs a device. - operationId: prod_tt_sasportal.deployments.devices.signDevice - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalSignDeviceRequest' + get: + description: Returns a list of legacy organizations. + operationId: prod_tt_sasportal.customers.listLegacyOrganizations security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3671,28 +3661,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/nodes/{nodesId}/deployments/{deploymentsId}/devices: + $ref: '#/components/schemas/SasPortalListLegacyOrganizationsResponse' + parameters: [] + /v1alpha1/customers:provisionDeployment: parameters: *ref_31 post: - description: Creates a device under a node or customer. - operationId: prod_tt_sasportal.nodes.deployments.devices.create + 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/SasPortalDevice' + $ref: '#/components/schemas/SasPortalProvisionDeploymentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3708,21 +3690,22 @@ paths: 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 - get: - description: Lists devices under a node or customer. - operationId: prod_tt_sasportal.nodes.deployments.devices.list + $ref: '#/components/schemas/SasPortalProvisionDeploymentResponse' + parameters: [] + /v1alpha1/customers:migrateOrganization: + parameters: *ref_31 + 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' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3738,41 +3721,15 @@ paths: 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: 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: + $ref: '#/components/schemas/SasPortalOperation' + parameters: [] + /v1alpha1/customers:listGcpProjectDeployments: parameters: *ref_31 - 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' + 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 @@ -3788,23 +3745,14 @@ paths: 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}: + $ref: >- + #/components/schemas/SasPortalListGcpProjectDeploymentsResponse + parameters: [] + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}: parameters: *ref_31 patch: description: Updates an existing deployment. - operationId: prod_tt_sasportal.nodes.deployments.patch + operationId: prod_tt_sasportal.customers.deployments.patch requestBody: content: application/json: @@ -3828,7 +3776,7 @@ paths: $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string @@ -3844,7 +3792,7 @@ paths: format: google-fieldmask get: description: Returns a requested deployment. - operationId: prod_tt_sasportal.nodes.deployments.get + operationId: prod_tt_sasportal.customers.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3863,7 +3811,7 @@ paths: $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string @@ -3874,7 +3822,7 @@ paths: type: string delete: description: Deletes a deployment. - operationId: prod_tt_sasportal.nodes.deployments.delete + operationId: prod_tt_sasportal.customers.deployments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3893,44 +3841,7 @@ paths: $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/{deploymentsId}:move: - parameters: *ref_31 - 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 - 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: nodesId + name: customersId required: true schema: type: string @@ -3939,11 +3850,11 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/deployments: + /v1alpha1/customers/{customersId}/deployments: parameters: *ref_31 get: description: Lists deployments. - operationId: prod_tt_sasportal.nodes.deployments.list + operationId: prod_tt_sasportal.customers.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3962,10 +3873,14 @@ paths: $ref: '#/components/schemas/SasPortalListDeploymentsResponse' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string + - in: query + name: filter + schema: + type: string - in: query name: pageSize schema: @@ -3975,20 +3890,14 @@ paths: name: pageToken schema: type: string - - in: query - name: filter - schema: - type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices:createSigned: - parameters: *ref_31 post: - description: Creates a signed device under a node or customer. - operationId: prod_tt_sasportal.nodes.nodes.devices.createSigned + description: Creates a new deployment. + operationId: prod_tt_sasportal.customers.deployments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4004,23 +3913,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path - name: nodesId - required: true - schema: - type: string - - in: path - name: nodesId1 + name: customersId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices: + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}:move: parameters: *ref_31 - 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.customers.deployments.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4036,34 +3945,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalOperation' parameters: - - in: path - name: nodesId - required: true - schema: - type: string - - in: path - name: nodesId1 - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: customersId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: deploymentsId + required: true schema: type: string + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices: + parameters: *ref_31 post: description: Creates a device under a node or customer. - operationId: prod_tt_sasportal.nodes.nodes.devices.create + operationId: prod_tt_sasportal.customers.deployments.devices.create requestBody: content: application/json: @@ -4087,20 +3985,18 @@ paths: $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: nodesId1 + name: deploymentsId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/nodes: - parameters: *ref_31 get: - description: Lists nodes. - operationId: prod_tt_sasportal.nodes.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 @@ -4116,15 +4012,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: nodesId1 + name: deploymentsId required: true schema: type: string @@ -4141,14 +4037,16 @@ paths: name: filter schema: type: string + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices:createSigned: + parameters: *ref_31 post: - description: Creates a new node. - operationId: prod_tt_sasportal.nodes.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 @@ -4164,23 +4062,28 @@ 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: deploymentsId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/deployments: + /v1alpha1/customers/{customersId}/devices/{devicesId}:move: parameters: *ref_31 - get: - description: Lists deployments. - operationId: prod_tt_sasportal.nodes.nodes.deployments.list + 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 @@ -4196,39 +4099,58 @@ 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: devicesId required: true schema: type: string - - in: query - name: filter + /v1alpha1/customers/{customersId}/devices/{devicesId}: + parameters: *ref_31 + get: + description: Gets details about a device. + operationId: prod_tt_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: pageToken + - in: path + name: devicesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: Creates a new deployment. - operationId: prod_tt_sasportal.nodes.nodes.deployments.create + patch: + description: Updates a device. + operationId: prod_tt_sasportal.customers.devices.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4244,28 +4166,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: nodesId1 + name: devicesId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}:move: - parameters: *ref_31 - 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' + - 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 @@ -4281,28 +4201,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: nodesId1 + name: devicesId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes: + /v1alpha1/customers/{customersId}/devices: parameters: *ref_31 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.customers.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4318,16 +4238,16 @@ 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 get: - description: Lists nodes. - operationId: prod_tt_sasportal.nodes.nodes.list + description: Lists devices under a node or customer. + operationId: prod_tt_sasportal.customers.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4343,15 +4263,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: query - name: filter + name: pageToken schema: type: string - in: query @@ -4360,14 +4280,19 @@ paths: type: integer format: int32 - in: query - name: pageToken + name: filter schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}: + /v1alpha1/customers/{customersId}/devices/{devicesId}:signDevice: parameters: *ref_31 - delete: - description: Deletes a node. - operationId: prod_tt_sasportal.nodes.nodes.delete + 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 @@ -4386,23 +4311,25 @@ paths: $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: nodesId1 + name: devicesId required: true schema: type: string + /v1alpha1/customers/{customersId}/devices/{devicesId}:updateSigned: + parameters: *ref_31 patch: - description: Updates an existing node. - operationId: prod_tt_sasportal.nodes.nodes.patch + description: Updates a signed device. + operationId: prod_tt_sasportal.customers.devices.updateSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4418,26 +4345,98 @@ 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: devicesId + required: true + schema: + type: string + /v1alpha1/customers/{customersId}/devices:createSigned: + parameters: *ref_31 + 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' + 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 + /v1alpha1/customers/{customersId}/nodes: + parameters: *ref_31 + 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: customersId required: true schema: type: string - in: query - name: updateMask + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter schema: type: string - format: google-fieldmask - 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.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4456,20 +4455,15 @@ paths: $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 - /v1alpha1/nodes/{nodesId}/devices/{devicesId}: + /v1alpha1/customers/{customersId}/nodes/{nodesId}: parameters: *ref_31 - delete: - description: Deletes a device. - operationId: prod_tt_sasportal.nodes.devices.delete + get: + description: Returns a requested node. + operationId: prod_tt_sasportal.customers.nodes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4485,21 +4479,26 @@ 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 - get: - description: Gets details about a device. - operationId: prod_tt_sasportal.nodes.devices.get + 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 @@ -4515,26 +4514,26 @@ 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: devicesId + name: nodesId required: true schema: type: string - patch: - description: Updates a device. - operationId: prod_tt_sasportal.nodes.devices.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDevice' + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a node. + operationId: prod_tt_sasportal.customers.nodes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4550,33 +4549,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: devicesId + name: nodesId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1alpha1/nodes/{nodesId}/devices/{devicesId}:move: + /v1alpha1/customers/{customersId}/nodes/{nodesId}:move: parameters: *ref_31 post: - description: Moves a device under another node or customer. - operationId: prod_tt_sasportal.nodes.devices.move + description: Moves a node under another node or customer. + operationId: prod_tt_sasportal.customers.nodes.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeviceRequest' + $ref: '#/components/schemas/SasPortalMoveNodeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4595,20 +4589,20 @@ paths: $ref: '#/components/schemas/SasPortalOperation' 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}/devices: + /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices: parameters: *ref_31 get: description: Lists devices under a node or customer. - operationId: prod_tt_sasportal.nodes.devices.list + operationId: prod_tt_sasportal.customers.nodes.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4627,12 +4621,13 @@ paths: $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: nodesId + required: true schema: type: string - in: query @@ -4644,9 +4639,13 @@ paths: 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.devices.create + operationId: prod_tt_sasportal.customers.nodes.devices.create requestBody: content: application/json: @@ -4669,16 +4668,21 @@ paths: 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/nodes/{nodesId}/devices:createSigned: + /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices:createSigned: parameters: *ref_31 post: description: Creates a signed device under a node or customer. - operationId: prod_tt_sasportal.nodes.devices.createSigned + operationId: prod_tt_sasportal.customers.nodes.devices.createSigned requestBody: content: application/json: @@ -4701,21 +4705,26 @@ paths: 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/nodes/{nodesId}/devices/{devicesId}:signDevice: + /v1alpha1/customers/{customersId}/nodes/{nodesId}/nodes: parameters: *ref_31 post: - description: Signs a device. - operationId: prod_tt_sasportal.nodes.devices.signDevice + description: Creates a new node. + operationId: prod_tt_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 @@ -4731,28 +4740,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}/devices/{devicesId}:updateSigned: - parameters: *ref_31 - patch: - description: Updates a signed device. - operationId: prod_tt_sasportal.nodes.devices.updateSigned - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' + get: + description: Lists nodes. + operationId: prod_tt_sasportal.customers.nodes.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4768,55 +4770,41 @@ 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: devicesId + name: nodesId required: true schema: type: string - /v1alpha1/nodes/{nodesId}: - parameters: *ref_31 - 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 + - in: query + name: pageToken schema: type: string - /v1alpha1/installer:generateSecret: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v1alpha1/customers/{customersId}/nodes/{nodesId}/deployments: parameters: *ref_31 post: - description: Generates a secret to be used with the ValidateInstaller. - operationId: prod_tt_sasportal.installer.generateSecret + description: Creates a new deployment. + operationId: prod_tt_sasportal.customers.nodes.deployments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalGenerateSecretRequest' + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4832,18 +4820,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalGenerateSecretResponse' - parameters: [] - /v1alpha1/installer:validate: - parameters: *ref_31 - 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' + $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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4859,5 +4850,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalValidateInstallerResponse' - parameters: [] + $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 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 b354478c..9bb39614 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/publicca.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/publicca.yaml @@ -11,7 +11,7 @@ info: publicly trusted certificate authority. version: v1 x-discovery-doc-revision: '20240527' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/public-certificate-authority/docs servers: @@ -147,7 +147,7 @@ components: - '2' x-stackQL-resources: external_account_keys: - id: publicca.external_account_keys + id: google.publicca.external_account_keys name: external_account_keys title: External_account_keys methods: 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 21c756fd..b88f0972 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: '20240521' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/pubsub/docs servers: @@ -1682,7 +1682,7 @@ components: - '2' x-stackQL-resources: topics_iam_policies: - id: pubsub.topics_iam_policies + id: google.pubsub.topics_iam_policies name: topics_iam_policies title: Topics_iam_policies methods: @@ -1719,7 +1719,7 @@ components: update: [] delete: [] topics: - id: pubsub.topics + id: google.pubsub.topics name: topics title: Topics methods: @@ -1771,12 +1771,14 @@ components: - $ref: >- #/components/x-stackQL-resources/topics/methods/projects_topics_list insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/topics/methods/projects_topics_patch delete: - $ref: >- #/components/x-stackQL-resources/topics/methods/projects_topics_delete subscriptions: - id: pubsub.subscriptions + id: google.pubsub.subscriptions name: subscriptions title: Subscriptions methods: @@ -1880,12 +1882,14 @@ components: - $ref: >- #/components/x-stackQL-resources/subscriptions/methods/projects_subscriptions_list insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/subscriptions/methods/projects_subscriptions_patch delete: - $ref: >- #/components/x-stackQL-resources/subscriptions/methods/projects_subscriptions_delete snapshots: - id: pubsub.snapshots + id: google.pubsub.snapshots name: snapshots title: Snapshots methods: @@ -1945,12 +1949,14 @@ components: - $ref: >- #/components/x-stackQL-resources/snapshots/methods/projects_snapshots_list insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/snapshots/methods/projects_snapshots_patch delete: - $ref: >- #/components/x-stackQL-resources/snapshots/methods/projects_snapshots_delete subscriptions_iam_policies: - id: pubsub.subscriptions_iam_policies + id: google.pubsub.subscriptions_iam_policies name: subscriptions_iam_policies title: Subscriptions_iam_policies methods: @@ -1987,7 +1993,7 @@ components: update: [] delete: [] snapshots_iam_policies: - id: pubsub.snapshots_iam_policies + id: google.pubsub.snapshots_iam_policies name: snapshots_iam_policies title: Snapshots_iam_policies methods: @@ -2024,7 +2030,7 @@ components: update: [] delete: [] schemas_iam_policies: - id: pubsub.schemas_iam_policies + id: google.pubsub.schemas_iam_policies name: schemas_iam_policies title: Schemas_iam_policies methods: @@ -2061,7 +2067,7 @@ components: update: [] delete: [] schemas: - id: pubsub.schemas + id: google.pubsub.schemas name: schemas title: Schemas methods: @@ -2121,10 +2127,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/schemas/methods/projects_schemas_list - $ref: >- #/components/x-stackQL-resources/schemas/methods/projects_schemas_get + - $ref: >- + #/components/x-stackQL-resources/schemas/methods/projects_schemas_list insert: - $ref: >- #/components/x-stackQL-resources/schemas/methods/projects_schemas_create @@ -2133,7 +2139,7 @@ components: - $ref: >- #/components/x-stackQL-resources/schemas/methods/projects_schemas_delete schemas_revisions: - id: pubsub.schemas_revisions + id: google.pubsub.schemas_revisions name: schemas_revisions title: Schemas_revisions methods: @@ -2156,7 +2162,7 @@ components: update: [] delete: [] schemas_revision: - id: pubsub.schemas_revision + id: google.pubsub.schemas_revision name: schemas_revision title: Schemas_revision methods: 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 0ab3c0a5..154ed5a9 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/pubsublite.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/pubsublite.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1 x-discovery-doc-revision: '20240524' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/pubsub/lite/docs servers: @@ -791,7 +791,7 @@ components: - '2' x-stackQL-resources: operations: - id: pubsublite.operations + id: google.pubsublite.operations name: operations title: Operations methods: @@ -829,17 +829,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/operations/methods/admin_projects_locations_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/admin_projects_locations_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/admin_projects_locations_operations_list insert: [] update: [] delete: - $ref: >- #/components/x-stackQL-resources/operations/methods/admin_projects_locations_operations_delete topics: - id: pubsublite.topics + id: google.pubsublite.topics name: topics title: Topics methods: @@ -916,21 +916,23 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/topics/methods/admin_projects_locations_topics_list - $ref: >- #/components/x-stackQL-resources/topics/methods/admin_projects_locations_topics_get - $ref: >- #/components/x-stackQL-resources/topics/methods/admin_projects_locations_reservations_topics_list + - $ref: >- + #/components/x-stackQL-resources/topics/methods/admin_projects_locations_topics_list insert: - $ref: >- #/components/x-stackQL-resources/topics/methods/admin_projects_locations_topics_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/topics/methods/admin_projects_locations_topics_patch delete: - $ref: >- #/components/x-stackQL-resources/topics/methods/admin_projects_locations_topics_delete topics_partitions: - id: pubsublite.topics_partitions + id: google.pubsublite.topics_partitions name: topics_partitions title: Topics_partitions methods: @@ -949,7 +951,7 @@ components: update: [] delete: [] subscriptions: - id: pubsublite.subscriptions + id: google.pubsublite.subscriptions name: subscriptions title: Subscriptions methods: @@ -1021,19 +1023,21 @@ components: select: - $ref: >- #/components/x-stackQL-resources/subscriptions/methods/admin_projects_locations_topics_subscriptions_list - - $ref: >- - #/components/x-stackQL-resources/subscriptions/methods/admin_projects_locations_subscriptions_list - $ref: >- #/components/x-stackQL-resources/subscriptions/methods/admin_projects_locations_subscriptions_get + - $ref: >- + #/components/x-stackQL-resources/subscriptions/methods/admin_projects_locations_subscriptions_list insert: - $ref: >- #/components/x-stackQL-resources/subscriptions/methods/admin_projects_locations_subscriptions_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/subscriptions/methods/admin_projects_locations_subscriptions_patch delete: - $ref: >- #/components/x-stackQL-resources/subscriptions/methods/admin_projects_locations_subscriptions_delete reservations: - id: pubsublite.reservations + id: google.pubsublite.reservations name: reservations title: Reservations methods: @@ -1078,19 +1082,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/reservations/methods/admin_projects_locations_reservations_list - $ref: >- #/components/x-stackQL-resources/reservations/methods/admin_projects_locations_reservations_get + - $ref: >- + #/components/x-stackQL-resources/reservations/methods/admin_projects_locations_reservations_list insert: - $ref: >- #/components/x-stackQL-resources/reservations/methods/admin_projects_locations_reservations_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/reservations/methods/admin_projects_locations_reservations_patch delete: - $ref: >- #/components/x-stackQL-resources/reservations/methods/admin_projects_locations_reservations_delete cursors: - id: pubsublite.cursors + id: google.pubsublite.cursors name: cursors title: Cursors methods: 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 ddeb026f..fad449da 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: '20240510' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/migration-center servers: @@ -536,7 +536,7 @@ components: - '2' x-stackQL-resources: locations: - id: rapidmigrationassessment.locations + id: google.rapidmigrationassessment.locations name: locations title: Locations methods: @@ -558,13 +558,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: rapidmigrationassessment.operations + id: google.rapidmigrationassessment.operations name: operations title: Operations methods: @@ -602,14 +602,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' collectors: - id: rapidmigrationassessment.collectors + id: google.rapidmigrationassessment.collectors name: collectors title: Collectors methods: @@ -675,15 +675,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/collectors/methods/list' - $ref: '#/components/x-stackQL-resources/collectors/methods/get' + - $ref: '#/components/x-stackQL-resources/collectors/methods/list' insert: - $ref: '#/components/x-stackQL-resources/collectors/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/collectors/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/collectors/methods/delete' annotations: - id: rapidmigrationassessment.annotations + id: google.rapidmigrationassessment.annotations name: annotations title: Annotations methods: 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 4bbe5539..515b2763 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: '20240526' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/recaptcha-enterprise/ servers: @@ -36,1180 +36,1362 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment: - description: Account defender risk assessment. + GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction: + description: >- + A redirect action returns a 307 (temporary redirect) response, pointing + the user to a ReCaptcha interstitial page to attach a token. + properties: {} + type: object + id: GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction + GoogleCloudRecaptchaenterpriseV1Event: properties: - labels: - readOnly: true + headers: type: array items: type: string - enum: - - ACCOUNT_DEFENDER_LABEL_UNSPECIFIED - - PROFILE_MATCH - - SUSPICIOUS_LOGIN_ACTIVITY - - SUSPICIOUS_ACCOUNT_CREATION - - RELATED_ACCOUNTS_NUMBER_HIGH - 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. - description: Output only. Labels for this request. - id: GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment - type: object - GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest: - properties: - skipBillingCheck: - type: boolean - 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-enterprise/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-enterprise/docs/billing-information. - type: object - description: The migrate key request message. - id: GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest - GoogleCloudRecaptchaenterpriseV1ScoreDistribution: - type: object - id: GoogleCloudRecaptchaenterpriseV1ScoreDistribution - 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). - type: object - additionalProperties: - format: int64 - type: string - description: Score distribution. - GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest: - type: object - properties: - annotation: - description: >- - Optional. The annotation that will be 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. - enumDeprecated: - - false - - false - - false - - true - - true + description: Optional. HTTP header information about the request. + hashedAccountId: type: string + deprecated: true + format: byte + 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. + fraudPrevention: enum: - - ANNOTATION_UNSPECIFIED - - LEGITIMATE - - FRAUDULENT - - PASSWORD_CORRECT - - PASSWORD_INCORRECT + - FRAUD_PREVENTION_UNSPECIFIED + - ENABLED + - DISABLED + description: Optional. The Fraud Prevention setting for this assessment. 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. + 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. - >- - 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. - accountId: + 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 + userInfo: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1UserInfo' 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. + 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. + firewallPolicyEvaluation: + type: boolean + description: >- + Optional. Flag for enabling firewall policy config assessment. If + this flag is enabled, the firewall policy will be evaluated and a + suggested firewall action will be returned in the response. + express: + type: boolean + description: >- + Optional. Flag for a reCAPTCHA express request for an assessment + without a token. If enabled, `site_key` must reference a SCORE key + with WAF feature set to EXPRESS. + ja3: type: string - reasons: - items: - 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 - 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: array - description: Optional. Reasons for the annotation that are assigned to the event. - hashedAccountId: + description: Optional. JA3 fingerprint for SSL clients. + 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' + expectedAction: 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 - transactionEvent: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionEvent + 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. + wafTokenAssessment: + type: boolean description: >- - Optional. If the assessment is part of a payment transaction, - provide details on payment lifecycle events that occur in the - transaction. - id: GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest - description: The request message to annotate an Assessment. - GoogleCloudRecaptchaenterpriseV1TokenProperties: - description: Properties of the provided event token. + Optional. Flag for running WAF token assessment. If enabled, the + token must be specified, and have been created by a WAF-enabled key. + userIpAddress: + description: >- + Optional. The IP address in the request from the user's device + related to this event. + type: string + requestedUri: + type: string + description: >- + Optional. The URI resource the user requested that triggered an + assessment. + siteKey: + type: string + description: >- + Optional. The site key that was used to invoke reCAPTCHA Enterprise + on your site and generate the token. + userAgent: + type: string + description: >- + Optional. The user agent present in the request from the user's + device related to this event. + token: + type: string + description: >- + Optional. The user response token provided by the reCAPTCHA + Enterprise client-side integration on your site. type: object + description: The event being assessed. + id: GoogleCloudRecaptchaenterpriseV1Event + GoogleCloudRecaptchaenterpriseV1TransactionEvent: properties: - invalidReason: - description: Output only. Reason associated with the response when valid = false. - readOnly: true - enum: - - INVALID_REASON_UNSPECIFIED - - UNKNOWN_INVALID_REASON - - MALFORMED - - EXPIRED - - DUPE - - MISSING - - BROWSER_ERROR + 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. + eventTime: + format: google-datetime 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. - hostname: description: >- - Output only. The hostname of the page on which the token was - generated (Web keys only). - readOnly: true + Optional. Timestamp when this transaction event occurred; otherwise + assumed to be the time of the API call. + reason: type: string - valid: - readOnly: true - type: boolean 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). - action: + Optional. The reason or standardized code that corresponds with this + transaction event, if one exists. For example, a CHARGEBACK event + with code 6005. + eventType: + 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 + 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. + type: object + id: GoogleCloudRecaptchaenterpriseV1TransactionEvent + description: Describes an event in the lifecycle of a payment transaction. + GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict: + type: object + properties: + reasons: + description: Output only. Reasons contributing to the SMS toll fraud verdict. readOnly: true - type: string - description: Output only. Action name provided at token generation. - createTime: + items: + type: string + enumDescriptions: + - Default unspecified reason + - The provided phone number was invalid + enum: + - SMS_TOLL_FRAUD_REASON_UNSPECIFIED + - INVALID_PHONE_NUMBER + type: array + risk: description: >- - Output only. The timestamp corresponding to the generation of the - token. + Output only. Probability of an SMS event being fraudulent. Values + are from 0.0 (lowest) to 1.0 (highest). readOnly: true + format: float + type: number + id: GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict + description: Information about SMS toll fraud. + GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse: + properties: + nextPageToken: type: string - format: google-datetime - iosBundleId: - type: string - readOnly: true description: >- - Output only. The ID of the iOS bundle with which the token was - generated (iOS keys only). - androidPackageName: + 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 memberships listed by the query. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership + id: >- + GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse + type: object + description: The response to a `ListRelatedAccountGroupMemberships` call. + GoogleCloudRecaptchaenterpriseV1TestingOptions: + id: GoogleCloudRecaptchaenterpriseV1TestingOptions + type: object + description: Options for user acceptance testing. + properties: + 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. + enum: + - TESTING_CHALLENGE_UNSPECIFIED + - NOCAPTCHA + - UNSOLVABLE_CHALLENGE type: string - readOnly: true description: >- - Output only. The name of the Android package with which the token - was generated (Android keys only). - id: GoogleCloudRecaptchaenterpriseV1TokenProperties - GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest: - description: The reorder firewall policies request message. - properties: - names: - items: - type: string + Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all + challenge requests for this site will return nocaptcha if NOCAPTCHA, + or an unsolvable challenge if CHALLENGE. + testingScore: + type: number + format: float description: >- - Required. A list containing all policy names, in the new order. Each - name is in the format - `projects/{project}/firewallpolicies/{firewallpolicy}`. - type: array - id: GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest - type: object - GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest: + Optional. All assessments for this Key will return this score. Must + be between 0 (likely not legitimate) and 1 (likely legitimate) + inclusive. + GoogleCloudRecaptchaenterpriseV1ChallengeMetrics: + description: Metrics related to challenges. + id: GoogleCloudRecaptchaenterpriseV1ChallengeMetrics properties: - hashedAccountId: + failedCount: + format: int64 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. + Count of submitted challenge solutions that were incorrect or + otherwise deemed suspicious such that a subsequent challenge was + triggered. type: string - deprecated: true - format: byte - accountId: + pageloadCount: + format: int64 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. + Count of reCAPTCHA checkboxes or badges rendered. This is mostly + equivalent to a count of pageloads for pages that include reCAPTCHA. type: string - pageSize: + nocaptchaCount: 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. - format: int32 - type: integer - pageToken: + Count of nocaptchas (successful verification without a challenge) + issued. + format: int64 + type: string + passedCount: 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. + Count of nocaptchas (successful verification without a challenge) + plus submitted challenge solutions that were correct and resulted in + verification. + format: int64 type: string type: object - id: >- - GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest - description: The request message to search related account group memberships. - GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction: + GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction: + description: >- + A block action serves an HTTP error code a prevents the request from + hitting the backend. type: object + properties: {} + id: GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict: description: >- - A substitute action transparently serves a different page than the one - requested. - id: GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction + Information about card testing fraud, where an adversary is testing + fraudulently obtained cards or brute forcing their details. + type: object + id: >- + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict properties: - path: - type: string + risk: + readOnly: true description: >- - Optional. The address to redirect to. The target is a relative path - in the current host. Example: "/blog/404.html". - GoogleCloudRecaptchaenterpriseV1TransactionDataItem: - id: GoogleCloudRecaptchaenterpriseV1TransactionDataItem - description: Line items being purchased in this transaction. + 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 + GoogleCloudRecaptchaenterpriseV1ListKeysResponse: + id: GoogleCloudRecaptchaenterpriseV1ListKeysResponse + description: Response to request to list keys in a project. properties: - merchantAccountId: - type: string - description: >- - Optional. When a merchant is specified, its corresponding - account_id. Necessary to populate marketplace-style transactions. - quantity: - type: string - description: Optional. The quantity of this item that is being purchased. - format: int64 - name: + nextPageToken: type: string - description: Optional. The full name of the item. - value: description: >- - Optional. The value per item that the user is paying, in the - transaction currency, after discounts. - format: double - type: number - type: object - GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification: + Token to retrieve the next page of results. It is set to empty if no + keys remain in results. + keys: + description: Key details. + items: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' + type: array type: object - id: GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification + GoogleCloudRecaptchaenterpriseV1FirewallAction: properties: - encryptedLeakMatchPrefixes: + includeRecaptchaScript: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction 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` + This action will inject reCAPTCHA JavaScript code into the HTML page + returned by the site backend. + redirect: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction + description: >- + This action will redirect the request to a ReCaptcha interstitial to + attach a token. + allow: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction + description: >- + The user request did not match any policy and should be allowed + access to the requested resource. + substitute: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction + description: >- + This action will transparently serve a different page to an + offending user. + block: + description: >- + This action will deny access to a given page. The user will get an + HTTP error code. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction + setHeader: + description: >- + This action will set a custom header but allow the request to + continue to the customer backend. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction + description: >- + An individual action. Each action represents what to do if a policy + matches. + type: object + id: GoogleCloudRecaptchaenterpriseV1FirewallAction + GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction: + properties: {} + description: An allow action continues processing a request unimpeded. + id: GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction + type: object + GoogleCloudRecaptchaenterpriseV1RiskAnalysis: + properties: + extendedVerdictReasons: readOnly: true - type: array items: - format: byte type: string - reencryptedUserCredentialsHash: - format: byte - 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`. - lookupHashPrefix: - type: string - 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. - encryptedUserCredentialsHash: - type: string - 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 - description: Private password leak verification info. - GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals: - properties: - cardLabels: + Output only. Extended verdict reasons to be used for experimentation + only. The set of possible reasons is subject to change. type: array + reasons: + readOnly: true items: enumDescriptions: - - No label specified. - - This card has been detected as prepaid. + - 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. - >- - This card has been detected as virtual, such as a card number - generated for a single transaction or merchant. + Interactions with the site were significantly different than + expected patterns. - >- - This card has been detected as being used in an unexpected - geographic location. + 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: - - CARD_LABEL_UNSPECIFIED - - PREPAID - - VIRTUAL - - UNEXPECTED_LOCATION + - CLASSIFICATION_REASON_UNSPECIFIED + - AUTOMATION + - UNEXPECTED_ENVIRONMENT + - TOO_MUCH_TRAFFIC + - UNEXPECTED_USAGE_PATTERNS + - LOW_CONFIDENCE_SCORE + - SUSPECTED_CARDING + - SUSPECTED_CHARGEBACK type: string - description: Output only. The labels for the payment card in this transaction. + description: Output only. Reasons contributing to the risk analysis verdict. + type: array + score: + format: float readOnly: true - description: Signals describing the payment card used in this transaction. - id: GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals - type: object - GoogleCloudRecaptchaenterpriseV1AppleDeveloperId: + 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). + description: Risk analysis result for an event. + id: GoogleCloudRecaptchaenterpriseV1RiskAnalysis type: object + GoogleCloudRecaptchaenterpriseV1FirewallPolicy: description: >- - Contains fields that are required to perform Apple-specific integrity - checks. - id: GoogleCloudRecaptchaenterpriseV1AppleDeveloperId + A FirewallPolicy represents a single matching pattern and resulting + actions to take. properties: - privateKey: + path: 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 - teamId: + 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 + actions: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallAction description: >- - Required. The Apple team ID (10-character string) owning the - provisioning profile used to build your application. - keyId: - type: string - description: Required. The Apple developer key ID (10-character string). - GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction: - id: 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: - key: + 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. + name: type: string description: >- - Optional. The header key to set in the request to the backend - server. - value: + Identifier. The resource name for the FirewallPolicy in the format + `projects/{project}/firewallpolicies/{firewallpolicy}`. + condition: type: string description: >- - Optional. The header value to set in the request to the backend - server. + 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. + 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 + id: GoogleCloudRecaptchaenterpriseV1FirewallPolicy type: object - GoogleCloudRecaptchaenterpriseV1UserInfo: - id: GoogleCloudRecaptchaenterpriseV1UserInfo - description: >- - User information associated with a request protected by reCAPTCHA - Enterprise. + GoogleCloudRecaptchaenterpriseV1Assessment: type: object + description: A reCAPTCHA Enterprise assessment resource. properties: - createAccountTime: + fraudSignals: 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 - type: string - userIds: - description: Optional. Identifiers associated with this user or request. - items: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1UserId' - type: array - accountId: + Output only. Fraud Signals specific to the users involved in a + payment transaction. + readOnly: true + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignals' + privatePasswordLeakVerification: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification 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 - GoogleCloudRecaptchaenterpriseV1Event: - type: object - id: GoogleCloudRecaptchaenterpriseV1Event - description: The event being assessed. - properties: - requestedUri: + Optional. The private password leak verification field contains the + parameters that are used to to check for leaks privately without + sharing user credentials. + accountVerification: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo description: >- - Optional. The URI resource the user requested that triggered an - assessment. - type: string - token: - type: string + Optional. Account verification information for identity + verification. The assessment event must include a token and site key + to use this feature. + phoneFraudAssessment: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment + readOnly: true description: >- - Optional. The user response token provided by the reCAPTCHA - Enterprise client-side integration on your site. - userAgent: - 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. + fraudPreventionAssessment: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment description: >- - Optional. The user agent present in the request from the user's - device related to this event. - wafTokenAssessment: - type: boolean + Output only. Assessment returned by Fraud Prevention when + TransactionData is provided. + readOnly: true + event: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Event' + description: Optional. The event being assessed. + riskAnalysis: + description: Output only. The risk analysis result for the event being assessed. + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1RiskAnalysis' + readOnly: true + accountDefenderAssessment: + readOnly: true 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' + Output only. Assessment returned by account defender when an account + identifier is provided. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment + name: + description: >- + Output only. Identifier. The resource name for the Assessment in the + format `projects/{project}/assessments/{assessment}`. + type: string + readOnly: true + firewallPolicyAssessment: + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment + description: >- + Output only. Assessment returned when firewall policies belonging to + the project are evaluated using the field + firewall_policy_evaluation. + tokenProperties: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1TokenProperties' + description: Output only. Properties of the provided event token. + readOnly: true + id: GoogleCloudRecaptchaenterpriseV1Assessment + GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment: + properties: + smsTollFraudVerdict: + readOnly: true 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. - firewallPolicyEvaluation: - type: boolean + Output only. Assessment of this phone event for risk of SMS toll + fraud. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict + description: Assessment for Phone Fraud + type: object + id: GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment + GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest: + id: GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest + properties: + skipBillingCheck: description: >- - Optional. Flag for enabling firewall policy config assessment. If - this flag is enabled, the firewall policy will be evaluated and a - suggested firewall action will be returned in the response. - express: + 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-enterprise/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-enterprise/docs/billing-information. type: boolean - description: >- - Optional. Flag for a reCAPTCHA express request for an assessment - without a token. If enabled, `site_key` must reference a SCORE key - with WAF feature set to EXPRESS. - expectedAction: + type: object + description: The migrate key request message. + GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse: + type: object + properties: + legacySecretKey: 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. - headers: + 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. + id: GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse + description: >- + Secret key is used only in legacy reCAPTCHA. It must be used in a 3rd + party integration with legacy reCAPTCHA. + GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest: + description: The reorder firewall policies request message. + id: GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest + properties: + names: + description: >- + Required. A list containing all policy names, in the new order. Each + name is in the format + `projects/{project}/firewallpolicies/{firewallpolicy}`. + type: array items: type: string - type: array - description: Optional. HTTP header information about the request. - ja3: - description: Optional. JA3 fingerprint for SSL clients. - type: string - siteKey: + type: object + GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest: + properties: + accountId: description: >- - Optional. The site key that was used to invoke reCAPTCHA Enterprise - on your site and generate the token. + 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 - 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' hashedAccountId: - format: byte deprecated: true - type: string - 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. - userIpAddress: - description: >- - Optional. The IP address in the request from the user's device - related to this event. - type: string - 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 - GoogleCloudRecaptchaenterpriseV1Key: - properties: - createTime: - format: google-datetime description: >- - Output only. The timestamp corresponding to the creation of this - key. - readOnly: true + 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: string - iosSettings: - description: Settings for keys that can be used by iOS apps. - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1IOSKeySettings' - webSettings: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1WebKeySettings' - description: Settings for keys that can be used by websites. - labels: - type: object - additionalProperties: - type: string + format: byte + pageSize: + type: integer description: >- - Optional. See [Creating and managing labels] - (https://cloud.google.com/recaptcha-enterprise/docs/labels). - androidSettings: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AndroidKeySettings - description: Settings for keys that can be used by Android apps. - wafSettings: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1WafSettings' - description: Optional. Settings for WAF - displayName: + 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. + format: int32 + pageToken: description: >- - Required. Human-readable display name of this key. Modifiable by - user. + 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 + id: >- + GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest + description: The request message to search related account group memberships. + type: object + GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup: + properties: name: type: string description: >- - Identifier. The resource name for the Key in the format - `projects/{project}/keys/{key}`. - testingOptions: - description: Optional. Options for user acceptance testing. - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1TestingOptions' - id: GoogleCloudRecaptchaenterpriseV1Key + Required. Identifier. The resource name for the related account + group in the format + `projects/{project}/relatedaccountgroups/{related_account_group}`. + id: GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup + description: A group of related accounts. type: object - description: >- - A key used to identify and configure applications (web and/or mobile) - that use reCAPTCHA Enterprise. - GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict: + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict: type: object - id: GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict + id: >- + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict properties: risk: + 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: number readOnly: true - description: >- - Output only. Probability of an SMS event being fraudulent. Values - are from 0.0 (lowest) to 1.0 (highest). - reasons: - type: array + description: >- + Information about stolen instrument fraud, where the user is not the + legitimate owner of the instrument being used for the purchase. + GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment: + description: Account defender risk assessment. + type: object + properties: + labels: readOnly: true - description: Output only. Reasons contributing to the SMS toll fraud verdict. + type: array + description: Output only. Labels for this request. items: - type: string enumDescriptions: - - Default unspecified reason - - The provided phone number was invalid + - 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. enum: - - SMS_TOLL_FRAUD_REASON_UNSPECIFIED - - INVALID_PHONE_NUMBER - description: Information about SMS toll fraud. - GoogleCloudRecaptchaenterpriseV1ScoreMetrics: - description: Metrics related to scoring. - id: 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. - GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction: - id: GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction + - ACCOUNT_DEFENDER_LABEL_UNSPECIFIED + - PROFILE_MATCH + - SUSPICIOUS_LOGIN_ACTIVITY + - SUSPICIOUS_ACCOUNT_CREATION + - RELATED_ACCOUNTS_NUMBER_HIGH + type: string + id: GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment + GoogleCloudRecaptchaenterpriseV1UserId: type: object - description: >- - A block action serves an HTTP error code a prevents the request from - hitting the backend. - properties: {} - GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse: - id: >- - GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse properties: - nextPageToken: + username: 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. - relatedAccountGroupMemberships: + 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. + email: + description: Optional. An email address. + type: string + phoneNumber: + description: Optional. A phone number. Should use the E.164 format. + type: string + id: GoogleCloudRecaptchaenterpriseV1UserId + description: An identifier associated with a user. + GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse: + properties: + relatedAccountGroups: + description: The groups of related accounts listed by the query. items: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership - description: The memberships listed by the query. + #/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup type: array - description: The response to a `ListRelatedAccountGroupMemberships` call. - type: object - GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse: - properties: - legacySecretKey: + nextPageToken: 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. - id: GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse + 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 + description: The response to a `ListRelatedAccountGroups` call. type: object - description: >- - Secret key is used only in legacy reCAPTCHA. It must be used in a 3rd - party integration with legacy reCAPTCHA. - GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction: - id: >- - 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. + GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse: properties: {} + id: GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse + description: The reorder firewall policies response message. type: object - GoogleCloudRecaptchaenterpriseV1IOSKeySettings: - description: Settings specific to keys that can be used by iOS apps. - id: GoogleCloudRecaptchaenterpriseV1IOSKeySettings + GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo: + id: GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo + type: object + description: Details about the transaction from the gateway. properties: - appleDeveloperId: + cvvResponseCode: + type: string description: >- - Optional. Apple Developer account details for the app that is - protected by the reCAPTCHA Key. reCAPTCHA Enterprise leverages - platform-specific checks like Apple App Attest and Apple DeviceCheck - to protect your app from abuse. Providing these fields allows - reCAPTCHA Enterprise to get a better assessment of the integrity of - your app. + Optional. CVV response code from the gateway (available only when + reCAPTCHA Enterprise is called after authorization). + name: + description: >- + Optional. Name of the gateway service (for example, stripe, square, + paypal). + type: string + gatewayResponseCode: + type: string + description: >- + Optional. Gateway response code describing the state of the + transaction. + avsResponseCode: + type: string + description: >- + Optional. AVS response code from the gateway (available only when + reCAPTCHA Enterprise is called after authorization). + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment: + id: GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment + properties: + stolenInstrumentVerdict: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AppleDeveloperId - allowedBundleIds: - type: array - items: - type: string + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict description: >- - Optional. iOS bundle ids of apps allowed to use the key. Example: - 'com.companyname.productname.appname' - allowAllBundleIds: - description: Optional. If set to true, allowed_bundle_ids are not enforced. - type: boolean + Output only. Assessment of this transaction for risk of a stolen + instrument. + readOnly: true + cardTestingVerdict: + description: >- + Output only. Assessment of this transaction for risk of being part + of a card testing attack. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict + readOnly: true + transactionRisk: + format: float + type: number + readOnly: true + 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). + behavioralTrustVerdict: + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict + description: Output only. Assessment of this transaction for behavioral trust. type: object - GoogleCloudRecaptchaenterpriseV1TransactionDataUser: + description: Assessment for Fraud Prevention. + GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction: properties: - emailVerified: - type: boolean + value: + type: string description: >- - 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. + Optional. The header value to set in the request to the backend + server. + key: + description: >- + Optional. The header key to set in the request to the backend + server. type: string + 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 + GoogleCloudRecaptchaenterpriseV1TransactionDataUser: + properties: phoneVerified: type: boolean description: >- Optional. Whether the phone number has been verified to be accessible by the user (OTP or similar). - creationMs: - type: string - format: int64 - description: Optional. The epoch milliseconds of the user's account creation. accountId: type: string 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. + emailVerified: + 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. + creationMs: + type: string + format: int64 + description: Optional. The epoch milliseconds of the user's account creation. + email: + description: Optional. The email address of the user. + type: string + type: object id: GoogleCloudRecaptchaenterpriseV1TransactionDataUser description: Details about a user's account involved in the transaction. + GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest: + id: GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest type: object - GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse: - type: object + description: The request message to annotate an Assessment. properties: - nextPageToken: - type: string + transactionEvent: description: >- - Token to retrieve the next page of results. It is set to empty if no - policies remain in results. - firewallPolicies: - description: Policy details. + 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: items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy - type: array - id: GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse - description: Response to request to list firewall policies belonging to a project. - GoogleCloudRecaptchaenterpriseV1ListKeysResponse: - description: Response to request to list keys in a project. - properties: - keys: + 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 + description: Optional. Reasons for the annotation that are assigned to the event. type: array - description: Key details. - items: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' - nextPageToken: + accountId: type: string description: >- - Token to retrieve the next page of results. It is set to empty if no - keys remain in results. - type: object - id: GoogleCloudRecaptchaenterpriseV1ListKeysResponse - GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment: - description: Policy config assessment. - type: object - id: GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment - properties: - firewallPolicy: - readOnly: true + 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: 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 will be left empty. - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy' - error: + 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. + type: string + format: byte + annotation: + enumDeprecated: + - false + - false + - false + - true + - true + type: string + enum: + - ANNOTATION_UNSPECIFIED + - LEGITIMATE + - FRAUDULENT + - PASSWORD_CORRECT + - PASSWORD_INCORRECT + 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. description: >- - Output only. If the processing of a policy config fails, an error - will be populated and the firewall_policy will be left empty. - readOnly: true - $ref: '#/components/schemas/GoogleRpcStatus' - GoogleCloudRecaptchaenterpriseV1Assessment: - description: A reCAPTCHA Enterprise assessment resource. + Optional. The annotation that will be 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. + GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification: + description: Private password leak verification info. type: object properties: - riskAnalysis: - readOnly: true - description: Output only. The risk analysis result for the event being assessed. - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1RiskAnalysis' - tokenProperties: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1TokenProperties' - description: Output only. Properties of the provided event token. - readOnly: true - name: - type: string - readOnly: true - description: >- - Output only. Identifier. The resource name for the Assessment in the - format `projects/{project}/assessments/{assessment}`. - privatePasswordLeakVerification: - description: >- - Optional. The private password leak verification field contains the - parameters that are used to to check for leaks privately without - sharing user credentials. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification - accountVerification: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo - description: >- - Optional. Account verification information for identity - verification. The assessment event must include a token and site key - to use this feature. - fraudSignals: - readOnly: true - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignals' - description: >- - Output only. Fraud Signals specific to the users involved in a - payment transaction. - phoneFraudAssessment: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment - 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. - fraudPreventionAssessment: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment - readOnly: true + lookupHashPrefix: description: >- - Output only. Assessment returned by Fraud Prevention when - TransactionData is provided. - accountDefenderAssessment: - readOnly: true + 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 + format: byte + encryptedUserCredentialsHash: + format: byte + type: string description: >- - Output only. Assessment returned by account defender when an account - identifier is provided. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment - event: - description: Optional. The event being assessed. - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Event' - firewallPolicyAssessment: + Optional. Encrypted Scrypt hash of the canonicalized + username+password. It is re-encrypted by the server and returned + through `reencrypted_user_credentials_hash`. + encryptedLeakMatchPrefixes: readOnly: true - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment + items: + format: byte + type: string description: >- - Output only. Assessment returned when firewall policies belonging to - the project are evaluated using the field - firewall_policy_evaluation. - id: GoogleCloudRecaptchaenterpriseV1Assessment - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict: - description: >- - Information about stolen instrument fraud, where the user is not the - legitimate owner of the instrument being used for the purchase. - type: object - id: >- - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict - properties: - risk: - format: float - type: number + 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: + format: byte + 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). + 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 - GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo: + id: GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification + GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse: properties: - languageCode: + nextPageToken: description: >- - Optional. Language code preference for the verification message, set - as a IETF BCP 47 language code. + 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 - endpoints: + relatedAccountGroupMemberships: type: array - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo - description: Optional. Endpoints that can be used for identity verification. - username: - 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: string - latestVerificationResult: - 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 - type: string - enumDescriptions: - - No information about the latest account verification. - - >- - The user was successfully verified. This means the account - verification challenge was successfully completed. - - The user failed the verification challenge. - - >- - The site is not properly onboarded to use the account verification - feature. - - >- - The recipient is not allowed for account verification. This can - occur during integration but should not occur in production. - - >- - The recipient has already been sent too many verification codes in - a short amount of time. - - >- - The verification flow could not be completed due to a critical - internal error. - - >- - The client has exceeded their two factor request quota for this - period of time. - - >- - The request cannot be processed at the time because of an - incident. This bypass can be restricted to a problematic - destination email domain, a customer, or could affect the entire - service. - - >- - The request parameters do not match with the token provided and - cannot be processed. - description: Output only. Result of the latest account verification challenge. - readOnly: true - id: GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo - description: Information about account verification, used for identity verification. + description: The queried memberships. + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership + description: The response to a `SearchRelatedAccountGroupMemberships` call. type: object - GoogleCloudRecaptchaenterpriseV1ChallengeMetrics: - description: Metrics related to challenges. + id: >- + GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse + GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals: + id: GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals + type: object + description: Signals describing the user involved in this transaction. properties: - failedCount: - type: string - format: int64 + activeDaysLowerBound: + type: integer + format: int32 description: >- - Count of submitted challenge solutions that were incorrect or - otherwise deemed suspicious such that a subsequent challenge was - triggered. - nocaptchaCount: - type: string - format: int64 + 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 + syntheticRisk: + type: number + format: float description: >- - Count of nocaptchas (successful verification without a challenge) - issued. - pageloadCount: - format: int64 + 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. + readOnly: true + GoogleCloudRecaptchaenterpriseV1AndroidKeySettings: + id: GoogleCloudRecaptchaenterpriseV1AndroidKeySettings + type: object + properties: + supportNonGoogleAppStoreDistribution: description: >- - Count of reCAPTCHA checkboxes or badges rendered. This is mostly - equivalent to a count of pageloads for pages that include reCAPTCHA. - type: string - passedCount: - format: int64 - type: string + 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 + allowAllPackageNames: + type: boolean + description: Optional. If set to true, allowed_package_names are not enforced. + allowedPackageNames: + items: + type: string + type: array description: >- - Count of nocaptchas (successful verification without a challenge) - plus submitted challenge solutions that were correct and resulted in - verification. + Optional. Android package names of apps allowed to use the key. + Example: 'com.companyname.appname' + description: Settings specific to keys that can be used by Android apps. + GoogleCloudRecaptchaenterpriseV1UserInfo: type: object - id: GoogleCloudRecaptchaenterpriseV1ChallengeMetrics - GoogleCloudRecaptchaenterpriseV1UserId: + id: GoogleCloudRecaptchaenterpriseV1UserInfo properties: - phoneNumber: + createAccountTime: + format: google-datetime + 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 - description: Optional. A phone number. Should use the E.164 format. - username: + accountId: 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. - email: - description: Optional. An email address. - type: string - id: GoogleCloudRecaptchaenterpriseV1UserId - description: An identifier associated with a user. + 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. + userIds: + items: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1UserId' + description: Optional. Identifiers associated with this user or request. + type: array + description: >- + User information associated with a request protected by reCAPTCHA + Enterprise. + GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse: type: object - GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo: + description: Response to request to list firewall policies belonging to a project. + id: GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse properties: - gatewayResponseCode: - type: string - description: >- - Optional. Gateway response code describing the state of the - transaction. - avsResponseCode: - type: string - description: >- - Optional. AVS response code from the gateway (available only when - reCAPTCHA Enterprise is called after authorization). - name: + firewallPolicies: + description: Policy details. + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy + type: array + nextPageToken: type: string description: >- - Optional. Name of the gateway service (for example, stripe, square, - paypal). - cvvResponseCode: - description: >- - Optional. CVV response code from the gateway (available only when - reCAPTCHA Enterprise is called after authorization). - type: string - id: GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo - type: object - description: Details about the transaction from the gateway. - GoogleProtobufEmpty: + Token to retrieve the next page of results. It is set to empty if no + policies remain in results. + GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction: + id: >- + GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction 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); } + 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. + GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals: type: object - id: GoogleProtobufEmpty - GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo: - description: Information about a verification endpoint that can be used for 2FA. + id: GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals + description: Signals describing the payment card used in this transaction. properties: - emailAddress: - 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. - format: google-datetime - type: string - readOnly: true - requestToken: + cardLabels: readOnly: true - type: string - description: >- - Output only. Token to provide to the client to trigger endpoint - verification. It must be used within 15 minutes. - phoneNumber: - description: >- - Phone number for which to trigger a verification request. Should be - given in E.164 format. - type: string - id: GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo - type: object + items: + 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. + type: string + type: array + description: Output only. The labels for the payment card in this transaction. GoogleCloudRecaptchaenterpriseV1TransactionData: - type: object - id: GoogleCloudRecaptchaenterpriseV1TransactionData description: >- Transaction data associated with a payment protected by reCAPTCHA Enterprise. properties: - billingAddress: + paymentMethod: + type: string description: >- - Optional. Address associated with the payment method when - applicable. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataAddress - user: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataUser + 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) + currencyCode: + description: Optional. The currency code in ISO-4217 format. + type: string + value: + format: double + type: number description: >- - Optional. Information about the user paying/initiating the - transaction. + Optional. The decimal value of the transaction in the specified + currency. 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. - type: string - cardLastFour: - type: string - description: Optional. The last four digits of the card. shippingAddress: $ref: >- #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataAddress description: >- Optional. Destination address if this transaction involves shipping a physical item. + cardLastFour: + description: Optional. The last four digits of the card. + type: string merchants: + type: array items: $ref: >- #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataUser description: >- Optional. Information about the user or users fulfilling the transaction. - type: array - value: + shippingValue: + format: double type: number description: >- - Optional. The decimal value of the transaction in the specified - currency. - format: double + Optional. The value of shipping in the specified currency. 0 for + free or no shipping. + user: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataUser + description: >- + Optional. Information about the user paying/initiating the + transaction. + cardBin: + type: string + description: >- + Optional. The Bank Identification Number - generally the first 6 or + 8 digits of the card. + gatewayInfo: + description: >- + Optional. Information about the payment gateway's response to the + transaction. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo + billingAddress: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataAddress + description: >- + Optional. Address associated with the payment method when + applicable. items: - type: array + description: Optional. Items purchased in this transaction. items: $ref: >- #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataItem - description: Optional. Items purchased in this transaction. - gatewayInfo: + type: array + id: GoogleCloudRecaptchaenterpriseV1TransactionData + type: object + GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse: + type: object + id: GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse + description: Empty response for AnnotateAssessment. + properties: {} + GoogleCloudRecaptchaenterpriseV1IOSKeySettings: + type: object + description: Settings specific to keys that can be used by iOS apps. + properties: + appleDeveloperId: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AppleDeveloperId description: >- - Optional. Information about the payment gateway's response to the - transaction. - currencyCode: - type: string - description: Optional. The currency code in ISO-4217 format. - shippingValue: + Optional. Apple Developer account details for the app that is + protected by the reCAPTCHA Key. reCAPTCHA Enterprise leverages + platform-specific checks like Apple App Attest and Apple DeviceCheck + to protect your app from abuse. Providing these fields allows + reCAPTCHA Enterprise to get a better assessment of the integrity of + your app. + allowAllBundleIds: + type: boolean + description: Optional. If set to true, allowed_bundle_ids are not enforced. + allowedBundleIds: + type: array + items: + type: string description: >- - Optional. The value of shipping in the specified currency. 0 for - free or no shipping. - format: double - type: number - cardBin: + Optional. iOS bundle ids of apps allowed to use the key. Example: + 'com.companyname.productname.appname' + id: GoogleCloudRecaptchaenterpriseV1IOSKeySettings + GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment: + id: GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment + type: object + properties: + error: + $ref: '#/components/schemas/GoogleRpcStatus' description: >- - Optional. The Bank Identification Number - generally the first 6 or - 8 digits of the card. - type: string - paymentMethod: + Output only. If the processing of a policy config fails, an error + will be populated and the firewall_policy will be left empty. + readOnly: true + firewallPolicy: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy' 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 + 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 will be left empty. + readOnly: true + description: Policy config assessment. GoogleCloudRecaptchaenterpriseV1WafSettings: properties: wafService: - description: Required. The WAF service that uses this key. enumDescriptions: - Undefined WAF - Cloud Armor - Fastly - Cloudflare - type: string enum: - WAF_SERVICE_UNSPECIFIED - CA - FASTLY - CLOUDFLARE + type: string + description: Required. The WAF service that uses this key. wafFeature: + description: Required. The WAF feature for which this key is enabled. + type: string + enum: + - WAF_FEATURE_UNSPECIFIED + - CHALLENGE_PAGE + - SESSION_TOKEN + - ACTION_TOKEN + - EXPRESS enumDescriptions: - Undefined feature. - Redirects suspicious traffic to reCAPTCHA. @@ -1220,220 +1402,90 @@ components: - >- Use reCAPTCHA WAF express protection to protect any content other than web pages, like APIs and IoT devices. - type: string - enum: - - WAF_FEATURE_UNSPECIFIED - - CHALLENGE_PAGE - - SESSION_TOKEN - - ACTION_TOKEN - - EXPRESS - description: Required. The WAF feature for which this key is enabled. description: >- Settings specific to keys that can be used for WAF (Web Application Firewall). - type: object id: GoogleCloudRecaptchaenterpriseV1WafSettings - GoogleCloudRecaptchaenterpriseV1TransactionDataAddress: - properties: - locality: - description: Optional. The town/city of the address. - type: string - postalCode: - type: string - description: Optional. The postal or ZIP code of the address. - 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 - recipient: - type: string - description: >- - Optional. The recipient name, potentially including information such - as "care of". - 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 - description: Structured address format for billing and shipping addresses. - id: GoogleCloudRecaptchaenterpriseV1TransactionDataAddress - type: object - GoogleCloudRecaptchaenterpriseV1TransactionEvent: - id: GoogleCloudRecaptchaenterpriseV1TransactionEvent - type: object - properties: - 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. - eventType: - 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 - 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. - eventTime: - format: google-datetime - description: >- - Optional. Timestamp when this transaction event occurred; otherwise - assumed to be the time of the API call. + type: object + GoogleCloudRecaptchaenterpriseV1TransactionDataItem: + description: Line items being purchased in this transaction. + properties: + name: type: string - reason: + description: Optional. The full name of the item. + merchantAccountId: 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. - description: Describes an event in the lifecycle of a payment transaction. - GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership: - properties: - accountId: + Optional. When a merchant is specified, its corresponding + account_id. Necessary to populate marketplace-style transactions. + value: 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 + Optional. The value per item that the user is paying, in the + transaction currency, after discounts. + format: double + type: number + quantity: type: string + description: Optional. The quantity of this item that is being purchased. + format: int64 + id: GoogleCloudRecaptchaenterpriseV1TransactionDataItem + type: object + GoogleRpcStatus: + properties: + message: 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. - name: + 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 + items: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any description: >- - Required. Identifier. The resource name for this membership in the - format - `projects/{project}/relatedaccountgroups/{relatedaccountgroup}/memberships/{membership}`. + 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. + 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 - description: A membership in a group of related accounts. - id: GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership - GoogleCloudRecaptchaenterpriseV1Metrics: + GoogleCloudRecaptchaenterpriseV1AppleDeveloperId: type: object + id: GoogleCloudRecaptchaenterpriseV1AppleDeveloperId properties: - challengeMetrics: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ChallengeMetrics + keyId: + description: Required. The Apple developer key ID (10-character string). + type: string + teamId: + type: string description: >- - Metrics will be continuous and in order by dates, and in the - granularity of day. Only challenge-based keys (CHECKBOX, INVISIBLE), - will have challenge-based data. + Required. The Apple team ID (10-character string) owning the + provisioning profile used to build your application. + 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: >- + Contains fields that are required to perform Apple-specific integrity + checks. + GoogleCloudRecaptchaenterpriseV1Metrics: + description: Metrics for a single Key. + properties: name: type: string description: >- @@ -1442,516 +1494,443 @@ components: readOnly: true startTime: description: Inclusive start time aligned to a day (UTC). - format: google-datetime type: string + format: google-datetime scoreMetrics: + type: array items: $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1ScoreMetrics' description: >- Metrics will be continuous and in order by dates, and in the granularity of day. All Key types should have score-based data. + challengeMetrics: type: array - id: GoogleCloudRecaptchaenterpriseV1Metrics - description: Metrics for a single Key. - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict: - properties: - risk: - format: float - type: number - readOnly: true - 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). - type: object - id: >- - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict - description: >- - Information about card testing fraud, where an adversary is testing - fraudulently obtained cards or brute forcing their details. - GoogleCloudRecaptchaenterpriseV1AndroidKeySettings: - description: Settings specific to keys that can be used by Android apps. - id: GoogleCloudRecaptchaenterpriseV1AndroidKeySettings - properties: - supportNonGoogleAppStoreDistribution: - 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: - description: >- - Optional. Android package names of apps allowed to use the key. - Example: 'com.companyname.appname' - items: - type: string - type: array - allowAllPackageNames: - description: Optional. If set to true, allowed_package_names are not enforced. - type: boolean - type: object - GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment: - description: Assessment for Phone Fraud - id: GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment - properties: - smsTollFraudVerdict: - description: >- - Output only. Assessment of this phone event for risk of SMS toll - fraud. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict - type: object - GoogleCloudRecaptchaenterpriseV1RiskAnalysis: - id: GoogleCloudRecaptchaenterpriseV1RiskAnalysis - properties: - extendedVerdictReasons: - items: - type: string - description: >- - Output only. Extended verdict reasons to be used for experimentation - only. The set of possible reasons is subject to change. - readOnly: true - type: array - score: - 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). - type: number - reasons: + Metrics will be continuous and in order by dates, and in the + granularity of day. Only challenge-based keys (CHECKBOX, INVISIBLE), + will have challenge-based data. 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. - readOnly: true - type: array - type: object - description: Risk analysis result for an event. - GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals: - description: Signals describing the user involved in this transaction. - properties: - 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. - activeDaysLowerBound: - type: integer - format: int32 - readOnly: true - 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: object - id: GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment: - id: GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment - description: Assessment for Fraud Prevention. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ChallengeMetrics type: object - properties: - stolenInstrumentVerdict: - description: >- - Output only. Assessment of this transaction for risk of a stolen - instrument. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict - cardTestingVerdict: - readOnly: true - description: >- - Output only. Assessment of this transaction for risk of being part - of a card testing attack. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict - transactionRisk: + id: GoogleCloudRecaptchaenterpriseV1Metrics + GoogleCloudRecaptchaenterpriseV1FraudSignals: + id: GoogleCloudRecaptchaenterpriseV1FraudSignals + description: Fraud signals describing users and cards involved in the transaction. + properties: + cardSignals: readOnly: true - type: number - format: float + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals 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). - behavioralTrustVerdict: - description: Output only. Assessment of this transaction for behavioral trust. + Output only. Signals describing the payment card or cards used in + this transaction. + userSignals: + description: Output only. Signals describing the end user in this transaction. $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals readOnly: true - GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse: type: object - description: The response to a `ListRelatedAccountGroups` call. - id: GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse - 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 - relatedAccountGroups: - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup - description: The groups of related accounts listed by the query. - type: array - GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse: - description: Empty response for AnnotateAssessment. + GoogleProtobufEmpty: + type: object properties: {} - id: GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse + 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); } + GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo: type: object - GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup: properties: - name: + emailAddress: + type: string + description: Email address for which to trigger a verification request. + requestToken: + readOnly: true type: string description: >- - Required. Identifier. The resource name for the related account - group in the format - `projects/{project}/relatedaccountgroups/{related_account_group}`. - id: GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup - type: object - description: A group of related accounts. - GoogleCloudRecaptchaenterpriseV1WebKeySettings: - id: GoogleCloudRecaptchaenterpriseV1WebKeySettings - type: object + Output only. Token to provide to the client to trigger endpoint + verification. It must be used within 15 minutes. + lastVerificationTime: + description: >- + Output only. Timestamp of the last successful verification for the + endpoint, if any. + format: google-datetime + type: string + readOnly: true + phoneNumber: + type: string + description: >- + Phone number for which to trigger a verification request. Should be + given in E.164 format. + id: GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo + description: Information about a verification endpoint that can be used for 2FA. + GoogleCloudRecaptchaenterpriseV1TransactionDataAddress: properties: - challengeSecurityPreference: - 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. + locality: + description: Optional. The town/city of the address. type: string + recipient: 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. - allowedDomains: + Optional. The recipient name, potentially including information such + as "care of". + type: string + administrativeArea: + description: >- + Optional. The state, province, or otherwise administrative area of + the address. + type: string + regionCode: + type: string + description: Optional. The CLDR country/region of the address. + postalCode: + type: string + description: Optional. The postal or ZIP code of the address. + address: type: array 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' + 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. items: type: string - allowAmpTraffic: - type: boolean + type: object + id: GoogleCloudRecaptchaenterpriseV1TransactionDataAddress + description: Structured address format for billing and shipping addresses. + GoogleCloudRecaptchaenterpriseV1ScoreDistribution: + properties: + scoreBuckets: 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. - allowAllDomains: - type: boolean + 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). + type: object + additionalProperties: + type: string + format: int64 + description: Score distribution. + type: object + id: GoogleCloudRecaptchaenterpriseV1ScoreDistribution + GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction: + id: GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction + description: >- + A substitute action transparently serves a different page than the one + requested. + properties: + path: + type: string description: >- - Optional. If set to true, it means allowed_domains will not be - enforced. - integrationType: + Optional. The address to redirect to. The target is a relative path + in the current host. Example: "/blog/404.html". + type: object + GoogleCloudRecaptchaenterpriseV1TokenProperties: + id: GoogleCloudRecaptchaenterpriseV1TokenProperties + description: Properties of the provided event token. + properties: + hostname: + description: >- + Output only. The hostname of the page on which the token was + generated (Web keys only). type: string - description: Required. Describes how this key is integrated with the website. + readOnly: true + createTime: + description: >- + Output only. The timestamp corresponding to the generation of the + token. + type: string + readOnly: true + format: google-datetime + invalidReason: enum: - - INTEGRATION_TYPE_UNSPECIFIED - - SCORE - - CHECKBOX - - INVISIBLE + - INVALID_REASON_UNSPECIFIED + - UNKNOWN_INVALID_REASON + - MALFORMED + - EXPIRED + - DUPE + - MISSING + - BROWSER_ERROR 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. - >- - 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: Settings specific to keys that can be used by websites. - GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse: + A retriable error (such as network failure) occurred on the + browser. Could easily be simulated by an attacker. + type: string + description: Output only. Reason associated with the response when valid = false. + readOnly: true + action: + readOnly: true + description: Output only. Action name provided at token generation. + type: string + iosBundleId: + readOnly: true + type: string + description: >- + Output only. The ID of the iOS bundle with which the token was + generated (iOS keys only). + valid: + type: boolean + 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). + readOnly: true + androidPackageName: + type: string + readOnly: true + description: >- + Output only. The name of the Android package with which the token + was generated (Android keys only). + type: object + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict: id: >- - GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse - description: The response to a `SearchRelatedAccountGroupMemberships` call. + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict properties: - nextPageToken: - type: string + trust: + 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. - relatedAccountGroupMemberships: - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership - type: array - description: The queried memberships. + 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 + readOnly: true type: object - GoogleCloudRecaptchaenterpriseV1TestingOptions: - id: GoogleCloudRecaptchaenterpriseV1TestingOptions + description: Information about behavioral trust of the transaction. + GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo: properties: - testingScore: + username: description: >- - Optional. All assessments for this Key will return this score. Must - be between 0 (likely not legitimate) and 1 (likely legitimate) - inclusive. - type: number - format: float - testingChallenge: + Username of the account that is being verified. Deprecated. + Customers should now provide the `account_id` field in + `event.user_info`. + deprecated: true + type: string + latestVerificationResult: + type: string enumDescriptions: + - No information about the latest account verification. - >- - Perform the normal risk analysis and return either nocaptcha or a - challenge depending on risk and trust factors. + The user was successfully verified. This means the account + verification challenge was successfully completed. + - The user failed the verification challenge. - >- - Challenge requests for this key always return a nocaptcha, which - does not require a solution. + The site is not properly onboarded to use the account verification + feature. - >- - Challenge requests for this key always return an unsolvable - challenge. + The recipient is not allowed for account verification. This can + occur during integration but should not occur in production. + - >- + The recipient has already been sent too many verification codes in + a short amount of time. + - >- + The verification flow could not be completed due to a critical + internal error. + - >- + The client has exceeded their two factor request quota for this + period of time. + - >- + The request cannot be processed at the time because of an + incident. This bypass can be restricted to a problematic + destination email domain, a customer, or could affect the entire + service. + - >- + The request parameters do not match with the token provided and + cannot be processed. enum: - - TESTING_CHALLENGE_UNSPECIFIED - - NOCAPTCHA - - UNSOLVABLE_CHALLENGE - description: >- - Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all - challenge requests for this site will return nocaptcha if NOCAPTCHA, - or an unsolvable challenge if CHALLENGE. + - 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 + description: Output only. Result of the latest account verification challenge. + readOnly: true + endpoints: + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo + description: Optional. Endpoints that can be used for identity verification. + type: array + languageCode: type: string + description: >- + Optional. Language code preference for the verification message, set + as a IETF BCP 47 language code. + description: Information about account verification, used for identity verification. type: object - description: Options for user acceptance testing. - GoogleCloudRecaptchaenterpriseV1FirewallPolicy: + id: GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo + GoogleCloudRecaptchaenterpriseV1Key: type: object + id: GoogleCloudRecaptchaenterpriseV1Key properties: - path: - type: string - 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. + testingOptions: + description: Optional. Options for user acceptance testing. + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1TestingOptions' name: type: string description: >- - Identifier. The resource name for the FirewallPolicy in the format - `projects/{project}/firewallpolicies/{firewallpolicy}`. - condition: + Identifier. The resource name for the Key in the format + `projects/{project}/keys/{key}`. + wafSettings: + description: Optional. Settings for WAF + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1WafSettings' + webSettings: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1WebKeySettings' + description: Settings for keys that can be used by websites. + displayName: type: string 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. - description: + Required. Human-readable display name of this key. Modifiable by + user. + createTime: + format: google-datetime description: >- - Optional. A description of what this policy aims to achieve, for - convenience purposes. The description can at most include 256 UTF-8 - characters. + Output only. The timestamp corresponding to the creation of this + key. + readOnly: true type: string - actions: - type: array + labels: 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. - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallAction + Optional. See [Creating and managing labels] + (https://cloud.google.com/recaptcha-enterprise/docs/labels). + type: object + additionalProperties: + type: string + iosSettings: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1IOSKeySettings' + description: Settings for keys that can be used by iOS apps. + androidSettings: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AndroidKeySettings + description: Settings for keys that can be used by Android apps. description: >- - A FirewallPolicy represents a single matching pattern and resulting - actions to take. - id: GoogleCloudRecaptchaenterpriseV1FirewallPolicy - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict: - description: Information about behavioral trust of the transaction. - id: >- - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict + A key used to identify and configure applications (web and/or mobile) + that use reCAPTCHA Enterprise. + GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership: + id: GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership + description: A membership in a group of related accounts. type: object properties: - trust: + name: 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 - GoogleRpcStatus: - properties: - message: + Required. Identifier. The resource name for this membership in the + format + `projects/{project}/relatedaccountgroups/{relatedaccountgroup}/memberships/{membership}`. type: string + accountId: 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: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. + 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: 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. - type: integer - format: int32 - 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). - GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse: - type: object - id: GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse - description: The reorder firewall policies response message. - properties: {} - GoogleCloudRecaptchaenterpriseV1FirewallAction: + 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 + format: byte + deprecated: true + GoogleCloudRecaptchaenterpriseV1WebKeySettings: + description: Settings specific to keys that can be used by websites. + id: GoogleCloudRecaptchaenterpriseV1WebKeySettings type: object - id: GoogleCloudRecaptchaenterpriseV1FirewallAction - description: >- - An individual action. Each action represents what to do if a policy - matches. properties: - substitute: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction - description: >- - This action will transparently serve a different page to an - offending user. - redirect: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction - description: >- - This action will redirect the request to a ReCaptcha interstitial to - attach a token. - block: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction + integrationType: + enum: + - INTEGRATION_TYPE_UNSPECIFIED + - SCORE + - CHECKBOX + - INVISIBLE + 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. + type: string + allowAmpTraffic: + type: boolean description: >- - This action will deny access to a given page. The user will get an - HTTP error code. - setHeader: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction + 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. + allowAllDomains: + type: boolean description: >- - This action will set a custom header but allow the request to - continue to the customer backend. - includeRecaptchaScript: + Optional. If set to true, it means allowed_domains will not be + enforced. + challengeSecurityPreference: description: >- - This action will inject reCAPTCHA JavaScript code into the HTML page - returned by the site backend. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction - allow: + Optional. Settings for the frequency and difficulty at which this + key triggers captcha challenges. This should only be specified for + IntegrationTypes CHECKBOX and INVISIBLE. + type: string + 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. + enum: + - CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED + - USABILITY + - BALANCE + - SECURITY + allowedDomains: + items: + type: string + type: array description: >- - The user request did not match any policy and should be allowed - access to the requested resource. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction - GoogleCloudRecaptchaenterpriseV1FraudSignals: + 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' + GoogleCloudRecaptchaenterpriseV1ScoreMetrics: + description: Metrics related to scoring. + id: GoogleCloudRecaptchaenterpriseV1ScoreMetrics + type: object properties: - cardSignals: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals - readOnly: true + actionMetrics: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ScoreDistribution + type: object description: >- - Output only. Signals describing the payment card or cards used in - this transaction. - userSignals: - description: Output only. Signals describing the end user in this transaction. - readOnly: true + 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/GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals - id: GoogleCloudRecaptchaenterpriseV1FraudSignals - type: object - description: Fraud signals describing users and cards involved in the transaction. - GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction: - type: object - id: GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction - properties: {} - description: An allow action continues processing a request unimpeded. - GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction: - type: object - description: >- - A redirect action returns a 307 (temporary redirect) response, pointing - the user to a ReCaptcha interstitial page to attach a token. - id: GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction - properties: {} + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ScoreDistribution + description: Aggregated score metrics for all traffic. parameters: - 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 - 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 alt: description: Data format for response. in: query @@ -1962,10 +1941,10 @@ components: - json - media - proto - callback: - description: JSONP + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: callback + name: fields schema: type: string _.xgafv: @@ -1977,16 +1956,40 @@ components: enum: - '1' - '2' - 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 - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + callback: + description: JSONP in: query - name: upload_protocol + 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 + 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 prettyPrint: @@ -1995,53 +1998,62 @@ 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. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: quotaUser + name: upload_protocol schema: type: string x-stackQL-resources: - keys_metrics: - id: recaptchaenterprise.keys_metrics - name: keys_metrics - title: Keys_metrics + assessments: + id: google.recaptchaenterprise.assessments + name: assessments + title: Assessments methods: - get_metrics: + annotate: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}~1metrics/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1assessments~1{assessmentsId}:annotate/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/keys_metrics/methods/get_metrics' - insert: [] - update: [] - delete: [] - keys: - id: recaptchaenterprise.keys - name: keys - title: Keys - methods: - get: + create: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}/get' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1assessments/post' response: mediaType: application/json openAPIDocKey: '200' - delete: + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/assessments/methods/create' + update: [] + delete: [] + relatedaccountgroupmemberships: + id: google.recaptchaenterprise.relatedaccountgroupmemberships + name: relatedaccountgroupmemberships + title: Relatedaccountgroupmemberships + methods: + search: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}/delete' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1relatedaccountgroupmemberships:search/post response: mediaType: application/json openAPIDocKey: '200' - patch: + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + keys: + id: google.recaptchaenterprise.keys + name: keys + title: Keys + methods: + create: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}/patch' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys/post' response: mediaType: application/json openAPIDocKey: '200' @@ -2055,123 +2067,79 @@ components: list: operation: *ref_1 response: *ref_2 - create: + delete: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys/post' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}/delete' response: mediaType: application/json openAPIDocKey: '200' - migrate: + get: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}:migrate/post' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}/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: [] - delete: - - $ref: '#/components/x-stackQL-resources/keys/methods/delete' - keys_legacy_secret_key: - id: recaptchaenterprise.keys_legacy_secret_key - name: keys_legacy_secret_key - title: Keys_legacy_secret_key - methods: - retrieve_legacy_secret_key: + patch: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}:retrieveLegacySecretKey/get + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + migrate: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}:migrate/post' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - memberships: - id: recaptchaenterprise.memberships - name: memberships - title: Memberships - methods: - _list: - operation: &ref_3 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1relatedaccountgroups~1{relatedaccountgroupsId}~1memberships/get - response: &ref_4 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.relatedAccountGroupMemberships - list: - operation: *ref_3 - response: *ref_4 sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/memberships/methods/list' - insert: [] - update: [] - delete: [] - relatedaccountgroups: - id: recaptchaenterprise.relatedaccountgroups - name: relatedaccountgroups - title: Relatedaccountgroups + - $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' + delete: + - $ref: '#/components/x-stackQL-resources/keys/methods/delete' + keys_metrics: + id: google.recaptchaenterprise.keys_metrics + name: keys_metrics + title: Keys_metrics methods: - _list: - operation: &ref_5 - $ref: '#/paths/~1v1~1projects~1{projectsId}~1relatedaccountgroups/get' - response: &ref_6 + get_metrics: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}~1metrics/get' + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.relatedAccountGroups - list: - operation: *ref_5 - response: *ref_6 sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/relatedaccountgroups/methods/list' + - $ref: '#/components/x-stackQL-resources/keys_metrics/methods/get_metrics' insert: [] update: [] delete: [] - assessments: - id: recaptchaenterprise.assessments - name: assessments - title: Assessments + keys_legacy_secret_key: + id: google.recaptchaenterprise.keys_legacy_secret_key + name: keys_legacy_secret_key + title: Keys_legacy_secret_key methods: - annotate: + retrieve_legacy_secret_key: operation: $ref: >- - #/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' + #/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}:retrieveLegacySecretKey/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: [] - insert: - - $ref: '#/components/x-stackQL-resources/assessments/methods/create' + insert: [] update: [] delete: [] firewallpolicies: - id: recaptchaenterprise.firewallpolicies + id: google.recaptchaenterprise.firewallpolicies name: firewallpolicies title: Firewallpolicies methods: - patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies~1{firewallpoliciesId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' delete: operation: $ref: >- @@ -2179,81 +2147,122 @@ components: response: mediaType: application/json openAPIDocKey: '200' - get: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies~1{firewallpoliciesId}/get + #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies~1{firewallpoliciesId}/patch response: mediaType: application/json openAPIDocKey: '200' - reorder: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies:reorder/post + #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies~1{firewallpoliciesId}/get response: mediaType: application/json openAPIDocKey: '200' _list: - operation: &ref_7 + operation: &ref_3 $ref: '#/paths/~1v1~1projects~1{projectsId}~1firewallpolicies/get' - response: &ref_8 + response: &ref_4 mediaType: application/json openAPIDocKey: '200' objectKey: $.firewallPolicies list: - operation: *ref_7 - response: *ref_8 + operation: *ref_3 + response: *ref_4 create: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1firewallpolicies/post' response: mediaType: application/json openAPIDocKey: '200' + reorder: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies:reorder/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' insert: - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/delete' - relatedaccountgroupmemberships: - id: recaptchaenterprise.relatedaccountgroupmemberships - name: relatedaccountgroupmemberships - title: Relatedaccountgroupmemberships + relatedaccountgroups: + id: google.recaptchaenterprise.relatedaccountgroups + name: relatedaccountgroups + title: Relatedaccountgroups methods: - search: - operation: + _list: + operation: &ref_5 + $ref: '#/paths/~1v1~1projects~1{projectsId}~1relatedaccountgroups/get' + response: &ref_6 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.relatedAccountGroups + list: + operation: *ref_5 + response: *ref_6 + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/relatedaccountgroups/methods/list' + insert: [] + update: [] + delete: [] + memberships: + id: google.recaptchaenterprise.memberships + name: memberships + title: Memberships + methods: + _list: + operation: &ref_7 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1relatedaccountgroupmemberships:search/post - response: + #/paths/~1v1~1projects~1{projectsId}~1relatedaccountgroups~1{relatedaccountgroupsId}~1memberships/get + response: &ref_8 mediaType: application/json openAPIDocKey: '200' + objectKey: $.relatedAccountGroupMemberships + list: + operation: *ref_7 + response: *ref_8 sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/memberships/methods/list' insert: [] update: [] delete: [] paths: - /v1/projects/{projectsId}/keys/{keysId}/metrics: + /v1/projects/{projectsId}/assessments/{assessmentsId}:annotate: parameters: &ref_9 - - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/quotaUser' - get: + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/upload_protocol' + post: description: >- - Get some aggregated metrics for a Key. This data can be used to build - dashboards. - operationId: recaptchaenterprise.projects.keys.getMetrics + 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 @@ -2265,7 +2274,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Metrics' + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse parameters: - in: path name: projectsId @@ -2273,15 +2283,20 @@ paths: schema: type: string - in: path - name: keysId + name: assessmentsId required: true schema: type: string - /v1/projects/{projectsId}/keys/{keysId}: + /v1/projects/{projectsId}/assessments: parameters: *ref_9 - get: - description: Returns the specified key. - operationId: recaptchaenterprise.projects.keys.get + 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' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2293,21 +2308,25 @@ 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 - delete: - description: Deletes the specified key. - operationId: recaptchaenterprise.projects.keys.delete + /v1/projects/{projectsId}/relatedaccountgroupmemberships:search: + parameters: *ref_9 + 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 @@ -2319,21 +2338,19 @@ 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 - patch: - description: Updates the specified key. - operationId: recaptchaenterprise.projects.keys.patch + /v1/projects/{projectsId}/keys: + parameters: *ref_9 + post: + description: Creates a new reCAPTCHA Enterprise key. + operationId: recaptchaenterprise.projects.keys.create requestBody: content: application/json: @@ -2357,18 +2374,6 @@ paths: 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: - parameters: *ref_9 get: description: Returns the list of all keys that belong to a project. operationId: recaptchaenterprise.projects.keys.list @@ -2400,14 +2405,11 @@ paths: name: pageToken schema: type: string - post: - description: Creates a new reCAPTCHA Enterprise key. - operationId: recaptchaenterprise.projects.keys.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' + /v1/projects/{projectsId}/keys/{keysId}: + parameters: *ref_9 + delete: + description: Deletes the specified key. + operationId: recaptchaenterprise.projects.keys.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2419,29 +2421,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/keys/{keysId}:migrate: - parameters: *ref_9 - 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 + - in: path + name: keysId + required: true + schema: + type: string + get: + description: Returns the specified key. + operationId: recaptchaenterprise.projects.keys.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2465,14 +2459,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/keys/{keysId}:retrieveLegacySecretKey: - parameters: *ref_9 - 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 + patch: + description: Updates the specified key. + operationId: recaptchaenterprise.projects.keys.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2484,8 +2478,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' parameters: - in: path name: projectsId @@ -2497,11 +2490,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/relatedaccountgroups/{relatedaccountgroupsId}/memberships: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/keys/{keysId}/metrics: parameters: *ref_9 get: - description: Get memberships in a group of related accounts. - operationId: recaptchaenterprise.projects.relatedaccountgroups.memberships.list + description: >- + 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 @@ -2513,8 +2513,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Metrics' parameters: - in: path name: projectsId @@ -2522,24 +2521,18 @@ paths: schema: type: string - in: path - name: relatedaccountgroupsId + 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}/relatedaccountgroups: + /v1/projects/{projectsId}/keys/{keysId}:retrieveLegacySecretKey: parameters: *ref_9 get: - description: List groups of related accounts. - operationId: recaptchaenterprise.projects.relatedaccountgroups.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 @@ -2552,36 +2545,34 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse + #/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}/assessments/{assessmentsId}:annotate: + /v1/projects/{projectsId}/keys/{keysId}:migrate: parameters: *ref_9 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 + 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/GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest + #/components/schemas/GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2593,8 +2584,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' parameters: - in: path name: projectsId @@ -2602,20 +2592,15 @@ paths: schema: type: string - in: path - name: assessmentsId + name: keysId required: true schema: type: string - /v1/projects/{projectsId}/assessments: + /v1/projects/{projectsId}/firewallpolicies/{firewallpoliciesId}: parameters: *ref_9 - 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' + delete: + description: Deletes the specified firewall policy. + operationId: recaptchaenterprise.projects.firewallpolicies.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2627,16 +2612,18 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1Assessment + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/firewallpolicies/{firewallpoliciesId}: - parameters: *ref_9 + - in: path + name: firewallpoliciesId + required: true + schema: + type: string patch: description: Updates the specified firewall policy. operationId: recaptchaenterprise.projects.firewallpolicies.patch @@ -2675,9 +2662,9 @@ paths: schema: type: string format: google-fieldmask - delete: - description: Deletes the specified firewall policy. - operationId: recaptchaenterprise.projects.firewallpolicies.delete + get: + description: Returns the specified firewall policy. + operationId: recaptchaenterprise.projects.firewallpolicies.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2689,7 +2676,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy parameters: - in: path name: projectsId @@ -2701,9 +2689,11 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/firewallpolicies: + parameters: *ref_9 get: - description: Returns the specified firewall policy. - operationId: recaptchaenterprise.projects.firewallpolicies.get + 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 @@ -2716,29 +2706,34 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: firewallpoliciesId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/firewallpolicies:reorder: - parameters: *ref_9 + - in: query + name: pageSize + schema: + type: integer + format: int32 post: - description: Reorders all firewall policies. - operationId: recaptchaenterprise.projects.firewallpolicies.reorder + 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/GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2751,18 +2746,24 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/firewallpolicies: + /v1/projects/{projectsId}/firewallpolicies:reorder: parameters: *ref_9 - get: - description: Returns the list of all firewall policies that belong to a project. - operationId: recaptchaenterprise.projects.firewallpolicies.list + post: + description: Reorders all firewall policies. + operationId: recaptchaenterprise.projects.firewallpolicies.reorder + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2775,34 +2776,18 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse 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 - 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 + /v1/projects/{projectsId}/relatedaccountgroups: + parameters: *ref_9 + get: + description: List groups of related accounts. + operationId: recaptchaenterprise.projects.relatedaccountgroups.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2815,24 +2800,27 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/relatedaccountgroupmemberships:search: + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/relatedaccountgroups/{relatedaccountgroupsId}/memberships: parameters: *ref_9 - post: - description: Search group memberships related to a given account. - operationId: recaptchaenterprise.projects.relatedaccountgroupmemberships.search - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest + get: + description: Get memberships in a group of related accounts. + operationId: recaptchaenterprise.projects.relatedaccountgroups.memberships.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2845,10 +2833,24 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse parameters: - in: path name: projectsId required: true schema: type: string + - in: path + name: relatedaccountgroupsId + required: true + 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/recommendationengine.yaml b/providers/src/googleapis.com/v00.00.00000/services/recommendationengine.yaml index 64e48151..0c251941 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: '20240523' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/recommendations-ai/docs servers: @@ -1578,7 +1578,7 @@ components: - '2' x-stackQL-resources: catalogs: - id: recommendationengine.catalogs + id: google.recommendationengine.catalogs name: catalogs title: Catalogs methods: @@ -1605,10 +1605,12 @@ components: - $ref: >- #/components/x-stackQL-resources/catalogs/methods/projects_locations_catalogs_list insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/catalogs/methods/projects_locations_catalogs_patch delete: [] operations: - id: recommendationengine.operations + id: google.recommendationengine.operations name: operations title: Operations methods: @@ -1651,18 +1653,18 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_catalogs_operations_list + #/components/x-stackQL-resources/operations/methods/projects_locations_catalogs_event_stores_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_catalogs_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_catalogs_event_stores_operations_list - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_catalogs_event_stores_operations_get + #/components/x-stackQL-resources/operations/methods/projects_locations_catalogs_operations_list insert: [] update: [] delete: [] prediction_api_key_registrations: - id: recommendationengine.prediction_api_key_registrations + id: google.recommendationengine.prediction_api_key_registrations name: prediction_api_key_registrations title: Prediction_api_key_registrations methods: @@ -1703,7 +1705,7 @@ components: - $ref: >- #/components/x-stackQL-resources/prediction_api_key_registrations/methods/projects_locations_catalogs_event_stores_prediction_api_key_registrations_delete placements: - id: recommendationengine.placements + id: google.recommendationengine.placements name: placements title: Placements methods: @@ -1720,7 +1722,7 @@ components: update: [] delete: [] user_events: - id: recommendationengine.user_events + id: google.recommendationengine.user_events name: user_events title: User_events methods: @@ -1778,7 +1780,7 @@ components: update: [] delete: [] catalog_items: - id: recommendationengine.catalog_items + id: google.recommendationengine.catalog_items name: catalog_items title: Catalog_items methods: @@ -1830,14 +1832,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/catalog_items/methods/projects_locations_catalogs_catalog_items_list - $ref: >- #/components/x-stackQL-resources/catalog_items/methods/projects_locations_catalogs_catalog_items_get + - $ref: >- + #/components/x-stackQL-resources/catalog_items/methods/projects_locations_catalogs_catalog_items_list insert: - $ref: >- #/components/x-stackQL-resources/catalog_items/methods/projects_locations_catalogs_catalog_items_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/catalog_items/methods/projects_locations_catalogs_catalog_items_patch delete: - $ref: >- #/components/x-stackQL-resources/catalog_items/methods/projects_locations_catalogs_catalog_items_delete 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 ec49e41d..050c5dbd 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: '20240519' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/recommender/docs/ servers: @@ -34,22 +34,14 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudRecommenderV1SecurityProjection: - id: GoogleCloudRecommenderV1SecurityProjection - type: object - properties: - details: - type: object - additionalProperties: - description: Properties of the object. - type: any - description: >- - Additional security impact details that is provided by the - recommender. - description: Contains various ways of describing the impact on Security. GoogleTypeMoney: type: object + description: Represents an amount of money with its currency type. + id: GoogleTypeMoney properties: + currencyCode: + type: string + description: The three-letter currency code defined in ISO 4217. units: type: string format: int64 @@ -57,6 +49,8 @@ components: 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 @@ -64,115 +58,68 @@ 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 - currencyCode: - type: string - description: The three-letter currency code defined in ISO 4217. - id: GoogleTypeMoney - description: Represents an amount of money with its currency type. - GoogleCloudRecommenderV1ReliabilityProjection: - id: GoogleCloudRecommenderV1ReliabilityProjection - properties: - details: - description: Per-recommender projection. - additionalProperties: - type: any - description: Properties of the object. - type: object - risks: - description: Reliability risks mitigated by this recommendation. - type: array - items: - type: string - 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. - description: Contains information on the impact of a reliability recommendation. + GoogleCloudRecommenderV1SustainabilityProjection: type: object - GoogleCloudRecommenderV1RecommenderConfig: - id: GoogleCloudRecommenderV1RecommenderConfig + id: GoogleCloudRecommenderV1SustainabilityProjection + description: >- + Contains metadata about how much sustainability a recommendation can + save or incur. properties: - updateTime: - format: google-datetime - type: string - description: Last time when the config was updated. - name: - type: string - description: >- - Identifier. Name of recommender config. Eg, - projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config - etag: - type: string + kgCO2e: + format: double description: >- - Fingerprint of the RecommenderConfig. Provides optimistic locking - when updating. - displayName: + Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e + so that the name renders correctly in camelCase (kgCO2e). + type: number + duration: type: string + description: Duration for which this sustainability applies. + format: google-duration + GoogleCloudRecommenderV1MarkRecommendationFailedRequest: + properties: + etag: description: >- - A user-settable field to provide a human-readable name to be used in - user interfaces. - 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 + Required. Fingerprint of the Recommendation. Provides optimistic + locking. type: string - recommenderGenerationConfig: - description: >- - RecommenderGenerationConfig which configures the Generation of - recommendations for this recommender. - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1RecommenderGenerationConfig - annotations: - 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. + stateMetadata: additionalProperties: type: string - description: Configuration for a Recommender. + description: >- + State properties to include with this state. Overwrites any existing + `state_metadata`. Keys must match the regex `/^a-z0-9{0,62}$/`. + Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`. + type: object type: object - GoogleCloudRecommenderV1CostProjection: + id: GoogleCloudRecommenderV1MarkRecommendationFailedRequest + description: Request for the `MarkRecommendationFailed` Method. + GoogleCloudRecommenderV1RecommendationInsightReference: properties: - costInLocalCurrency: - $ref: '#/components/schemas/GoogleTypeMoney' - description: >- - The approximate cost savings in the billing account's local - currency. - cost: - $ref: '#/components/schemas/GoogleTypeMoney' + insight: 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: - description: Duration for which this cost applies. - format: google-duration + Insight resource name, e.g. + projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID] type: string - id: GoogleCloudRecommenderV1CostProjection - description: >- - Contains metadata about how much money a recommendation can save or - incur. + id: GoogleCloudRecommenderV1RecommendationInsightReference + description: Reference to an associated insight. + type: object + GoogleCloudRecommenderV1ListInsightsResponse: + description: Response to the `ListInsights` method. type: object + properties: + insights: + description: The set of insights for the `parent` resource. + type: array + items: + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + 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. + id: GoogleCloudRecommenderV1ListInsightsResponse GoogleCloudRecommenderV1Insight: + type: object properties: category: enum: @@ -183,6 +130,7 @@ components: - MANAGEABILITY - SUSTAINABILITY - RELIABILITY + description: Category being targeted by the insight. enumDescriptions: - Unspecified category. - The insight is related to cost. @@ -192,22 +140,12 @@ components: - The insight is related to sustainability. - This insight is related to reliability. type: string - description: Category being targeted by the insight. - 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 + type: array description: Recommendations derived from this insight. - lastRefreshTime: - description: Timestamp of the latest data used to generate the insight. - type: string - format: google-datetime severity: enum: - SEVERITY_UNSPECIFIED @@ -215,6 +153,7 @@ components: - MEDIUM - HIGH - CRITICAL + type: string description: Insight's severity. enumDescriptions: - Insight has unspecified severity. @@ -222,315 +161,237 @@ components: - Insight has medium severity. - Insight has high severity. - Insight has critical severity. - type: string - insightSubtype: - description: >- - Insight subtype. Insight content schema will be stable for a given - subtype. - type: string - targetResources: - description: Fully qualified resource names that this insight is targeting. - type: array - items: - type: string etag: description: >- Fingerprint of the Insight. Provides optimistic locking when updating states. type: string - observationPeriod: - type: string - 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 + targetResources: + items: + type: string + description: Fully qualified resource names that this insight is targeting. + type: array stateInfo: $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightStateInfo' description: Information state and metadata. content: + description: >- + A struct of custom fields to explain the insight. Example: + "grantedPermissionsCount": "1000" additionalProperties: type: any description: Properties of the object. type: object + description: + type: string description: >- - A struct of custom fields to explain the insight. Example: - "grantedPermissionsCount": "1000" + Free-form human readable summary in English. The maximum length is + 500 characters. + insightSubtype: + description: >- + Insight subtype. Insight content schema will be stable for a given + subtype. + type: string + 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). + type: string + format: google-duration name: description: Identifier. Name of the insight. type: string id: GoogleCloudRecommenderV1Insight - type: object description: >- An insight along with the information used to derive the insight. The insight may have associated recommendations as well. - GoogleCloudRecommenderV1RecommenderGenerationConfig: - id: GoogleCloudRecommenderV1RecommenderGenerationConfig + GoogleCloudRecommenderV1RecommendationContent: + id: GoogleCloudRecommenderV1RecommendationContent properties: - params: - description: >- - Parameters for this RecommenderGenerationConfig. These configs can - be used by or are applied to all subtypes. + overview: additionalProperties: - description: Properties of the object. type: any + description: Properties of the object. + description: Condensed overview information about the recommendation. type: object - type: object - description: >- - A Configuration to customize the generation of recommendations. Eg, - customizing the lookback period considered when generating a - recommendation. - GoogleCloudRecommenderV1ListRecommendationsResponse: - id: GoogleCloudRecommenderV1ListRecommendationsResponse - description: Response to the `ListRecommendations` method. - 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. - recommendations: + operationGroups: items: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' - description: The set of recommendations for the `parent` resource. + $ref: '#/components/schemas/GoogleCloudRecommenderV1OperationGroup' type: array + 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. + description: Contains what resources are changing and how they are changing. type: object - GoogleCloudRecommenderV1OperationGroup: - description: Group of operations that need to be performed atomically. - id: GoogleCloudRecommenderV1OperationGroup + GoogleCloudRecommenderV1InsightStateInfo: type: object + description: Information related to insight state. properties: - operations: - items: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Operation' - type: array + stateMetadata: + type: object + additionalProperties: + type: string 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. - GoogleCloudRecommenderV1RecommendationStateInfo: - id: GoogleCloudRecommenderV1RecommendationStateInfo - description: Information for state. Contains state and metadata. - type: object - properties: + A map of metadata for the state, provided by user or automations + systems. state: - description: The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED. enum: - STATE_UNSPECIFIED - ACTIVE - - CLAIMED - - SUCCEEDED - - FAILED + - ACCEPTED - DISMISSED + description: Insight state. type: string 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. + - Unspecified state. - >- - Recommendation is in succeeded state. Recommendations content is - immutable and cannot be updated by Google. SUCCEEDED - recommendations can be marked as SUCCEEDED, or FAILED. + Insight is active. Content for ACTIVE insights can be updated by + Google. ACTIVE insights can be marked DISMISSED OR ACCEPTED. - >- - Recommendation is in failed state. Recommendations content is - immutable and cannot be updated by Google. FAILED recommendations - can be marked as SUCCEEDED, or FAILED. + 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). - >- - Recommendation is in dismissed state. Recommendation content can - be updated by Google. DISMISSED recommendations can be marked as - ACTIVE. - stateMetadata: - additionalProperties: - type: string - description: >- - A map of metadata for the state, provided by user or automations - systems. - type: object - GoogleCloudRecommenderV1MarkRecommendationFailedRequest: + Insight is dismissed. Content for DISMISSED insights can be + updated by Google. DISMISSED insights can be marked as ACTIVE. + id: GoogleCloudRecommenderV1InsightStateInfo + GoogleCloudRecommenderV1Impact: properties: - stateMetadata: - additionalProperties: - type: string - 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}$/`. - etag: - description: >- - Required. Fingerprint of the Recommendation. Provides optimistic - locking. + costProjection: + description: Use with CategoryType.COST + $ref: '#/components/schemas/GoogleCloudRecommenderV1CostProjection' + category: + 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. type: string - id: GoogleCloudRecommenderV1MarkRecommendationFailedRequest - description: Request for the `MarkRecommendationFailed` Method. + enum: + - CATEGORY_UNSPECIFIED + - COST + - SECURITY + - PERFORMANCE + - MANAGEABILITY + - SUSTAINABILITY + - RELIABILITY + sustainabilityProjection: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1SustainabilityProjection + description: Use with CategoryType.SUSTAINABILITY + reliabilityProjection: + $ref: '#/components/schemas/GoogleCloudRecommenderV1ReliabilityProjection' + description: Use with CategoryType.RELIABILITY + securityProjection: + $ref: '#/components/schemas/GoogleCloudRecommenderV1SecurityProjection' + description: Use with CategoryType.SECURITY + id: GoogleCloudRecommenderV1Impact + description: Contains the impact a recommendation can have for a given category. type: object - GoogleCloudRecommenderV1MarkInsightAcceptedRequest: + GoogleCloudRecommenderV1SecurityProjection: + description: Contains various ways of describing the impact on Security. + id: GoogleCloudRecommenderV1SecurityProjection type: object - description: Request for the `MarkInsightAccepted` method. properties: - stateMetadata: + details: type: object additionalProperties: - type: string + description: Properties of the object. + type: any description: >- - Optional. State properties user wish to include with this state. - Full replace of the current state_metadata. - etag: - type: string - description: Required. Fingerprint of the Insight. Provides optimistic locking. - id: GoogleCloudRecommenderV1MarkInsightAcceptedRequest - GoogleCloudRecommenderV1InsightRecommendationReference: - id: GoogleCloudRecommenderV1InsightRecommendationReference + Additional security impact details that is provided by the + recommender. + GoogleCloudRecommenderV1Operation: + id: GoogleCloudRecommenderV1Operation properties: - recommendation: - type: string + value: description: >- - Recommendation resource name, e.g. - projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID] - type: object - description: Reference to an associated recommendation. - GoogleCloudRecommenderV1RecommendationContent: - description: Contains what resources are changing and how they are changing. - properties: - overview: + Value for the `path` field. Will be set for actions:'add'/'replace'. + Maybe set for action: 'test'. Either this or `value_matcher` will be + set for 'test' operation. An exact match must be performed. + type: any + pathValueMatchers: additionalProperties: - type: any - description: Properties of the object. + $ref: '#/components/schemas/GoogleCloudRecommenderV1ValueMatcher' type: object - description: Condensed overview information about the recommendation. - 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. - items: - $ref: '#/components/schemas/GoogleCloudRecommenderV1OperationGroup' - type: array - type: object - id: GoogleCloudRecommenderV1RecommendationContent - GoogleCloudRecommenderV1Recommendation: - id: GoogleCloudRecommenderV1Recommendation - type: object - properties: - primaryImpact: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Impact' description: >- - The primary impact that this recommendation can have while trying to - optimize for one category. - etag: + 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. + action: type: string description: >- - Fingerprint of the Recommendation. Provides optimistic locking when - updating states. - lastRefreshTime: - format: google-datetime + Type of this operation. Contains one of 'add', 'remove', 'replace', + 'move', 'copy', 'test' and custom operations. This field is + case-insensitive and always populated. + path: description: >- - Last time this recommendation was refreshed by the system that - created it in the first place. - type: string - associatedInsights: - description: Insights that led to this recommendation. - items: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1RecommendationInsightReference - type: array - description: + Path to the target field being operated on. If the operation is at + the resource level, then path should be "/". This field is always + populated. type: string + resourceType: description: >- - Free-form human readable summary in English. The maximum length is - 500 characters. - 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). + Type of GCP resource being modified/tested. This field is always + populated. Example: cloudresourcemanager.googleapis.com/Project, + compute.googleapis.com/Instance type: string - description: Recommendation's priority. - enum: - - PRIORITY_UNSPECIFIED - - P4 - - P3 - - P2 - - P1 - additionalImpact: - type: array + valueMatcher: + $ref: '#/components/schemas/GoogleCloudRecommenderV1ValueMatcher' description: >- - Optional set of additional impact that this recommendation may have - when trying to optimize for the primary category. These may be - positive or negative. - items: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Impact' - recommenderSubtype: - type: string + 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. + pathFilters: + additionalProperties: + type: any 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" - name: - description: Identifier. Name of recommendation. - type: string - xorGroupId: + 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. + type: object + resource: type: string 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. - content: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommendationContent' - description: >- - Content of the recommendation describing recommended changes to - resources. - targetResources: - items: - type: string - type: array + Contains the fully qualified resource name. This field is always + populated. ex: //cloudresourcemanager.googleapis.com/projects/foo. + sourceResource: + type: string description: >- - Fully qualified resource names that this recommendation is - targeting. - stateInfo: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommendationStateInfo' - description: Information for state. Contains state and metadata. - description: >- - A recommendation along with a suggested action. E.g., a rightsizing - recommendation for an underutilized VM, IAM role recommendations, etc - GoogleCloudRecommenderV1InsightTypeGenerationConfig: - description: >- - A configuration to customize the generation of insights. Eg, customizing - the lookback period considered when generating a insight. - id: GoogleCloudRecommenderV1InsightTypeGenerationConfig - type: object - properties: - params: + 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`. + sourcePath: 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 - GoogleCloudRecommenderV1MarkRecommendationDismissedRequest: - id: GoogleCloudRecommenderV1MarkRecommendationDismissedRequest - properties: - etag: - description: Fingerprint of the Recommendation. Provides optimistic locking. + Can be set with action 'copy' or 'move' to indicate the source field + within resource or source_resource, ignored if provided for other + operation types. type: string - type: object - description: Request for the `MarkRecommendationDismissed` Method. - GoogleCloudRecommenderV1Operation: description: >- Contains an operation for a resource loosely based on the JSON-PATCH format with support for: * Custom filters for describing partial array @@ -539,103 +400,62 @@ components: described. * Allows extension to custom operations not natively supported by RFC6902. See https://tools.ietf.org/html/rfc6902 for details on the original RFC. + type: object + GoogleCloudRecommenderV1ReliabilityProjection: + type: object + description: Contains information on the impact of a reliability recommendation. + id: GoogleCloudRecommenderV1ReliabilityProjection properties: - 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. - 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 - value: - description: >- - Value for the `path` field. Will be set for actions:'add'/'replace'. - Maybe set for action: 'test'. Either this or `value_matcher` will be - set for 'test' operation. An exact match must be performed. - type: any - sourceResource: - description: >- - Can be set with action 'copy' to copy resource configuration across - different resources of the same type. Example: A resource clone can - be done via action = 'copy', path = "/", from = "/", source_resource - = and resource_name = . This field is empty for all other values of - `action`. - type: string - pathValueMatchers: + risks: + description: Reliability risks mitigated by this recommendation. + 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. + type: array + details: type: object + description: Per-recommender projection. additionalProperties: - $ref: '#/components/schemas/GoogleCloudRecommenderV1ValueMatcher' - 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. - resource: - description: >- - Contains the fully qualified resource name. This field is always - populated. ex: //cloudresourcemanager.googleapis.com/projects/foo. - type: string - path: - description: >- - Path to the target field being operated on. If the operation is at - the resource level, then path should be "/". This field is always - populated. - type: string - resourceType: - description: >- - Type of GCP resource being modified/tested. This field is always - populated. Example: cloudresourcemanager.googleapis.com/Project, - compute.googleapis.com/Instance + description: Properties of the object. + type: any + GoogleCloudRecommenderV1MarkRecommendationDismissedRequest: + type: object + description: Request for the `MarkRecommendationDismissed` Method. + id: GoogleCloudRecommenderV1MarkRecommendationDismissedRequest + properties: + etag: + description: Fingerprint of the Recommendation. Provides optimistic locking. type: string - pathFilters: + GoogleCloudRecommenderV1RecommenderGenerationConfig: + id: GoogleCloudRecommenderV1RecommenderGenerationConfig + properties: + params: additionalProperties: type: any + description: Properties of the object. 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. + Parameters for this RecommenderGenerationConfig. These configs can + be used by or are applied to all subtypes. type: object - 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. - id: GoogleCloudRecommenderV1Operation type: object + description: >- + A Configuration to customize the generation of recommendations. Eg, + customizing the lookback period considered when generating a + recommendation. GoogleCloudRecommenderV1MarkRecommendationClaimedRequest: - description: Request for the `MarkRecommendationClaimed` Method. id: GoogleCloudRecommenderV1MarkRecommendationClaimedRequest type: object - properties: - etag: - description: >- - Required. Fingerprint of the Recommendation. Provides optimistic - locking. - type: string - 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}$/`. - additionalProperties: - type: string - type: object - GoogleCloudRecommenderV1MarkRecommendationSucceededRequest: properties: etag: type: string @@ -650,80 +470,81 @@ components: `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 - description: Request for the `MarkRecommendationSucceeded` Method. - type: object - GoogleCloudRecommenderV1SustainabilityProjection: - properties: - duration: - description: Duration for which this sustainability applies. - type: string - format: google-duration - kgCO2e: - format: double - description: >- - Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e - so that the name renders correctly in camelCase (kgCO2e). - type: number + description: Request for the `MarkRecommendationClaimed` Method. + GoogleCloudRecommenderV1InsightTypeConfig: type: object - id: GoogleCloudRecommenderV1SustainabilityProjection - description: >- - Contains metadata about how much sustainability a recommendation can - save or incur. - GoogleCloudRecommenderV1RecommendationInsightReference: - description: Reference to an associated insight. - id: GoogleCloudRecommenderV1RecommendationInsightReference properties: - insight: + etag: type: string description: >- - Insight resource name, e.g. - projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID] - type: object - GoogleCloudRecommenderV1ValueMatcher: - type: object - description: Contains various matching options for values for a GCP resource field. - id: GoogleCloudRecommenderV1ValueMatcher - properties: - matchesPattern: - 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 + Fingerprint of the InsightTypeConfig. Provides optimistic locking + when updating. + updateTime: type: string - GoogleCloudRecommenderV1InsightTypeConfig: - type: object - description: Configuration for an InsightType. - properties: + format: google-datetime + description: Last time when the config was updated. name: description: >- Identifier. Name of insight type config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config type: string - insightTypeGenerationConfig: - description: >- - InsightTypeGenerationConfig which configures the generation of - insights for this insight type. - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1InsightTypeGenerationConfig - displayName: + 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. + 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. + displayName: type: string description: >- A user-settable field to provide a human-readable name to be used in user interfaces. - etag: + insightTypeGenerationConfig: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1InsightTypeGenerationConfig + description: >- + InsightTypeGenerationConfig which configures the generation of + insights for this insight type. + description: Configuration for an InsightType. + id: GoogleCloudRecommenderV1InsightTypeConfig + GoogleCloudRecommenderV1ValueMatcher: + id: GoogleCloudRecommenderV1ValueMatcher + description: Contains various matching options for values for a GCP resource field. + properties: + matchesPattern: type: string description: >- - Fingerprint of the InsightTypeConfig. Provides optimistic locking - when updating. - revisionId: + 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: object + GoogleCloudRecommenderV1RecommenderConfig: + id: GoogleCloudRecommenderV1RecommenderConfig + type: object + description: Configuration for a Recommender. + properties: + displayName: 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 + A user-settable field to provide a human-readable name to be used in + user interfaces. 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 @@ -732,163 +553,351 @@ 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. + etag: + type: string + description: >- + Fingerprint of the RecommenderConfig. Provides optimistic locking + when updating. + recommenderGenerationConfig: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1RecommenderGenerationConfig + description: >- + RecommenderGenerationConfig which configures the Generation of + recommendations for this recommender. + updateTime: + type: string + description: Last time when the config was updated. + format: google-datetime + 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 + name: + description: >- + Identifier. Name of recommender config. Eg, + projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config + type: string + GoogleCloudRecommenderV1ListRecommendationsResponse: + properties: + recommendations: + items: + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + description: The set of recommendations for the `parent` resource. + type: array + 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 + description: Response to the `ListRecommendations` method. + id: GoogleCloudRecommenderV1ListRecommendationsResponse + GoogleCloudRecommenderV1InsightTypeGenerationConfig: + type: object + description: >- + A configuration to customize the generation of insights. Eg, customizing + the lookback period considered when generating a insight. + properties: + params: + type: object + 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 + id: GoogleCloudRecommenderV1InsightTypeGenerationConfig + GoogleCloudRecommenderV1OperationGroup: + description: Group of operations that need to be performed atomically. + id: GoogleCloudRecommenderV1OperationGroup + properties: + operations: + type: array + 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: object + GoogleCloudRecommenderV1MarkRecommendationSucceededRequest: + type: object + id: GoogleCloudRecommenderV1MarkRecommendationSucceededRequest + properties: + etag: + type: string + description: >- + Required. Fingerprint of the Recommendation. Provides optimistic + locking. + stateMetadata: additionalProperties: type: string type: object - updateTime: + 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}$/`. + description: Request for the `MarkRecommendationSucceeded` Method. + GoogleCloudRecommenderV1InsightRecommendationReference: + id: GoogleCloudRecommenderV1InsightRecommendationReference + properties: + recommendation: type: string - format: google-datetime - description: Last time when the config was updated. - id: GoogleCloudRecommenderV1InsightTypeConfig - GoogleCloudRecommenderV1InsightStateInfo: + description: >- + Recommendation resource name, e.g. + projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID] + type: object + description: Reference to an associated recommendation. + GoogleCloudRecommenderV1MarkInsightAcceptedRequest: + description: Request for the `MarkInsightAccepted` method. + id: GoogleCloudRecommenderV1MarkInsightAcceptedRequest type: object - description: Information related to insight state. - id: GoogleCloudRecommenderV1InsightStateInfo properties: + etag: + type: string + description: Required. Fingerprint of the Insight. Provides optimistic locking. stateMetadata: type: object additionalProperties: type: string description: >- - A map of metadata for the state, provided by user or automations - systems. + Optional. State properties user wish to include with this state. + Full replace of the current state_metadata. + GoogleCloudRecommenderV1CostProjection: + id: GoogleCloudRecommenderV1CostProjection + type: object + properties: + costInLocalCurrency: + $ref: '#/components/schemas/GoogleTypeMoney' + description: >- + The approximate cost savings in the billing account's local + currency. + duration: + format: google-duration + description: Duration for which this cost applies. + type: string + 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' + description: >- + Contains metadata about how much money a recommendation can save or + incur. + GoogleCloudRecommenderV1RecommendationStateInfo: + description: Information for state. Contains state and metadata. + type: object + properties: state: - description: Insight state. enum: - STATE_UNSPECIFIED - ACTIVE - - ACCEPTED + - CLAIMED + - SUCCEEDED + - FAILED - DISMISSED + description: The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED. + type: string enumDescriptions: - - Unspecified state. + - Default state. Don't use directly. - >- - Insight is active. Content for ACTIVE insights can be updated by - Google. ACTIVE insights can be marked DISMISSED OR ACCEPTED. + Recommendation is active and can be applied. Recommendations + content can be updated by Google. ACTIVE recommendations can be + marked as CLAIMED, SUCCEEDED, or FAILED. - >- - 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). + 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. - >- - Insight is dismissed. Content for DISMISSED insights can be - updated by Google. DISMISSED insights can be marked as ACTIVE. - type: string - GoogleCloudRecommenderV1ListInsightsResponse: - id: GoogleCloudRecommenderV1ListInsightsResponse + 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. + stateMetadata: + description: >- + A map of metadata for the state, provided by user or automations + systems. + additionalProperties: + type: string + type: object + id: GoogleCloudRecommenderV1RecommendationStateInfo + GoogleCloudRecommenderV1Recommendation: + description: >- + A recommendation along with a suggested action. E.g., a rightsizing + recommendation for an underutilized VM, IAM role recommendations, etc + type: object + id: GoogleCloudRecommenderV1Recommendation properties: - insights: + additionalImpact: items: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' - description: The set of insights for the `parent` resource. + $ref: '#/components/schemas/GoogleCloudRecommenderV1Impact' + 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. + type: array + stateInfo: + description: Information for state. Contains state and metadata. + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommendationStateInfo' + targetResources: type: array - 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. - type: object - GoogleCloudRecommenderV1Impact: - type: object - properties: - category: - 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. + Fully qualified resource names that this recommendation is + targeting. + items: + type: string + name: + type: string + description: Identifier. Name of recommendation. + priority: + type: string enum: - - CATEGORY_UNSPECIFIED - - COST - - SECURITY - - PERFORMANCE - - MANAGEABILITY - - SUSTAINABILITY - - RELIABILITY + - PRIORITY_UNSPECIFIED + - P4 + - P3 + - P2 + - P1 + description: Recommendation's 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). + description: type: string - securityProjection: - description: Use with CategoryType.SECURITY - $ref: '#/components/schemas/GoogleCloudRecommenderV1SecurityProjection' - costProjection: - description: Use with CategoryType.COST - $ref: '#/components/schemas/GoogleCloudRecommenderV1CostProjection' - sustainabilityProjection: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1SustainabilityProjection - description: Use with CategoryType.SUSTAINABILITY - reliabilityProjection: - $ref: '#/components/schemas/GoogleCloudRecommenderV1ReliabilityProjection' - description: Use with CategoryType.RELIABILITY - id: GoogleCloudRecommenderV1Impact - description: Contains the impact a recommendation can have for a given category. + description: >- + Free-form human readable summary in English. The maximum length is + 500 characters. + lastRefreshTime: + description: >- + Last time this recommendation was refreshed by the system that + created it in the first place. + format: google-datetime + type: string + primaryImpact: + description: >- + The primary impact that this recommendation can have while trying to + optimize for one category. + $ref: '#/components/schemas/GoogleCloudRecommenderV1Impact' + content: + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommendationContent' + description: >- + Content of the recommendation describing recommended changes to + resources. + 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" + etag: + type: string + description: >- + Fingerprint of the Recommendation. Provides optimistic locking when + updating states. + xorGroupId: + type: string + 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. + associatedInsights: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1RecommendationInsightReference + description: Insights that led to this recommendation. 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 + 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 - enum: - - json - - media - - proto 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 - access, quota, and reports. Required unless you provide an OAuth 2.0 - token. + callback: + description: JSONP in: query - name: key + name: callback 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 - 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 - 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 - 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 _.xgafv: description: V1 error format. in: query @@ -898,68 +907,124 @@ 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: + insight_types_config: + id: google.recommender.insight_types_config + name: insight_types_config + title: Insight_types_config + methods: + organizations_locations_insight_types_get_config: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_insight_types_update_config: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/patch + response: + mediaType: application/json + openAPIDocKey: '200' + billing_accounts_locations_insight_types_update_config: + operation: + $ref: >- + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/patch + response: + mediaType: application/json + openAPIDocKey: '200' + billing_accounts_locations_insight_types_get_config: + operation: + $ref: >- + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_insight_types_get_config: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_insight_types_update_config: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/patch + 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: [] + delete: [] insights: - id: recommender.insights + id: google.recommender.insights name: insights title: Insights methods: - billing_accounts_locations_insight_types_insights_mark_accepted: + organizations_locations_insight_types_insights_get: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}/get response: mediaType: application/json openAPIDocKey: '200' - _billing_accounts_locations_insight_types_insights_list: + _organizations_locations_insight_types_insights_list: operation: &ref_1 $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get response: &ref_2 mediaType: application/json openAPIDocKey: '200' objectKey: $.insights - billing_accounts_locations_insight_types_insights_list: + organizations_locations_insight_types_insights_list: operation: *ref_1 response: *ref_2 - billing_accounts_locations_insight_types_insights_get: + organizations_locations_insight_types_insights_mark_accepted: 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}:markAccepted/post response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_insight_types_insights_list: + billing_accounts_locations_insight_types_insights_mark_accepted: + operation: + $ref: >- + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post + response: + mediaType: application/json + openAPIDocKey: '200' + _billing_accounts_locations_insight_types_insights_list: operation: &ref_3 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get response: &ref_4 mediaType: application/json openAPIDocKey: '200' objectKey: $.insights - projects_locations_insight_types_insights_list: + billing_accounts_locations_insight_types_insights_list: operation: *ref_3 response: *ref_4 - projects_locations_insight_types_insights_get: + billing_accounts_locations_insight_types_insights_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}/get + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}/get response: mediaType: application/json openAPIDocKey: '200' - 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' @@ -974,13 +1039,6 @@ components: folders_locations_insight_types_insights_list: operation: *ref_5 response: *ref_6 - folders_locations_insight_types_insights_mark_accepted: - operation: - $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post - response: - mediaType: application/json - openAPIDocKey: '200' folders_locations_insight_types_insights_get: operation: $ref: >- @@ -988,232 +1046,211 @@ components: response: mediaType: application/json openAPIDocKey: '200' - 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_list: + _projects_locations_insight_types_insights_list: operation: &ref_7 $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get response: &ref_8 mediaType: application/json openAPIDocKey: '200' objectKey: $.insights - organizations_locations_insight_types_insights_list: + projects_locations_insight_types_insights_list: operation: *ref_7 response: *ref_8 - organizations_locations_insight_types_insights_mark_accepted: + projects_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~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + 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/billing_accounts_locations_insight_types_insights_list + #/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_list + #/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_list + #/components/x-stackQL-resources/insights/methods/organizations_locations_insight_types_insights_list - $ref: >- - #/components/x-stackQL-resources/insights/methods/folders_locations_insight_types_insights_get + #/components/x-stackQL-resources/insights/methods/billing_accounts_locations_insight_types_insights_list - $ref: >- - #/components/x-stackQL-resources/insights/methods/organizations_locations_insight_types_insights_get + #/components/x-stackQL-resources/insights/methods/folders_locations_insight_types_insights_list - $ref: >- - #/components/x-stackQL-resources/insights/methods/organizations_locations_insight_types_insights_list + #/components/x-stackQL-resources/insights/methods/projects_locations_insight_types_insights_list insert: [] update: [] delete: [] - insight_types_config: - id: recommender.insight_types_config - name: insight_types_config - title: Insight_types_config + recommenders_config: + id: google.recommender.recommenders_config + name: recommenders_config + title: Recommenders_config methods: - billing_accounts_locations_insight_types_update_config: + organizations_locations_recommenders_get_config: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/patch + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/get response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_insight_types_get_config: + organizations_locations_recommenders_update_config: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_insight_types_get_config: + billing_accounts_locations_recommenders_get_config: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/get + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_insight_types_update_config: + billing_accounts_locations_recommenders_update_config: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/patch + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_insight_types_update_config: + projects_locations_recommenders_update_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_insight_types_get_config: + projects_locations_recommenders_get_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/get + #/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/insight_types_config/methods/billing_accounts_locations_insight_types_get_config + #/components/x-stackQL-resources/recommenders_config/methods/organizations_locations_recommenders_get_config - $ref: >- - #/components/x-stackQL-resources/insight_types_config/methods/projects_locations_insight_types_get_config + #/components/x-stackQL-resources/recommenders_config/methods/billing_accounts_locations_recommenders_get_config - $ref: >- - #/components/x-stackQL-resources/insight_types_config/methods/organizations_locations_insight_types_get_config + #/components/x-stackQL-resources/recommenders_config/methods/projects_locations_recommenders_get_config insert: [] update: [] delete: [] recommendations: - id: recommender.recommendations + id: google.recommender.recommendations name: recommendations title: Recommendations methods: - billing_accounts_locations_recommenders_recommendations_mark_succeeded: - operation: - $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post - response: - mediaType: application/json - openAPIDocKey: '200' - billing_accounts_locations_recommenders_recommendations_mark_failed: - operation: - $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post - response: - mediaType: application/json - openAPIDocKey: '200' - billing_accounts_locations_recommenders_recommendations_get: + 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_list: + _organizations_locations_recommenders_recommendations_list: operation: &ref_9 $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/get response: &ref_10 mediaType: application/json openAPIDocKey: '200' objectKey: $.recommendations - billing_accounts_locations_recommenders_recommendations_list: + organizations_locations_recommenders_recommendations_list: operation: *ref_9 response: *ref_10 - billing_accounts_locations_recommenders_recommendations_mark_claimed: + organizations_locations_recommenders_recommendations_mark_succeeded: 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}:markSucceeded/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' - _projects_locations_recommenders_recommendations_list: - operation: &ref_11 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get - response: &ref_12 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.recommendations - projects_locations_recommenders_recommendations_list: - operation: *ref_11 - response: *ref_12 - projects_locations_recommenders_recommendations_mark_succeeded: + organizations_locations_recommenders_recommendations_mark_failed: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~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_get: + organizations_locations_recommenders_recommendations_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_recommendations_mark_failed: + billing_accounts_locations_recommenders_recommendations_mark_dismissed: 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}:markDismissed/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_recommendations_mark_claimed: + billing_accounts_locations_recommenders_recommendations_mark_claimed: 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}:markClaimed/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' - folders_locations_recommenders_recommendations_mark_failed: + billing_accounts_locations_recommenders_recommendations_mark_succeeded: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~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}:markSucceeded/post response: mediaType: application/json openAPIDocKey: '200' - folders_locations_recommenders_recommendations_mark_claimed: + billing_accounts_locations_recommenders_recommendations_get: 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}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get response: mediaType: application/json openAPIDocKey: '200' - folders_locations_recommenders_recommendations_mark_succeeded: - operation: + _billing_accounts_locations_recommenders_recommendations_list: + operation: &ref_11 $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post - response: + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get + response: &ref_12 mediaType: application/json openAPIDocKey: '200' - folders_locations_recommenders_recommendations_mark_dismissed: + objectKey: $.recommendations + billing_accounts_locations_recommenders_recommendations_list: + operation: *ref_11 + response: *ref_12 + 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' @@ -1228,166 +1265,120 @@ components: folders_locations_recommenders_recommendations_list: operation: *ref_13 response: *ref_14 - folders_locations_recommenders_recommendations_get: - operation: - $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_locations_recommenders_recommendations_mark_dismissed: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_locations_recommenders_recommendations_mark_succeeded: + folders_locations_recommenders_recommendations_mark_dismissed: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_recommenders_recommendations_mark_failed: + folders_locations_recommenders_recommendations_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_recommenders_recommendations_get: + folders_locations_recommenders_recommendations_mark_succeeded: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_recommenders_recommendations_list: - operation: &ref_15 - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get - response: &ref_16 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.recommendations - organizations_locations_recommenders_recommendations_list: - operation: *ref_15 - response: *ref_16 - organizations_locations_recommenders_recommendations_mark_claimed: + folders_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~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/billing_accounts_locations_recommenders_recommendations_get - - $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/projects_locations_recommenders_recommendations_get - - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/folders_locations_recommenders_recommendations_list - - $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/organizations_locations_recommenders_recommendations_list - insert: [] - update: [] - delete: [] - recommenders_config: - id: recommender.recommenders_config - name: recommenders_config - title: Recommenders_config - methods: - billing_accounts_locations_recommenders_update_config: + projects_locations_recommenders_recommendations_mark_dismissed: 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}:markDismissed/post response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_recommenders_get_config: + projects_locations_recommenders_recommendations_mark_succeeded: 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~1{recommendationsId}:markSucceeded/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_update_config: + projects_locations_recommenders_recommendations_mark_claimed: 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}:markClaimed/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_get_config: - operation: + _projects_locations_recommenders_recommendations_list: + operation: &ref_15 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/get - response: + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get + response: &ref_16 mediaType: application/json openAPIDocKey: '200' - organizations_locations_recommenders_update_config: + objectKey: $.recommendations + projects_locations_recommenders_recommendations_list: + operation: *ref_15 + response: *ref_16 + projects_locations_recommenders_recommendations_mark_failed: 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}:markFailed/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_recommenders_get_config: + projects_locations_recommenders_recommendations_get: 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}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/recommenders_config/methods/billing_accounts_locations_recommenders_get_config + #/components/x-stackQL-resources/recommendations/methods/organizations_locations_recommenders_recommendations_get - $ref: >- - #/components/x-stackQL-resources/recommenders_config/methods/projects_locations_recommenders_get_config + #/components/x-stackQL-resources/recommendations/methods/billing_accounts_locations_recommenders_recommendations_get - $ref: >- - #/components/x-stackQL-resources/recommenders_config/methods/organizations_locations_recommenders_get_config + #/components/x-stackQL-resources/recommendations/methods/folders_locations_recommenders_recommendations_get + - $ref: >- + #/components/x-stackQL-resources/recommendations/methods/projects_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/folders_locations_recommenders_recommendations_list + - $ref: >- + #/components/x-stackQL-resources/recommendations/methods/projects_locations_recommenders_recommendations_list insert: [] update: [] delete: [] paths: - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: + /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config: parameters: &ref_17 - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/quotaUser' - post: + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/_.xgafv' + 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.billingAccounts.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 @@ -1399,10 +1390,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' parameters: - in: path - name: billingAccountsId + name: organizationsId required: true schema: type: string @@ -1416,18 +1407,16 @@ paths: required: true schema: type: string - - in: path - name: insightsId - required: true - schema: - type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: - parameters: *ref_17 - get: + patch: 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 + 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 @@ -1439,11 +1428,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' parameters: - in: path - name: billingAccountsId + name: organizationsId required: true schema: type: string @@ -1458,25 +1446,21 @@ paths: schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + name: validateOnly schema: - type: string + type: boolean - in: query - name: pageSize + name: updateMask schema: - type: integer - format: int32 - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: + type: string + format: google-fieldmask + /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: parameters: *ref_17 get: description: >- Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type. - operationId: recommender.billingAccounts.locations.insightTypes.insights.get + operationId: recommender.organizations.locations.insightTypes.insights.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1491,7 +1475,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path - name: billingAccountsId + name: organizationsId required: true schema: type: string @@ -1510,18 +1494,13 @@ paths: required: true schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config: + /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: parameters: *ref_17 - 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' + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1533,10 +1512,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse parameters: - in: path - name: billingAccountsId + name: organizationsId required: true schema: type: string @@ -1551,19 +1531,34 @@ paths: schema: type: string - in: query - name: validateOnly + name: pageToken schema: - type: boolean + type: string - in: query - name: updateMask + name: filter schema: type: string - format: google-fieldmask - get: + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: + parameters: *ref_17 + 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 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 @@ -1575,10 +1570,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path - name: billingAccountsId + name: organizationsId required: true schema: type: string @@ -1592,26 +1587,18 @@ paths: required: true schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: + - in: path + name: insightsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/config: parameters: *ref_17 - 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 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 @@ -1623,10 +1610,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' parameters: - in: path - name: billingAccountsId + name: organizationsId required: true schema: type: string @@ -1640,31 +1627,16 @@ paths: 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_17 - 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.billingAccounts.locations.recommenders.recommendations.markFailed + 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/GoogleCloudRecommenderV1MarkRecommendationFailedRequest + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1676,10 +1648,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' parameters: - in: path - name: billingAccountsId + name: organizationsId required: true schema: type: string @@ -1693,18 +1665,32 @@ paths: required: true schema: type: string - - in: path - name: recommendationsId - required: true + - in: query + name: updateMask schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: + format: google-fieldmask + - in: query + name: validateOnly + schema: + type: boolean + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: parameters: *ref_17 - 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.billingAccounts.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 @@ -1719,7 +1705,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: billingAccountsId + name: organizationsId required: true schema: type: string @@ -1738,13 +1724,13 @@ paths: required: true schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: parameters: *ref_17 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.organizations.locations.recommenders.recommendations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1760,7 +1746,7 @@ paths: #/components/schemas/GoogleCloudRecommenderV1ListRecommendationsResponse parameters: - in: path - name: billingAccountsId + name: organizationsId required: true schema: type: string @@ -1774,38 +1760,39 @@ 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: filter - schema: - type: string - in: query name: pageToken schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: parameters: *ref_17 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.billingAccounts.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 @@ -1820,7 +1807,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: billingAccountsId + name: organizationsId required: true schema: type: string @@ -1839,23 +1826,25 @@ paths: required: true schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: parameters: *ref_17 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.billingAccounts.locations.recommenders.recommendations.markDismissed + recommender.organizations.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 @@ -1870,7 +1859,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: billingAccountsId + name: organizationsId required: true schema: type: string @@ -1889,18 +1878,26 @@ paths: required: true schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/config: + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: parameters: *ref_17 - patch: + post: description: >- - Updates a Recommender Config. This will create a new revision of the - config. - operationId: recommender.billingAccounts.locations.recommenders.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/GoogleCloudRecommenderV1RecommenderConfig' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationFailedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1912,10 +1909,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: billingAccountsId + name: organizationsId required: true schema: type: string @@ -1929,20 +1926,18 @@ paths: 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/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: + parameters: *ref_17 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 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 @@ -1954,10 +1949,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: billingAccountsId + name: organizationsId required: true schema: type: string @@ -1971,13 +1966,28 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: + - in: path + name: recommendationsId + required: true + schema: + type: string + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: parameters: *ref_17 - 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 + 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.billingAccounts.locations.recommenders.recommendations.markDismissed + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationDismissedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1989,11 +1999,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: projectsId + name: billingAccountsId required: true schema: type: string @@ -2003,30 +2012,34 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId 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/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: parameters: *ref_17 - get: + post: description: >- - Gets the requested insight. Requires the recommender.*.get IAM - permission for the specified insight type. - operationId: recommender.projects.locations.insightTypes.insights.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.billingAccounts.locations.recommenders.recommendations.markClaimed + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationClaimedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2038,10 +2051,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: projectsId + name: billingAccountsId required: true schema: type: string @@ -2051,31 +2064,35 @@ 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}:markAccepted: + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: parameters: *ref_17 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 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/GoogleCloudRecommenderV1MarkInsightAcceptedRequest + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationFailedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2087,10 +2104,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: projectsId + name: billingAccountsId required: true schema: type: string @@ -2100,22 +2117,35 @@ 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/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: parameters: *ref_17 - get: + post: description: >- - Gets the requested InsightTypeConfig. There is only one instance of the - config for each InsightType. - operationId: recommender.projects.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 @@ -2127,10 +2157,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: projectsId + name: billingAccountsId required: true schema: type: string @@ -2140,20 +2170,22 @@ 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/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: + parameters: *ref_17 + get: description: >- - 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/GoogleCloudRecommenderV1InsightTypeConfig' + 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 @@ -2165,10 +2197,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: projectsId + name: billingAccountsId required: true schema: type: string @@ -2178,31 +2210,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/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/config: + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: parameters: *ref_17 - patch: + get: 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' + 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 @@ -2214,10 +2237,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1ListRecommendationsResponse parameters: - in: path - name: projectsId + name: billingAccountsId required: true schema: type: string @@ -2232,19 +2256,25 @@ paths: schema: type: string - in: query - name: validateOnly + 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 + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/config: + parameters: *ref_17 get: description: >- Gets the requested Recommender Config. There is only one instance of the config for each Recommender. - operationId: recommender.projects.locations.recommenders.getConfig + operationId: recommender.billingAccounts.locations.recommenders.getConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2259,7 +2289,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' parameters: - in: path - name: projectsId + name: billingAccountsId required: true schema: type: string @@ -2273,13 +2303,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: - parameters: *ref_17 - get: + patch: 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 + 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' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2291,11 +2324,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1ListRecommendationsResponse + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' parameters: - in: path - name: projectsId + name: billingAccountsId required: true schema: type: string @@ -2310,38 +2342,30 @@ paths: schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + name: validateOnly schema: - type: string + type: boolean - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: - parameters: *ref_17 - 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 + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: + parameters: *ref_17 + 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.billingAccounts.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 @@ -2353,10 +2377,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path - name: projectsId + name: billingAccountsId required: true schema: type: string @@ -2366,22 +2390,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/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: parameters: *ref_17 get: description: >- - Gets the requested recommendation. Requires the recommender.*.get IAM - permission for the specified recommender. - operationId: recommender.projects.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 @@ -2393,10 +2417,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse parameters: - in: path - name: projectsId + name: billingAccountsId required: true schema: type: string @@ -2406,34 +2431,30 @@ paths: schema: type: string - in: path - name: recommendersId + name: insightTypesId 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/{recommendationsId}:markFailed: + - 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}: parameters: *ref_17 - post: + 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.projects.locations.recommenders.recommendations.markFailed - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationFailedRequest + 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 @@ -2445,10 +2466,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path - name: projectsId + name: billingAccountsId required: true schema: type: string @@ -2458,33 +2479,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}:markClaimed: + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config: parameters: *ref_17 - post: + patch: 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 + 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/GoogleCloudRecommenderV1MarkRecommendationClaimedRequest + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2496,10 +2511,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' parameters: - in: path - name: projectsId + name: billingAccountsId required: true schema: type: string @@ -2509,32 +2524,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: validateOnly + schema: + type: boolean + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: - parameters: *ref_17 - post: + format: google-fieldmask + 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 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 @@ -2546,10 +2553,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' parameters: - in: path - name: projectsId + name: billingAccountsId required: true schema: type: string @@ -2559,34 +2566,26 @@ 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}:markFailed: + /v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: parameters: *ref_17 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.folders.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.folders.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 @@ -2598,7 +2597,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path name: foldersId @@ -2611,33 +2610,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/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: + /v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: parameters: *ref_17 - 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.folders.locations.recommenders.recommendations.markClaimed - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationClaimedRequest + 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 @@ -2649,7 +2637,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse parameters: - in: path name: foldersId @@ -2662,34 +2651,30 @@ paths: schema: type: string - in: path - name: recommendersId + name: insightTypesId required: true schema: type: string - - in: path - name: recommendationsId - required: true + - in: query + name: pageToken schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: parameters: *ref_17 - 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.folders.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.folders.locations.insightTypes.insights.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2701,7 +2686,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path name: foldersId @@ -2714,31 +2699,33 @@ 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/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: + /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: parameters: *ref_17 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.folders.locations.recommenders.recommendations.markDismissed + 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/GoogleCloudRecommenderV1MarkRecommendationDismissedRequest + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationClaimedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2821,13 +2808,22 @@ paths: name: pageToken schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: + /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: parameters: *ref_17 - 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.folders.locations.recommenders.recommendations.markDismissed + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationDismissedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2861,13 +2857,13 @@ paths: required: true schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: + /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: parameters: *ref_17 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 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 @@ -2879,8 +2875,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path name: foldersId @@ -2893,39 +2888,34 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId 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: recommendationsId + required: true schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: + /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: parameters: *ref_17 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.folders.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.folders.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 @@ -2937,7 +2927,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path name: foldersId @@ -2950,22 +2940,34 @@ 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/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: + /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: parameters: *ref_17 - 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 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2977,7 +2979,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path name: foldersId @@ -2990,22 +2992,32 @@ 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/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: + /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: parameters: *ref_17 - get: + post: description: >- - Gets the requested insight. Requires the recommender.*.get IAM - permission for the specified insight type. - operationId: recommender.organizations.locations.insightTypes.insights.get + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3017,10 +3029,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -3030,22 +3042,35 @@ 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/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: + /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: parameters: *ref_17 - get: + post: 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 + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3057,11 +3082,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -3071,39 +3095,33 @@ 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 + - in: path + name: recommendationsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: + /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: parameters: *ref_17 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 + 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/GoogleCloudRecommenderV1MarkInsightAcceptedRequest + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationClaimedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3115,10 +3133,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -3128,27 +3146,83 @@ 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/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config: + /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: parameters: *ref_17 - patch: + get: description: >- - Updates an InsightTypeConfig change. This will create a new revision of - the config. - operationId: recommender.organizations.locations.insightTypes.updateConfig + 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 + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1ListRecommendationsResponse + 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 + 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}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: + parameters: *ref_17 + 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.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 @@ -3160,10 +3234,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -3173,24 +3247,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/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: + parameters: *ref_17 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.projects.locations.recommenders.recommendations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3202,10 +3274,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -3215,17 +3287,22 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/config: + - in: path + name: recommendationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/config: parameters: *ref_17 patch: description: >- Updates a Recommender Config. This will create a new revision of the config. - operationId: recommender.organizations.locations.recommenders.updateConfig + operationId: recommender.projects.locations.recommenders.updateConfig requestBody: content: application/json: @@ -3245,7 +3322,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -3272,7 +3349,7 @@ paths: description: >- Gets the requested Recommender Config. There is only one instance of the config for each Recommender. - operationId: recommender.organizations.locations.recommenders.getConfig + operationId: recommender.projects.locations.recommenders.getConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3287,7 +3364,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -3301,23 +3378,13 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: + /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config: parameters: *ref_17 - 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.organizations.locations.recommenders.recommendations.markDismissed - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationDismissedRequest + 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 @@ -3329,10 +3396,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -3342,35 +3409,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/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: - parameters: *ref_17 - post: + patch: 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 + 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/GoogleCloudRecommenderV1MarkRecommendationSucceededRequest + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3382,10 +3434,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -3395,35 +3447,26 @@ 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/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: + format: google-fieldmask + - in: query + name: validateOnly + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: parameters: *ref_17 - post: + 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.organizations.locations.recommenders.recommendations.markFailed - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationFailedRequest + 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 @@ -3435,10 +3478,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -3448,62 +3492,30 @@ paths: schema: type: string - in: path - name: recommendersId - required: true - schema: - type: string - - in: path - name: recommendationsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: - parameters: *ref_17 - 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 - 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: organizationsId + name: insightTypesId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: filter schema: type: string - - in: path - name: recommendersId - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: recommendationsId - required: true + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: + /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: parameters: *ref_17 get: 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 + 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 @@ -3515,11 +3527,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1ListRecommendationsResponse + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -3529,42 +3540,31 @@ paths: schema: type: string - in: path - name: recommendersId + name: insightTypesId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: insightsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: + /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: parameters: *ref_17 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.organizations.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.projects.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 @@ -3576,10 +3576,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -3589,12 +3589,12 @@ 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 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 71c67132..097ace6e 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/redis.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/redis.yaml @@ -8,7 +8,7 @@ info: description: Creates and manages Redis instances on the Google Cloud Platform. version: v1 x-discovery-doc-revision: '20240524' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/memorystore/docs/redis/ servers: @@ -2995,7 +2995,7 @@ components: - '2' x-stackQL-resources: locations: - id: redis.locations + id: google.redis.locations name: locations title: Locations methods: @@ -3017,13 +3017,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: redis.operations + id: google.redis.operations name: operations title: Operations methods: @@ -3061,14 +3061,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' clusters: - id: redis.clusters + id: google.redis.clusters name: clusters title: Clusters methods: @@ -3113,15 +3113,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/clusters/methods/list' - $ref: '#/components/x-stackQL-resources/clusters/methods/get' + - $ref: '#/components/x-stackQL-resources/clusters/methods/list' insert: - $ref: '#/components/x-stackQL-resources/clusters/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/clusters/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/clusters/methods/delete' clusters_certificate_authority: - id: redis.clusters_certificate_authority + id: google.redis.clusters_certificate_authority name: clusters_certificate_authority title: Clusters_certificate_authority methods: @@ -3140,7 +3141,7 @@ components: update: [] delete: [] instances: - id: redis.instances + id: google.redis.instances name: instances title: Instances methods: @@ -3220,15 +3221,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/instances/methods/list' - $ref: '#/components/x-stackQL-resources/instances/methods/get' + - $ref: '#/components/x-stackQL-resources/instances/methods/list' insert: - $ref: '#/components/x-stackQL-resources/instances/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/instances/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/instances/methods/delete' instances_auth_string: - id: redis.instances_auth_string + id: google.redis.instances_auth_string name: instances_auth_string title: Instances_auth_string methods: 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 5ad67426..2f1911db 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/resourcesettings.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/resourcesettings.yaml @@ -11,7 +11,7 @@ info: Resource Hierarchy. version: v1 x-discovery-doc-revision: '20240529' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/resource-manager/docs/resource-settings/overview servers: @@ -37,31 +37,9 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudResourcesettingsV1Value: - properties: - booleanValue: - type: boolean - description: Defines this value as being a boolean value. - enumValue: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1ValueEnumValue' - description: Defines this value as being a Enum. - stringMapValue: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1ValueStringMap' - description: Defines this value as being a StringMap. - stringValue: - description: Defines this value as being a string value. - type: string - durationValue: - description: Defines this value as being a Duration. - type: string - format: google-duration - stringSetValue: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1ValueStringSet' - description: Defines this value as being a StringSet. - type: object - id: GoogleCloudResourcesettingsV1Value - description: The data in a setting value. GoogleCloudResourcesettingsV1ValueStringSet: + id: GoogleCloudResourcesettingsV1ValueStringSet + 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 @@ -72,57 +50,11 @@ components: type: string description: The strings in the set type: array - id: GoogleCloudResourcesettingsV1ValueStringSet - type: object - GoogleCloudResourcesettingsV1ListSettingsResponse: - id: GoogleCloudResourcesettingsV1ListSettingsResponse - type: object - description: The response from ListSettings. - 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. - GoogleCloudResourcesettingsV1ValueStringMap: - properties: - mappings: - description: The key-value pairs in the map - type: object - additionalProperties: - type: string - 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 - type: object - GoogleCloudResourcesettingsV1ValueEnumValue: - id: GoogleCloudResourcesettingsV1ValueEnumValue - properties: - value: - description: The value of this enum - type: string - 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 GoogleCloudResourcesettingsV1Setting: + description: The schema for settings. + type: object + id: GoogleCloudResourcesettingsV1Setting properties: - name: - description: >- - The resource name of the setting. Must be in one of the following - forms: * `projects/{project_number}/settings/{setting_name}` * - `folders/{folder_id}/settings/{setting_name}` * - `organizations/{organization_id}/settings/{setting_name}` For - example, "/projects/123/settings/gcp-enableMyFeature" - type: string effectiveValue: readOnly: true description: >- @@ -138,6 +70,20 @@ 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' + name: + description: >- + The resource name of the setting. Must be in one of the following + forms: * `projects/{project_number}/settings/{setting_name}` * + `folders/{folder_id}/settings/{setting_name}` * + `organizations/{organization_id}/settings/{setting_name}` For + example, "/projects/123/settings/gcp-enableMyFeature" + type: string + 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: description: >- A fingerprint used for optimistic concurrency. See UpdateSetting for @@ -149,16 +95,60 @@ components: description: >- Output only. Metadata about a setting which is not editable by the end user. - localValue: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Value' + GoogleCloudResourcesettingsV1ListSettingsResponse: + type: object + id: GoogleCloudResourcesettingsV1ListSettingsResponse + properties: + nextPageToken: + type: string + description: Unused. A page token used to retrieve the next page. + settings: + type: array 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. - id: GoogleCloudResourcesettingsV1Setting + A list of settings that are available at the specified Cloud + resource. + items: + $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' + description: The response from ListSettings. + GoogleCloudResourcesettingsV1Value: + description: The data in a setting value. + id: GoogleCloudResourcesettingsV1Value + properties: + enumValue: + $ref: '#/components/schemas/GoogleCloudResourcesettingsV1ValueEnumValue' + description: Defines this value as being a Enum. + stringSetValue: + description: Defines this value as being a StringSet. + $ref: '#/components/schemas/GoogleCloudResourcesettingsV1ValueStringSet' + durationValue: + type: string + description: Defines this value as being a Duration. + format: google-duration + stringMapValue: + $ref: '#/components/schemas/GoogleCloudResourcesettingsV1ValueStringMap' + description: Defines this value as being a StringMap. + booleanValue: + description: Defines this value as being a boolean value. + type: boolean + stringValue: + description: Defines this value as being a string value. + type: string type: object - description: The schema for settings. + GoogleCloudResourcesettingsV1ValueStringMap: + properties: + mappings: + type: object + 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. + id: GoogleCloudResourcesettingsV1ValueStringMap GoogleCloudResourcesettingsV1SettingMetadata: + id: GoogleCloudResourcesettingsV1SettingMetadata properties: displayName: type: string @@ -171,13 +161,9 @@ components: 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. dataType: type: string + description: The data type for this setting. enumDescriptions: - Unspecified data type. - A boolean setting. @@ -186,7 +172,6 @@ components: - A Enum setting - A Duration setting - A string->string map setting - description: The data type for this setting. enum: - DATA_TYPE_UNSPECIFIED - BOOLEAN @@ -195,34 +180,43 @@ components: - ENUM_VALUE - DURATION_VALUE - STRING_MAP + readOnly: + description: >- + A flag indicating that values of this setting cannot be modified. + See documentation for the specific setting for updates and reasons. + type: boolean description: Metadata about a setting which is not editable by the end user. type: object - id: GoogleCloudResourcesettingsV1SettingMetadata - parameters: - quotaUser: + GoogleCloudResourcesettingsV1ValueEnumValue: + id: GoogleCloudResourcesettingsV1ValueEnumValue + type: object + properties: + value: + type: string + description: The value of this enum 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. + 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. + parameters: + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: $.xgafv + name: fields 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 key: description: >- API key. Your API key identifies your project and provides you with API @@ -232,38 +226,22 @@ 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 - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - 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 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 upload_protocol: @@ -272,15 +250,37 @@ components: 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 + _.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: settings: - id: resourcesettings.settings + id: google.resourcesettings.settings name: settings title: Settings methods: @@ -294,13 +294,6 @@ components: organizations_settings_list: operation: *ref_1 response: *ref_2 - organizations_settings_patch: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1settings~1{settingsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' organizations_settings_get: operation: $ref: >- @@ -308,15 +301,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - folders_settings_get: - operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1settings~1{settingsId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - folders_settings_patch: + organizations_settings_patch: operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1settings~1{settingsId}/patch' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1settings~1{settingsId}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -330,6 +318,18 @@ components: folders_settings_list: operation: *ref_3 response: *ref_4 + folders_settings_patch: + operation: + $ref: '#/paths/~1v1~1folders~1{foldersId}~1settings~1{settingsId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + folders_settings_get: + operation: + $ref: '#/paths/~1v1~1folders~1{foldersId}~1settings~1{settingsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' projects_settings_patch: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1settings~1{settingsId}/patch' @@ -354,35 +354,41 @@ components: response: *ref_6 sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/settings/methods/organizations_settings_list - $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/folders_settings_list - $ref: >- #/components/x-stackQL-resources/settings/methods/projects_settings_get + - $ref: >- + #/components/x-stackQL-resources/settings/methods/organizations_settings_list + - $ref: >- + #/components/x-stackQL-resources/settings/methods/folders_settings_list - $ref: >- #/components/x-stackQL-resources/settings/methods/projects_settings_list insert: [] - update: [] + update: + - $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/projects_settings_patch delete: [] paths: /v1/organizations/{organizationsId}/settings: parameters: &ref_7 - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/alt' get: description: >- Lists all the settings that are available on the Cloud resource @@ -407,11 +413,6 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - in: query name: view schema: @@ -420,25 +421,18 @@ paths: name: pageToken schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 /v1/organizations/{organizationsId}/settings/{settingsId}: parameters: *ref_7 - 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.organizations.settings.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -462,11 +456,27 @@ paths: required: true schema: type: string - get: + - in: query + name: view + schema: + type: string + patch: 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 + 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 @@ -490,17 +500,13 @@ paths: required: true schema: type: string - - in: query - name: view - schema: - type: string - /v1/folders/{foldersId}/settings/{settingsId}: + /v1/folders/{foldersId}/settings: parameters: *ref_7 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 + 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 @@ -512,22 +518,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' + $ref: >- + #/components/schemas/GoogleCloudResourcesettingsV1ListSettingsResponse parameters: - in: path name: foldersId required: true schema: type: string - - in: path - name: settingsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - in: query name: view schema: type: string + /v1/folders/{foldersId}/settings/{settingsId}: + parameters: *ref_7 patch: description: >- Updates a specified setting. Returns a `google.rpc.Status` with @@ -568,13 +581,11 @@ paths: required: true schema: type: string - /v1/folders/{foldersId}/settings: - parameters: *ref_7 get: description: >- - Lists all the settings that are available on the Cloud resource - `parent`. - operationId: resourcesettings.folders.settings.list + 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 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -586,27 +597,22 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudResourcesettingsV1ListSettingsResponse + $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' parameters: - in: path name: foldersId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: settingsId + required: true schema: type: string - in: query name: view schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 /v1/projects/{projectsId}/settings/{settingsId}: parameters: *ref_7 patch: @@ -708,11 +714,11 @@ paths: schema: type: string - in: query - name: view + name: pageToken schema: type: string - in: query - name: pageToken + name: view schema: type: string - in: query 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 6805054b..2be960ef 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/retail.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/retail.yaml @@ -12,7 +12,7 @@ info: models, across your websites and mobile applications. version: v2 x-discovery-doc-revision: '20240523' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/recommendations servers: @@ -6789,7 +6789,7 @@ components: - '2' x-stackQL-resources: operations: - id: retail.operations + id: google.retail.operations name: operations title: Operations methods: @@ -6856,24 +6856,24 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list + #/components/x-stackQL-resources/operations/methods/projects_locations_catalogs_branches_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_catalogs_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_catalogs_operations_list - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_catalogs_operations_get + #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_catalogs_branches_operations_get + #/components/x-stackQL-resources/operations/methods/projects_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_operations_list - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_operations_get insert: [] update: [] delete: [] catalogs: - id: retail.catalogs + id: google.retail.catalogs name: catalogs title: Catalogs methods: @@ -6921,10 +6921,12 @@ components: - $ref: >- #/components/x-stackQL-resources/catalogs/methods/projects_locations_catalogs_list insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/catalogs/methods/projects_locations_catalogs_patch delete: [] catalogs_default_branch: - id: retail.catalogs_default_branch + id: google.retail.catalogs_default_branch name: catalogs_default_branch title: Catalogs_default_branch methods: @@ -6943,7 +6945,7 @@ components: update: [] delete: [] catalogs_completion_config: - id: retail.catalogs_completion_config + id: google.retail.catalogs_completion_config name: catalogs_completion_config title: Catalogs_completion_config methods: @@ -6969,7 +6971,7 @@ components: update: [] delete: [] catalogs_attributes_config: - id: retail.catalogs_attributes_config + id: google.retail.catalogs_attributes_config name: catalogs_attributes_config title: Catalogs_attributes_config methods: @@ -6995,7 +6997,7 @@ components: update: [] delete: [] products: - id: retail.products + id: google.retail.products name: products title: Products methods: @@ -7061,19 +7063,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/products/methods/projects_locations_catalogs_branches_products_list - $ref: >- #/components/x-stackQL-resources/products/methods/projects_locations_catalogs_branches_products_get + - $ref: >- + #/components/x-stackQL-resources/products/methods/projects_locations_catalogs_branches_products_list insert: - $ref: >- #/components/x-stackQL-resources/products/methods/projects_locations_catalogs_branches_products_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/products/methods/projects_locations_catalogs_branches_products_patch delete: - $ref: >- #/components/x-stackQL-resources/products/methods/projects_locations_catalogs_branches_products_delete products_fulfillment_places: - id: retail.products_fulfillment_places + id: google.retail.products_fulfillment_places name: products_fulfillment_places title: Products_fulfillment_places methods: @@ -7097,7 +7101,7 @@ components: update: [] delete: [] products_local_inventories: - id: retail.products_local_inventories + id: google.retail.products_local_inventories name: products_local_inventories title: Products_local_inventories methods: @@ -7121,7 +7125,7 @@ components: update: [] delete: [] attributes_config_catalog_attribute: - id: retail.attributes_config_catalog_attribute + id: google.retail.attributes_config_catalog_attribute name: attributes_config_catalog_attribute title: Attributes_config_catalog_attribute methods: @@ -7145,7 +7149,7 @@ components: update: [] delete: [] attributes_config: - id: retail.attributes_config + id: google.retail.attributes_config name: attributes_config title: Attributes_config methods: @@ -7162,7 +7166,7 @@ components: update: [] delete: [] placements: - id: retail.placements + id: google.retail.placements name: placements title: Placements methods: @@ -7186,7 +7190,7 @@ components: update: [] delete: [] serving_configs: - id: retail.serving_configs + id: google.retail.serving_configs name: serving_configs title: Serving_configs methods: @@ -7245,19 +7249,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/serving_configs/methods/projects_locations_catalogs_serving_configs_list - $ref: >- #/components/x-stackQL-resources/serving_configs/methods/projects_locations_catalogs_serving_configs_get + - $ref: >- + #/components/x-stackQL-resources/serving_configs/methods/projects_locations_catalogs_serving_configs_list insert: - $ref: >- #/components/x-stackQL-resources/serving_configs/methods/projects_locations_catalogs_serving_configs_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/serving_configs/methods/projects_locations_catalogs_serving_configs_patch delete: - $ref: >- #/components/x-stackQL-resources/serving_configs/methods/projects_locations_catalogs_serving_configs_delete serving_configs_control: - id: retail.serving_configs_control + id: google.retail.serving_configs_control name: serving_configs_control title: Serving_configs_control methods: @@ -7281,7 +7287,7 @@ components: update: [] delete: [] completion_data: - id: retail.completion_data + id: google.retail.completion_data name: completion_data title: Completion_data methods: @@ -7298,7 +7304,7 @@ components: update: [] delete: [] controls: - id: retail.controls + id: google.retail.controls name: controls title: Controls methods: @@ -7343,19 +7349,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/controls/methods/projects_locations_catalogs_controls_list - $ref: >- #/components/x-stackQL-resources/controls/methods/projects_locations_catalogs_controls_get + - $ref: >- + #/components/x-stackQL-resources/controls/methods/projects_locations_catalogs_controls_list insert: - $ref: >- #/components/x-stackQL-resources/controls/methods/projects_locations_catalogs_controls_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/controls/methods/projects_locations_catalogs_controls_patch delete: - $ref: >- #/components/x-stackQL-resources/controls/methods/projects_locations_catalogs_controls_delete models: - id: retail.models + id: google.retail.models name: models title: Models methods: @@ -7421,19 +7429,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/models/methods/projects_locations_catalogs_models_list - $ref: >- #/components/x-stackQL-resources/models/methods/projects_locations_catalogs_models_get + - $ref: >- + #/components/x-stackQL-resources/models/methods/projects_locations_catalogs_models_list insert: - $ref: >- #/components/x-stackQL-resources/models/methods/projects_locations_catalogs_models_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/models/methods/projects_locations_catalogs_models_patch delete: - $ref: >- #/components/x-stackQL-resources/models/methods/projects_locations_catalogs_models_delete user_events: - id: retail.user_events + id: google.retail.user_events name: user_events title: User_events methods: 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 c9d5650f..35b1602f 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: '20240524' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/run/ servers: @@ -4692,7 +4692,7 @@ components: - '2' x-stackQL-resources: locations: - id: run.locations + id: google.run.locations name: locations title: Locations methods: @@ -4723,7 +4723,7 @@ components: update: [] delete: [] operations: - id: run.operations + id: google.run.operations name: operations title: Operations methods: @@ -4761,14 +4761,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' jobs: - id: run.jobs + id: google.run.jobs name: jobs title: Jobs methods: @@ -4820,15 +4820,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/jobs/methods/list' - $ref: '#/components/x-stackQL-resources/jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/jobs/methods/list' insert: - $ref: '#/components/x-stackQL-resources/jobs/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/jobs/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/jobs/methods/delete' jobs_iam_policies: - id: run.jobs_iam_policies + id: google.run.jobs_iam_policies name: jobs_iam_policies title: Jobs_iam_policies methods: @@ -4865,7 +4866,7 @@ components: update: [] delete: [] executions: - id: run.executions + id: google.run.executions name: executions title: Executions methods: @@ -4917,7 +4918,7 @@ components: delete: - $ref: '#/components/x-stackQL-resources/executions/methods/delete' tasks: - id: run.tasks + id: google.run.tasks name: tasks title: Tasks methods: @@ -4947,7 +4948,7 @@ components: update: [] delete: [] services: - id: run.services + id: google.run.services name: services title: Services methods: @@ -4992,15 +4993,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/services/methods/list' - $ref: '#/components/x-stackQL-resources/services/methods/get' + - $ref: '#/components/x-stackQL-resources/services/methods/list' insert: - $ref: '#/components/x-stackQL-resources/services/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/services/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/services/methods/delete' services_iam_policies: - id: run.services_iam_policies + id: google.run.services_iam_policies name: services_iam_policies title: Services_iam_policies methods: @@ -5037,7 +5039,7 @@ components: update: [] delete: [] revisions: - id: run.revisions + id: google.run.revisions name: revisions title: Revisions methods: 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 1606e36e..1bb1fd1d 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: '20240227' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/deployment-manager/runtime-configurator/ servers: @@ -232,7 +232,7 @@ components: - '2' x-stackQL-resources: operations: - id: runtimeconfig.operations + id: google.runtimeconfig.operations name: operations title: Operations methods: 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 16d946cf..d371791e 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: '20240521' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' 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,297 +35,395 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - SasPortalSetupSasAnalyticsMetadata: - id: SasPortalSetupSasAnalyticsMetadata - properties: {} - description: >- - Metadata returned by the long running operation for the - SetupSasAnalytics rpc. - type: object - SasPortalValidateInstallerResponse: - properties: {} - id: SasPortalValidateInstallerResponse - type: object - description: Response for ValidateInstaller. - 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 - id: SasPortalProvisionDeploymentRequest + SasPortalFrequencyRange: 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: - 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 - 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 - SasPortalMigrateOrganizationMetadata: + lowFrequencyMhz: + description: The lowest frequency of the frequency range in MHz. + format: double + type: number + highFrequencyMhz: + description: The highest frequency of the frequency range in MHz. + type: number + format: double type: object - properties: - operationState: - enum: - - OPERATION_STATE_UNSPECIFIED - - OPERATION_STATE_PENDING - - OPERATION_STATE_RUNNING - - OPERATION_STATE_SUCCEEDED - - OPERATION_STATE_FAILED - readOnly: true - enumDescriptions: - - Unspecified. - - Pending (Not started). - - In-progress. - - Done successfully. - - Done with errors. - description: Output only. Current operation state - type: string - description: >- - Long-running operation metadata message returned by the - MigrateOrganization. - id: SasPortalMigrateOrganizationMetadata - SasPortalListCustomersResponse: - description: Response for `ListCustomers`. + description: Frequency range from `low_frequency` to `high_frequency`. + id: SasPortalFrequencyRange + SasPortalListNodesResponse: + description: Response for ListNodes. + type: object + id: SasPortalListNodesResponse 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. + 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 - customers: - type: array + nodes: + description: The nodes that match the request. items: - $ref: '#/components/schemas/SasPortalCustomer' - description: The list of customers that match the request. - id: SasPortalListCustomersResponse - type: object - SasPortalEmpty: - type: object - 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); } - properties: {} - SasPortalDeploymentAssociation: - id: SasPortalDeploymentAssociation - description: Association between a gcp project and a SAS user id. + $ref: '#/components/schemas/SasPortalNode' + type: array + SasPortalValidateInstallerRequest: + id: SasPortalValidateInstallerRequest type: object properties: - gcpProjectId: + installerId: + description: >- + Required. Unique installer id (CPI ID) from the Certified + Professional Installers database. type: string - description: GCP project id of the associated project. - userId: + secret: + description: Required. Secret returned by the GenerateSecret. type: string - description: User id of the deployment. - SasPortalGetPolicyRequest: - properties: - resource: + encodedSecret: type: string - description: Required. The resource for which the policy is being requested. + description: >- + Required. JSON Web Token signed using a CPI private key. Payload + must include a "secret" claim whose value is the secret. + description: Request for ValidateInstaller. + SasPortalCustomer: type: object - id: SasPortalGetPolicyRequest - description: Request message for `GetPolicy` method. - SasPortalMoveDeploymentRequest: + properties: + sasUserIds: + type: array + description: User IDs used by the devices belonging to this customer. + items: + type: string + name: + type: string + description: Output only. Resource name of the customer. + displayName: + description: >- + Required. Name of the organization that the customer entity + represents. + type: string + description: Entity representing a SAS customer. + id: SasPortalCustomer + SasPortalMoveDeviceRequest: + id: SasPortalMoveDeviceRequest properties: destination: type: string description: >- Required. The name of the new parent resource node or customer to - reparent the deployment under. - description: Request for MoveDeployment. - id: SasPortalMoveDeploymentRequest + reparent the device under. type: object - SasPortalDeviceAirInterface: + description: Request for MoveDevice. + SasPortalProvisionDeploymentResponse: + type: object + id: SasPortalProvisionDeploymentResponse 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 + errorMessage: 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 - id: SasPortalDeviceAirInterface - type: object - description: Information about the device's air interface. - SasPortalDeployment: - id: SasPortalDeployment + Optional. Optional error message if the provisioning request is not + successful. + description: >- + Response for [ProvisionDeployment]. + [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. + SasPortalListGcpProjectDeploymentsResponse: + description: Response for [ListGcpProjectDeployments]. + id: SasPortalListGcpProjectDeploymentsResponse type: object - description: The Deployment. properties: - frns: - description: >- - Output only. The FCC Registration Numbers (FRNs) copied from its - direct parent. - items: - type: string - type: array - readOnly: true - displayName: - description: The deployment's display name. - type: string - sasUserIds: + deployments: items: - type: string - description: >- - User ID used by the devices belonging to this deployment. Each - deployment should be associated with one unique user ID. + $ref: '#/components/schemas/SasPortalGcpProjectDeployment' type: array - name: - type: string - description: Output only. Resource name. - readOnly: true - SasPortalNrqzValidation: - description: Information about National Radio Quiet Zone validation. + description: Optional. Deployments associated with the GCP project + SasPortalSetupSasAnalyticsMetadata: + id: SasPortalSetupSasAnalyticsMetadata + properties: {} + description: >- + Metadata returned by the long running operation for the + SetupSasAnalytics rpc. + type: object + SasPortalListLegacyOrganizationsResponse: type: object + description: >- + Response for [ListLegacyOrganizations]. + [spectrum.sas.portal.v1alpha1.Provisioning.ListLegacyOrganizations]. + id: SasPortalListLegacyOrganizationsResponse properties: - latitude: - format: double - type: number - description: Device latitude that's associated with the validation. - caseId: - type: string - description: Validation case ID. - state: - enum: - - STATE_UNSPECIFIED - - DRAFT - - FINAL - type: string - enumDescriptions: - - Unspecified state. - - Draft state. - - Final state. - description: State of the NRQZ validation info. - cpiId: + organizations: + type: array + description: Optional. Legacy SAS organizations. + items: + $ref: '#/components/schemas/SasPortalOrganization' + SasPortalGcpProjectDeployment: + id: SasPortalGcpProjectDeployment + properties: + hasEnabledAnalytics: + type: boolean + description: Whether SAS analytics has been enabled. + 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. + type: object + SasPortalDpaMoveList: + description: An entry in a DPA's move list. + id: SasPortalDpaMoveList + properties: + frequencyRange: + description: The frequency range that the move list affects. + $ref: '#/components/schemas/SasPortalFrequencyRange' + dpaId: + type: string + description: The ID of the DPA. + type: object + SasPortalDeviceModel: + description: Information about the model of the device. + properties: + hardwareVersion: + type: string + description: The hardware version of the device. + softwareVersion: + description: The software version of the device. + type: string + vendor: + type: string + description: The name of the device vendor. + firmwareVersion: + type: string + description: The firmware version of the device. + name: + description: The name of the device model. + type: string + id: SasPortalDeviceModel + type: object + SasPortalListDeploymentsResponse: + type: object + id: SasPortalListDeploymentsResponse + description: Response for ListDeployments. + properties: + deployments: + type: array + items: + $ref: '#/components/schemas/SasPortalDeployment' + description: The deployments that match the request. + nextPageToken: + type: string + 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. + SasPortalNrqzValidation: + properties: + caseId: + description: Validation case ID. type: string - description: CPI who signed the validation. longitude: description: Device longitude that's associated with the validation. + type: number + format: double + latitude: format: double + description: Device latitude that's associated with the validation. type: number + state: + enum: + - STATE_UNSPECIFIED + - DRAFT + - FINAL + description: State of the NRQZ validation info. + type: string + enumDescriptions: + - Unspecified state. + - Draft state. + - Final state. + cpiId: + type: string + description: CPI who signed the validation. + type: object + description: Information about National Radio Quiet Zone validation. id: SasPortalNrqzValidation - SasPortalSignDeviceRequest: + SasPortalDeviceMetadata: + description: Device data overridable by both SAS Portal and registration requests. type: object - description: Request for SignDevice. properties: - device: + commonChannelGroup: 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 - SasPortalCreateSignedDeviceRequest: - type: object - id: SasPortalCreateSignedDeviceRequest + 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 + nrqzValidation: + description: Output only. National Radio Quiet Zone validation info. + $ref: '#/components/schemas/SasPortalNrqzValidation' + readOnly: true + antennaModel: + description: >- + If populated, the Antenna Model Pattern to use. Format is: + `RecordCreatorId:PatternId` + type: string + nrqzValidated: + description: >- + Output only. Set to `true` if a CPI has validated that they have + coordinated with the National Quiet Zone office. + type: boolean + readOnly: true + deprecated: 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). + id: SasPortalDeviceMetadata + SasPortalDeviceAirInterface: + description: Information about the device's air interface. properties: - encodedDevice: + supportedSpec: 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. + 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 - format: byte - installerId: + 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 + type: string + id: SasPortalDeviceAirInterface + type: object + SasPortalSetPolicyRequest: + description: Request message for `SetPolicy` method. + type: object + id: SasPortalSetPolicyRequest + properties: + policy: + $ref: '#/components/schemas/SasPortalPolicy' + description: Required. The policy to be applied to the `resource`. + resource: type: string description: >- - Required. Unique installer id (CPI ID) from the Certified - Professional Installers database. - description: Request for CreateSignedDevice. - SasPortalGenerateSecretRequest: - id: SasPortalGenerateSecretRequest - description: Request for GenerateSecret. + Required. The resource for which the policy is being specified. This + policy replaces any existing policy. + disableNotification: + description: >- + Optional. Set the field as `true` to disable the onboarding + notification. + type: boolean + SasPortalProvisionDeploymentRequest: type: object - properties: {} - SasPortalDpaMoveList: + id: SasPortalProvisionDeploymentRequest properties: - frequencyRange: - description: The frequency range that the move list affects. - $ref: '#/components/schemas/SasPortalFrequencyRange' - dpaId: + newDeploymentDisplayName: type: string - description: The ID of the DPA. - description: An entry in a DPA's move list. + 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. + 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 + organizationId: + format: int64 + type: string + description: >- + Optional. If this field is set then a new deployment will be created + under the organization specified by this id. + 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. + SasPortalGenerateSecretResponse: + id: SasPortalGenerateSecretResponse + properties: + secret: + type: string + description: The secret generated by the string and used by ValidateInstaller. type: object - id: SasPortalDpaMoveList + description: Response for GenerateSecret. SasPortalMoveNodeRequest: - id: SasPortalMoveNodeRequest type: object description: Request for MoveNode. + id: SasPortalMoveNodeRequest properties: destination: type: string description: >- Required. The name of the new parent resource node or customer to reparent the node under. - SasPortalGcpProjectDeployment: + SasPortalMigrateOrganizationMetadata: description: >- - Deployment associated with the GCP project. Includes whether SAS - analytics has been enabled or not. - properties: - hasEnabledAnalytics: - type: boolean - description: Whether SAS analytics has been enabled. - deployment: - $ref: '#/components/schemas/SasPortalDeployment' - description: Deployment associated with the GCP project. - id: SasPortalGcpProjectDeployment + Long-running operation metadata message returned by the + MigrateOrganization. type: object + id: SasPortalMigrateOrganizationMetadata + properties: + operationState: + description: Output only. Current operation state + 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. + readOnly: true + type: string SasPortalInstallationParams: + id: SasPortalInstallationParams description: Information about the device installation parameters. properties: - cpeCbsdIndication: - description: >- - If present, this parameter specifies whether the CBSD is a CPE-CBSD - or not. - type: boolean - horizontalAccuracy: - format: double + 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 + type: string + description: Specifies how the height is measured. + antennaAzimuth: 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 + 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. + format: int32 + type: integer antennaGain: description: >- Peak antenna gain in dBi. This parameter is a double with a value @@ -334,112 +432,92 @@ components: format: double type: number 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. - format: double - type: number + cpeCbsdIndication: + description: >- + If present, this parameter specifies whether the CBSD is a CPE-CBSD + or not. + type: boolean 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 - indoorDeployment: - type: boolean + format: double + eirpCapability: + type: integer + format: int32 description: >- - Whether the device antenna is indoor or not. `true`: indoor. - `false`: outdoor. + 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. 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 - heightType: - type: string - 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. - description: Specifies how the height is measured. + type: number antennaBeamwidth: - type: integer + format: int32 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 + type: integer verticalAccuracy: - type: number - 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. - eirpCapability: + format: double + type: number + horizontalAccuracy: + format: double + type: number 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 + 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: + type: boolean + description: >- + Whether the device antenna is indoor or not. `true`: indoor. + `false`: outdoor. 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 - 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. 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. - type: object - id: SasPortalInstallationParams - SasPortalUpdateSignedDeviceRequest: - type: object - properties: - encodedDevice: - type: string - format: byte 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: + 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 - description: >- - Required. Unique installer ID (CPI ID) from the Certified - Professional Installers database. - id: SasPortalUpdateSignedDeviceRequest - description: Request for UpdateSignedDevice. + type: object + SasPortalValidateInstallerResponse: + id: SasPortalValidateInstallerResponse + description: Response for ValidateInstaller. + properties: {} + type: object SasPortalAssignment: + type: object + description: Associates `members` with a `role`. id: SasPortalAssignment properties: role: @@ -448,739 +526,661 @@ components: members: items: type: string - type: array 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 - SasPortalSetPolicyRequest: - description: Request message for `SetPolicy` method. + type: array + SasPortalGetPolicyRequest: 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: type: string - description: >- - Required. The resource for which the policy is being specified. This - policy replaces any existing policy. - type: object - id: SasPortalSetPolicyRequest - SasPortalDeviceModel: - properties: - name: - description: The name of the device model. - type: string - softwareVersion: - description: The software version of the device. - type: string - vendor: - type: string - description: The name of the device vendor. - firmwareVersion: - type: string - description: The firmware version of the device. - hardwareVersion: - type: string - description: The hardware version of the device. - id: SasPortalDeviceModel - description: Information about the model of the device. - type: object - SasPortalListGcpProjectDeploymentsResponse: + description: Required. The resource for which the policy is being requested. 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]. + description: Request message for `GetPolicy` method. + id: SasPortalGetPolicyRequest SasPortalNode: - description: The Node. type: object - id: SasPortalNode + description: The Node. properties: + name: + type: string + description: Output only. Resource name. sasUserIds: - description: User ids used by the devices belonging to this node. type: array items: type: string + description: User ids used by the devices belonging to this node. displayName: - type: string description: The node's display name. - name: - type: string - description: Output only. Resource name. - SasPortalValidateInstallerRequest: - properties: - 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 - installerId: - description: >- - Required. Unique installer id (CPI ID) from the Certified - Professional Installers database. type: string + id: SasPortalNode + SasPortalTestPermissionsResponse: + description: Response message for `TestPermissions` method. + id: SasPortalTestPermissionsResponse type: object - description: Request for ValidateInstaller. - id: SasPortalValidateInstallerRequest - SasPortalSetupSasAnalyticsResponse: - description: >- - Response returned by the long running operation for the - SetupSasAnalytics rpc. + properties: + permissions: + description: A set of permissions that the caller is allowed. + items: + type: string + type: array + SasPortalDeviceGrant: type: object - properties: {} - id: SasPortalSetupSasAnalyticsResponse - SasPortalFrequencyRange: - id: SasPortalFrequencyRange properties: - highFrequencyMhz: - description: The highest frequency of the frequency range in MHz. - format: double - type: number - lowFrequencyMhz: + maxEirp: format: double - description: The lowest frequency of the frequency range in MHz. type: number - type: object - description: Frequency range from `low_frequency` to `high_frequency`. - SasPortalTestPermissionsRequest: - description: Request message for `TestPermissions` method. - type: object - properties: - resource: description: >- - Required. The resource for which the permissions are being - requested. + 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). + channelType: + description: Type of channel used. + enum: + - CHANNEL_TYPE_UNSPECIFIED + - CHANNEL_TYPE_GAA + - CHANNEL_TYPE_PAL type: string - permissions: - items: - type: string - description: The set of permissions to check for the `resource`. + enumDescriptions: + - '' + - '' + - '' + grantId: + type: string + description: Grant Id. + frequencyRange: + description: The transmission frequency range. + $ref: '#/components/schemas/SasPortalFrequencyRange' + moveList: type: array - id: SasPortalTestPermissionsRequest - SasPortalTestPermissionsResponse: - id: SasPortalTestPermissionsResponse - properties: - permissions: + items: + $ref: '#/components/schemas/SasPortalDpaMoveList' + description: The DPA move lists on which this grant appears. + expireTime: + description: The expiration time of the grant. + format: google-datetime + type: string + suspensionReason: + description: If the grant is suspended, the reason(s) for suspension. items: type: string type: array - description: A set of permissions that the caller is allowed. - description: Response message for `TestPermissions` method. - type: object - SasPortalOperation: + lastHeartbeatTransmitExpireTime: + format: google-datetime + description: The transmit expiration time of the last heartbeat. + type: string + state: + 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. + type: string + description: State of the grant. description: >- - This resource represents a long-running operation that is the result of - a network API call. - id: SasPortalOperation + 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 + SasPortalDeployment: + id: SasPortalDeployment + description: The Deployment. properties: - 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. - 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. - done: - type: boolean + displayName: + type: string + description: The deployment's display name. + frns: 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. The FCC Registration Numbers (FRNs) copied from its + direct parent. + type: array + items: + type: string + readOnly: true 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 - error: - $ref: '#/components/schemas/SasPortalStatus' + readOnly: true + description: Output only. Resource name. + sasUserIds: description: >- - The error result of the operation in case of failure or - cancellation. - type: object - SasPortalChannelWithScore: - id: SasPortalChannelWithScore - 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 - type: object - SasPortalPolicy: - id: SasPortalPolicy + 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 type: object + SasPortalTestPermissionsRequest: properties: - assignments: - items: - $ref: '#/components/schemas/SasPortalAssignment' - type: array - description: List of assignments - etag: + resource: type: string 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 - description: Defines an access control policy to the resources. + Required. The resource for which the permissions are being + requested. + permissions: + description: The set of permissions to check for the `resource`. + type: array + items: + type: string + id: SasPortalTestPermissionsRequest + type: object + description: Request message for `TestPermissions` method. SasPortalDeviceConfig: type: object description: Information about the device configuration. + id: SasPortalDeviceConfig properties: - updateTime: - type: string - description: Output only. The last time the device configuration was edited. - format: google-datetime + installationParams: + $ref: '#/components/schemas/SasPortalInstallationParams' + description: Installation parameters for the device. measurementCapabilities: - type: array description: Measurement reporting capabilities of the device. + type: array items: enum: - MEASUREMENT_CAPABILITY_UNSPECIFIED - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT + type: string enumDescriptions: - '' - '' - '' - type: string callSign: + type: string description: The call sign of the device operator. + userId: type: string - airInterface: - description: Information about this device's air interface. - $ref: '#/components/schemas/SasPortalDeviceAirInterface' - state: - description: State of the configuration. + description: The identifier of a device user. + updateTime: + description: Output only. The last time the device configuration was edited. + format: google-datetime type: string - enum: - - DEVICE_CONFIG_STATE_UNSPECIFIED - - DRAFT - - FINAL - enumDescriptions: - - '' - - '' - - '' - isSigned: - type: boolean - description: Output only. Whether the configuration has been signed by a CPI. category: + enum: + - DEVICE_CATEGORY_UNSPECIFIED + - DEVICE_CATEGORY_A + - DEVICE_CATEGORY_B + description: FCC category of the device. enumDescriptions: - Unspecified device category. - Category A. - Category B. type: string + isSigned: + type: boolean + description: Output only. Whether the configuration has been signed by a CPI. + state: + enumDescriptions: + - '' + - '' + - '' enum: - - DEVICE_CATEGORY_UNSPECIFIED - - DEVICE_CATEGORY_A - - DEVICE_CATEGORY_B - description: FCC category of the device. - userId: - description: The identifier of a device user. + - DEVICE_CONFIG_STATE_UNSPECIFIED + - DRAFT + - FINAL + description: State of the configuration. type: string - installationParams: - description: Installation parameters for the device. - $ref: '#/components/schemas/SasPortalInstallationParams' + airInterface: + description: Information about this device's air interface. + $ref: '#/components/schemas/SasPortalDeviceAirInterface' model: description: Information about this device model. $ref: '#/components/schemas/SasPortalDeviceModel' - id: SasPortalDeviceConfig - SasPortalListLegacyOrganizationsResponse: - description: >- - Response for [ListLegacyOrganizations]. - [spectrum.sas.portal.v1alpha1.Provisioning.ListLegacyOrganizations]. - id: SasPortalListLegacyOrganizationsResponse - type: object - properties: - organizations: - type: array - items: - $ref: '#/components/schemas/SasPortalOrganization' - description: Optional. Legacy SAS organizations. - SasPortalStatus: + SasPortalCreateSignedDeviceRequest: + id: SasPortalCreateSignedDeviceRequest 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). + description: Request for CreateSignedDevice. properties: - code: - format: int32 - description: The status code, which should be an enum value of google.rpc.Code. - type: integer - 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 - message: - type: string + encodedDevice: + format: byte 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: SasPortalStatus - SasPortalOrganization: - type: object - description: Organization details. - properties: - id: - format: int64 - description: Id of organization + 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 - displayName: + installerId: type: string - description: Name of organization - id: SasPortalOrganization - SasPortalGenerateSecretResponse: + description: >- + Required. Unique installer id (CPI ID) from the Certified + Professional Installers database. + SasPortalSignDeviceRequest: properties: - secret: - description: The secret generated by the string and used by ValidateInstaller. - type: string - description: Response for GenerateSecret. + 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' type: object - id: SasPortalGenerateSecretResponse - SasPortalDevice: + id: SasPortalSignDeviceRequest + description: Request for SignDevice. + SasPortalPolicy: type: object - id: SasPortalDevice properties: - grants: - type: array - description: Output only. Grants held by the device. - items: - $ref: '#/components/schemas/SasPortalDeviceGrant' - 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. - type: string - enum: - - DEVICE_STATE_UNSPECIFIED - - RESERVED - - REGISTERED - - DEREGISTERED - description: Output only. Device state. - currentChannels: - description: Output only. Current channels with scores. - deprecated: true - type: array - readOnly: true - items: - $ref: '#/components/schemas/SasPortalChannelWithScore' - activeConfig: - description: >- - Output only. Current configuration of the device as registered to - the SAS. - $ref: '#/components/schemas/SasPortalDeviceConfig' - grantRangeAllowlists: - type: array + assignments: items: - $ref: '#/components/schemas/SasPortalFrequencyRange' - description: >- - Only ranges that are within the allowlists are available for new - grants. - preloadedConfig: - description: Configuration of the device, as specified via SAS Portal API. - $ref: '#/components/schemas/SasPortalDeviceConfig' - 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 - serialNumber: - description: A serial number assigned to the device by the device manufacturer. - type: string - displayName: - description: Device display name. - type: string - name: + $ref: '#/components/schemas/SasPortalAssignment' + type: array + description: List of assignments + etag: type: string - description: Output only. The resource path name. - deviceMetadata: description: >- - Device parameters that can be overridden by both SAS Portal and SAS - registration requests. - $ref: '#/components/schemas/SasPortalDeviceMetadata' + 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 + description: Defines an access control policy to the resources. + id: SasPortalPolicy SasPortalSetupSasAnalyticsRequest: - type: object description: Request for the SetupSasAnalytics rpc. id: SasPortalSetupSasAnalyticsRequest + type: object properties: userId: type: string description: >- Optional. User id to setup analytics for, if not provided the user id associated with the project is used. optional - SasPortalCustomer: + SasPortalMigrateOrganizationRequest: + id: SasPortalMigrateOrganizationRequest properties: - displayName: - description: >- - Required. Name of the organization that the customer entity - represents. - type: string - sasUserIds: - description: User IDs used by the devices belonging to this customer. - items: - type: string - type: array - name: + organizationId: + format: int64 type: string - description: Output only. Resource name of the customer. - description: Entity representing a SAS customer. + description: Required. Id of the SAS organization to be migrated. + 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. + 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: {} + type: object + id: SasPortalEmpty + SasPortalSetupSasAnalyticsResponse: + id: SasPortalSetupSasAnalyticsResponse + properties: {} + type: object + description: >- + Response returned by the long running operation for the + SetupSasAnalytics rpc. + SasPortalGenerateSecretRequest: + type: object + description: Request for GenerateSecret. + properties: {} + id: SasPortalGenerateSecretRequest + SasPortalStatus: type: object - id: SasPortalCustomer - SasPortalListNodesResponse: - id: SasPortalListNodesResponse properties: - nodes: + details: items: - $ref: '#/components/schemas/SasPortalNode' - description: The nodes that match the request. + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object type: array - 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. + 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: + format: int32 + type: integer + 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 + 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: SasPortalStatus + SasPortalListCustomersResponse: type: object - description: Response for ListNodes. - SasPortalListDeploymentsResponse: - description: Response for ListDeployments. - type: object - id: SasPortalListDeploymentsResponse properties: - deployments: - items: - $ref: '#/components/schemas/SasPortalDeployment' - description: The deployments that match the request. + 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 ListDeployments + 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 deployments. - SasPortalMoveDeviceRequest: + missing or empty, it means there are no more customers. + id: SasPortalListCustomersResponse + description: Response for `ListCustomers`. + SasPortalMoveDeploymentRequest: type: object - description: Request for MoveDevice. + id: SasPortalMoveDeploymentRequest + description: Request for MoveDeployment. properties: destination: type: string description: >- Required. The name of the new parent resource node or customer to - reparent the device under. - id: SasPortalMoveDeviceRequest - SasPortalListDevicesResponse: - description: Response for ListDevices. - id: SasPortalListDevicesResponse + reparent the deployment under. + SasPortalChannelWithScore: + description: The channel with score. type: object + id: SasPortalChannelWithScore properties: - 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. - devices: - description: The devices that match the request. - items: - $ref: '#/components/schemas/SasPortalDevice' - type: array - 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: - maxEirp: + score: 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 - moveList: - items: - $ref: '#/components/schemas/SasPortalDpaMoveList' - description: The DPA move lists on which this grant appears. - type: array - expireTime: - format: google-datetime - type: string - description: The expiration time of the grant. + description: The channel score, normalized to be in the range [0,100]. frequencyRange: $ref: '#/components/schemas/SasPortalFrequencyRange' - description: The transmission frequency range. - grantId: - description: Grant Id. - type: string - channelType: - description: Type of channel used. - enumDescriptions: - - '' - - '' - - '' - enum: - - CHANNEL_TYPE_UNSPECIFIED - - CHANNEL_TYPE_GAA - - CHANNEL_TYPE_PAL + description: The frequency range of the channel. + SasPortalOperation: + type: object + description: >- + This resource represents a long-running operation that is the result of + a network API call. + id: SasPortalOperation + 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`. + 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. + name: type: string - state: - 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: >- + 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/SasPortalStatus' + description: >- + The error result of the operation in case of failure or + cancellation. + SasPortalDeploymentAssociation: + id: SasPortalDeploymentAssociation + description: Association between a gcp project and a SAS user id. + properties: + userId: + description: User id of the deployment. type: string - description: State of the grant. - lastHeartbeatTransmitExpireTime: + gcpProjectId: 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. - items: - type: string - type: array + description: GCP project id of the associated project. type: object - id: SasPortalDeviceGrant - 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. + SasPortalOrganization: + properties: + id: + format: int64 + description: Id of organization + type: string + displayName: + description: Name of organization + type: string + description: Organization details. type: object + id: SasPortalOrganization + SasPortalUpdateSignedDeviceRequest: properties: - organizationId: + encodedDevice: + format: byte + 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: int64 - description: Required. Id of the SAS organization to be migrated. - id: SasPortalMigrateOrganizationRequest - SasPortalProvisionDeploymentResponse: + installerId: + description: >- + Required. Unique installer ID (CPI ID) from the Certified + Professional Installers database. + type: string + description: Request for UpdateSignedDevice. + id: SasPortalUpdateSignedDeviceRequest type: object - description: >- - Response for [ProvisionDeployment]. - [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. - id: SasPortalProvisionDeploymentResponse + SasPortalListDevicesResponse: properties: - errorMessage: + devices: + type: array + items: + $ref: '#/components/schemas/SasPortalDevice' + description: The devices that match the request. + nextPageToken: description: >- - Optional. Optional error message if the provisioning request is not - successful. + 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 - SasPortalDeviceMetadata: - id: SasPortalDeviceMetadata - description: Device data overridable by both SAS Portal and registration requests. + type: object + id: SasPortalListDevicesResponse + description: Response for ListDevices. + SasPortalDevice: properties: - nrqzValidated: - deprecated: true + serialNumber: + type: string + description: A serial number assigned to the device by the device manufacturer. + deviceMetadata: + $ref: '#/components/schemas/SasPortalDeviceMetadata' description: >- - Output only. Set to `true` if a CPI has validated that they have - coordinated with the National Quiet Zone office. - readOnly: true - type: boolean - antennaModel: + Device parameters that can be overridden by both SAS Portal and SAS + registration requests. + name: + description: Output only. The resource path name. + type: string + activeConfig: description: >- - If populated, the Antenna Model Pattern to use. Format is: - `RecordCreatorId:PatternId` + Output only. Current configuration of the device as registered to + the SAS. + $ref: '#/components/schemas/SasPortalDeviceConfig' + preloadedConfig: + description: Configuration of the device, as specified via SAS Portal API. + $ref: '#/components/schemas/SasPortalDeviceConfig' + displayName: + description: Device display name. type: string - commonChannelGroup: + currentChannels: + readOnly: true + items: + $ref: '#/components/schemas/SasPortalChannelWithScore' + description: Output only. Current channels with scores. + deprecated: true + type: array + grantRangeAllowlists: 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). + Only ranges that are within the allowlists are available for new + grants. + type: array + items: + $ref: '#/components/schemas/SasPortalFrequencyRange' + fccId: 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). + 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. + state: type: string - nrqzValidation: - readOnly: true - $ref: '#/components/schemas/SasPortalNrqzValidation' - description: Output only. National Radio Quiet Zone validation info. + 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 + grants: + description: Output only. Grants held by the device. + type: array + items: + $ref: '#/components/schemas/SasPortalDeviceGrant' type: object + id: SasPortalDevice SasPortalMigrateOrganizationResponse: + type: object + id: SasPortalMigrateOrganizationResponse properties: deploymentAssociation: type: array + items: + $ref: '#/components/schemas/SasPortalDeploymentAssociation' description: >- Optional. A list of deployment association that were created for the migration, or current associations if they already exist. - items: - $ref: '#/components/schemas/SasPortalDeploymentAssociation' - id: SasPortalMigrateOrganizationResponse description: >- Response for [MigrateOrganization]. [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. - type: object parameters: - 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 - 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: - 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. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: quotaUser + name: uploadType schema: type: string - access_token: - description: OAuth access token. + callback: + description: JSONP in: query - name: access_token + 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 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"). + 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 - 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 + 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: policies: - id: sasportal.policies + id: google.sasportal.policies name: policies title: Policies methods: - policies_set: + policies_get: operation: - $ref: '#/paths/~1v1alpha1~1policies:set/post' + $ref: '#/paths/~1v1alpha1~1policies:get/post' response: mediaType: application/json openAPIDocKey: '200' @@ -1190,9 +1190,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - policies_get: + policies_set: operation: - $ref: '#/paths/~1v1alpha1~1policies:get/post' + $ref: '#/paths/~1v1alpha1~1policies:set/post' response: mediaType: application/json openAPIDocKey: '200' @@ -1201,150 +1201,130 @@ components: insert: [] update: [] delete: [] - customers: - id: sasportal.customers - name: customers - title: Customers + devices: + id: google.sasportal.devices + name: devices + title: Devices methods: - customers_provision_deployment: + deployments_devices_get: operation: - $ref: '#/paths/~1v1alpha1~1customers:provisionDeployment/post' + $ref: >- + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/get response: mediaType: application/json openAPIDocKey: '200' - customers_setup_sas_analytics: + deployments_devices_delete: operation: - $ref: '#/paths/~1v1alpha1~1customers:setupSasAnalytics/post' + $ref: >- + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/delete response: mediaType: application/json openAPIDocKey: '200' - _customers_list: - operation: &ref_1 - $ref: '#/paths/~1v1alpha1~1customers/get' - response: &ref_2 + deployments_devices_patch: + operation: + $ref: >- + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/patch + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.customers - customers_list: - operation: *ref_1 - response: *ref_2 - customers_get: + deployments_devices_move: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/get' + $ref: >- + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:move/post response: mediaType: application/json openAPIDocKey: '200' - customers_patch: + deployments_devices_sign_device: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/patch' + $ref: >- + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:signDevice/post response: mediaType: application/json openAPIDocKey: '200' - customers_migrate_organization: + nodes_devices_patch: operation: - $ref: '#/paths/~1v1alpha1~1customers:migrateOrganization/post' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/patch' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/customers/methods/customers_list' - - $ref: '#/components/x-stackQL-resources/customers/methods/customers_get' - insert: [] - update: [] - delete: [] - customers_legacy_organizations: - id: sasportal.customers_legacy_organizations - name: customers_legacy_organizations - title: Customers_legacy_organizations - methods: - customers_list_legacy_organizations: + nodes_devices_delete: operation: - $ref: '#/paths/~1v1alpha1~1customers:listLegacyOrganizations/get' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/delete' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/customers_legacy_organizations/methods/customers_list_legacy_organizations - insert: [] - update: [] - delete: [] - customers_gcp_project_deployments: - id: sasportal.customers_gcp_project_deployments - name: customers_gcp_project_deployments - title: Customers_gcp_project_deployments - methods: - customers_list_gcp_project_deployments: + nodes_devices_get: operation: - $ref: '#/paths/~1v1alpha1~1customers:listGcpProjectDeployments/get' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/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: [] - delete: [] - devices: - id: sasportal.devices - name: devices - title: Devices - methods: - customers_devices_get: + _nodes_devices_list: + operation: &ref_1 + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/get' + response: &ref_2 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.devices + nodes_devices_list: + operation: *ref_1 + response: *ref_2 + nodes_devices_create: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/get + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/post' response: mediaType: application/json openAPIDocKey: '200' - customers_devices_delete: + nodes_devices_sign_device: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/delete + #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:signDevice/post response: mediaType: application/json openAPIDocKey: '200' - customers_devices_patch: + nodes_devices_move: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/patch + #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:move/post response: mediaType: application/json openAPIDocKey: '200' - _customers_devices_list: + _nodes_nodes_devices_list: operation: &ref_3 - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/get' + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/get response: &ref_4 mediaType: application/json openAPIDocKey: '200' objectKey: $.devices - customers_devices_list: + nodes_nodes_devices_list: operation: *ref_3 response: *ref_4 - customers_devices_create: + nodes_nodes_devices_create: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/post' + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - customers_devices_move: + nodes_deployments_devices_create: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:move/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - customers_devices_sign_device: - operation: + _nodes_deployments_devices_list: + operation: &ref_5 $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:signDevice/post - response: + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/get + response: &ref_6 mediaType: application/json openAPIDocKey: '200' + objectKey: $.devices + nodes_deployments_devices_list: + operation: *ref_5 + response: *ref_6 customers_nodes_devices_create: operation: $ref: >- @@ -1353,344 +1333,444 @@ components: mediaType: application/json openAPIDocKey: '200' _customers_nodes_devices_list: - operation: &ref_5 + operation: &ref_7 $ref: >- #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/get - response: &ref_6 + response: &ref_8 mediaType: application/json openAPIDocKey: '200' objectKey: $.devices customers_nodes_devices_list: - operation: *ref_5 - response: *ref_6 + operation: *ref_7 + response: *ref_8 _customers_deployments_devices_list: - operation: &ref_7 + operation: &ref_9 $ref: >- #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/get - response: &ref_8 + response: &ref_10 mediaType: application/json openAPIDocKey: '200' objectKey: $.devices customers_deployments_devices_list: - operation: *ref_7 - response: *ref_8 + operation: *ref_9 + response: *ref_10 customers_deployments_devices_create: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/post + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/post + response: + mediaType: application/json + openAPIDocKey: '200' + customers_devices_delete: + operation: + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + customers_devices_get: + operation: + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + customers_devices_patch: + operation: + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + _customers_devices_list: + operation: &ref_11 + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/get' + response: &ref_12 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.devices + customers_devices_list: + operation: *ref_11 + response: *ref_12 + customers_devices_create: + operation: + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/post' + response: + mediaType: application/json + openAPIDocKey: '200' + customers_devices_move: + operation: + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:move/post + response: + mediaType: application/json + openAPIDocKey: '200' + customers_devices_sign_device: + operation: + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:signDevice/post + response: + mediaType: application/json + openAPIDocKey: '200' + 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_nodes_devices_list + - $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/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 + - $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 + 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 + methods: + deployments_devices_update_signed: + operation: + $ref: >- + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:updateSigned/patch response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_delete: + nodes_devices_update_signed: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/delete + #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:updateSigned/patch response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_get: + nodes_devices_create_signed: operation: - $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/get + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices:createSigned/post' response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_patch: + nodes_nodes_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/patch + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_move: + nodes_deployments_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:move/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_sign_device: + customers_nodes_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:signDevice/post + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - _nodes_deployments_devices_list: - operation: &ref_9 - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/get - response: &ref_10 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.devices - nodes_deployments_devices_list: - operation: *ref_9 - response: *ref_10 - nodes_deployments_devices_create: + customers_deployments_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/post + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - _nodes_nodes_devices_list: - operation: &ref_11 - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/get - response: &ref_12 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.devices - nodes_nodes_devices_list: - operation: *ref_11 - response: *ref_12 - nodes_nodes_devices_create: + customers_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/post - response: - mediaType: application/json - openAPIDocKey: '200' - nodes_devices_patch: - operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/patch' + #/paths/~1v1alpha1~1customers~1{customersId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_delete: + customers_devices_update_signed: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/delete' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:updateSigned/patch response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_get: + 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 + - $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: [] + delete: [] + deployments: + id: google.sasportal.deployments + name: deployments + title: Deployments + methods: + deployments_get: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/get' + $ref: '#/paths/~1v1alpha1~1deployments~1{deploymentsId}/get' response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_move: + nodes_nodes_deployments_create: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:move/post - response: - mediaType: application/json - openAPIDocKey: '200' - nodes_devices_create: - operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/post' + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/post response: mediaType: application/json openAPIDocKey: '200' - _nodes_devices_list: + _nodes_nodes_deployments_list: operation: &ref_13 - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/get' + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/get response: &ref_14 mediaType: application/json openAPIDocKey: '200' - objectKey: $.devices - nodes_devices_list: + objectKey: $.deployments + nodes_nodes_deployments_list: operation: *ref_13 response: *ref_14 - nodes_devices_sign_device: + 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' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_devices_get - - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_devices_list - - $ref: >- - #/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/deployments_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/nodes_devices_get' - - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_devices_list - insert: - - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_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_deployments_devices_create - - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_nodes_devices_create - - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_devices_create - update: [] - 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 - devices_signed: - id: sasportal.devices_signed - name: devices_signed - title: Devices_signed - methods: - customers_devices_update_signed: + _nodes_deployments_list: + operation: &ref_15 + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments/get' + response: &ref_16 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.deployments + nodes_deployments_list: + operation: *ref_15 + response: *ref_16 + nodes_deployments_delete: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:updateSigned/patch + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - customers_devices_create_signed: + nodes_deployments_patch: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices:createSigned/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/patch response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_devices_create_signed: + nodes_deployments_get: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices:createSigned/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/get response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_devices_create_signed: + _customers_nodes_deployments_list: + operation: &ref_17 + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/get + response: &ref_18 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.deployments + customers_nodes_deployments_list: + operation: *ref_17 + response: *ref_18 + customers_nodes_deployments_create: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices:createSigned/post + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/post response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_update_signed: + customers_deployments_get: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:updateSigned/patch + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/get response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_devices_create_signed: + customers_deployments_patch: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices:createSigned/post + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/patch response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_devices_create_signed: + customers_deployments_delete: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices:createSigned/post + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_create_signed: + customers_deployments_move: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices:createSigned/post' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}:move/post response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_update_signed: + customers_deployments_create: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:updateSigned/patch + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/post' response: mediaType: application/json openAPIDocKey: '200' + _customers_deployments_list: + operation: &ref_19 + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/get' + response: &ref_20 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.deployments + customers_deployments_list: + operation: *ref_19 + response: *ref_20 sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/nodes_deployments_get + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/customers_nodes_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/customers_deployments_get + - $ref: >- + #/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 insert: - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/customers_devices_create_signed + #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_create - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/customers_nodes_devices_create_signed + #/components/x-stackQL-resources/deployments/methods/customers_nodes_deployments_create + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/customers_deployments_create + update: - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/customers_deployments_devices_create_signed + #/components/x-stackQL-resources/deployments/methods/nodes_deployments_patch - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/nodes_deployments_devices_create_signed + #/components/x-stackQL-resources/deployments/methods/customers_deployments_patch + delete: - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/nodes_nodes_devices_create_signed + #/components/x-stackQL-resources/deployments/methods/nodes_deployments_delete - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/nodes_devices_create_signed - update: [] - delete: [] + #/components/x-stackQL-resources/deployments/methods/customers_deployments_delete nodes: - id: sasportal.nodes + id: google.sasportal.nodes name: nodes title: Nodes methods: - customers_nodes_patch: + nodes_nodes_move: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/patch + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}:move/post' response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_move: + nodes_nodes_create: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}:move/post + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/post' response: mediaType: application/json openAPIDocKey: '200' - _nodes_nodes_nodes_list: - operation: &ref_15 - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/get' - response: &ref_16 + _nodes_nodes_list: + operation: &ref_21 + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/get' + response: &ref_22 mediaType: application/json openAPIDocKey: '200' objectKey: $.nodes - nodes_nodes_nodes_list: - operation: *ref_15 - response: *ref_16 - nodes_nodes_nodes_create: + nodes_nodes_list: + operation: *ref_21 + response: *ref_22 + nodes_nodes_delete: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/post + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/delete' response: mediaType: application/json openAPIDocKey: '200' - 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' - nodes_nodes_delete: - operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/delete' - response: + _nodes_nodes_nodes_list: + operation: &ref_23 + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/get' + response: &ref_24 mediaType: application/json openAPIDocKey: '200' - nodes_nodes_patch: + objectKey: $.nodes + nodes_nodes_nodes_list: + operation: *ref_23 + response: *ref_24 + 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_list: - operation: &ref_17 - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/get' - response: &ref_18 + customers_nodes_patch: + operation: + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/patch + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.nodes - nodes_nodes_list: - operation: *ref_17 - response: *ref_18 - nodes_nodes_create: + customers_nodes_move: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/post' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}:move/post response: mediaType: application/json openAPIDocKey: '200' @@ -1703,423 +1783,250 @@ components: - $ref: >- #/components/x-stackQL-resources/nodes/methods/nodes_nodes_nodes_create - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_patch' + - $ref: >- + #/components/x-stackQL-resources/nodes/methods/customers_nodes_patch delete: - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_delete' - customer_node: - id: sasportal.customer_node - name: customer_node - title: Customer_node + node: + id: google.sasportal.node + name: node + title: Node methods: - customers_nodes_get: + nodes_nodes_get: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/get' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + nodes_get: + operation: + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/customer_node/methods/customers_nodes_get + - $ref: '#/components/x-stackQL-resources/node/methods/nodes_nodes_get' + - $ref: '#/components/x-stackQL-resources/node/methods/nodes_get' insert: [] update: [] delete: [] - customer_nodes: - id: sasportal.customer_nodes - name: customer_nodes - title: Customer_nodes + installer: + id: google.sasportal.installer + name: installer + title: Installer methods: - customers_nodes_delete: - operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - customers_nodes_create: + installer_validate: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/post' + $ref: '#/paths/~1v1alpha1~1installer:validate/post' response: mediaType: application/json openAPIDocKey: '200' - _customers_nodes_list: - operation: &ref_19 - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/get' - response: &ref_20 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.nodes - customers_nodes_list: - operation: *ref_19 - response: *ref_20 - _customers_nodes_nodes_list: - operation: &ref_21 - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/get - response: &ref_22 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.nodes - customers_nodes_nodes_list: - operation: *ref_21 - response: *ref_22 - customers_nodes_nodes_create: + installer_generate_secret: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/post + $ref: '#/paths/~1v1alpha1~1installer:generateSecret/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_list - - $ref: >- - #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_nodes_list - insert: - - $ref: >- - #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_create - - $ref: >- - #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_nodes_create + select: [] + insert: [] update: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_delete - deployments: - id: sasportal.deployments - name: deployments - title: Deployments + delete: [] + customers: + id: google.sasportal.customers + name: customers + title: Customers methods: - _customers_nodes_deployments_list: - operation: &ref_23 - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/get - response: &ref_24 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.deployments - customers_nodes_deployments_list: - operation: *ref_23 - response: *ref_24 - customers_nodes_deployments_create: - operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/post - response: - mediaType: application/json - openAPIDocKey: '200' - customers_deployments_delete: + customers_get: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/delete + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/get' response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_patch: + customers_patch: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/patch + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/patch' response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_get: + customers_migrate_organization: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/get + $ref: '#/paths/~1v1alpha1~1customers:migrateOrganization/post' response: mediaType: application/json openAPIDocKey: '200' - _customers_deployments_list: + _customers_list: operation: &ref_25 - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/get' + $ref: '#/paths/~1v1alpha1~1customers/get' response: &ref_26 mediaType: application/json openAPIDocKey: '200' - objectKey: $.deployments - customers_deployments_list: + objectKey: $.customers + customers_list: operation: *ref_25 response: *ref_26 - customers_deployments_create: + customers_provision_deployment: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/post' + $ref: '#/paths/~1v1alpha1~1customers:provisionDeployment/post' response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_move: + customers_setup_sas_analytics: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}:move/post + $ref: '#/paths/~1v1alpha1~1customers:setupSasAnalytics/post' response: mediaType: application/json openAPIDocKey: '200' - deployments_get: + 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' + 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~1deployments~1{deploymentsId}/get' + $ref: '#/paths/~1v1alpha1~1customers:listGcpProjectDeployments/get' response: mediaType: application/json openAPIDocKey: '200' - _nodes_deployments_list: - operation: &ref_27 - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments/get' - response: &ref_28 + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/customers_gcp_project_deployments/methods/customers_list_gcp_project_deployments + insert: [] + update: [] + 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' - objectKey: $.deployments - nodes_deployments_list: - operation: *ref_27 - response: *ref_28 - nodes_deployments_delete: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/customers_legacy_organizations/methods/customers_list_legacy_organizations + insert: [] + update: [] + delete: [] + customer_node: + id: google.sasportal.customer_node + name: customer_node + title: Customer_node + methods: + customers_nodes_get: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/delete + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/get' response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_patch: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/customer_node/methods/customers_nodes_get + insert: [] + update: [] + delete: [] + customer_nodes: + id: google.sasportal.customer_nodes + name: customer_nodes + title: Customer_nodes + methods: + customers_nodes_delete: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/patch + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/delete response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_get: + customers_nodes_create: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/get + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/post' response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_move: - operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}:move/post - response: + _customers_nodes_list: + operation: &ref_27 + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/get' + response: &ref_28 mediaType: application/json openAPIDocKey: '200' - nodes_nodes_deployments_create: + objectKey: $.nodes + customers_nodes_list: + operation: *ref_27 + response: *ref_28 + customers_nodes_nodes_create: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/post + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/post response: mediaType: application/json openAPIDocKey: '200' - _nodes_nodes_deployments_list: + _customers_nodes_nodes_list: operation: &ref_29 $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/get + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/get response: &ref_30 mediaType: application/json openAPIDocKey: '200' - objectKey: $.deployments - nodes_nodes_deployments_list: + objectKey: $.nodes + customers_nodes_nodes_list: operation: *ref_29 response: *ref_30 sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_nodes_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_get - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_list - - $ref: >- - #/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/nodes_deployments_get + #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_nodes_list - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_list + #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_list insert: - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_nodes_deployments_create - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_create + #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_nodes_create - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_create + #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_create update: [] delete: - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_delete - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_deployments_delete - installer: - id: 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: [] - delete: [] - node: - id: sasportal.node - name: node - title: Node - methods: - nodes_get: - operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - nodes_nodes_get: - operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/node/methods/nodes_get' - - $ref: '#/components/x-stackQL-resources/node/methods/nodes_nodes_get' - insert: [] - update: [] - delete: [] + #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_delete paths: - /v1alpha1/policies:set: + /v1alpha1/policies:get: parameters: &ref_31 - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/prettyPrint' - 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 - 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/SasPortalPolicy' - parameters: [] - /v1alpha1/policies:test: - parameters: *ref_31 - 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 - 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/SasPortalTestPermissionsResponse' - parameters: [] - /v1alpha1/policies:get: - parameters: *ref_31 - 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 - 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/SasPortalPolicy' - parameters: [] - /v1alpha1/customers:provisionDeployment: - parameters: *ref_31 - 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 - 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:listLegacyOrganizations: - parameters: *ref_31 - get: - description: Returns a list of legacy organizations. - operationId: sasportal.customers.listLegacyOrganizations + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/key' + 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 @@ -2135,15 +2042,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListLegacyOrganizationsResponse' + $ref: '#/components/schemas/SasPortalPolicy' parameters: [] - /v1alpha1/customers:listGcpProjectDeployments: + /v1alpha1/policies:test: parameters: *ref_31 - 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 + 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 @@ -2159,22 +2069,20 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/SasPortalListGcpProjectDeploymentsResponse + $ref: '#/components/schemas/SasPortalTestPermissionsResponse' parameters: [] - /v1alpha1/customers:setupSasAnalytics: + /v1alpha1/policies:set: parameters: *ref_31 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 + 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/SasPortalSetupSasAnalyticsRequest' + $ref: '#/components/schemas/SasPortalSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2190,13 +2098,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalPolicy' parameters: [] - /v1alpha1/customers: + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}: parameters: *ref_31 get: - description: Returns a list of requested customers. - operationId: sasportal.customers.list + description: Gets details about a device. + operationId: sasportal.deployments.devices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2212,22 +2120,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListCustomersResponse' + $ref: '#/components/schemas/SasPortalDevice' 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/{customersId}: - parameters: *ref_31 - get: - description: Returns a requested customer. - operationId: sasportal.customers.get + type: string + delete: + description: Deletes a device. + operationId: sasportal.deployments.devices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2243,21 +2150,26 @@ 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: path + name: devicesId required: true schema: type: string patch: - description: Updates an existing customer. - operationId: sasportal.customers.patch + description: Updates a device. + operationId: sasportal.deployments.devices.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCustomer' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2273,10 +2185,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCustomer' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: deploymentsId + required: true + schema: + type: string + - in: path + name: devicesId required: true schema: type: string @@ -2285,20 +2202,16 @@ paths: schema: type: string format: google-fieldmask - /v1alpha1/customers:migrateOrganization: + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:move: parameters: *ref_31 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 + description: Moves a device under another node or customer. + operationId: sasportal.deployments.devices.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMigrateOrganizationRequest' + $ref: '#/components/schemas/SasPortalMoveDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2315,12 +2228,27 @@ paths: application/json: schema: $ref: '#/components/schemas/SasPortalOperation' - parameters: [] - /v1alpha1/customers/{customersId}/devices/{devicesId}: + 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_31 - get: - description: Gets details about a device. - operationId: sasportal.customers.devices.get + post: + description: Signs a device. + operationId: sasportal.deployments.devices.signDevice + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalSignDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2336,10 +2264,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: customersId + name: deploymentsId required: true schema: type: string @@ -2348,9 +2276,16 @@ paths: required: true schema: type: string - delete: - description: Deletes a device. - operationId: sasportal.customers.devices.delete + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:updateSigned: + parameters: *ref_31 + 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 @@ -2366,10 +2301,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: deploymentsId required: true schema: type: string @@ -2378,9 +2313,38 @@ paths: required: true schema: type: string + /v1alpha1/deployments/{deploymentsId}: + parameters: *ref_31 + get: + description: Returns a requested deployment. + operationId: 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/nodes/{nodesId}/devices/{devicesId}: + parameters: *ref_31 patch: description: Updates a device. - operationId: sasportal.customers.devices.patch + operationId: sasportal.nodes.devices.patch requestBody: content: application/json: @@ -2404,7 +2368,7 @@ paths: $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string @@ -2418,11 +2382,9 @@ paths: schema: type: string format: google-fieldmask - /v1alpha1/customers/{customersId}/devices: - parameters: *ref_31 - get: - description: Lists devices under a node or customer. - operationId: sasportal.customers.devices.list + delete: + description: Deletes a device. + operationId: sasportal.nodes.devices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2438,34 +2400,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: customersId + 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: devicesId + required: true schema: type: string - post: - description: Creates a device under a node or customer. - operationId: sasportal.customers.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 @@ -2484,15 +2433,20 @@ paths: $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - /v1alpha1/customers/{customersId}/devices/{devicesId}:updateSigned: + - in: path + name: devicesId + required: true + schema: + type: string + /v1alpha1/nodes/{nodesId}/devices/{devicesId}:updateSigned: parameters: *ref_31 patch: description: Updates a signed device. - operationId: sasportal.customers.devices.updateSigned + operationId: sasportal.nodes.devices.updateSigned requestBody: content: application/json: @@ -2516,7 +2470,7 @@ paths: $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string @@ -2525,16 +2479,11 @@ paths: required: true schema: type: string - /v1alpha1/customers/{customersId}/devices:createSigned: + /v1alpha1/nodes/{nodesId}/devices: parameters: *ref_31 - 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' + get: + description: Lists devices under a node or customer. + operationId: sasportal.nodes.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2550,23 +2499,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 - /v1alpha1/customers/{customersId}/devices/{devicesId}:move: - parameters: *ref_31 + - 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: Moves a device under another node or customer. - operationId: sasportal.customers.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 @@ -2582,23 +2542,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: devicesId + name: nodesId required: true schema: type: string - /v1alpha1/customers/{customersId}/devices/{devicesId}:signDevice: + /v1alpha1/nodes/{nodesId}/devices/{devicesId}:signDevice: parameters: *ref_31 post: description: Signs a device. - operationId: sasportal.customers.devices.signDevice + operationId: sasportal.nodes.devices.signDevice requestBody: content: application/json: @@ -2622,7 +2577,7 @@ paths: $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string @@ -2631,16 +2586,16 @@ paths: required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}: + /v1alpha1/nodes/{nodesId}/devices:createSigned: parameters: *ref_31 - patch: - description: Updates an existing node. - operationId: sasportal.customers.nodes.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/SasPortalNode' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2656,26 +2611,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDevice' parameters: - - in: path - name: customersId - required: true - schema: - type: string - in: path name: nodesId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: Returns a requested node. - operationId: sasportal.customers.nodes.get + /v1alpha1/nodes/{nodesId}/devices/{devicesId}:move: + parameters: *ref_31 + 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 @@ -2691,21 +2643,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path - name: customersId + name: nodesId 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 + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}:move: + parameters: *ref_31 + 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 @@ -2721,23 +2680,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: nodesId + name: nodesId1 required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes: + /v1alpha1/nodes/{nodesId}/nodes: parameters: *ref_31 post: description: Creates a new node. - operationId: sasportal.customers.nodes.create + operationId: sasportal.nodes.nodes.create requestBody: content: application/json: @@ -2761,13 +2720,13 @@ paths: $ref: '#/components/schemas/SasPortalNode' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string get: description: Lists nodes. - operationId: sasportal.customers.nodes.list + operationId: sasportal.nodes.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2786,33 +2745,28 @@ paths: $ref: '#/components/schemas/SasPortalListNodesResponse' parameters: - in: path - name: customersId + 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/customers/{customersId}/nodes/{nodesId}:move: + type: string + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}: parameters: *ref_31 - post: - description: Moves a node under another node or customer. - operationId: sasportal.customers.nodes.move - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalMoveNodeRequest' + delete: + description: Deletes a node. + operationId: sasportal.nodes.nodes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2828,23 +2782,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalEmpty' 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_31 get: - description: Lists nodes. - operationId: sasportal.customers.nodes.nodes.list + description: Returns a requested node. + operationId: sasportal.nodes.nodes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2860,34 +2812,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' + $ref: '#/components/schemas/SasPortalNode' 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: 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: sasportal.customers.nodes.nodes.create + patch: + description: Updates an existing node. + operationId: sasportal.nodes.nodes.patch requestBody: content: application/json: @@ -2910,64 +2849,26 @@ 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}/deployments: - parameters: *ref_31 - get: - description: Lists deployments. - operationId: sasportal.customers.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: customersId - required: true - schema: - type: string - in: path - name: nodesId + 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 + name: updateMask schema: type: string + format: google-fieldmask + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/deployments: + parameters: *ref_31 post: description: Creates a new deployment. - operationId: sasportal.customers.nodes.deployments.create + operationId: sasportal.nodes.nodes.deployments.create requestBody: content: application/json: @@ -2991,25 +2892,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}/devices:createSigned: - parameters: *ref_31 - 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' + get: + description: Lists deployments. + operationId: sasportal.nodes.nodes.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3025,28 +2919,41 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $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 - /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices: + - 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}/nodes/{nodesId1}/devices:createSigned: parameters: *ref_31 post: - description: Creates a device under a node or customer. - operationId: sasportal.customers.nodes.devices.create + 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 @@ -3065,18 +2972,20 @@ paths: $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - in: path - name: nodesId + name: nodesId1 required: true schema: type: string + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices: + parameters: *ref_31 get: description: Lists devices under a node or customer. - operationId: sasportal.customers.nodes.devices.list + operationId: sasportal.nodes.nodes.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3095,12 +3004,12 @@ paths: $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string - in: path - name: nodesId + name: nodesId1 required: true schema: type: string @@ -3117,11 +3026,46 @@ paths: name: pageToken schema: type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices: + 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 + 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: nodesId1 + required: true + schema: + type: string + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/nodes: parameters: *ref_31 get: - description: Lists devices under a node or customer. - operationId: sasportal.customers.deployments.devices.list + description: Lists nodes. + operationId: sasportal.nodes.nodes.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3137,23 +3081,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $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 - - in: query - name: pageSize - schema: - type: integer - format: int32 - in: query name: filter schema: @@ -3162,14 +3101,19 @@ paths: 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: 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 @@ -3185,23 +3129,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/customers/{customersId}/deployments/{deploymentsId}/devices:createSigned: + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices:createSigned: parameters: *ref_31 post: description: Creates a signed device under a node or customer. - operationId: sasportal.customers.deployments.devices.createSigned + operationId: sasportal.nodes.deployments.devices.createSigned requestBody: content: application/json: @@ -3225,7 +3169,7 @@ paths: $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string @@ -3234,11 +3178,16 @@ paths: required: true schema: type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}: + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices: parameters: *ref_31 - delete: - description: Deletes a deployment. - operationId: sasportal.customers.deployments.delete + 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' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3254,10 +3203,10 @@ 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 @@ -3266,14 +3215,9 @@ paths: 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' + get: + description: Lists devices under a node or customer. + operationId: sasportal.nodes.deployments.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3289,10 +3233,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string @@ -3302,13 +3246,28 @@ paths: schema: type: string - in: query - name: updateMask + name: filter schema: type: string - format: google-fieldmask - get: - description: Returns a requested deployment. - operationId: sasportal.customers.deployments.get + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}:move: + parameters: *ref_31 + post: + description: Moves a deployment under another node or customer. + operationId: sasportal.nodes.deployments.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3324,10 +3283,10 @@ 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 @@ -3336,11 +3295,11 @@ paths: required: true schema: type: string - /v1alpha1/customers/{customersId}/deployments: + /v1alpha1/nodes/{nodesId}/deployments: parameters: *ref_31 get: description: Lists deployments. - operationId: sasportal.customers.deployments.list + operationId: sasportal.nodes.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3359,7 +3318,7 @@ paths: $ref: '#/components/schemas/SasPortalListDeploymentsResponse' parameters: - in: path - name: customersId + name: nodesId required: true schema: type: string @@ -3376,14 +3335,11 @@ paths: name: pageToken schema: type: string - post: - description: Creates a new deployment. - operationId: sasportal.customers.deployments.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDeployment' + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}: + parameters: *ref_31 + delete: + description: Deletes a deployment. + operationId: sasportal.nodes.deployments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3399,23 +3355,26 @@ 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 - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}:move: - parameters: *ref_31 - post: - description: Moves a deployment under another node or customer. - operationId: sasportal.customers.deployments.move + - in: path + name: deploymentsId + required: true + schema: + type: string + patch: + description: Updates an existing deployment. + operationId: sasportal.nodes.deployments.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3431,10 +3390,10 @@ 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 @@ -3443,11 +3402,14 @@ paths: required: true schema: type: string - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}: - parameters: *ref_31 - delete: - description: Deletes a device. - operationId: sasportal.deployments.devices.delete + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: Returns a requested deployment. + operationId: sasportal.nodes.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3463,21 +3425,23 @@ 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/nodes/{nodesId}: + parameters: *ref_31 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 @@ -3493,26 +3457,23 @@ 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 - patch: - description: Updates a device. - operationId: sasportal.deployments.devices.patch + /v1alpha1/installer:validate: + parameters: *ref_31 + post: + description: Validates the identity of a Certified Professional Installer (CPI). + operationId: sasportal.installer.validate requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalValidateInstallerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3527,34 +3488,19 @@ paths: 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 - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:move: + schema: + $ref: '#/components/schemas/SasPortalValidateInstallerResponse' + parameters: [] + /v1alpha1/installer:generateSecret: parameters: *ref_31 post: - description: Moves a device under another node or customer. - operationId: sasportal.deployments.devices.move + description: Generates a secret to be used with the ValidateInstaller. + operationId: sasportal.installer.generateSecret requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeviceRequest' + $ref: '#/components/schemas/SasPortalGenerateSecretRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3570,28 +3516,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}/devices/{devicesId}:updateSigned: + $ref: '#/components/schemas/SasPortalGenerateSecretResponse' + parameters: [] + /v1alpha1/customers/{customersId}: parameters: *ref_31 - patch: - description: Updates a signed device. - operationId: sasportal.deployments.devices.updateSigned - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' + get: + description: Returns a requested customer. + operationId: sasportal.customers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3607,28 +3538,21 @@ 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 - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:signDevice: - parameters: *ref_31 - post: - description: Signs a device. - operationId: sasportal.deployments.devices.signDevice + patch: + description: Updates an existing customer. + operationId: sasportal.customers.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalSignDeviceRequest' + $ref: '#/components/schemas/SasPortalCustomer' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3644,23 +3568,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalCustomer' parameters: - in: path - name: deploymentsId + name: customersId required: true schema: type: string - - in: path - name: devicesId - required: true + - in: query + name: updateMask schema: type: string - /v1alpha1/deployments/{deploymentsId}: + format: google-fieldmask + /v1alpha1/customers:listGcpProjectDeployments: parameters: *ref_31 get: - description: Returns a requested deployment. - operationId: sasportal.deployments.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 @@ -3676,23 +3602,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' - parameters: - - in: path - name: deploymentsId - required: true - schema: - type: string - /v1alpha1/installer:validate: + $ref: >- + #/components/schemas/SasPortalListGcpProjectDeploymentsResponse + parameters: [] + /v1alpha1/customers:migrateOrganization: parameters: *ref_31 post: - description: Validates the identity of a Certified Professional Installer (CPI). - operationId: sasportal.installer.validate + 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/SasPortalValidateInstallerRequest' + $ref: '#/components/schemas/SasPortalMigrateOrganizationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3708,18 +3634,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalValidateInstallerResponse' + $ref: '#/components/schemas/SasPortalOperation' parameters: [] - /v1alpha1/installer:generateSecret: + /v1alpha1/customers: parameters: *ref_31 - 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 list of requested customers. + operationId: sasportal.customers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3735,13 +3656,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalGenerateSecretResponse' - parameters: [] - /v1alpha1/nodes/{nodesId}: + $ref: '#/components/schemas/SasPortalListCustomersResponse' + parameters: + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1alpha1/customers:listLegacyOrganizations: parameters: *ref_31 get: - description: Returns a requested node. - operationId: sasportal.nodes.get + description: Returns a list of legacy organizations. + operationId: sasportal.customers.listLegacyOrganizations security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3757,18 +3687,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' - parameters: - - in: path - name: nodesId - required: true - schema: - type: string - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices: + $ref: '#/components/schemas/SasPortalListLegacyOrganizationsResponse' + parameters: [] + /v1alpha1/customers:provisionDeployment: parameters: *ref_31 - get: - description: Lists devices under a node or customer. - operationId: sasportal.nodes.deployments.devices.list + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalProvisionDeploymentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3784,39 +3716,21 @@ paths: 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: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string + $ref: '#/components/schemas/SasPortalProvisionDeploymentResponse' + parameters: [] + /v1alpha1/customers:setupSasAnalytics: + parameters: *ref_31 post: - description: Creates a device under a node or customer. - operationId: sasportal.nodes.deployments.devices.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: sasportal.customers.setupSasAnalytics requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalSetupSasAnalyticsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3832,28 +3746,18 @@ paths: 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: + $ref: '#/components/schemas/SasPortalOperation' + parameters: [] + /v1alpha1/customers/{customersId}/nodes/{nodesId}: parameters: *ref_31 - post: - description: Creates a signed device under a node or customer. - operationId: sasportal.nodes.deployments.devices.createSigned + patch: + description: Updates an existing node. + operationId: sasportal.customers.nodes.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3869,23 +3773,26 @@ 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: deploymentsId + name: nodesId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/deployments: - parameters: *ref_31 + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask get: - description: Lists deployments. - operationId: sasportal.nodes.deployments.list + description: Returns a requested node. + operationId: sasportal.customers.nodes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3901,31 +3808,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDeploymentsResponse' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path - name: nodesId + 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/nodes/{nodesId}/deployments/{deploymentsId}: - parameters: *ref_31 delete: - description: Deletes a deployment. - operationId: sasportal.nodes.deployments.delete + description: Deletes a node. + operationId: sasportal.customers.nodes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3944,23 +3841,25 @@ paths: $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: deploymentsId + name: nodesId required: true schema: type: string - patch: - description: Updates an existing deployment. - operationId: sasportal.nodes.deployments.patch + /v1alpha1/customers/{customersId}/nodes/{nodesId}:move: + parameters: *ref_31 + post: + description: Moves a node under another node or customer. + operationId: sasportal.customers.nodes.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalMoveNodeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3976,26 +3875,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: deploymentsId + name: nodesId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: Returns a requested deployment. - operationId: sasportal.nodes.deployments.get + /v1alpha1/customers/{customersId}/nodes: + parameters: *ref_31 + post: + description: Creates a new node. + operationId: sasportal.customers.nodes.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4011,28 +3912,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path - name: nodesId - required: true - schema: - type: string - - in: path - name: deploymentsId + name: customersId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}:move: - parameters: *ref_31 - 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: Lists nodes. + operationId: sasportal.customers.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4048,23 +3937,31 @@ 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: deploymentsId - required: true + - in: query + name: pageToken schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices: + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1alpha1/customers/{customersId}/nodes/{nodesId}/deployments: parameters: *ref_31 get: - description: Lists devices under a node or customer. - operationId: sasportal.nodes.nodes.devices.list + description: Lists deployments. + operationId: sasportal.customers.nodes.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4080,15 +3977,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: path - name: nodesId1 + name: nodesId required: true schema: type: string @@ -4106,13 +4003,13 @@ paths: schema: type: string post: - description: Creates a device under a node or customer. - operationId: sasportal.nodes.nodes.devices.create + description: Creates a new deployment. + operationId: sasportal.customers.nodes.deployments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4128,28 +4025,28 @@ 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 - in: path - name: nodesId1 + name: nodesId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices:createSigned: + /v1alpha1/customers/{customersId}/nodes/{nodesId}/nodes: parameters: *ref_31 post: - description: Creates a signed device under a node or customer. - operationId: sasportal.nodes.nodes.devices.createSigned + description: Creates a new node. + operationId: sasportal.customers.nodes.nodes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4165,23 +4062,21 @@ 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}/nodes: - parameters: *ref_31 get: description: Lists nodes. - operationId: sasportal.nodes.nodes.nodes.list + operationId: sasportal.customers.nodes.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4200,12 +4095,12 @@ paths: $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 @@ -4215,21 +4110,23 @@ paths: type: integer format: int32 - in: query - name: filter + name: pageToken schema: type: string - in: query - name: pageToken + name: filter schema: type: string + /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices: + parameters: *ref_31 post: - description: Creates a new node. - operationId: sasportal.nodes.nodes.nodes.create + description: Creates a device under a node or customer. + operationId: sasportal.customers.nodes.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4245,28 +4142,71 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $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 + 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: customersId + required: true + schema: + type: string - in: path - name: nodesId1 + name: nodesId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/deployments: + - 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: parameters: *ref_31 post: - description: Creates a new deployment. - operationId: sasportal.nodes.nodes.deployments.create + description: Creates a signed device under a node or customer. + operationId: sasportal.customers.nodes.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4282,21 +4222,23 @@ 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: nodesId1 + name: nodesId required: true schema: type: string + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}: + parameters: *ref_31 get: - description: Lists deployments. - operationId: sasportal.nodes.nodes.deployments.list + description: Returns a requested deployment. + operationId: sasportal.customers.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4312,41 +4254,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDeploymentsResponse' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path - name: nodesId + name: customersId required: true 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: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}:move: - parameters: *ref_31 - post: - description: Moves a node under another node or customer. - operationId: sasportal.nodes.nodes.move + patch: + description: Updates an existing deployment. + operationId: sasportal.customers.deployments.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveNodeRequest' + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4362,23 +4289,26 @@ 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: deploymentsId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}: - parameters: *ref_31 - get: - description: Returns a requested node. - operationId: sasportal.nodes.nodes.get + - 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 @@ -4394,21 +4324,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - in: path - name: nodesId1 + name: deploymentsId required: true schema: type: string - delete: - description: Deletes a node. - operationId: sasportal.nodes.nodes.delete + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}:move: + parameters: *ref_31 + post: + description: Moves a deployment under another node or customer. + operationId: sasportal.customers.deployments.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4424,26 +4361,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path - name: nodesId + name: customersId required: true 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/customers/{customersId}/deployments: + parameters: *ref_31 + post: + description: Creates a new deployment. + operationId: 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 @@ -4459,28 +4398,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path - name: nodesId - required: true - schema: - type: string - - in: path - name: nodesId1 + name: customersId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1alpha1/nodes/{nodesId}/nodes: - parameters: *ref_31 get: - description: Lists nodes. - operationId: sasportal.nodes.nodes.list + description: Lists deployments. + operationId: sasportal.customers.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4496,10 +4423,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string @@ -4509,21 +4436,23 @@ paths: type: integer format: int32 - in: query - name: filter + name: pageToken schema: type: string - in: query - name: pageToken + name: filter schema: type: string + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices:createSigned: + parameters: *ref_31 post: - description: Creates a new node. - operationId: sasportal.nodes.nodes.create + description: Creates a signed device under a node or customer. + operationId: 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 @@ -4539,18 +4468,66 @@ 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 - /v1alpha1/nodes/{nodesId}/devices/{devicesId}: + - in: path + name: deploymentsId + required: true + schema: + type: string + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices: parameters: *ref_31 - patch: - description: Updates a device. - operationId: sasportal.nodes.devices.patch + get: + description: Lists devices under a node or customer. + operationId: sasportal.customers.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: customersId + 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: sasportal.customers.deployments.devices.create requestBody: content: application/json: @@ -4574,23 +4551,20 @@ 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 - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask + /v1alpha1/customers/{customersId}/devices/{devicesId}: + parameters: *ref_31 delete: description: Deletes a device. - operationId: sasportal.nodes.devices.delete + operationId: sasportal.customers.devices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4609,7 +4583,7 @@ paths: $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string @@ -4620,7 +4594,7 @@ paths: type: string get: description: Gets details about a device. - operationId: sasportal.nodes.devices.get + operationId: sasportal.customers.devices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4639,7 +4613,7 @@ paths: $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string @@ -4648,16 +4622,14 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}:move: - parameters: *ref_31 - post: - description: Moves a device under another node or customer. - operationId: sasportal.nodes.devices.move + patch: + description: Updates a device. + operationId: sasportal.customers.devices.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeviceRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4673,10 +4645,10 @@ 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 @@ -4685,16 +4657,21 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1alpha1/customers/{customersId}/devices:createSigned: parameters: *ref_31 post: - description: Creates a device under a node or customer. - operationId: sasportal.nodes.devices.create + description: Creates a signed device under a node or customer. + operationId: sasportal.customers.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,13 +4690,15 @@ paths: $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string + /v1alpha1/customers/{customersId}/devices: + parameters: *ref_31 get: description: Lists devices under a node or customer. - operationId: sasportal.nodes.devices.list + operationId: sasportal.customers.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4738,33 +4717,31 @@ paths: $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path - name: nodesId + name: customersId 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: filter + name: pageSize schema: - type: string - /v1alpha1/nodes/{nodesId}/devices:createSigned: - parameters: *ref_31 + type: integer + format: int32 post: - description: Creates a signed device under a node or customer. - operationId: sasportal.nodes.devices.createSigned + description: Creates a device under a node or customer. + operationId: sasportal.customers.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4783,20 +4760,20 @@ paths: $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}:signDevice: + /v1alpha1/customers/{customersId}/devices/{devicesId}:move: parameters: *ref_31 post: - description: Signs a device. - operationId: sasportal.nodes.devices.signDevice + description: Moves a device under another node or customer. + operationId: sasportal.customers.devices.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalSignDeviceRequest' + $ref: '#/components/schemas/SasPortalMoveDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4812,10 +4789,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path - name: nodesId + name: customersId required: true schema: type: string @@ -4824,11 +4801,11 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}:updateSigned: + /v1alpha1/customers/{customersId}/devices/{devicesId}:updateSigned: parameters: *ref_31 patch: description: Updates a signed device. - operationId: sasportal.nodes.devices.updateSigned + operationId: sasportal.customers.devices.updateSigned requestBody: content: application/json: @@ -4852,7 +4829,44 @@ paths: $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: nodesId + name: customersId + required: true + schema: + type: string + - in: path + name: devicesId + required: true + schema: + type: string + /v1alpha1/customers/{customersId}/devices/{devicesId}:signDevice: + parameters: *ref_31 + post: + description: Signs a device. + operationId: sasportal.customers.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: customersId 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 c985e1a3..e3fda3f5 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: '20240527' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/secret-manager/ servers: @@ -1011,7 +1011,7 @@ components: - '2' x-stackQL-resources: locations: - id: secretmanager.locations + id: google.secretmanager.locations name: locations title: Locations methods: @@ -1033,13 +1033,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] secrets: - id: secretmanager.secrets + id: google.secretmanager.secrets name: secrets title: Secrets methods: @@ -1079,19 +1079,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/secrets/methods/list' - $ref: '#/components/x-stackQL-resources/secrets/methods/get' - $ref: '#/components/x-stackQL-resources/secrets/methods/list' - $ref: '#/components/x-stackQL-resources/secrets/methods/get' + - $ref: '#/components/x-stackQL-resources/secrets/methods/list' insert: - $ref: '#/components/x-stackQL-resources/secrets/methods/create' - $ref: '#/components/x-stackQL-resources/secrets/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/secrets/methods/patch' + - $ref: '#/components/x-stackQL-resources/secrets/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/secrets/methods/delete' - $ref: '#/components/x-stackQL-resources/secrets/methods/delete' secrets_version: - id: secretmanager.secrets_version + id: google.secretmanager.secrets_version name: secrets_version title: Secrets_version methods: @@ -1108,7 +1110,7 @@ components: update: [] delete: [] secrets_iam_policies: - id: secretmanager.secrets_iam_policies + id: google.secretmanager.secrets_iam_policies name: secrets_iam_policies title: Secrets_iam_policies methods: @@ -1147,7 +1149,7 @@ components: update: [] delete: [] versions: - id: secretmanager.versions + id: google.secretmanager.versions name: versions title: Versions methods: @@ -1199,10 +1201,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/versions/methods/list' - $ref: '#/components/x-stackQL-resources/versions/methods/get' - $ref: '#/components/x-stackQL-resources/versions/methods/list' - $ref: '#/components/x-stackQL-resources/versions/methods/get' + - $ref: '#/components/x-stackQL-resources/versions/methods/list' insert: [] update: [] delete: [] 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 1cdeef80..8c86bd3d 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/securitycenter.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/securitycenter.yaml @@ -10,7 +10,7 @@ info: findings within an organization. version: v1 x-discovery-doc-revision: '20240527' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/security-command-center servers: @@ -8701,7 +8701,7 @@ components: - '2' x-stackQL-resources: findings: - id: securitycenter.findings + id: google.securitycenter.findings name: findings title: Findings methods: @@ -8859,10 +8859,16 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/findings/methods/organizations_sources_findings_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/findings/methods/folders_sources_findings_patch + - $ref: >- + #/components/x-stackQL-resources/findings/methods/projects_sources_findings_patch + - $ref: >- + #/components/x-stackQL-resources/findings/methods/organizations_sources_findings_patch delete: [] security_health_analytics_modules: - id: securitycenter.security_health_analytics_modules + id: google.securitycenter.security_health_analytics_modules name: security_health_analytics_modules title: Security_health_analytics_modules methods: @@ -8964,18 +8970,18 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/security_health_analytics_modules/methods/folders_security_health_analytics_settings_custom_modules_list - $ref: >- #/components/x-stackQL-resources/security_health_analytics_modules/methods/folders_security_health_analytics_settings_custom_modules_get - - $ref: >- - #/components/x-stackQL-resources/security_health_analytics_modules/methods/projects_security_health_analytics_settings_custom_modules_list - $ref: >- #/components/x-stackQL-resources/security_health_analytics_modules/methods/projects_security_health_analytics_settings_custom_modules_get - - $ref: >- - #/components/x-stackQL-resources/security_health_analytics_modules/methods/organizations_security_health_analytics_settings_custom_modules_list - $ref: >- #/components/x-stackQL-resources/security_health_analytics_modules/methods/organizations_security_health_analytics_settings_custom_modules_get + - $ref: >- + #/components/x-stackQL-resources/security_health_analytics_modules/methods/folders_security_health_analytics_settings_custom_modules_list + - $ref: >- + #/components/x-stackQL-resources/security_health_analytics_modules/methods/projects_security_health_analytics_settings_custom_modules_list + - $ref: >- + #/components/x-stackQL-resources/security_health_analytics_modules/methods/organizations_security_health_analytics_settings_custom_modules_list insert: - $ref: >- #/components/x-stackQL-resources/security_health_analytics_modules/methods/folders_security_health_analytics_settings_custom_modules_create @@ -8992,7 +8998,7 @@ components: - $ref: >- #/components/x-stackQL-resources/security_health_analytics_modules/methods/organizations_security_health_analytics_settings_custom_modules_delete custom_modules: - id: securitycenter.custom_modules + id: google.securitycenter.custom_modules name: custom_modules title: Custom_modules methods: @@ -9089,10 +9095,22 @@ components: - $ref: >- #/components/x-stackQL-resources/custom_modules/methods/organizations_event_threat_detection_settings_custom_modules_get insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/custom_modules/methods/folders_security_health_analytics_settings_custom_modules_patch + - $ref: >- + #/components/x-stackQL-resources/custom_modules/methods/folders_event_threat_detection_settings_custom_modules_patch + - $ref: >- + #/components/x-stackQL-resources/custom_modules/methods/projects_security_health_analytics_settings_custom_modules_patch + - $ref: >- + #/components/x-stackQL-resources/custom_modules/methods/projects_event_threat_detection_settings_custom_modules_patch + - $ref: >- + #/components/x-stackQL-resources/custom_modules/methods/organizations_security_health_analytics_settings_custom_modules_patch + - $ref: >- + #/components/x-stackQL-resources/custom_modules/methods/organizations_event_threat_detection_settings_custom_modules_patch delete: [] custom_modules_descendant: - id: securitycenter.custom_modules_descendant + id: google.securitycenter.custom_modules_descendant name: custom_modules_descendant title: Custom_modules_descendant methods: @@ -9180,7 +9198,7 @@ components: update: [] delete: [] effective_custom_modules: - id: securitycenter.effective_custom_modules + id: google.securitycenter.effective_custom_modules name: effective_custom_modules title: Effective_custom_modules methods: @@ -9296,33 +9314,33 @@ components: select: - $ref: >- #/components/x-stackQL-resources/effective_custom_modules/methods/folders_security_health_analytics_settings_effective_custom_modules_get - - $ref: >- - #/components/x-stackQL-resources/effective_custom_modules/methods/folders_security_health_analytics_settings_effective_custom_modules_list - $ref: >- #/components/x-stackQL-resources/effective_custom_modules/methods/folders_event_threat_detection_settings_effective_custom_modules_get - - $ref: >- - #/components/x-stackQL-resources/effective_custom_modules/methods/folders_event_threat_detection_settings_effective_custom_modules_list - $ref: >- #/components/x-stackQL-resources/effective_custom_modules/methods/projects_security_health_analytics_settings_effective_custom_modules_get - - $ref: >- - #/components/x-stackQL-resources/effective_custom_modules/methods/projects_security_health_analytics_settings_effective_custom_modules_list - $ref: >- #/components/x-stackQL-resources/effective_custom_modules/methods/projects_event_threat_detection_settings_effective_custom_modules_get - - $ref: >- - #/components/x-stackQL-resources/effective_custom_modules/methods/projects_event_threat_detection_settings_effective_custom_modules_list - $ref: >- #/components/x-stackQL-resources/effective_custom_modules/methods/organizations_security_health_analytics_settings_effective_custom_modules_get - - $ref: >- - #/components/x-stackQL-resources/effective_custom_modules/methods/organizations_security_health_analytics_settings_effective_custom_modules_list - $ref: >- #/components/x-stackQL-resources/effective_custom_modules/methods/organizations_event_threat_detection_settings_effective_custom_modules_get + - $ref: >- + #/components/x-stackQL-resources/effective_custom_modules/methods/folders_security_health_analytics_settings_effective_custom_modules_list + - $ref: >- + #/components/x-stackQL-resources/effective_custom_modules/methods/folders_event_threat_detection_settings_effective_custom_modules_list + - $ref: >- + #/components/x-stackQL-resources/effective_custom_modules/methods/projects_security_health_analytics_settings_effective_custom_modules_list + - $ref: >- + #/components/x-stackQL-resources/effective_custom_modules/methods/projects_event_threat_detection_settings_effective_custom_modules_list + - $ref: >- + #/components/x-stackQL-resources/effective_custom_modules/methods/organizations_security_health_analytics_settings_effective_custom_modules_list - $ref: >- #/components/x-stackQL-resources/effective_custom_modules/methods/organizations_event_threat_detection_settings_effective_custom_modules_list insert: [] update: [] delete: [] mute_configs: - id: securitycenter.mute_configs + id: google.securitycenter.mute_configs name: mute_configs title: Mute_configs methods: @@ -9557,58 +9575,70 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/mute_configs/methods/folders_mute_configs_list + #/components/x-stackQL-resources/mute_configs/methods/folders_locations_mute_configs_get - $ref: >- - #/components/x-stackQL-resources/mute_configs/methods/folders_mute_configs_get + #/components/x-stackQL-resources/mute_configs/methods/projects_locations_mute_configs_get - $ref: >- - #/components/x-stackQL-resources/mute_configs/methods/folders_locations_mute_configs_list + #/components/x-stackQL-resources/mute_configs/methods/organizations_locations_mute_configs_get - $ref: >- - #/components/x-stackQL-resources/mute_configs/methods/folders_locations_mute_configs_get + #/components/x-stackQL-resources/mute_configs/methods/folders_mute_configs_get - $ref: >- - #/components/x-stackQL-resources/mute_configs/methods/projects_mute_configs_list + #/components/x-stackQL-resources/mute_configs/methods/folders_locations_mute_configs_list - $ref: >- #/components/x-stackQL-resources/mute_configs/methods/projects_mute_configs_get - $ref: >- #/components/x-stackQL-resources/mute_configs/methods/projects_locations_mute_configs_list - - $ref: >- - #/components/x-stackQL-resources/mute_configs/methods/projects_locations_mute_configs_get - - $ref: >- - #/components/x-stackQL-resources/mute_configs/methods/organizations_mute_configs_list - $ref: >- #/components/x-stackQL-resources/mute_configs/methods/organizations_mute_configs_get - $ref: >- #/components/x-stackQL-resources/mute_configs/methods/organizations_locations_mute_configs_list - $ref: >- - #/components/x-stackQL-resources/mute_configs/methods/organizations_locations_mute_configs_get - insert: + #/components/x-stackQL-resources/mute_configs/methods/folders_mute_configs_list - $ref: >- - #/components/x-stackQL-resources/mute_configs/methods/folders_mute_configs_create + #/components/x-stackQL-resources/mute_configs/methods/projects_mute_configs_list - $ref: >- - #/components/x-stackQL-resources/mute_configs/methods/folders_locations_mute_configs_create + #/components/x-stackQL-resources/mute_configs/methods/organizations_mute_configs_list + insert: - $ref: >- - #/components/x-stackQL-resources/mute_configs/methods/projects_mute_configs_create + #/components/x-stackQL-resources/mute_configs/methods/folders_locations_mute_configs_create - $ref: >- #/components/x-stackQL-resources/mute_configs/methods/projects_locations_mute_configs_create + - $ref: >- + #/components/x-stackQL-resources/mute_configs/methods/organizations_locations_mute_configs_create + - $ref: >- + #/components/x-stackQL-resources/mute_configs/methods/folders_mute_configs_create + - $ref: >- + #/components/x-stackQL-resources/mute_configs/methods/projects_mute_configs_create - $ref: >- #/components/x-stackQL-resources/mute_configs/methods/organizations_mute_configs_create + update: - $ref: >- - #/components/x-stackQL-resources/mute_configs/methods/organizations_locations_mute_configs_create - update: [] - delete: + #/components/x-stackQL-resources/mute_configs/methods/folders_locations_mute_configs_patch - $ref: >- - #/components/x-stackQL-resources/mute_configs/methods/folders_mute_configs_delete + #/components/x-stackQL-resources/mute_configs/methods/projects_locations_mute_configs_patch - $ref: >- - #/components/x-stackQL-resources/mute_configs/methods/folders_locations_mute_configs_delete + #/components/x-stackQL-resources/mute_configs/methods/organizations_locations_mute_configs_patch - $ref: >- - #/components/x-stackQL-resources/mute_configs/methods/projects_mute_configs_delete + #/components/x-stackQL-resources/mute_configs/methods/folders_mute_configs_patch - $ref: >- - #/components/x-stackQL-resources/mute_configs/methods/projects_locations_mute_configs_delete + #/components/x-stackQL-resources/mute_configs/methods/projects_mute_configs_patch - $ref: >- - #/components/x-stackQL-resources/mute_configs/methods/organizations_mute_configs_delete + #/components/x-stackQL-resources/mute_configs/methods/organizations_mute_configs_patch + delete: + - $ref: >- + #/components/x-stackQL-resources/mute_configs/methods/folders_locations_mute_configs_delete + - $ref: >- + #/components/x-stackQL-resources/mute_configs/methods/projects_locations_mute_configs_delete - $ref: >- #/components/x-stackQL-resources/mute_configs/methods/organizations_locations_mute_configs_delete + - $ref: >- + #/components/x-stackQL-resources/mute_configs/methods/folders_mute_configs_delete + - $ref: >- + #/components/x-stackQL-resources/mute_configs/methods/projects_mute_configs_delete + - $ref: >- + #/components/x-stackQL-resources/mute_configs/methods/organizations_mute_configs_delete notification_configs: - id: securitycenter.notification_configs + id: google.securitycenter.notification_configs name: notification_configs title: Notification_configs methods: @@ -9727,18 +9757,18 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/notification_configs/methods/folders_notification_configs_list - $ref: >- #/components/x-stackQL-resources/notification_configs/methods/folders_notification_configs_get - - $ref: >- - #/components/x-stackQL-resources/notification_configs/methods/projects_notification_configs_list - $ref: >- #/components/x-stackQL-resources/notification_configs/methods/projects_notification_configs_get - - $ref: >- - #/components/x-stackQL-resources/notification_configs/methods/organizations_notification_configs_list - $ref: >- #/components/x-stackQL-resources/notification_configs/methods/organizations_notification_configs_get + - $ref: >- + #/components/x-stackQL-resources/notification_configs/methods/folders_notification_configs_list + - $ref: >- + #/components/x-stackQL-resources/notification_configs/methods/projects_notification_configs_list + - $ref: >- + #/components/x-stackQL-resources/notification_configs/methods/organizations_notification_configs_list insert: - $ref: >- #/components/x-stackQL-resources/notification_configs/methods/folders_notification_configs_create @@ -9746,7 +9776,13 @@ components: #/components/x-stackQL-resources/notification_configs/methods/projects_notification_configs_create - $ref: >- #/components/x-stackQL-resources/notification_configs/methods/organizations_notification_configs_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/notification_configs/methods/folders_notification_configs_patch + - $ref: >- + #/components/x-stackQL-resources/notification_configs/methods/projects_notification_configs_patch + - $ref: >- + #/components/x-stackQL-resources/notification_configs/methods/organizations_notification_configs_patch delete: - $ref: >- #/components/x-stackQL-resources/notification_configs/methods/folders_notification_configs_delete @@ -9755,7 +9791,7 @@ components: - $ref: >- #/components/x-stackQL-resources/notification_configs/methods/organizations_notification_configs_delete big_query_exports: - id: securitycenter.big_query_exports + id: google.securitycenter.big_query_exports name: big_query_exports title: Big_query_exports methods: @@ -9876,14 +9912,14 @@ components: select: - $ref: >- #/components/x-stackQL-resources/big_query_exports/methods/folders_big_query_exports_get - - $ref: >- - #/components/x-stackQL-resources/big_query_exports/methods/folders_big_query_exports_list - $ref: >- #/components/x-stackQL-resources/big_query_exports/methods/projects_big_query_exports_get - - $ref: >- - #/components/x-stackQL-resources/big_query_exports/methods/projects_big_query_exports_list - $ref: >- #/components/x-stackQL-resources/big_query_exports/methods/organizations_big_query_exports_get + - $ref: >- + #/components/x-stackQL-resources/big_query_exports/methods/folders_big_query_exports_list + - $ref: >- + #/components/x-stackQL-resources/big_query_exports/methods/projects_big_query_exports_list - $ref: >- #/components/x-stackQL-resources/big_query_exports/methods/organizations_big_query_exports_list insert: @@ -9893,7 +9929,13 @@ components: #/components/x-stackQL-resources/big_query_exports/methods/projects_big_query_exports_create - $ref: >- #/components/x-stackQL-resources/big_query_exports/methods/organizations_big_query_exports_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/big_query_exports/methods/folders_big_query_exports_patch + - $ref: >- + #/components/x-stackQL-resources/big_query_exports/methods/projects_big_query_exports_patch + - $ref: >- + #/components/x-stackQL-resources/big_query_exports/methods/organizations_big_query_exports_patch delete: - $ref: >- #/components/x-stackQL-resources/big_query_exports/methods/folders_big_query_exports_delete @@ -9902,7 +9944,7 @@ components: - $ref: >- #/components/x-stackQL-resources/big_query_exports/methods/organizations_big_query_exports_delete assets: - id: securitycenter.assets + id: google.securitycenter.assets name: assets title: Assets methods: @@ -9973,7 +10015,7 @@ components: update: [] delete: [] assets_security_marks: - id: securitycenter.assets_security_marks + id: google.securitycenter.assets_security_marks name: assets_security_marks title: Assets_security_marks methods: @@ -10004,7 +10046,7 @@ components: update: [] delete: [] sources: - id: securitycenter.sources + id: google.securitycenter.sources name: sources title: Sources methods: @@ -10060,21 +10102,23 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: >- + #/components/x-stackQL-resources/sources/methods/organizations_sources_get - $ref: >- #/components/x-stackQL-resources/sources/methods/folders_sources_list - $ref: >- #/components/x-stackQL-resources/sources/methods/projects_sources_list - $ref: >- #/components/x-stackQL-resources/sources/methods/organizations_sources_list - - $ref: >- - #/components/x-stackQL-resources/sources/methods/organizations_sources_get insert: - $ref: >- #/components/x-stackQL-resources/sources/methods/organizations_sources_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/sources/methods/organizations_sources_patch delete: [] findings_security_marks: - id: securitycenter.findings_security_marks + id: google.securitycenter.findings_security_marks name: findings_security_marks title: Findings_security_marks methods: @@ -10105,7 +10149,7 @@ components: update: [] delete: [] external_systems: - id: securitycenter.external_systems + id: google.securitycenter.external_systems name: external_systems title: External_systems methods: @@ -10133,10 +10177,16 @@ components: sqlVerbs: select: [] insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/external_systems/methods/folders_sources_findings_external_systems_patch + - $ref: >- + #/components/x-stackQL-resources/external_systems/methods/projects_sources_findings_external_systems_patch + - $ref: >- + #/components/x-stackQL-resources/external_systems/methods/organizations_sources_findings_external_systems_patch delete: [] event_threat_detection_settings: - id: securitycenter.event_threat_detection_settings + id: google.securitycenter.event_threat_detection_settings name: event_threat_detection_settings title: Event_threat_detection_settings methods: @@ -10167,7 +10217,7 @@ components: update: [] delete: [] event_threat_detection_modules: - id: securitycenter.event_threat_detection_modules + id: google.securitycenter.event_threat_detection_modules name: event_threat_detection_modules title: Event_threat_detection_modules methods: @@ -10270,7 +10320,7 @@ components: - $ref: >- #/components/x-stackQL-resources/event_threat_detection_modules/methods/organizations_event_threat_detection_settings_custom_modules_delete organization_settings: - id: securitycenter.organization_settings + id: google.securitycenter.organization_settings name: organization_settings title: Organization_settings methods: @@ -10296,7 +10346,7 @@ components: update: [] delete: [] operations: - id: securitycenter.operations + id: google.securitycenter.operations name: operations title: Operations methods: @@ -10333,17 +10383,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/operations/methods/organizations_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/organizations_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/organizations_operations_list insert: [] update: [] delete: - $ref: >- #/components/x-stackQL-resources/operations/methods/organizations_operations_delete sources_iam_policies: - id: securitycenter.sources_iam_policies + id: google.securitycenter.sources_iam_policies name: sources_iam_policies title: Sources_iam_policies methods: @@ -10380,7 +10430,7 @@ components: update: [] delete: [] simulations: - id: securitycenter.simulations + id: google.securitycenter.simulations name: simulations title: Simulations methods: @@ -10399,7 +10449,7 @@ components: update: [] delete: [] valued_resources: - id: securitycenter.valued_resources + id: google.securitycenter.valued_resources name: valued_resources title: Valued_resources methods: @@ -10436,15 +10486,15 @@ components: select: - $ref: >- #/components/x-stackQL-resources/valued_resources/methods/organizations_simulations_valued_resources_get - - $ref: >- - #/components/x-stackQL-resources/valued_resources/methods/organizations_simulations_valued_resources_list - $ref: >- #/components/x-stackQL-resources/valued_resources/methods/organizations_simulations_attack_exposure_results_valued_resources_list + - $ref: >- + #/components/x-stackQL-resources/valued_resources/methods/organizations_simulations_valued_resources_list insert: [] update: [] delete: [] attack_paths: - id: securitycenter.attack_paths + id: google.securitycenter.attack_paths name: attack_paths title: Attack_paths methods: @@ -10493,7 +10543,7 @@ components: update: [] delete: [] resource_value_configs: - id: securitycenter.resource_value_configs + id: google.securitycenter.resource_value_configs name: resource_value_configs title: Resource_value_configs methods: @@ -10543,7 +10593,9 @@ components: - $ref: >- #/components/x-stackQL-resources/resource_value_configs/methods/organizations_resource_value_configs_list insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/resource_value_configs/methods/organizations_resource_value_configs_patch delete: - $ref: >- #/components/x-stackQL-resources/resource_value_configs/methods/organizations_resource_value_configs_delete 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 56355e14..6fa1bd59 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: '20240520' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/service-consumer-management/docs/overview servers: @@ -34,435 +34,385 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - V1Beta1ImportProducerOverridesResponse: - description: Response message for ImportProducerOverrides - properties: - overrides: - type: array - description: The overrides that were created from the imported data. - items: - $ref: '#/components/schemas/V1Beta1QuotaOverride' - id: V1Beta1ImportProducerOverridesResponse - type: object - LongRunning: + SystemParameter: 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)). + 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: - 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: + httpHeader: description: >- - Maximum time between two subsequent poll requests. Default value: 45 - seconds. - type: string - format: google-duration - totalPollTimeout: - format: google-duration - description: 'Total polling timeout. Default value: 5 minutes.' + Define the HTTP header name to use for the parameter. It is case + insensitive. type: string - initialPollDelay: + urlQueryParameter: type: string - format: google-duration description: >- - Initial delay after which the first poll request will be made. - Default value: 5 seconds. - type: object - id: LongRunning - PolicyBinding: - id: PolicyBinding - description: Translates to IAM Policy bindings (without auditing at this level) - properties: - members: + Define the URL query parameter name to use for the parameter. It is + case sensitive. + name: 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: - type: string - type: array - role: + Define the name of the parameter, such as "api_key" . It is case + sensitive. type: string - description: >- - Role. (https://cloud.google.com/iam/docs/understanding-roles) For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. type: object - CppSettings: + id: SystemParameter + SourceInfo: + id: SourceInfo + description: Source information used to create a Service Config properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. + sourceFiles: + items: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: array + description: All files used during config generation. type: object - id: CppSettings - description: Settings for C++ client libraries. CancelOperationRequest: + description: The request message for Operations.CancelOperation. type: object properties: {} - description: The request message for Operations.CancelOperation. id: CancelOperationRequest - V1Beta1BatchCreateProducerOverridesResponse: + ListOperationsResponse: type: object - id: V1Beta1BatchCreateProducerOverridesResponse - description: Response message for BatchCreateProducerOverrides + description: The response message for Operations.ListOperations. properties: - overrides: + nextPageToken: + description: The standard List next-page token. + type: string + operations: + items: + $ref: '#/components/schemas/Operation' + type: array + description: >- + A list of operations that matches the specified filter in the + request. + id: ListOperationsResponse + 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: type: array - description: The overrides that were created. items: - $ref: '#/components/schemas/V1Beta1QuotaOverride' - SourceContext: + $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. + type: object + AuthenticationRule: properties: - fileName: + requirements: + description: Requirements for additional authentication providers. + type: array + items: + $ref: '#/components/schemas/AuthRequirement' + oauth: + $ref: '#/components/schemas/OAuthRequirements' + description: The requirements for OAuth credentials. + allowWithoutCredential: + type: boolean + description: >- + If true, the service accepts API keys without any other credential. + This flag only applies to HTTP and gRPC requests. + selector: 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 + Selects the methods to which this rule applies. Refer to selector + for syntax details. + id: AuthenticationRule + type: object description: >- - `SourceContext` represents information about the source of a protobuf - element, like the file in which it is defined. + 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. + MethodSettings: + id: MethodSettings type: object - V1Beta1QuotaOverride: properties: - adminOverrideAncestor: + selector: 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. - metric: - description: >- - The name of the metric to which this override applies. An example - name would be: `compute.googleapis.com/cpus` - type: string - name: + 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: >- - 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` - type: string - dimensions: - additionalProperties: + 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 - 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 - unit: + longRunning: 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 - description: A quota override - id: V1Beta1QuotaOverride + 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. + V1Beta1RefreshConsumerResponse: type: object - Publishing: + id: V1Beta1RefreshConsumerResponse + 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. + CustomErrorRule: + description: A custom error rule. + id: CustomErrorRule type: object - id: Publishing properties: - documentationUri: + selector: type: string description: >- - Link to product home page. Example: - https://cloud.google.com/asset-inventory/docs/overview - newIssueUri: - type: string + Selects messages to which this rule applies. Refer to selector for + syntax details. + isErrorType: + type: boolean description: >- - Link to a *public* URI where users can report issues. Example: - https://issuetracker.google.com/issues/new?component=190865&template=1161103 - methodSettings: + Mark this message as possible payload in error response. Otherwise, + objects of this type will be filtered when they appear in error + payload. + Quota: + properties: + limits: + description: List of QuotaLimit definitions for the service. 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. + $ref: '#/components/schemas/QuotaLimit' type: array - 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". - librarySettings: + metricRules: items: - $ref: '#/components/schemas/ClientLibrarySettings' + $ref: '#/components/schemas/MetricRule' 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 - codeownerGithubTeams: + List of MetricRule definitions, each one mapping a selected method + to one or more metrics. type: array - description: >- - GitHub teams to be added to CODEOWNERS in the directory in GitHub - containing source code for the client libraries for this API. + 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 + V1Beta1ImportProducerOverridesResponse: + properties: + overrides: items: - type: string - restReferenceDocumentationUri: - description: >- - Optional link to REST reference documentation. Example: - https://cloud.google.com/pubsub/lite/docs/reference/rest + $ref: '#/components/schemas/V1Beta1QuotaOverride' + type: array + description: The overrides that were created from the imported data. + description: Response message for ImportProducerOverrides + id: V1Beta1ImportProducerOverridesResponse + type: object + GoSettings: + type: object + id: GoSettings + properties: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + description: Settings for Go client libraries. + FieldPolicy: + id: FieldPolicy + properties: + selector: type: string - githubLabel: description: >- - GitHub label to apply to issues and pull requests opened for this - API. - type: string - 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 - protoReferenceDocumentationUri: + 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: >- - Optional link to proto reference documentation. Example: - https://cloud.google.com/pubsub/lite/docs/reference/rpc - docTagPrefix: + Specifies the resource type for the resource referred to by the + field. + resourcePermission: description: >- - A prefix used in sample code when demarking regions to be included - in documentation. + 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 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. - QuotaLimit: + 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 + TenancyUnit: + id: TenancyUnit type: object + description: Representation of a tenancy unit. properties: - 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. - 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. - maxLimit: + name: 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 - description: - type: string + Globally unique identifier of this tenancy unit + "services/{service}/{collection id}/{resource + id}/tenancyUnits/{unit}" + service: 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: - format: int64 + Output only. Google Cloud API name of the managed service owning + this tenancy unit. For example + 'serviceconsumermanagement.googleapis.com'. type: string + readOnly: true + consumer: + readOnly: true 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. - 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 - defaultLimit: + Output only. @OutputOnly Cloud resource name of the consumer of this + service. For example 'projects/123456'. type: string - format: int64 - 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. - values: - type: object - additionalProperties: - format: int64 - type: string + tenantResources: + items: + $ref: '#/components/schemas/TenantResource' 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: + Resources constituting the tenancy unit. There can be at most 512 + tenant resources in a tenancy unit. + type: array + createTime: type: string + readOnly: true + format: google-datetime + description: Output only. @OutputOnly The time this tenancy unit was created. + ApplyTenantProjectConfigRequest: + description: Request to apply configuration to an existing tenant project. + type: object + id: ApplyTenantProjectConfigRequest + properties: + projectConfig: + description: Configuration that should be applied to the existing tenant project. + $ref: '#/components/schemas/TenantProjectConfig' + tag: description: >- - Duration of this limit in textual notation. Must be "100s" or "1d". - Used by group-based quotas only. - name: + Required. Tag of the project. Must be less than 128 characters. + Required. 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. - id: QuotaLimit + SystemParameters: 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`. - DocumentationRule: - id: DocumentationRule - description: A documentation rule provides information about individual API elements. + ### 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: - 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 - deprecationDescription: - type: string - description: >- - Deprecation description of the selected element(s). It can be - provided if an element is marked as `deprecated`. - 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. - type: string - AttachTenantProjectRequest: - type: object - description: >- - Request to attach an existing project to the tenancy unit as a new - tenant resource. - properties: - tag: - type: string - description: >- - Required. Tag of the tenant resource after attachment. Must be less - than 128 characters. Required. - externalResource: - type: string - description: >- - When attaching an external project, this is in the format of - `projects/{project_number}`. - reservedResource: - type: string - 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. - id: AttachTenantProjectRequest - 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. - ServiceAccountConfig: - id: ServiceAccountConfig - properties: - accountId: - type: string - 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])`. - tenantProjectRoles: - description: Roles for the associated service account for the tenant project. + rules: items: - type: string + $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 - description: Describes the service account configuration for the tenant project. - type: object - PythonSettings: - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - id: PythonSettings - description: Settings for Python client libraries. + ClientLibrarySettings: type: object - MetricDescriptorMetadata: + description: Details about how and where to publish client libraries. + id: ClientLibrarySettings properties: - 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. - ingestDelay: + goSettings: + description: Settings for Go client libraries. + $ref: '#/components/schemas/GoSettings' + pythonSettings: + description: Settings for Python client libraries. + $ref: '#/components/schemas/PythonSettings' + dotnetSettings: + description: Settings for .NET client libraries. + $ref: '#/components/schemas/DotnetSettings' + rubySettings: + description: Settings for Ruby client libraries. + $ref: '#/components/schemas/RubySettings' + 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. + restNumericEnums: 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 + When using transport=rest, the client request will encode enums as + numbers rather than strings. + type: boolean + version: 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". + nodeSettings: + $ref: '#/components/schemas/NodeSettings' + description: Settings for Node client libraries. + cppSettings: + description: Settings for C++ client libraries. + $ref: '#/components/schemas/CppSettings' launchStage: - deprecated: true - description: Deprecated. Must use the MetricDescriptor.launch_stage instead. - type: string + description: Launch stage of this version of the API. enum: - LAUNCH_STAGE_UNSPECIFIED - UNIMPLEMENTED @@ -510,885 +460,884 @@ 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. - id: MetricDescriptorMetadata - description: Additional annotations that can be used to guide the usage of a metric. - type: object - TenancyUnit: - properties: - name: - type: string - description: >- - Globally unique identifier of this tenancy unit - "services/{service}/{collection id}/{resource - id}/tenancyUnits/{unit}" - createTime: - type: string - readOnly: true - description: Output only. @OutputOnly The time this tenancy unit was created. - format: google-datetime - 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 - 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'. - consumer: - type: string - readOnly: true - description: >- - Output only. @OutputOnly Cloud resource name of the consumer of this - service. For example 'projects/123456'. - description: Representation of a tenancy unit. - id: TenancyUnit - type: object - CustomHttpPattern: - description: A custom pattern is used for defining custom HTTP verb. - 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. - MetricRule: + UsageRule: properties: - metricCosts: - type: object - 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. 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: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - id: MetricRule + 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: >- + 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 + id: UsageRule + HttpRule: + id: HttpRule 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. - JavaSettings: - description: Settings for Java client libraries. - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - serviceClassNames: - type: object - additionalProperties: - type: string + # 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 | gRPC -----|----- `GET + /v1/messages/123456` | `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 + | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` + | `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 | + gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | + `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 | gRPC + -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | + `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 | gRPC -----|----- `GET /v1/messages/123456` | + `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` | + `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. Example: + http: rules: # Selects a gRPC method and applies HttpRule to it. - + 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 + properties: + patch: + type: string + description: Maps to HTTP PATCH. Used for updating a resource. + delete: + type: string + description: Maps to HTTP DELETE. Used for deleting a resource. + body: + 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 - libraryPackage: + 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. + get: + 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 + 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. + additionalBindings: + items: + $ref: '#/components/schemas/HttpRule' + 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). + selector: type: string - id: JavaSettings - type: object - 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. - id: SystemParameters + description: >- + Selects a method to which this rule applies. Refer to selector for + syntax details. + put: + type: string + description: Maps to HTTP PUT. Used for replacing a resource. + 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 + post: + type: string + description: >- + Maps to HTTP POST. Used for creating a resource or performing an + action. + MethodPolicy: + id: MethodPolicy type: object + description: Defines policies applying to an RPC method. properties: - rules: + selector: 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. + 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: type: array + description: Policies that are applicable to the request message. items: - $ref: '#/components/schemas/SystemParameterRule' - V1Beta1ServiceIdentity: - id: V1Beta1ServiceIdentity + $ref: '#/components/schemas/FieldPolicy' + V1AddVisibilityLabelsResponse: + type: object + id: V1AddVisibilityLabelsResponse properties: - name: + labels: + type: array description: >- - P4 service identity resource name. An example name would be: - `services/serviceconsumermanagement.googleapis.com/projects/123/serviceIdentities/default` - type: string - uniqueId: + The updated set of visibility labels for this consumer on this + service. + items: + type: string + 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. + 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: + name: type: string - description: The unique and stable id of the service identity. - tag: + description: The canonical name of this endpoint. + allowCors: 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 - email: + 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 + 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 - description: The email address of the service identity. - description: A service identity in the Identity and Access Management API. + aliases: + items: + 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. + type: array type: object - V1Beta1ImportProducerQuotaPoliciesResponse: - description: Response message for ImportProducerQuotaPolicies + id: Endpoint + AuthRequirement: type: object - id: V1Beta1ImportProducerQuotaPoliciesResponse properties: - policies: - description: The policies that were created from the imported data. - items: - $ref: '#/components/schemas/V1Beta1ProducerQuotaPolicy' - type: array - ClientLibrarySettings: + 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 + description: >- + User-defined authentication requirements, including support for [JSON + Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + V1GenerateDefaultIdentityResponse: properties: - restNumericEnums: + identity: + $ref: '#/components/schemas/V1DefaultIdentity' + description: DefaultIdentity that was created or retrieved. + role: + type: string description: >- - 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. - launchStage: - description: Launch stage of this version of the API. + Role attached to consumer project. Empty if not attached in this + request. (Under development, currently always return empty.) + attachStatus: + description: >- + Status of the role attachment. Under development + (go/si-attach-role), currently always return + ATTACH_STATUS_UNSPECIFIED) 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. + - Indicates that the AttachStatus was not set. - >- - 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 default identity was attached to a role successfully in this + request. - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. + The request specified that no attempt should be made to attach the + role. - >- - 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 - phpSettings: - $ref: '#/components/schemas/PhpSettings' - description: Settings for PHP client libraries. - cppSettings: - $ref: '#/components/schemas/CppSettings' - description: Settings for C++ client libraries. - version: + 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) 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". - dotnetSettings: - $ref: '#/components/schemas/DotnetSettings' - description: Settings for .NET client libraries. - javaSettings: - $ref: '#/components/schemas/JavaSettings' - description: Settings for legacy Java features, supported in the Service YAML. - nodeSettings: - $ref: '#/components/schemas/NodeSettings' - description: Settings for Node client libraries. - rubySettings: - description: Settings for Ruby client libraries. - $ref: '#/components/schemas/RubySettings' - pythonSettings: - $ref: '#/components/schemas/PythonSettings' - description: Settings for Python client libraries. - type: object - description: Details about how and where to publish client libraries. - id: ClientLibrarySettings - Status: + enum: + - ATTACH_STATUS_UNSPECIFIED + - ATTACHED + - ATTACH_SKIPPED + - PREVIOUSLY_ATTACHED + - ATTACH_DENIED_BY_ORG_POLICY + id: V1GenerateDefaultIdentityResponse 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). + Response message for the `GenerateDefaultIdentity` method. This response + message is assigned to the `response` field of the returned Operation + when that operation is done. + Operation: properties: - message: + metadata: 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. + 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: type: string - code: - type: integer - format: int32 - description: The status code, which should be an enum value of google.rpc.Code. - 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. - id: Status - V1Beta1EnableConsumerResponse: - id: V1Beta1EnableConsumerResponse + 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/Status' + 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: + 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 + `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`. + id: Operation type: object - properties: {} 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. - DeleteTenantProjectRequest: + This resource represents a long-running operation that is the result of + a network API call. + PhpSettings: + type: object + description: Settings for Php client libraries. + id: PhpSettings properties: - tag: - type: string - description: Required. Tag of the resource within the tenancy unit. - description: Request message to delete tenant project resource from the tenancy unit. - id: DeleteTenantProjectRequest + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + ContextRule: type: object - CustomError: + description: >- + A context rule provides information about the context for an individual + API element. properties: - rules: - type: array + allowedResponseExtensions: description: >- - The list of custom error rules that apply to individual API - messages. **NOTE:** All service configuration rules follow "last one - wins" order. + 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/CustomErrorRule' - types: + type: string + provided: + description: A list of full type names of provided contexts. items: type: string type: array + requested: + description: A list of full type names of requested contexts. + items: + type: string + type: array + allowedRequestExtensions: + type: array description: >- - The list of custom error detail types, e.g. - 'google.foo.v1.CustomError'. - id: 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 - AuthenticationRule: - id: AuthenticationRule - type: object - properties: + A list of full type names or extension IDs of extensions allowed in + grpc side channel from client to backend. + items: + type: string selector: - type: string description: >- Selects the methods to which this rule applies. Refer to selector for syntax details. - allowWithoutCredential: - type: boolean + type: string + id: ContextRule + Backend: + type: object + properties: + rules: + type: array description: >- - If true, the service accepts API keys without any other credential. - This flag only applies to HTTP and gRPC requests. - requirements: + 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/AuthRequirement' - description: Requirements for additional authentication providers. - type: array - oauth: - $ref: '#/components/schemas/OAuthRequirements' - description: The requirements for OAuth credentials. - 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. - SystemParameterRule: - id: SystemParameterRule - type: object + $ref: '#/components/schemas/BackendRule' + description: '`Backend` defines the backend configuration for a service.' + id: Backend + BillingDestination: properties: - selector: + metrics: + items: + type: string + type: array description: >- - Selects the methods to which this rule applies. Use '*' to indicate - all methods in all APIs. Refer to selector for syntax details. + Names of the metrics to report to this billing destination. Each + name must be defined in Service.metrics section. + monitoredResource: type: string - parameters: - type: array - 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. - description: >- - Define a system parameter rule mapping system parameter definitions to - methods. - V1RefreshConsumerResponse: - properties: {} + The monitored resource type. The type must be defined in + Service.monitored_resources section. type: object - 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. - Enum: - properties: - sourceContext: - description: The source context. - $ref: '#/components/schemas/SourceContext' - syntax: - description: The source syntax. - type: string - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - name: + Configuration of a specific billing destination (Currently only support + bill against consumer project). + id: BillingDestination + Publishing: + 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. + properties: + newIssueUri: type: string - description: Enum type name. - edition: + 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 description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. - options: - description: Protocol buffer options. + Optional link to REST reference documentation. Example: + https://cloud.google.com/pubsub/lite/docs/reference/rest + documentationUri: + description: >- + Link to product home page. Example: + https://cloud.google.com/asset-inventory/docs/overview + type: string + librarySettings: type: array items: - $ref: '#/components/schemas/Option' - enumvalue: + $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. + protoReferenceDocumentationUri: + type: string + description: >- + Optional link to proto reference documentation. Example: + https://cloud.google.com/pubsub/lite/docs/reference/rpc + 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. + type: array + githubLabel: + type: string + description: >- + GitHub label to apply to issues and pull requests opened for this + API. + methodSettings: type: array - description: Enum value definitions. items: - $ref: '#/components/schemas/EnumValue' - type: object - description: Enum type definition. - id: Enum - LabelDescriptor: - id: LabelDescriptor - properties: - description: + $ref: '#/components/schemas/MethodSettings' + description: >- + A list of API method settings, e.g. the behavior for methods that + use the long-running operation pattern. + apiShortName: type: string - description: A human-readable description for the label. - valueType: - enumDescriptions: - - A variable-length string. This is the default. - - Boolean; true or false. - - A 64-bit signed integer. + 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". + docTagPrefix: + description: >- + A prefix used in sample code when demarking regions to be included + in documentation. type: string + organization: enum: - - STRING - - BOOL - - INT64 - description: The type of data that can be assigned to the label. - key: + - CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED + - CLOUD + - ADS + - PHOTOS + - STREET_VIEW + - SHOPPING + - GEO + - GENERATIVE_AI type: string - description: The label key. - description: A description of a label. - type: object - Authentication: - id: 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 + 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 + V1Beta1ProducerQuotaPolicy: + id: V1Beta1ProducerQuotaPolicy properties: - providers: - type: array - description: Defines a set of authentication providers that a service supports. - items: - $ref: '#/components/schemas/AuthProvider' - rules: + metric: + type: string 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 - Mixin: - properties: - root: + The name of the metric to which this policy applies. An example name + would be: `compute.googleapis.com/cpus` + unit: type: string description: >- - If non-empty specifies a path under which inherited HTTP paths are - rooted. + 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. + policyValue: + format: int64 + description: >- + The quota policy value. Can be any nonnegative integer, or -1 + (unlimited quota). + type: string + container: + type: string + description: >- + The cloud resource container at which the quota policy is created. + The format is {container_type}/{container_number} + dimensions: + additionalProperties: + type: string + 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.' 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: The fully qualified name of the interface which is included. type: object - id: Mixin + description: Quota policy created by service producer. + V1EnableConsumerResponse: + type: object + properties: {} + id: V1EnableConsumerResponse 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"; } ... } - MetricDescriptor: - id: MetricDescriptor + Response message for the `EnableConsumer` method. This response message + is assigned to the `response` field of the returned Operation when that + operation is done. + CommonLanguageSettings: + description: Required information for every language. + id: CommonLanguageSettings properties: - valueType: - enum: - - VALUE_TYPE_UNSPECIFIED - - BOOL - - INT64 - - DOUBLE - - STRING - - DISTRIBUTION - - MONEY + destinations: + 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. 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 - 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: + The destination where API teams want this client library to be + published. + type: array + referenceDocsUri: 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"). - description: + Link to automatically generated reference documentation. Example: + https://cloud.google.com/nodejs/docs/reference/asset/latest + deprecated: true + type: object + BackendRule: + properties: + address: type: string description: >- - A detailed description of the metric, which can be used in - documentation. - type: + 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. + protocol: 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" - metadata: - $ref: '#/components/schemas/MetricDescriptorMetadata' - description: Optional. Metadata which can be used to guide usage of the metric. - monitoredResourceTypes: - 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. + operationDeadline: + type: number + format: double 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. - displayName: + The number of seconds to wait for the completion of a long running + operation. The default is no deadline. + selector: 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. - metricKind: + Selects the methods to which this rule applies. Refer to selector + for syntax details. + 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 - 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. + deadline: + type: number 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 - name: - description: The resource name of the metric descriptor. + 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 + pathTranslation: type: string - launchStage: - description: Optional. The launch stage of the metric definition. + enum: + - PATH_TRANSLATION_UNSPECIFIED + - CONSTANT_ADDRESS + - APPEND_PATH_TO_ADDRESS 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. + 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 - >- - 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 - labels: + 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: + type: object + additionalProperties: + $ref: '#/components/schemas/BackendRule' + description: The map between request protocol and the backend address. + minDeadline: + type: number + format: double + description: Deprecated, do not use. + deprecated: true + type: object + description: A backend rule provides configuration for an individual API element. + id: BackendRule + Type: + description: A protocol buffer message type. + properties: + fields: + type: array + items: + $ref: '#/components/schemas/Field' + description: The list of fields. + options: + description: The protocol buffer options. items: - $ref: '#/components/schemas/LabelDescriptor' - 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. + $ref: '#/components/schemas/Option' type: array - 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. - MonitoredResourceDescriptor: - id: MonitoredResourceDescriptor - properties: - 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 - 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: + sourceContext: + description: The source context. + $ref: '#/components/schemas/SourceContext' + oneofs: + type: array + items: + type: string + description: The list of types appearing in `oneof` definitions in this type. + edition: description: >- - Optional. A detailed description of the monitored resource type that - might be used in documentation. - type: string - launchStage: + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. type: string + syntax: + description: The source syntax. 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. + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + type: string enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - description: Optional. The launch stage of the monitored resource definition. - labels: - 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"`. - items: - $ref: '#/components/schemas/LabelDescriptor' - displayName: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + name: + description: The fully qualified message name. 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"`. - 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 - Billing: + id: Type + V1Beta1DisableConsumerResponse: + properties: {} + id: V1Beta1DisableConsumerResponse type: object - id: 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 - properties: - consumerDestinations: - 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. - items: - $ref: '#/components/schemas/BillingDestination' - BillingDestination: + Response message for the `DisableConsumer` method. This response message + is assigned to the `response` field of the returned Operation when that + operation is done. + Enum: type: object + id: Enum + description: Enum type definition. properties: - metrics: + enumvalue: + description: Enum value definitions. + items: + $ref: '#/components/schemas/EnumValue' + type: array + name: + description: Enum type name. + type: string + options: + description: Protocol buffer options. type: array - description: >- - Names of the metrics to report to this billing destination. Each - name must be defined in Service.metrics section. items: - type: string - monitoredResource: + $ref: '#/components/schemas/Option' + syntax: + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + description: The source syntax. + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + type: string + edition: description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. type: string - description: >- - Configuration of a specific billing destination (Currently only support - bill against consumer project). - id: BillingDestination + sourceContext: + description: The source context. + $ref: '#/components/schemas/SourceContext' CreateTenancyUnitRequest: + type: object description: >- Request to create a tenancy unit for a service consumer of a managed service. - type: object - id: CreateTenancyUnitRequest properties: tenancyUnitId: type: string @@ -1401,115 +1350,177 @@ components: service and service consumer pair, calling `CreateTenancyUnit` returns the existing tenancy unit if the provided identifier is identical or empty, otherwise the call fails. - MonitoringDestination: + id: CreateTenancyUnitRequest + Method: + type: object + id: Method + description: Method represents a method of an API interface. + properties: + responseTypeUrl: + description: The URL of the output message type. + type: string + requestStreaming: + type: boolean + description: If true, the request is streamed. + 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 + syntax: + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + type: string + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + description: The source syntax of this method. + name: + description: The simple name of this method. + type: string + requestTypeUrl: + type: string + description: A URL of the input message type. + Option: + id: Option + description: >- + A protocol buffer option, which can be attached to a message, field, + enumeration, etc. properties: - metrics: - type: array - items: - type: string + value: description: >- - Types of the metrics to report to this monitoring destination. Each - type must be defined in Service.metrics section. - monitoredResource: + 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 + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + name: description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. + 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: >- - Configuration of a specific monitoring destination (the producer project - or the consumer project). type: object - id: MonitoringDestination - V1Beta1ProducerQuotaPolicy: + Field: properties: - metric: + name: + description: The field name. type: string + typeUrl: description: >- - The name of the metric to which this policy applies. An example name - would be: `compute.googleapis.com/cpus` - container: + The field type URL, without the scheme, for message or enumeration + types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. type: string - description: >- - The cloud resource container at which the quota policy is created. - The format is {container_type}/{container_number} - unit: + cardinality: 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. - policyValue: - format: int64 - description: >- - The quota policy value. Can be any nonnegative integer, or -1 - (unlimited quota). + description: The field 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. + number: + type: integer + format: int32 + description: The field number. + packed: + description: Whether to use alternative packed wire representation. + type: boolean + 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. 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 - 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` + 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 + defaultValue: type: string - description: Quota policy created by service producer. - id: V1Beta1ProducerQuotaPolicy - type: object - MethodSettings: - 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 + The string value of the default value of this field. Proto2 syntax + only. + options: type: array 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... + $ref: '#/components/schemas/Option' + description: The protocol buffer options. + jsonName: type: string - longRunning: - $ref: '#/components/schemas/LongRunning' + description: The field JSON name. + oneofIndex: + format: int32 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 - id: MethodSettings - description: Describes the generator configuration for a method. + 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 type: object - SearchTenancyUnitsResponse: - description: Response for the search query. - id: SearchTenancyUnitsResponse + id: Field + description: A single field of a message type. + CppSettings: + description: Settings for C++ client libraries. + id: CppSettings properties: - nextPageToken: - type: string - description: Pagination token for large results. - tenancyUnits: - description: Tenancy Units matching the request. - items: - $ref: '#/components/schemas/TenancyUnit' - type: array + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' type: object DotnetSettings: - type: object + description: Settings for Dotnet client libraries. properties: ignoredResources: + type: array items: type: string description: >- @@ -1518,941 +1529,789 @@ components: handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location" - type: array common: $ref: '#/components/schemas/CommonLanguageSettings' description: Some settings. - renamedServices: + renamedResources: additionalProperties: type: string 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" + 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 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. - type: array items: type: string - renamedResources: - 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" - type: object + type: array forcedNamespaceAliases: description: >- Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision + type: array items: type: string - type: array id: DotnetSettings - description: Settings for Dotnet client libraries. - FieldPolicy: + type: object + BillingConfig: properties: - resourceType: + billingAccount: type: string description: >- - Specifies the resource type for the resource referred to by the - field. - selector: + Name of the billing account. For example + `billingAccounts/012345-567890-ABCDEF`. + id: BillingConfig + type: object + description: Describes the billing configuration for a new tenant project. + 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 + id: CustomError + properties: + types: + items: + type: string + type: array 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 - resourcePermission: - type: string + The list of custom error detail types, e.g. + 'google.foo.v1.CustomError'. + rules: + type: array + items: + $ref: '#/components/schemas/CustomErrorRule' 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". - id: FieldPolicy + The list of custom error rules that apply to individual API + messages. **NOTE:** All service configuration rules follow "last one + wins" order. + Logging: + id: Logging 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. - V1GenerateDefaultIdentityResponse: + 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: - role: + producerDestinations: + type: array + items: + $ref: '#/components/schemas/LoggingDestination' description: >- - Role attached to consumer project. Empty if not attached in this - request. (Under development, currently always return empty.) - type: string - 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) - type: string + 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' description: >- - Status of the role attachment. Under development - (go/si-attach-role), currently always return - ATTACH_STATUS_UNSPECIFIED) - enum: - - ATTACH_STATUS_UNSPECIFIED - - ATTACHED - - ATTACH_SKIPPED - - PREVIOUSLY_ATTACHED - - ATTACH_DENIED_BY_ORG_POLICY + 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 + V1DisableConsumerResponse: + properties: {} + type: object description: >- - Response message for the `GenerateDefaultIdentity` method. This response + Response message for the `DisableConsumer` method. This response message + is assigned to the `response` field of the returned Operation when that + operation is done. + id: V1DisableConsumerResponse + V1Beta1GenerateServiceIdentityResponse: + 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: V1GenerateDefaultIdentityResponse + properties: + identity: + description: ServiceIdentity that was created or retrieved. + $ref: '#/components/schemas/V1Beta1ServiceIdentity' + id: V1Beta1GenerateServiceIdentityResponse type: object - V1RemoveVisibilityLabelsResponse: + Control: 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. + Selects and configures the service controller used by the service. + Example: control: environment: servicecontrol.googleapis.com properties: - labels: - description: >- - The updated set of visibility labels for this consumer on this - service. + methodPolicies: items: - type: string + $ref: '#/components/schemas/MethodPolicy' type: array - id: V1RemoveVisibilityLabelsResponse - BackendRule: - type: object - id: BackendRule - description: A backend rule provides configuration for an individual API element. - 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 - 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. - 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 - minDeadline: - description: Deprecated, do not use. - type: number - deprecated: true - format: double - selector: + description: Defines policies applying to the API methods of the service. + environment: description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. + 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 - 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 - 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. + id: Control + SearchTenancyUnitsResponse: + id: SearchTenancyUnitsResponse + type: object + properties: + nextPageToken: + description: Pagination token for large results. type: string - deadline: - format: double - type: number + tenancyUnits: + description: Tenancy Units matching the request. + type: array + items: + $ref: '#/components/schemas/TenancyUnit' + description: Response for the search query. + TenantProjectPolicy: + description: >- + Describes policy settings that can be applied to a newly created tenant + project. + type: object + id: TenantProjectPolicy + properties: + policyBindings: description: >- - The number of seconds to wait for a response from a request. The - default varies based on the request protocol and deployment - environment. - operationDeadline: - format: double + 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 + JavaSettings: + description: Settings for Java client libraries. + properties: + serviceClassNames: description: >- - The number of seconds to wait for the completion of a long running - operation. The default is no deadline. - type: number - overridesByRequestProtocol: + 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: - $ref: '#/components/schemas/BackendRule' + type: string type: object - description: The map between request protocol and the backend address. - BillingConfig: - properties: - billingAccount: - type: string + libraryPackage: description: >- - Name of the billing account. For example - `billingAccounts/012345-567890-ABCDEF`. - type: object - id: BillingConfig - description: Describes the billing configuration for a new tenant project. - 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 + 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: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' type: object - id: Service + id: JavaSettings + Api: properties: - producerProjectId: - description: The Google project that owns this service. + syntax: + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + description: The source syntax of the service. + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS type: string - endpoints: - items: - $ref: '#/components/schemas/Endpoint' + name: 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. - type: array - billing: - $ref: '#/components/schemas/Billing' - description: Billing configuration. - context: - description: Context configuration. - $ref: '#/components/schemas/Context' - usage: - $ref: '#/components/schemas/Usage' - description: Configuration controlling usage of this service. - monitoring: - description: Monitoring configuration. - $ref: '#/components/schemas/Monitoring' - types: + The fully qualified name of this interface, including package name + followed by the interface's simple name. + type: string + 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' + description: Any metadata attached to the interface. type: array - sourceInfo: - $ref: '#/components/schemas/SourceInfo' - description: >- - Output only. The source information for this configuration if - available. - 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. + version: type: string - backend: - description: API backend configuration. - $ref: '#/components/schemas/Backend' - monitoredResources: - 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. - type: array - documentation: - $ref: '#/components/schemas/Documentation' - description: Additional API documentation. - control: - $ref: '#/components/schemas/Control' - description: Configuration for the service control plane. - enums: - type: array + 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: 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 - http: - $ref: '#/components/schemas/Http' - description: HTTP configuration. - customError: - $ref: '#/components/schemas/CustomError' - description: Custom error configuration. - logging: - $ref: '#/components/schemas/Logging' - description: Logging configuration. - quota: - $ref: '#/components/schemas/Quota' - description: Quota configuration. - metrics: + $ref: '#/components/schemas/Mixin' type: array - items: - $ref: '#/components/schemas/MetricDescriptor' - description: Defines the metrics used by this service. - apis: + description: Included interfaces. See Mixin. + methods: + description: The methods of this interface, in unspecified order. 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' + $ref: '#/components/schemas/Method' + sourceContext: + $ref: '#/components/schemas/SourceContext' description: >- - Settings for [Google Cloud Client - libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) - generated from APIs defined as protocol buffers. - name: + Source context for the protocol buffer service represented by this + message. + type: object + 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 + 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. + properties: + labels: 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. + The updated set of visibility labels for this consumer on this + service. + type: array + items: + type: string + id: V1RemoveVisibilityLabelsResponse + type: object + MonitoringDestination: + type: object + properties: + monitoredResource: 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: - $ref: '#/components/schemas/Type' + The monitored resource type. The type must be defined in + Service.monitored_resources section. + metrics: type: array - systemParameters: - description: System parameter configuration. - $ref: '#/components/schemas/SystemParameters' - 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`. - title: + Types of the metrics to report to this monitoring destination. Each + type must be defined in Service.metrics section. + items: + type: string + description: >- + Configuration of a specific monitoring destination (the producer project + or the consumer project). + id: MonitoringDestination + V1Beta1QuotaOverride: + type: object + description: A quota override + id: V1Beta1QuotaOverride + properties: + dimensions: + additionalProperties: + type: string + 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.' + 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. + overrideValue: + format: int64 + description: >- + The overriding quota limit value. Can be any nonnegative integer, or + -1 (unlimited quota). + type: string + adminOverrideAncestor: type: string description: >- - The product title for this service, it is the name displayed in - Google Cloud Console. - authentication: - $ref: '#/components/schemas/Authentication' - description: Auth configuration. - logs: - description: Defines the logs used by this service. - items: - $ref: '#/components/schemas/LogDescriptor' - type: array - ApplyTenantProjectConfigRequest: - properties: - tag: + The resource name of the ancestor that requested the override. For + example: "organizations/12345" or "folders/67890". Used by admin + overrides only. + name: type: string description: >- - Required. Tag of the project. Must be less than 128 characters. - Required. - projectConfig: - description: Configuration that should be applied to the existing tenant project. - $ref: '#/components/schemas/TenantProjectConfig' - id: ApplyTenantProjectConfigRequest - type: object - description: Request to apply configuration to an existing tenant project. - OAuthRequirements: - properties: - canonicalScopes: + 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 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 name of the metric to which this override applies. An example + name would be: `compute.googleapis.com/cpus` type: string + TenantResource: + id: TenantResource type: object - id: 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. - RubySettings: - type: object - description: Settings for Ruby client libraries. - id: RubySettings - properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - Field: - description: A single field of a message type. + description: Resource constituting the TenancyUnit. properties: - jsonName: + tag: type: string - description: The field JSON name. - packed: - type: boolean - description: Whether to use alternative packed wire representation. - options: - description: The protocol buffer options. - items: - $ref: '#/components/schemas/Option' - type: array - kind: + description: Unique per single tenancy unit. + status: + description: Status of tenant resource. 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 + - STATUS_UNSPECIFIED + - PENDING_CREATE + - ACTIVE + - PENDING_DELETE + - FAILED + - DELETED 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. - 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 - 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. - description: The field cardinality. + - 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. + resource: type: string - number: - format: int32 - description: The field number. - type: integer - defaultValue: + readOnly: true description: >- - The string value of the default value of this field. Proto2 syntax - only. + Output only. @OutputOnly Identifier of the tenant resource. For + cloud projects, it is in the form 'projects/{number}'. For example + 'projects/123456'. + V1ServiceAccount: + id: V1ServiceAccount + properties: + iamAccountName: + deprecated: true + type: string + description: Deprecated. See b/136209818. + tag: type: string - typeUrl: description: >- - The field type URL, without the scheme, for message or enumeration - types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + 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". + email: + type: string + description: The email address of the service account. + uniqueId: type: string + description: The unique and stable id of the service account. name: + description: >- + P4 SA resource name. An example name would be: + `services/serviceconsumermanagement.googleapis.com/projects/123/serviceAccounts/default` type: string - description: The field name. - id: Field - type: object - V1GenerateServiceAccountResponse: type: object + description: A service account in the Identity and Access Management API. + Page: 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 + Represents a documentation page. A page can contain subpages to + represent nested documentation set structure. + type: object properties: - account: - $ref: '#/components/schemas/V1ServiceAccount' - description: ServiceAccount that was created or retrieved. - V1EnableConsumerResponse: - id: V1EnableConsumerResponse + 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 + 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 + name: + 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`. + id: Page + 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. + properties: {} + type: object + V1Beta1EnableConsumerResponse: type: object - properties: {} + id: 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. - V1ServiceAccount: - description: A service account in the Identity and Access Management API. + properties: {} + Usage: properties: - iamAccountName: - deprecated: true - description: Deprecated. See b/136209818. - type: string - name: + rules: description: >- - P4 SA resource name. An example name would be: - `services/serviceconsumermanagement.googleapis.com/projects/123/serviceAccounts/default` - type: string - email: - type: string - description: The email address of the service account. - uniqueId: - type: string - description: The unique and stable id of the service account. - tag: + A list of usage rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + type: array + items: + $ref: '#/components/schemas/UsageRule' + requirements: + type: array 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". + 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 + 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 - id: V1ServiceAccount - type: object - NodeSettings: - description: Settings for Node client libraries. + description: Configuration controlling usage of a service. + id: Usage type: object + V1Beta1ImportProducerQuotaPoliciesResponse: + description: Response message for ImportProducerQuotaPolicies + id: V1Beta1ImportProducerQuotaPoliciesResponse properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - id: NodeSettings - ListOperationsResponse: - properties: - nextPageToken: - description: The standard List next-page token. - type: string - operations: - items: - $ref: '#/components/schemas/Operation' - description: >- - A list of operations that matches the specified filter in the - request. + policies: type: array - id: ListOperationsResponse + items: + $ref: '#/components/schemas/V1Beta1ProducerQuotaPolicy' + description: The policies that were created from the imported data. type: object - description: The response message for Operations.ListOperations. - Api: + 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: {} + 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. + 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 properties: - options: - type: array - items: - $ref: '#/components/schemas/Option' - description: Any metadata attached to the interface. - mixins: - items: - $ref: '#/components/schemas/Mixin' - type: array - description: Included interfaces. See Mixin. - 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 - methods: - description: The methods of this interface, in unspecified order. - type: array - items: - $ref: '#/components/schemas/Method' - sourceContext: - $ref: '#/components/schemas/SourceContext' + root: description: >- - Source context for the protocol buffer service represented by this - message. - syntax: - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - description: The source syntax of the service. + If non-empty specifies a path under which inherited HTTP paths are + rooted. type: string - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. name: - description: >- - The fully qualified name of this interface, including package name - followed by the interface's simple name. type: string - id: Api - AddTenantProjectRequest: - description: >- - Request to add a newly created and configured tenant project to a - tenancy unit. + description: The fully qualified name of the interface which is included. + id: Mixin + DeleteTenantProjectRequest: properties: - projectConfig: - description: >- - Configuration of the new tenant project to be added to tenancy unit - resources. - $ref: '#/components/schemas/TenantProjectConfig' tag: - description: >- - Required. Tag of the added project. Must be less than 128 - characters. Required. + description: Required. Tag of the resource within the tenancy unit. type: string - id: AddTenantProjectRequest type: object - LoggingDestination: - description: >- - Configuration of a specific logging destination (the producer project or - the consumer project). + id: DeleteTenantProjectRequest + description: Request message to delete tenant project resource from the tenancy unit. + ServiceAccountConfig: type: object properties: - monitoredResource: - type: string - description: >- - The monitored resource type. The type must be defined in the - Service.monitored_resources section. - logs: + tenantProjectRoles: + description: Roles for the associated service account for the tenant project. 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 - 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 + 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])`. + type: string + description: Describes the service account configuration for the tenant project. + id: ServiceAccountConfig + PolicyBinding: type: object - id: LogDescriptor + description: Translates to IAM Policy bindings (without auditing at this level) properties: - labels: + role: + type: string 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 + Role. (https://cloud.google.com/iam/docs/understanding-roles) For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. + members: items: - $ref: '#/components/schemas/LabelDescriptor' - name: + type: string + type: array 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 [/_-.]. + Uses the same format as in IAM policy. `member` must include both a + prefix and ID. For example, `user:{emailId}`, + `serviceAccount:{emailId}`, `group:{emailId}`. + id: PolicyBinding + CustomHttpPattern: + description: A custom pattern is used for defining custom HTTP verb. + properties: + kind: + description: The name of this custom HTTP verb. type: string - displayName: + path: + description: The path matched by this custom verb. type: string + type: object + id: CustomHttpPattern + OAuthRequirements: + id: OAuthRequirements + type: object + properties: + canonicalScopes: description: >- - 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. + 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 - 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 - id: Empty - EnumValue: - id: EnumValue + 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. + SourceContext: type: object - description: Enum value definition. properties: - number: - type: integer - description: Enum value number. - format: int32 - name: + fileName: type: string - description: Enum value name. - options: - description: Protocol buffer options. - items: - $ref: '#/components/schemas/Option' - type: array + 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. RemoveTenantProjectRequest: + description: >- + Request message to remove a tenant project resource from the tenancy + unit. id: RemoveTenantProjectRequest + type: object 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. + RubySettings: + id: RubySettings + description: Settings for Ruby client libraries. + properties: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. type: object - Quota: - id: Quota + LoggingDestination: + id: LoggingDestination properties: - metricRules: - description: >- - List of MetricRule definitions, each one mapping a selected method - to one or more metrics. + logs: type: array items: - $ref: '#/components/schemas/MetricRule' - 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 - type: object - AuthRequirement: - properties: - providerId: - type: string + type: string description: >- - id from authentication provider. Example: provider_id: - bookstore_auth - audiences: + 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: >- - 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 + The monitored resource type. The type must be defined in the + Service.monitored_resources section. type: string 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). - ListTenancyUnitsResponse: + Configuration of a specific logging destination (the producer project or + the consumer project). + Http: properties: - nextPageToken: - description: Pagination token for large results. - type: string - tenancyUnits: - items: - $ref: '#/components/schemas/TenancyUnit' + 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: + 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 - description: Tenancy units matching the request. - id: ListTenancyUnitsResponse - description: Response for the list request. + items: + $ref: '#/components/schemas/HttpRule' + id: Http type: object - V1Beta1DisableConsumerResponse: - 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. - id: V1Beta1DisableConsumerResponse + 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. + V1Beta1BatchCreateProducerOverridesResponse: + id: V1Beta1BatchCreateProducerOverridesResponse type: object - Type: - id: Type - description: A protocol buffer message type. properties: - fields: - items: - $ref: '#/components/schemas/Field' + overrides: + description: The overrides that were created. type: array - description: The list of fields. - edition: + items: + $ref: '#/components/schemas/V1Beta1QuotaOverride' + description: Response message for BatchCreateProducerOverrides + Billing: + type: object + id: 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 + properties: + consumerDestinations: + items: + $ref: '#/components/schemas/BillingDestination' description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. + 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 + DocumentationRule: + properties: + 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. + disableReplacementWords: type: string - sourceContext: - description: The source context. - $ref: '#/components/schemas/SourceContext' - syntax: - description: The source syntax. - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. + description: >- + String of comma or space separated case-sensitive words for which + method/field name replacement will be disabled by go/api-docgen. + deprecationDescription: + description: >- + Deprecation description of the selected element(s). It can be + provided if an element is marked as `deprecated`. type: string - options: - type: array - description: The protocol buffer options. - items: - $ref: '#/components/schemas/Option' - name: + description: type: string - description: The fully qualified message name. - oneofs: - items: - type: string - type: array - description: The list of types appearing in `oneof` definitions in this type. + 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. + id: DocumentationRule type: object Documentation: - type: object description: >- `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access @@ -2483,16 +2342,9 @@ components: 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 id: 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 overview: type: string description: >- @@ -2507,1094 +2359,1218 @@ components: 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' + documentationRootUrl: + type: string + description: The URL to the root of documentation. + sectionOverrides: type: array - pages: - description: The top level pages for the documentation set. items: $ref: '#/components/schemas/Page' - type: array - summary: + 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: 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`. - documentationRootUrl: - description: The URL to the root of documentation. type: string - serviceRootUrl: + pages: + type: array + items: + $ref: '#/components/schemas/Page' + description: The top level pages for the documentation set. + NodeSettings: + description: Settings for Node client libraries. + id: NodeSettings + type: object + properties: + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + Monitoring: + id: Monitoring + 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. + type: array + items: + $ref: '#/components/schemas/MonitoringDestination' + consumerDestinations: + 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. + 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 + 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. + properties: + account: + description: ServiceAccount that was created or retrieved. + $ref: '#/components/schemas/V1ServiceAccount' + type: object + id: V1GenerateServiceAccountResponse + JwtLocation: + description: Specifies a location to extract JWT from an API request. + properties: + cookie: type: string + description: Specifies cookie name to extract JWT token. + valuePrefix: 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. - AuthProvider: - id: AuthProvider + 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 + header: + description: Specifies HTTP header name to extract JWT token. + type: string + query: + description: Specifies URL query parameter name to extract JWT token. + type: string + type: object + id: JwtLocation + EnumValue: + type: object + properties: + name: + description: Enum value name. + type: string + options: + description: Protocol buffer options. + items: + $ref: '#/components/schemas/Option' + type: array + number: + description: Enum value number. + format: int32 + type: integer + id: EnumValue + description: Enum value definition. + TenantProjectConfig: + id: TenantProjectConfig + 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). + 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: + services: + 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 + items: + type: string + tenantProjectPolicy: + $ref: '#/components/schemas/TenantProjectPolicy' + description: Describes ownership and policies for the new tenant project. + serviceAccountConfig: + $ref: '#/components/schemas/ServiceAccountConfig' + description: Configuration for the IAM service account on the tenant project. + billingConfig: + description: Billing account properties. The billing account must be specified. + $ref: '#/components/schemas/BillingConfig' + labels: + description: Labels that are applied to this project. + additionalProperties: + type: string + 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`). + PythonSettings: + properties: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + id: PythonSettings + description: Settings for Python client libraries. type: object + LongRunning: + id: LongRunning properties: - 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). - 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 + initialPollDelay: + format: google-duration description: >- - Redirect URL if JWT token is required but not present or is expired. - Implement authorizationUrl of securityDefinitions in OpenAPI spec. - issuer: + Initial delay after which the first poll request will be made. + Default value: 5 seconds. type: string + maxPollDelay: 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 - id: - description: >- - The unique identifier of the auth provider. It will be referred to - by `AuthRequirement.provider_id`. Example: "bookstore_auth". + Maximum time between two subsequent poll requests. Default value: 45 + seconds. + format: google-duration type: string - jwtLocations: - type: array + pollDelayMultiplier: + format: float + type: number 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' - jwksUri: + Multiplier to gradually increase delay between subsequent polls + until it reaches max_poll_delay. Default value: 1.5. + totalPollTimeout: 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 - TenantProjectPolicy: + description: 'Total polling timeout. Default value: 5 minutes.' + 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)). type: object - id: TenantProjectPolicy + Authentication: description: >- - Describes policy settings that can be applied to a newly created tenant - project. + `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 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. + providers: + items: + $ref: '#/components/schemas/AuthProvider' type: array + description: Defines a set of authentication providers that a service supports. + rules: + description: >- + A list of authentication rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. items: - $ref: '#/components/schemas/PolicyBinding' - CommonLanguageSettings: - description: Required information for every language. - id: CommonLanguageSettings + $ref: '#/components/schemas/AuthenticationRule' + type: array + id: Authentication + SystemParameterRule: type: object + id: SystemParameterRule properties: - destinations: - description: >- - The destination where API teams want this client library to be - published. + parameters: 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. - type: string - enum: - - CLIENT_LIBRARY_DESTINATION_UNSPECIFIED - - GITHUB - - PACKAGE_MANAGER + $ref: '#/components/schemas/SystemParameter' type: array - referenceDocsUri: - type: string description: >- - Link to automatically generated reference documentation. Example: - https://cloud.google.com/nodejs/docs/reference/asset/latest - deprecated: true - 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: {} - Option: - id: Option - type: object - description: >- - A protocol buffer option, which can be attached to a message, field, - enumeration, etc. - properties: - value: - type: object + 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. + selector: 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: any - description: Properties of the object. Contains field @type with type URL. - name: + Selects the methods to which this rule applies. Use '*' to indicate + all methods in all APIs. Refer to selector for syntax details. 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"`. - 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. - id: V1DisableConsumerResponse - properties: {} - type: object - Method: - type: object - description: Method represents a method of an API interface. - id: Method + Define a system parameter rule mapping system parameter definitions to + methods. + ListTenancyUnitsResponse: + id: ListTenancyUnitsResponse + description: Response for the list request. properties: - requestTypeUrl: - description: A URL of the input message type. - type: string - requestStreaming: - description: If true, the request is streamed. - type: boolean - options: + tenancyUnits: items: - $ref: '#/components/schemas/Option' + $ref: '#/components/schemas/TenancyUnit' + description: Tenancy units matching the request. type: array - description: Any metadata attached to the method. - name: + nextPageToken: + description: Pagination token for large results. type: string - description: The simple name of this method. - syntax: - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - description: The source syntax of this method. + type: object + LabelDescriptor: + id: LabelDescriptor + description: A description of a label. + properties: + key: type: string - responseTypeUrl: + description: The label key. + description: type: string - description: The URL of the output message type. - responseStreaming: - type: boolean - description: If true, the response is streamed. - V1DefaultIdentity: - description: A default identity in the Identity and Access Management API. + description: A human-readable description for the label. + valueType: + enumDescriptions: + - 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: + - STRING + - BOOL + - INT64 type: object - id: V1DefaultIdentity + V1Beta1ServiceIdentity: + description: A service identity in the Identity and Access Management API. + type: object + id: V1Beta1ServiceIdentity properties: + name: + description: >- + P4 service identity resource name. An example name would be: + `services/serviceconsumermanagement.googleapis.com/projects/123/serviceIdentities/default` + type: string 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. + 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". email: - description: The email address of the default identity. type: string + description: The email address of the service identity. uniqueId: - description: The unique and stable id of the default identity. - type: string - name: - description: >- - Default identity resource name. An example name would be: - `services/serviceconsumermanagement.googleapis.com/projects/123/defaultIdentity` - type: string - Control: - id: Control - properties: - methodPolicies: - items: - $ref: '#/components/schemas/MethodPolicy' - description: Defines policies applying to the API methods of the service. - type: array - 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 - type: object - Operation: + description: The unique and stable id of the service identity. + AuthProvider: 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: - 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: - $ref: '#/components/schemas/Status' - description: >- - The error result of the operation in case of failure or - cancellation. - 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: + id: description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. + The unique identifier of the auth provider. It will be referred to + by `AuthRequirement.provider_id`. Example: "bookstore_auth". type: string - description: >- - This resource represents a long-running operation that is the result of - a network API call. - id: Operation - type: object - 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 | gRPC -----|----- `GET - /v1/messages/123456` | `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 - | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` - | `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 | - gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | - `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 | gRPC - -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | - `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 | gRPC -----|----- `GET /v1/messages/123456` | - `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` | - `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. Example: - http: rules: # Selects a gRPC method and applies HttpRule to it. - - 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 - id: HttpRule - properties: - 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). + jwtLocations: items: - $ref: '#/components/schemas/HttpRule' - selector: - type: string + $ref: '#/components/schemas/JwtLocation' description: >- - Selects a method to which this rule applies. Refer to selector for - syntax details. - get: + 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: description: >- - Maps to HTTP GET. Used for listing and getting information about - resources. - type: string - patch: + 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 - description: Maps to HTTP PATCH. Used for updating a resource. - put: - description: Maps to HTTP PUT. Used for replacing a resource. + authorizationUrl: type: string - 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 - post: + Redirect URL if JWT token is required but not present or is expired. + Implement authorizationUrl of securityDefinitions in OpenAPI spec. + audiences: 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. + 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 - responseBody: + jwksUri: 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. - 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' - UsageRule: - id: UsageRule + 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: AuthProvider + type: object 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 + 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: + type: object + id: MetricDescriptor properties: - allowUnregisteredCalls: + launchStage: + type: string + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - 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. + - >- + 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. + name: + type: string + description: The resource name of the metric descriptor. + displayName: + type: string description: >- - If true, the selected method allows unregistered calls, e.g. calls - that don't identify any user or application. - type: boolean - selector: + 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. + valueType: description: >- - Selects the methods to which this rule applies. Use '*' to indicate - all methods in all APIs. Refer to selector for syntax details. + 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 + 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. + type: string + unit: 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. - type: object - ContextRule: - type: object - description: >- - A context rule provides information about the context for an individual - API element. - id: ContextRule - properties: - allowedRequestExtensions: - items: - type: string - type: array + 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' + description: description: >- - A list of full type names or extension IDs of extensions allowed in - grpc side channel from client to backend. - allowedResponseExtensions: - items: - type: string + A detailed description of the metric, which can be used in + documentation. + type: string + metricKind: + enum: + - METRIC_KIND_UNSPECIFIED + - GAUGE + - DELTA + - CUMULATIVE + type: string + 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: >- - A list of full type names or extension IDs of extensions allowed in - grpc side channel from backend to client. - type: array - requested: + Whether the metric records instantaneous values, changes to a value, + etc. Some combinations of `metric_kind` and `value_type` might not + be supported. + 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: A list of full type names of requested contexts. - provided: - description: A list of full type names of provided contexts. - type: array - items: - type: string - selector: + type: type: string description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - SourceInfo: - properties: - sourceFiles: - description: All files used during config generation. + 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" + 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: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any + $ref: '#/components/schemas/LabelDescriptor' type: array - description: Source information used to create a Service Config + 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. + MonitoredResourceDescriptor: type: object - id: SourceInfo - V1AddVisibilityLabelsResponse: + 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: labels: type: array items: - type: string + $ref: '#/components/schemas/LabelDescriptor' description: >- - The updated set of visibility labels for this consumer on this - service. - 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. - type: object - id: V1AddVisibilityLabelsResponse - Endpoint: - id: Endpoint - type: object - properties: - allowCors: + 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: + type: string 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 + 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: The canonical name of this endpoint. - 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". + 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}"`. + displayName: type: string - aliases: - items: - 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. - type: array - 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 - CustomErrorRule: - type: object + 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: + description: >- + Optional. A detailed description of the monitored resource type that + might be used in documentation. + 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. + type: string + description: Optional. The launch stage of the monitored resource definition. + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + QuotaLimit: properties: - selector: + duration: type: string description: >- - Selects messages to which this rule applies. Refer to selector for - syntax details. - isErrorType: + Duration of this limit in textual notation. Must be "100s" or "1d". + Used by group-based quotas only. + maxLimit: + format: int64 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 - id: CustomErrorRule - description: A custom error rule. - JwtLocation: - properties: - cookie: + 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. + 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. type: string - description: Specifies cookie name to extract JWT token. - header: - description: Specifies HTTP header name to extract JWT token. + format: int64 + 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 - query: + displayName: type: string - description: Specifies URL query parameter name to extract JWT token. - valuePrefix: + 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: 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. - type: object - description: Specifies a location to extract JWT from an API request. - id: JwtLocation - SystemParameter: - id: SystemParameter - properties: - httpHeader: + 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. + description: type: string description: >- - Define the HTTP header name to use for the parameter. It is case - insensitive. - name: + 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`). + 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 + values: + additionalProperties: + format: int64 + type: string + type: object description: >- - Define the name of the parameter, such as "api_key" . It is case - sensitive. - urlQueryParameter: + 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. + defaultLimit: + format: int64 description: >- - Define the URL query parameter name to use for the parameter. It is - case sensitive. + 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 + 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. + `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`. + id: QuotaLimit + Service: + id: Service type: object - Usage: - id: Usage - description: Configuration controlling usage of a 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 properties: - producerNotificationChannel: + systemTypes: 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: + 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/UsageRule' + $ref: '#/components/schemas/Type' + type: array + billing: + $ref: '#/components/schemas/Billing' + description: Billing configuration. + apis: description: >- - A list of usage rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. + 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 - requirements: + customError: + $ref: '#/components/schemas/CustomError' + description: Custom error configuration. + monitoring: + $ref: '#/components/schemas/Monitoring' + description: Monitoring configuration. + documentation: + $ref: '#/components/schemas/Documentation' + description: Additional API documentation. + enums: 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 items: - type: string + $ref: '#/components/schemas/Enum' + control: + $ref: '#/components/schemas/Control' + description: Configuration for the service control plane. + name: + 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: object - MethodPolicy: - properties: - selector: + 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. + logging: + $ref: '#/components/schemas/Logging' + description: Logging configuration. + types: + type: array 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 - requestPolicies: + 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' + 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 + usage: + $ref: '#/components/schemas/Usage' + description: Configuration controlling usage of this service. + 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. + producerProjectId: + description: The Google project that owns this service. + type: string + systemParameters: + $ref: '#/components/schemas/SystemParameters' + description: System parameter configuration. + backend: + description: API backend configuration. + $ref: '#/components/schemas/Backend' + http: + $ref: '#/components/schemas/Http' + description: HTTP configuration. + metrics: + description: Defines the metrics used by this service. items: - $ref: '#/components/schemas/FieldPolicy' - description: Policies that are applicable to the request message. - id: MethodPolicy - description: Defines policies applying to an RPC method. - type: object - 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. - type: object - id: Http - properties: - fullyDecodeReservedExpansion: - type: boolean + $ref: '#/components/schemas/MetricDescriptor' + type: array + title: + type: string + description: >- + The product title for this service, it is the name displayed in + Google Cloud Console. + sourceInfo: + $ref: '#/components/schemas/SourceInfo' 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: + Output only. The source information for this configuration if + available. + logs: + items: + $ref: '#/components/schemas/LogDescriptor' + type: array + description: Defines the logs used by this service. + publishing: description: >- - A list of HTTP configuration rules that apply to individual API - methods. **NOTE:** All service configuration rules follow "last one - wins" order. + 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' + context: + description: Context configuration. + $ref: '#/components/schemas/Context' + 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 + quota: + $ref: '#/components/schemas/Quota' + description: Quota configuration. + authentication: + $ref: '#/components/schemas/Authentication' + description: Auth configuration. + endpoints: type: array + 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/HttpRule' - Page: - id: Page - description: >- - Represents a documentation page. A page can contain subpages to - represent nested documentation set structure. + $ref: '#/components/schemas/Endpoint' + MetricDescriptorMetadata: + description: Additional annotations that can be used to guide the usage of a metric. + id: MetricDescriptorMetadata type: object properties: - subpages: + ingestDelay: + format: google-duration 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: + 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 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: >- - 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`. + 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 - V1Beta1GenerateServiceIdentityResponse: - id: 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. - type: object - TenantResource: - type: object - description: Resource constituting the TenancyUnit. - properties: - status: + launchStage: + description: Deprecated. Must use the MetricDescriptor.launch_stage instead. 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 + - 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: - - STATUS_UNSPECIFIED - - PENDING_CREATE - - ACTIVE - - PENDING_DELETE - - FAILED - - DELETED - description: Status of tenant resource. - resource: - type: string - 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'. - tag: - description: Unique per single tenancy unit. + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED type: string - id: TenantResource - TenantProjectConfig: + deprecated: true + AddTenantProjectRequest: type: object properties: - tenantProjectPolicy: - description: Describes ownership and policies for the new tenant project. - $ref: '#/components/schemas/TenantProjectPolicy' - billingConfig: - $ref: '#/components/schemas/BillingConfig' - description: Billing account properties. The billing account must be specified. - serviceAccountConfig: - $ref: '#/components/schemas/ServiceAccountConfig' - description: Configuration for the IAM service account on the tenant project. - labels: - additionalProperties: - type: string - type: object - description: Labels that are applied to this project. - services: - items: - type: string - type: array + projectConfig: + $ref: '#/components/schemas/TenantProjectConfig' 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' - folder: - type: string + Configuration of the new tenant project to be added to tenancy unit + resources. + tag: 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`). - 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 - Logging: - type: object - id: Logging + Required. Tag of the added project. Must be less than 128 + characters. Required. + type: string 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: - items: - $ref: '#/components/schemas/LoggingDestination' - 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. - 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 - Monitoring: + Request to add a newly created and configured tenant project to a + tenancy unit. + id: AddTenantProjectRequest + Status: + id: Status type: object - id: Monitoring + 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: - producerDestinations: + code: + type: integer + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 + message: 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' + 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 - 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. + 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/MonitoringDestination' - type: array + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + MetricRule: + id: MetricRule 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 - Backend: + Bind API methods to metrics. Binding a method to a metric causes that + metric's configured quota behaviors to apply to the method call. + type: object properties: - rules: - type: array + metricCosts: 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' - description: '`Backend` defines the backend configuration for a service.' - id: Backend - type: object - Context: + 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: + type: string + format: int64 + selector: + type: string + description: >- + Selects the methods to which this rule applies. Refer to selector + for syntax details. + V1DefaultIdentity: + description: A default identity in the Identity and Access Management API. + id: V1DefaultIdentity type: object - id: Context + properties: + uniqueId: + description: The unique and stable id of the default identity. + type: string + name: + type: string + description: >- + Default identity resource name. An example name would be: + `services/serviceconsumermanagement.googleapis.com/projects/123/defaultIdentity` + 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 + email: + type: string + description: The email address of the default identity. + LogDescriptor: 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 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 properties: - rules: - items: - $ref: '#/components/schemas/ContextRule' + name: description: >- - A list of RPC context rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. + 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 + labels: type: array - GoSettings: + 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. + description: + type: string + description: >- + A human-readable description of this log. This information appears + in the documentation and can contain details. + 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 + UndeleteTenantProjectRequest: properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. + tag: + description: Required. Tag of the resource within the tenancy unit. + type: string + id: UndeleteTenantProjectRequest + description: >- + Request message to undelete tenant project resource previously deleted + from the tenancy unit. type: object - id: GoSettings - description: Settings for Go client libraries. - PhpSettings: - id: PhpSettings - description: Settings for Php client libraries. + AttachTenantProjectRequest: + description: >- + Request to attach an existing project to the tenancy unit as a new + tenant resource. properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' + 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 + tag: + type: string + description: >- + Required. Tag of the tenant resource after attachment. Must be less + than 128 characters. Required. + externalResource: + description: >- + When attaching an external project, this is in the format of + `projects/{project_number}`. + type: string + id: AttachTenantProjectRequest type: object parameters: - 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 - 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 - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string _.xgafv: description: V1 error format. in: query @@ -3604,13 +3580,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. + 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: key + name: oauth_token + schema: + type: string + access_token: + description: OAuth access token. + in: query + name: access_token schema: type: string prettyPrint: @@ -3629,6 +3614,27 @@ components: - 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 + 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 quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -3638,15 +3644,50 @@ 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 x-stackQL-resources: + operations: + id: google.serviceconsumermanagement.operations + name: operations + title: Operations + methods: + _list: + operation: &ref_1 + $ref: '#/paths/~1v1~1operations/get' + response: &ref_2 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + list: + operation: *ref_1 + response: *ref_2 + cancel: + operation: + $ref: '#/paths/~1v1~1operations~1{operationsId}:cancel/post' + response: + mediaType: application/json + openAPIDocKey: '200' + 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: [] + delete: + - $ref: '#/components/x-stackQL-resources/operations/methods/delete' services: - id: serviceconsumermanagement.services + id: google.serviceconsumermanagement.services name: services title: Services methods: @@ -3662,7 +3703,7 @@ components: update: [] delete: [] tenancy_units: - id: serviceconsumermanagement.tenancy_units + id: google.serviceconsumermanagement.tenancy_units name: tenancy_units title: Tenancy_units methods: @@ -3673,13 +3714,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - undelete_project: - operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:undeleteProject/post - response: - mediaType: application/json - openAPIDocKey: '200' delete: operation: $ref: >- @@ -3695,16 +3729,23 @@ components: mediaType: application/json openAPIDocKey: '200' _list: - operation: &ref_1 + operation: &ref_3 $ref: >- #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits/get - response: &ref_2 + response: &ref_4 mediaType: application/json openAPIDocKey: '200' objectKey: $.tenancyUnits list: - operation: *ref_1 - response: *ref_2 + operation: *ref_3 + response: *ref_4 + undelete_project: + operation: + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:undeleteProject/post + response: + mediaType: application/json + openAPIDocKey: '200' attach_project: operation: $ref: >- @@ -3721,28 +3762,28 @@ components: delete: - $ref: '#/components/x-stackQL-resources/tenancy_units/methods/delete' tenancy_units_project: - id: serviceconsumermanagement.tenancy_units_project + id: google.serviceconsumermanagement.tenancy_units_project name: tenancy_units_project title: Tenancy_units_project methods: - add_project: + remove_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}:removeProject/post response: mediaType: application/json openAPIDocKey: '200' - 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' - remove_project: + delete_project: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:removeProject/post + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:deleteProject/post response: mediaType: application/json openAPIDocKey: '200' @@ -3751,64 +3792,25 @@ components: insert: [] update: [] delete: [] - operations: - id: serviceconsumermanagement.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_3 - $ref: '#/paths/~1v1~1operations/get' - response: &ref_4 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 - 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: [] - delete: - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' paths: - /v1/services/{servicesId}:search: + /v1/operations: parameters: &ref_5 - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/upload_protocol' 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 @@ -3820,15 +3822,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SearchTenancyUnitsResponse' + $ref: '#/components/schemas/ListOperationsResponse' parameters: - - in: path - name: servicesId - required: true - schema: - type: string - in: query - name: pageToken + name: filter schema: type: string - in: query @@ -3837,33 +3834,28 @@ paths: type: integer format: int32 - in: query - name: query + name: pageToken schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:applyProjectConfig: + /v1/operations/{operationsId}:cancel: parameters: *ref_5 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 + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is 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/ApplyTenantProjectConfigRequest' + $ref: '#/components/schemas/CancelOperationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3875,43 +3867,69 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Empty' parameters: - in: path - name: servicesId - required: true - schema: - type: string - - in: path - name: servicesId1 + name: operationsId required: true schema: type: string + /v1/operations/{operationsId}: + parameters: *ref_5 + 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: servicesId2 + 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 + security: + - Oauth2: + - https://www.googleapis.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: tenancyUnitsId + name: operationsId required: true schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:undeleteProject: + /v1/services/{servicesId}:search: parameters: *ref_5 - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UndeleteTenantProjectRequest' + get: + description: Search tenancy units for a managed service. + operationId: serviceconsumermanagement.services.search security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3923,43 +3941,50 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/SearchTenancyUnitsResponse' parameters: - in: path name: servicesId required: true schema: type: string - - in: path - name: servicesId1 - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: servicesId2 - required: true + type: integer + format: int32 + - in: query + name: query schema: type: string - - in: path - name: tenancyUnitsId - required: true + - in: query + name: pageToken schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:addProject: + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:applyProjectConfig: parameters: *ref_5 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 + 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/AddTenantProjectRequest' + $ref: '#/components/schemas/ApplyTenantProjectConfigRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4124,24 +4149,23 @@ paths: name: filter schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:deleteProject: + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:removeProject: parameters: *ref_5 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 + 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/DeleteTenantProjectRequest' + $ref: '#/components/schemas/RemoveTenantProjectRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4175,26 +4199,21 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:attachProject: + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:undeleteProject: parameters: *ref_5 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 + 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/AttachTenantProjectRequest' + $ref: '#/components/schemas/UndeleteTenantProjectRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4228,23 +4247,21 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:removeProject: + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:addProject: parameters: *ref_5 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 + 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/RemoveTenantProjectRequest' + $ref: '#/components/schemas/AddTenantProjectRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4278,14 +4295,24 @@ paths: required: true schema: type: string - /v1/operations/{operationsId}: + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:deleteProject: parameters: *ref_5 - 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: serviceconsumermanagement.operations.get + 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' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4300,87 +4327,45 @@ paths: $ref: '#/components/schemas/Operation' 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: 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 + name: servicesId1 required: true schema: type: string - /v1/operations: - parameters: *ref_5 - 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: pageToken + - in: path + name: servicesId2 + required: true 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/operations/{operationsId}:cancel: + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:attachProject: parameters: *ref_5 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 + 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/CancelOperationRequest' + $ref: '#/components/schemas/AttachTenantProjectRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4392,10 +4377,25 @@ 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 + - in: path + name: servicesId1 + required: true + schema: + type: string + - in: path + name: servicesId2 + required: true + schema: + type: string + - in: path + name: tenancyUnitsId required: true 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 fd9cc2c7..66026d55 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/servicecontrol.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/servicecontrol.yaml @@ -10,7 +10,7 @@ info: with Service Infrastructure. version: v2 x-discovery-doc-revision: '20240516' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/service-control/ servers: @@ -1447,7 +1447,7 @@ components: - '2' x-stackQL-resources: services: - id: servicecontrol.services + id: google.servicecontrol.services name: services title: Services methods: 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 6d242027..2b4c0f6e 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/servicedirectory.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/servicedirectory.yaml @@ -10,7 +10,7 @@ info: services. version: v1 x-discovery-doc-revision: '20240526' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/service-directory servers: @@ -686,7 +686,7 @@ components: - '2' x-stackQL-resources: locations: - id: servicedirectory.locations + id: google.servicedirectory.locations name: locations title: Locations methods: @@ -708,13 +708,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] namespaces: - id: servicedirectory.namespaces + id: google.servicedirectory.namespaces name: namespaces title: Namespaces methods: @@ -759,15 +759,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/namespaces/methods/list' - $ref: '#/components/x-stackQL-resources/namespaces/methods/get' + - $ref: '#/components/x-stackQL-resources/namespaces/methods/list' insert: - $ref: '#/components/x-stackQL-resources/namespaces/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/namespaces/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/namespaces/methods/delete' namespaces_iam_policies: - id: servicedirectory.namespaces_iam_policies + id: google.servicedirectory.namespaces_iam_policies name: namespaces_iam_policies title: Namespaces_iam_policies methods: @@ -804,7 +805,7 @@ components: update: [] delete: [] services: - id: servicedirectory.services + id: google.servicedirectory.services name: services title: Services methods: @@ -856,15 +857,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/services/methods/list' - $ref: '#/components/x-stackQL-resources/services/methods/get' + - $ref: '#/components/x-stackQL-resources/services/methods/list' insert: - $ref: '#/components/x-stackQL-resources/services/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/services/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/services/methods/delete' services_iam_policies: - id: servicedirectory.services_iam_policies + id: google.servicedirectory.services_iam_policies name: services_iam_policies title: Services_iam_policies methods: @@ -901,7 +903,7 @@ components: update: [] delete: [] endpoints: - id: servicedirectory.endpoints + id: google.servicedirectory.endpoints name: endpoints title: Endpoints methods: @@ -946,11 +948,12 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/endpoints/methods/list' - $ref: '#/components/x-stackQL-resources/endpoints/methods/get' + - $ref: '#/components/x-stackQL-resources/endpoints/methods/list' insert: - $ref: '#/components/x-stackQL-resources/endpoints/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/endpoints/methods/delete' paths: 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 3ba60339..4e552358 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: '20240524' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/service-management/ servers: @@ -3922,7 +3922,7 @@ components: - '2' x-stackQL-resources: operations: - id: servicemanagement.operations + id: google.servicemanagement.operations name: operations title: Operations methods: @@ -3944,13 +3944,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: [] services: - id: servicemanagement.services + id: google.servicemanagement.services name: services title: Services methods: @@ -3996,15 +3996,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/services/methods/list' - $ref: '#/components/x-stackQL-resources/services/methods/get' + - $ref: '#/components/x-stackQL-resources/services/methods/list' insert: - $ref: '#/components/x-stackQL-resources/services/methods/create' update: [] delete: - $ref: '#/components/x-stackQL-resources/services/methods/delete' services_config: - id: servicemanagement.services_config + id: google.servicemanagement.services_config name: services_config title: Services_config methods: @@ -4022,7 +4022,7 @@ components: update: [] delete: [] services_iam_policies: - id: servicemanagement.services_iam_policies + id: google.servicemanagement.services_iam_policies name: services_iam_policies title: Services_iam_policies methods: @@ -4056,7 +4056,7 @@ components: update: [] delete: [] configs: - id: servicemanagement.configs + id: google.servicemanagement.configs name: configs title: Configs methods: @@ -4090,14 +4090,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/configs/methods/list' - $ref: '#/components/x-stackQL-resources/configs/methods/get' + - $ref: '#/components/x-stackQL-resources/configs/methods/list' insert: - $ref: '#/components/x-stackQL-resources/configs/methods/create' update: [] delete: [] rollouts: - id: servicemanagement.rollouts + id: google.servicemanagement.rollouts name: rollouts title: Rollouts methods: @@ -4125,14 +4125,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/rollouts/methods/list' - $ref: '#/components/x-stackQL-resources/rollouts/methods/get' + - $ref: '#/components/x-stackQL-resources/rollouts/methods/list' insert: - $ref: '#/components/x-stackQL-resources/rollouts/methods/create' update: [] delete: [] consumers_iam_policies: - id: servicemanagement.consumers_iam_policies + id: google.servicemanagement.consumers_iam_policies name: consumers_iam_policies title: Consumers_iam_policies methods: 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 08e0b4ac..4d7c0f64 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/servicenetworking.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/servicenetworking.yaml @@ -10,7 +10,7 @@ info: certain services. version: v1 x-discovery-doc-revision: '20240529' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: >- https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started @@ -38,2723 +38,2482 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - RangeReservation: - type: object - id: RangeReservation + PhpSettings: + id: PhpSettings properties: - ipPrefixLength: - 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 - type: integer - format: int32 - 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 validation fails. - items: - type: string - secondaryRangeIpPrefixLengths: - items: - type: integer - format: int32 - type: array - 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 - subnetworkCandidates: - items: - $ref: '#/components/schemas/Subnetwork' - 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. - type: array - description: Represents a range reservation. - Page: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. type: object + description: Settings for Php client libraries. + Method: + id: Method properties: - name: + requestTypeUrl: 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`. - subpages: - description: >- - Subpages of this page. The order of subpages specified here will be - honored in the generated docset. - type: array + description: A URL of the input message type. + requestStreaming: + description: If true, the request is streamed. + type: boolean + responseStreaming: + type: boolean + description: If true, the response is streamed. + syntax: + description: The source syntax of this method. + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + type: string + responseTypeUrl: + description: The URL of the output message type. + type: string + options: + description: Any metadata attached to the method. 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. + $ref: '#/components/schemas/Option' + type: array + name: + description: The simple name of this method. type: string - id: Page - description: >- - Represents a documentation page. A page can contain subpages to - represent nested documentation set structure. - PhpSettings: type: object - id: PhpSettings - description: Settings for Php client libraries. + description: Method represents a method of an API interface. + GoSettings: properties: common: description: Some settings. $ref: '#/components/schemas/CommonLanguageSettings' - HttpRule: + id: GoSettings + type: object + description: Settings for Go client libraries. + JavaSettings: properties: - get: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + serviceClassNames: description: >- - Maps to HTTP GET. Used for listing and getting information about - resources. - type: string - body: + 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 + libraryPackage: 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. + 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 - post: - description: >- - Maps to HTTP POST. Used for creating a resource or performing an - action. + type: object + id: JavaSettings + description: Settings for Java client libraries. + ClientLibrarySettings: + type: object + description: Details about how and where to publish client libraries. + id: ClientLibrarySettings + properties: + 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. + - 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 - responseBody: + rubySettings: + description: Settings for Ruby client libraries. + $ref: '#/components/schemas/RubySettings' + javaSettings: + description: Settings for legacy Java features, supported in the Service YAML. + $ref: '#/components/schemas/JavaSettings' + cppSettings: + $ref: '#/components/schemas/CppSettings' + description: Settings for C++ client libraries. + version: 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. - additionalBindings: - 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). - delete: - type: string - description: Maps to HTTP DELETE. Used for deleting a resource. - put: - type: string - description: Maps to HTTP PUT. Used for replacing a resource. - patch: - type: string - description: Maps to HTTP PATCH. Used for updating a resource. - selector: + 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". + pythonSettings: + $ref: '#/components/schemas/PythonSettings' + description: Settings for Python client libraries. + restNumericEnums: + type: boolean description: >- - Selects a method to which this rule applies. Refer to selector for - syntax details. - 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. - 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. Example - below selects a gRPC method and applies 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. - 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: - 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' - 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. - pages: - description: The top level pages for the documentation set. - items: - $ref: '#/components/schemas/Page' - type: array - 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. - 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 - type: object - ConsumerConfigMetadata: - id: ConsumerConfigMetadata - description: >- - Metadata provided through GetOperation request for the LRO generated by - UpdateConsumerConfig API. - type: object - properties: {} - PeeredDnsDomain: - id: PeeredDnsDomain - description: >- - DNS domain suffix for which requests originating in the producer VPC - network are resolved in the associated consumer VPC network. - 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. - JavaSettings: - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - 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: - 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 - type: object - id: JavaSettings - description: Settings for Java client libraries. - Publishing: - properties: - restReferenceDocumentationUri: - description: >- - Optional link to REST reference documentation. Example: - https://cloud.google.com/pubsub/lite/docs/reference/rest - type: string - 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 - type: string - description: For whom the client library is being published. - 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. - githubLabel: - type: string - description: >- - GitHub label to apply to issues and pull requests opened for this - API. - protoReferenceDocumentationUri: - type: string - description: >- - Optional link to proto reference documentation. Example: - https://cloud.google.com/pubsub/lite/docs/reference/rpc - 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: - items: - type: string - type: array - description: >- - GitHub teams to be added to CODEOWNERS in the directory in GitHub - containing source code for the client libraries for this API. - documentationUri: - type: string - description: >- - Link to product home page. Example: - https://cloud.google.com/asset-inventory/docs/overview - newIssueUri: - description: >- - Link to a *public* URI where users can report issues. Example: - https://issuetracker.google.com/issues/new?component=190865&template=1161103 - type: string - methodSettings: - 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. - docTagPrefix: - type: string - description: >- - A prefix used in sample code when demarking regions to be included - in documentation. - 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 - UpdateDnsRecordSetMetadata: - properties: {} - id: UpdateDnsRecordSetMetadata - description: >- - Metadata provided through GetOperation request for the LRO generated by - UpdateDnsRecordSet API - type: object - Method: - type: object - properties: - responseStreaming: - description: If true, the response is streamed. - type: boolean - requestStreaming: - type: boolean - description: If true, the request is streamed. - options: - description: Any metadata attached to the method. - items: - $ref: '#/components/schemas/Option' - type: array - responseTypeUrl: - type: string - description: The URL of the output message type. - name: - description: The simple name of this method. - type: string - requestTypeUrl: - type: string - description: A URL of the input message type. - syntax: - type: string - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - description: The source syntax of this method. - id: Method - description: Method represents a method of an API interface. - PythonSettings: - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - id: PythonSettings - description: Settings for Python client libraries. - type: object - CustomError: - properties: - types: - items: - type: string - description: >- - The list of custom error detail types, e.g. - 'google.foo.v1.CustomError'. - type: array - rules: - description: >- - 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 - 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 - 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: - consumerDestinations: - 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: - 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. - type: array - items: - $ref: '#/components/schemas/MonitoringDestination' - id: Monitoring - SystemParameters: - 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' - 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 - RemoveDnsRecordSetResponse: - type: object - description: Blank message response type for RemoveDnsRecordSet API - id: RemoveDnsRecordSetResponse - properties: {} + When using transport=rest, the client request will encode enums as + numbers rather than strings. + goSettings: + description: Settings for Go client libraries. + $ref: '#/components/schemas/GoSettings' + dotnetSettings: + $ref: '#/components/schemas/DotnetSettings' + description: Settings for .NET client libraries. + phpSettings: + $ref: '#/components/schemas/PhpSettings' + description: Settings for PHP client libraries. + nodeSettings: + $ref: '#/components/schemas/NodeSettings' + description: Settings for Node client libraries. 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. + id: RemoveDnsRecordSetRequest + type: object properties: - consumerNetwork: + zone: 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. + Required. The name of the private DNS zone in the shared producer + host project from which the record set will be removed. type: string dnsRecordSet: description: Required. The DNS record set to remove. $ref: '#/components/schemas/DnsRecordSet' - 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. - type: object - id: RemoveDnsRecordSetRequest - CustomErrorRule: - description: A custom error rule. - 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: + consumerNetwork: description: >- - Selects messages to which this rule applies. Refer to selector for - syntax details. + 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 + 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 type: object - id: CustomErrorRule - QuotaLimit: + id: Service properties: - defaultLimit: + logs: + items: + $ref: '#/components/schemas/LogDescriptor' + description: Defines the logs used by this service. + type: array + systemTypes: + items: + $ref: '#/components/schemas/Type' + type: array 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. - type: string - format: int64 - metric: + 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. + usage: + description: Configuration controlling usage of this service. + $ref: '#/components/schemas/Usage' + systemParameters: + $ref: '#/components/schemas/SystemParameters' + description: System parameter configuration. + producerProjectId: + description: The Google project that owns this service. type: string + name: 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. - 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 + logging: + $ref: '#/components/schemas/Logging' + description: Logging configuration. + monitoring: + description: Monitoring configuration. + $ref: '#/components/schemas/Monitoring' + http: + description: HTTP configuration. + $ref: '#/components/schemas/Http' + context: + description: Context configuration. + $ref: '#/components/schemas/Context' + configVersion: + format: uint32 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: + Obsolete. Do not use. This field has no semantic meaning. The + service config compiler always sets this field to `3`. + type: integer + apis: + type: array + items: + $ref: '#/components/schemas/Api' 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 - maxLimit: - type: string + 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. + types: + type: array 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 - name: + 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' + customError: + description: Custom error configuration. + $ref: '#/components/schemas/CustomError' + id: 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. - duration: + 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. + sourceInfo: description: >- - Duration of this limit in textual notation. Must be "100s" or "1d". - Used by group-based quotas only. - type: string - freeTier: + Output only. The source information for this configuration if + available. + $ref: '#/components/schemas/SourceInfo' + metrics: + description: Defines the metrics used by this service. + items: + $ref: '#/components/schemas/MetricDescriptor' + type: array + documentation: + description: Additional API documentation. + $ref: '#/components/schemas/Documentation' + enums: + type: array 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 + 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' + control: + $ref: '#/components/schemas/Control' + description: Configuration for the service control plane. + publishing: + $ref: '#/components/schemas/Publishing' 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: + Settings for [Google Cloud Client + libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) + generated from APIs defined as protocol buffers. + authentication: + $ref: '#/components/schemas/Authentication' + description: Auth configuration. + title: 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. + The product title for this service, it is the name displayed in + Google Cloud Console. 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`. - type: object - id: QuotaLimit - MethodPolicy: - properties: - requestPolicies: + quota: + description: Quota configuration. + $ref: '#/components/schemas/Quota' + 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/FieldPolicy' + $ref: '#/components/schemas/Endpoint' + type: array + backend: + $ref: '#/components/schemas/Backend' + description: API backend configuration. + monitoredResources: + items: + $ref: '#/components/schemas/MonitoredResourceDescriptor' 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 - type: object - description: Defines policies applying to an RPC method. - id: MethodPolicy - DisableVpcServiceControlsRequest: - id: DisableVpcServiceControlsRequest + Defines the monitored resources used by this service. This is + required by the Service.monitoring and Service.logging + configurations. + billing: + $ref: '#/components/schemas/Billing' + description: Billing configuration. + Api: + 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. properties: - consumerNetwork: - type: string + name: 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 disable VPC service controls. - type: object - RemoveDnsZoneRequest: - id: RemoveDnsZoneRequest - properties: - consumerNetwork: + The fully qualified name of this interface, including package name + followed by the interface's simple name. 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. - name: + syntax: + description: The source syntax of the service. 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. - 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. - type: object - LoggingDestination: - type: object - properties: - monitoredResource: + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + options: + type: array + items: + $ref: '#/components/schemas/Option' + description: Any metadata attached to the interface. + version: type: string description: >- - The monitored resource type. The type must be defined in the - Service.monitored_resources section. - logs: + 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. + sourceContext: + $ref: '#/components/schemas/SourceContext' 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 "/". + Source context for the protocol buffer service represented by this + message. + methods: + items: + $ref: '#/components/schemas/Method' + description: The methods of this interface, in unspecified order. type: array + mixins: + description: Included interfaces. See Mixin. items: - type: string - description: >- - Configuration of a specific logging destination (the producer project or - the consumer project). - id: LoggingDestination - Empty: + $ref: '#/components/schemas/Mixin' + type: array + type: object + CloudSQLConfig: + description: Cloud SQL configuration. 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 - properties: {} - BackendRule: 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 - minDeadline: - description: Deprecated, do not use. - format: double - type: number - deprecated: true - protocol: + umbrellaNetwork: + description: The name of the umbrella network in the Cloud SQL umbrella project. 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. - selector: - description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. + service: + description: Peering service used for peering with the Cloud SQL project. type: string - address: + umbrellaProject: + format: int64 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: + description: The project number of the Cloud SQL umbrella project. + id: CloudSQLConfig + MetricDescriptorMetadata: + description: Additional annotations that can be used to guide the usage of a metric. + type: object + id: MetricDescriptorMetadata + 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. + launchStage: enum: - - PATH_TRANSLATION_UNSPECIFIED - - CONSTANT_ADDRESS - - APPEND_PATH_TO_ADDRESS + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + description: Deprecated. Must use the MetricDescriptor.launch_stage instead. + type: string + deprecated: true enumDescriptions: - - '' + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. - >- - 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 + Prelaunch features are hidden from users and are only visible + internally. - >- - 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: + 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. + samplePeriod: type: string + format: google-duration 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. - 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 - overridesByRequestProtocol: - additionalProperties: - $ref: '#/components/schemas/BackendRule' - type: object - description: The map between request protocol and the backend address. - id: BackendRule - description: A backend rule provides configuration for an individual API element. + 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. + Mixin: type: object - Service: + id: Mixin 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 + 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: - systemParameters: - $ref: '#/components/schemas/SystemParameters' - description: System parameter configuration. - logs: - items: - $ref: '#/components/schemas/LogDescriptor' - type: array - description: Defines the logs used by this service. - id: + root: + 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. + 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. + AddDnsZoneRequest: + 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. + 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 + dnsSuffix: type: string - backend: - $ref: '#/components/schemas/Backend' - description: API backend configuration. - billing: - description: Billing configuration. - $ref: '#/components/schemas/Billing' - sourceInfo: - $ref: '#/components/schemas/SourceInfo' description: >- - Output only. The source information for this configuration if - available. - enums: - items: - $ref: '#/components/schemas/Enum' + Required. The DNS name suffix for the zones e.g. `example.com.`. + Cloud DNS requires that a DNS suffix ends with a trailing dot. + name: 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 - producerProjectId: - description: The Google project that owns this service. + 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. type: string - monitoring: - description: Monitoring configuration. - $ref: '#/components/schemas/Monitoring' - usage: - $ref: '#/components/schemas/Usage' - description: Configuration controlling usage of this service. - title: + id: AddDnsZoneRequest + type: object + EnableVpcServiceControlsRequest: + properties: + consumerNetwork: description: >- - The product title for this service, it is the name displayed in - Google Cloud Console. + 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: string - authentication: - description: Auth configuration. - $ref: '#/components/schemas/Authentication' - 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. + description: Request to enable VPC service controls. + id: EnableVpcServiceControlsRequest + type: object + Context: + properties: + rules: items: - $ref: '#/components/schemas/Endpoint' + $ref: '#/components/schemas/ContextRule' 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 - documentation: - $ref: '#/components/schemas/Documentation' - description: Additional API documentation. - 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 - items: - $ref: '#/components/schemas/Type' - type: array - quota: - description: Quota configuration. - $ref: '#/components/schemas/Quota' - customError: - $ref: '#/components/schemas/CustomError' - description: Custom error configuration. - metrics: - type: array - description: Defines the metrics used by this service. - items: - $ref: '#/components/schemas/MetricDescriptor' - publishing: + 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 + 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. + SystemParameters: + type: object + id: SystemParameters + properties: + rules: 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' - logging: - $ref: '#/components/schemas/Logging' - description: Logging configuration. - systemTypes: + 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/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. - http: - $ref: '#/components/schemas/Http' - description: HTTP configuration. + $ref: '#/components/schemas/SystemParameterRule' + 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. + PeeredDnsDomain: + id: PeeredDnsDomain + properties: 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. - monitoredResources: - type: array + 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. + dnsSuffix: + type: string 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' - control: - description: Configuration for the service control plane. - $ref: '#/components/schemas/Control' - apis: - type: array - items: - $ref: '#/components/schemas/Api' + The DNS domain name suffix e.g. `example.com.`. Cloud DNS requires + that a DNS suffix ends with a trailing dot. + type: object + description: >- + DNS domain suffix for which requests originating in the producer VPC + network are resolved in the associated consumer VPC network. + AuthRequirement: + properties: + audiences: + type: string 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. - context: - description: Context configuration. - $ref: '#/components/schemas/Context' - id: Service - PeeredDnsDomainMetadata: + 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 + id: AuthRequirement + type: object description: >- - Metadata provided through GetOperation request for the LRO generated by - CreatePeeredDnsDomain API. - properties: {} - id: PeeredDnsDomainMetadata + User-defined authentication requirements, including support for [JSON + Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + DocumentationRule: + description: A documentation rule provides information about individual API elements. type: object - ConsumerProject: - description: Represents a consumer project. + id: DocumentationRule properties: - projectNum: + 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 + 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 - format: int64 + disableReplacementWords: 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. - type: object - id: ConsumerProject - Quota: - type: object + String of comma or space separated case-sensitive words for which + method/field name replacement will be disabled by go/api-docgen. + type: string + CustomError: 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 + 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: - metricRules: + types: type: array items: - $ref: '#/components/schemas/MetricRule' + type: string description: >- - List of MetricRule definitions, each one mapping a selected method - to one or more metrics. - limits: - type: array - description: List of QuotaLimit definitions for the service. + The list of custom error detail types, e.g. + 'google.foo.v1.CustomError'. + rules: + description: >- + 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/QuotaLimit' - MetricDescriptorMetadata: - description: Additional annotations that can be used to guide the usage of a metric. - id: MetricDescriptorMetadata + $ref: '#/components/schemas/CustomErrorRule' + type: array + type: object + id: CustomError + MethodSettings: type: object properties: - samplePeriod: - format: google-duration + autoPopulatedFields: 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 - launchStage: - type: string - deprecated: true - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - 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. - - >- - 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: + 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: array + longRunning: + $ref: '#/components/schemas/LongRunning' 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. + 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 - format: google-duration - DnsZonePair: + id: MethodSettings + description: Describes the generator configuration for a method. + CustomHttpPattern: type: object - id: DnsZonePair - description: '* Represents a pair of private and peering DNS zone resources. *' - properties: - producerPrivateZone: - description: The private DNS zone in the shared producer host project. - $ref: '#/components/schemas/DnsZone' - consumerPeeringZone: - $ref: '#/components/schemas/DnsZone' - description: The DNS peering zone in the consumer project. - LabelDescriptor: - id: LabelDescriptor properties: - description: - type: string - description: A human-readable description for the label. - key: + path: + description: The path matched by this custom verb. 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. - enum: - - STRING - - BOOL - - INT64 + kind: type: string - description: The type of data that can be assigned to the label. + description: The name of this custom HTTP verb. + id: CustomHttpPattern + description: A custom pattern is used for defining custom HTTP verb. + AddSubnetworkRequest: + id: AddSubnetworkRequest + description: Request to create a subnetwork in a previously peered service network. type: object - description: A description of a label. - LongRunning: - 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: - description: >- - Multiplier to gradually increase delay between subsequent polls - until it reaches max_poll_delay. Default value: 1.5. - type: number - format: float - initialPollDelay: + secondaryIpRangeSpecs: + items: + $ref: '#/components/schemas/SecondaryIpRangeSpec' description: >- - Initial delay after which the first poll request will be made. - Default value: 5 seconds. + Optional. A list of secondary IP ranges to be created within the new + subnetwork. + type: array + internalRange: type: string - format: google-duration - maxPollDelay: + 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. + subnetworkUsers: + items: + type: string + description: >- + A list of members that are granted the + `roles/servicenetworking.subnetworkAdmin` role on the subnet. + type: array + 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 + 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 + region: type: string description: >- - Maximum time between two subsequent poll requests. Default value: 45 - seconds. - format: google-duration - totalPollTimeout: - description: 'Total polling timeout. Default value: 5 minutes.' - format: google-duration - type: string - type: object - Usage: - properties: - producerNotificationChannel: + Required. The name of a [region](/compute/docs/regions-zones) for + the subnet, such `europe-west1`. + purpose: + 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. type: string + privateIpv6GoogleAccess: 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. - rules: - items: - $ref: '#/components/schemas/UsageRule' - type: array + 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 + allowSubnetCidrRoutesOverlap: description: >- - A list of usage rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - requirements: - items: - type: string - type: array + 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 + role: 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: object - description: Configuration controlling usage of a service. - id: Usage - AddRolesResponse: - properties: - policyBinding: - type: array - items: - $ref: '#/components/schemas/PolicyBinding' + 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. + type: string + computeIdempotencyWindow: description: >- - Required. List of policy bindings that were added to the shared VPC - host project. - description: Represents IAM roles added to the shared VPC host project. - type: object - id: AddRolesResponse - AddDnsZoneRequest: - type: object - 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. - id: AddDnsZoneRequest - properties: - name: + 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 + format: google-duration + type: string + consumer: + 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. + 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. + description: + description: Optional. Description of the subnet. type: string 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. - dnsSuffix: + 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. + checkServiceNetworkingUsePermission: + type: boolean 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 - SecondaryIpRange: - id: SecondaryIpRange - properties: - ipCidrRange: - type: string - description: Secondary IP CIDR range in `x.x.x.x/y` format. - rangeName: + Optional. The IAM permission check determines whether the consumer + project has 'servicenetworking.services.use' permission or not. + subnetwork: type: string - description: Name of the secondary IP range. - type: object - RemoveDnsRecordSetMetadata: - id: RemoveDnsRecordSetMetadata - description: >- - Metadata provided through GetOperation request for the LRO generated by - RemoveDnsRecordSet API - type: object - properties: {} - ListOperationsResponse: - properties: - operations: description: >- - A list of operations that matches the specified filter in the - request. + 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. + 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. type: array items: - $ref: '#/components/schemas/Operation' - nextPageToken: + type: string + requestedAddress: type: string - description: The standard List next-page token. - description: The response message for Operations.ListOperations. - type: object - id: ListOperationsResponse - BillingDestination: + 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: + 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. + Monitoring: + id: Monitoring type: object - description: >- - Configuration of a specific billing destination (Currently only support - bill against consumer project). properties: - metrics: - type: array + consumerDestinations: + items: + $ref: '#/components/schemas/MonitoringDestination' description: >- - Names of the metrics to report to this billing destination. Each - name must be defined in Service.metrics section. + 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: items: - type: string - monitoredResource: + $ref: '#/components/schemas/MonitoringDestination' + type: array description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. - type: string - id: BillingDestination - Endpoint: - id: Endpoint + 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. + 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 + UpdateConsumerConfigRequest: + properties: + consumerConfig: + description: Required. The updated peering config. + $ref: '#/components/schemas/ConsumerConfig' + description: >- + Request to update the configuration of a service networking connection + including the import/export of custom routes and subnetwork routes with + public IP. + type: object + id: UpdateConsumerConfigRequest + RangeReservation: type: object properties: - allowCors: - type: boolean + ipPrefixLength: 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: + 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 + requestedRanges: 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. + 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. items: type: string type: array - name: - type: string - description: The canonical name of this endpoint. - target: - type: string + subnetworkCandidates: + 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". - 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 - ListDnsZonesResponse: - description: >- - Represents all DNS zones in the shared producer host project and the - matching peering zones in the consumer project. - type: object - properties: - dnsZonePairs: + 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: description: >- - All pairs of private DNS zones in the shared producer host project - and the matching peering zones in the consumer project.. + 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: - $ref: '#/components/schemas/DnsZonePair' + format: int32 + type: integer type: array - id: ListDnsZonesResponse - AuthenticationRule: - type: object + id: RangeReservation + description: Represents a range reservation. + Type: + id: Type properties: - requirements: + options: type: array + description: The protocol buffer options. items: - $ref: '#/components/schemas/AuthRequirement' - description: Requirements for additional authentication providers. - allowWithoutCredential: - type: boolean - description: >- - If true, the service accepts API keys without any other credential. - This flag only applies to HTTP and gRPC requests. - oauth: - description: The requirements for OAuth credentials. - $ref: '#/components/schemas/OAuthRequirements' - selector: - description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. + $ref: '#/components/schemas/Option' + edition: type: string - 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. - DotnetSettings: - description: Settings for Dotnet client libraries. - type: object - id: DotnetSettings - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - ignoredResources: - type: array - 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" - items: - type: string - renamedServices: - additionalProperties: - type: string - 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. - forcedNamespaceAliases: + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. + fields: type: array items: - type: string - description: >- - Namespaces which must be aliased in snippets due to a known (but - non-generator-predictable) naming collision - handwrittenSignatures: - type: array + $ref: '#/components/schemas/Field' + description: The list of fields. + sourceContext: + $ref: '#/components/schemas/SourceContext' + description: The source context. + oneofs: + description: The list of types appearing in `oneof` definitions in this type. 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. - 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 - 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 - properties: - 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 - selector: - description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. + type: array + syntax: + description: The source syntax. + type: string + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + name: type: string + description: The fully qualified message name. + description: A protocol buffer message type. type: object - EnableVpcServiceControlsRequest: + DnsZone: + id: DnsZone properties: - consumerNetwork: + name: 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. + 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 - id: EnableVpcServiceControlsRequest - description: Request to enable VPC service controls. + dnsSuffix: + description: >- + The DNS name suffix of this zone e.g. `example.com.`. Cloud DNS + requires that a DNS suffix ends with a trailing dot. + type: string + description: Represents a DNS zone resource. type: object - AddDnsZoneMetadata: + DeletePeeredDnsDomainMetadata: type: object + properties: {} + id: DeletePeeredDnsDomainMetadata description: >- Metadata provided through GetOperation request for the LRO generated by - AddDnsZone API - id: AddDnsZoneMetadata - properties: {} - DnsRecordSet: + DeletePeeredDnsDomain API. + SecondaryIpRange: type: object - id: DnsRecordSet - properties: - 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: - description: >- - Required. The period of time for which this RecordSet can be cached - by resolvers. - format: google-duration + id: SecondaryIpRange + properties: + rangeName: + description: Name of the secondary IP range. 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 - type: + ipCidrRange: + description: Secondary IP CIDR range in `x.x.x.x/y` format. type: string - description: Required. The identifier of a supported record type. - description: Represents a DNS record set resource. Control: + id: Control type: object properties: methodPolicies: - type: array 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 - type: string - id: Control description: >- Selects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com - Connection: - id: Connection + GoogleCloudServicenetworkingV1ConsumerConfigReservedRange: + type: object + description: Allocated IP address ranges for this private service access connection. + properties: + address: + 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. + ipPrefixLength: + description: The prefix length of the reserved range. + type: integer + format: int32 + name: + description: The name of the reserved range. + type: string + id: GoogleCloudServicenetworkingV1ConsumerConfigReservedRange + RemoveDnsRecordSetMetadata: + properties: {} + type: object + id: RemoveDnsRecordSetMetadata 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. + Metadata provided through GetOperation request for the LRO generated by + RemoveDnsRecordSet API + AuthenticationRule: properties: - reservedPeeringRanges: - type: array - items: - type: string + allowWithoutCredential: 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: + 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. + requirements: + items: + $ref: '#/components/schemas/AuthRequirement' + description: Requirements for additional authentication providers. + type: array + selector: description: >- - Output only. The name of the peering service that's associated with - this connection, in the following format: `services/{service name}`. - readOnly: true - type: string - peering: - readOnly: true + Selects the methods to which this rule applies. Refer to selector + for syntax details. type: string + 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: AuthenticationRule + SearchRangeRequest: + properties: + ipPrefixLength: + type: integer + format: int32 description: >- - Output only. The name of the VPC Network Peering connection that was - created by the service producer. + 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: 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. - type: object - RemoveDnsZoneResponse: + 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. + id: SearchRangeRequest type: object - description: Blank message response type for RemoveDnsZone API - id: RemoveDnsZoneResponse - properties: {} - AddSubnetworkRequest: + description: Request to search for an unused range within allocated ranges. + GoogleCloudServicenetworkingV1betaSubnetwork: properties: - role: + name: + description: Subnetwork name. See https://cloud.google.com/compute/docs/vpc/ type: string - 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. - secondaryIpRangeSpecs: - type: array - items: - $ref: '#/components/schemas/SecondaryIpRangeSpec' - description: >- - Optional. A list of secondary IP ranges to be created within the new - subnetwork. - computeIdempotencyWindow: + network: type: string 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 - format: google-duration - consumerNetwork: + 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: 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. - allowSubnetCidrRoutesOverlap: + description: Subnetwork CIDR range in `10.x.x.x/y` format. + outsideAllocation: 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) - purpose: - 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. + This is a discovered subnet that is not within the current consumer + allocated ranges. + description: >- + Represents a subnet that was created or discovered by a private access + management service. + id: GoogleCloudServicenetworkingV1betaSubnetwork + type: object + Enum: + properties: + name: type: string - internalRange: + description: Enum type name. + edition: 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. + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. type: string - subnetwork: + options: + items: + $ref: '#/components/schemas/Option' + type: array + description: Protocol buffer options. + sourceContext: + description: The source context. + $ref: '#/components/schemas/SourceContext' + syntax: + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. type: string + description: The source syntax. + enumvalue: + type: array + items: + $ref: '#/components/schemas/EnumValue' + description: Enum value definitions. + type: object + id: Enum + description: Enum type definition. + 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: {} + ContextRule: + properties: + allowedResponseExtensions: + type: array + items: + 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. - requestedRanges: + A list of full type names or extension IDs of extensions allowed in + grpc side channel from backend to client. + provided: + items: + type: string + description: A list of full type names of provided contexts. + type: array + requested: + items: + type: string type: array + description: A list of full type names of requested contexts. + selector: + type: string 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. + Selects the methods to which this rule applies. Refer to selector + for syntax details. + allowedRequestExtensions: + description: >- + A list of full type names or extension IDs of extensions allowed in + grpc side channel from client to backend. items: type: string - checkServiceNetworkingUsePermission: - type: boolean + type: array + id: ContextRule + description: >- + A context rule provides information about the context for an individual + API element. + type: object + PeeredDnsDomainMetadata: + type: object + id: PeeredDnsDomainMetadata + description: >- + Metadata provided through GetOperation request for the LRO generated by + CreatePeeredDnsDomain API. + properties: {} + FieldPolicy: + id: FieldPolicy + properties: + resourcePermission: description: >- - Optional. The IAM permission check determines whether the consumer - project has 'servicenetworking.services.use' permission or not. - 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 - description: Optional. Description of the subnet. - useCustomComputeIdempotencyWindow: + selector: 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 - type: boolean - region: + 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: >- - Required. The name of a [region](/compute/docs/regions-zones) for - the subnet, such `europe-west1`. - outsideAllocationPublicIpRange: + 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. + LogDescriptor: + id: LogDescriptor + properties: + description: 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. + A human-readable description of this log. This information appears + in the documentation and can contain details. type: string - ipPrefixLength: - 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 - format: int32 - type: integer - consumer: + displayName: 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. - requestedAddress: - type: string + The human-readable name for this log. This information appears on + the user interface and should be concise. + labels: 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. - subnetworkUsers: + 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: - type: string + $ref: '#/components/schemas/LabelDescriptor' + name: description: >- - A list of members that are granted the - `roles/servicenetworking.subnetworkAdmin` role on the subnet. - type: array - privateIpv6GoogleAccess: + 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 + 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 + PolicyBinding: + description: Grouping of IAM role and IAM member. + properties: + member: 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. + 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 type: string - description: Request to create a subnetwork in a previously peered service network. - id: AddSubnetworkRequest + role: + 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/compute.xpnAdmin' 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 + type: string + id: PolicyBinding type: object - ClientLibrarySettings: + UpdateDnsRecordSetMetadata: type: object + description: >- + Metadata provided through GetOperation request for the LRO generated by + UpdateDnsRecordSet API + id: UpdateDnsRecordSetMetadata + properties: {} + Subnetwork: + id: Subnetwork properties: - 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. - pythonSettings: - $ref: '#/components/schemas/PythonSettings' - description: Settings for Python client libraries. - launchStage: - description: Launch stage of this version of the API. - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED + region: + description: GCP region where the subnetwork is located. 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. - restNumericEnums: + network: 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. - dotnetSettings: - description: Settings for .NET client libraries. - $ref: '#/components/schemas/DotnetSettings' - cppSettings: - $ref: '#/components/schemas/CppSettings' - description: Settings for C++ client libraries. - goSettings: - $ref: '#/components/schemas/GoSettings' - description: Settings for Go client libraries. - rubySettings: - description: Settings for Ruby client libraries. - $ref: '#/components/schemas/RubySettings' - version: + 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 + secondaryIpRanges: + description: List of secondary IP ranges in this subnetwork. + items: + $ref: '#/components/schemas/SecondaryIpRange' + type: array + ipCidrRange: + description: Subnetwork CIDR range in `10.x.x.x/y` format. type: string + outsideAllocation: 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". - description: Details about how and where to publish client libraries. - id: ClientLibrarySettings - UpdateDnsRecordSetRequest: + This is a discovered subnet that is not within the current consumer + allocated ranges. + type: boolean + name: + type: string + description: Subnetwork name. See https://cloud.google.com/compute/docs/vpc/ + type: object 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. + Represents a subnet that was created or discovered by a private access + management service. + ConsumerProject: + description: Represents a consumer project. + id: ConsumerProject + properties: + 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. + type: string + format: int64 + type: object + UpdateDnsRecordSetRequest: + id: UpdateDnsRecordSetRequest properties: newDnsRecordSet: - $ref: '#/components/schemas/DnsRecordSet' description: >- Required. The new values that the DNS record set should be updated to hold. - 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. + $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 from which the record set will be removed. existingDnsRecordSet: - description: Required. The existing DNS record set to update. $ref: '#/components/schemas/DnsRecordSet' - id: UpdateDnsRecordSetRequest + description: Required. The existing DNS record set to update. + 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. type: object - AuthRequirement: + ConsumerConfigMetadata: + description: >- + Metadata provided through GetOperation request for the LRO generated by + UpdateConsumerConfig API. type: object - id: AuthRequirement + id: ConsumerConfigMetadata + properties: {} + NodeSettings: + type: object + id: NodeSettings properties: - audiences: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + description: Settings for Node client libraries. + SystemParameter: + properties: + name: 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: + Define the name of the parameter, such as "api_key" . It is case + sensitive. + httpHeader: + description: >- + Define the HTTP header name to use for the parameter. It is case + insensitive. + type: string + urlQueryParameter: type: string description: >- - id from authentication provider. Example: provider_id: - bookstore_auth + Define the URL query parameter name to use for the parameter. It is + case sensitive. + 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). - SourceInfo: + 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 + ListDnsRecordSetsResponse: properties: - sourceFiles: + dnsRecordSets: + description: DNS record Set Resource items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - description: All files used during config generation. + $ref: '#/components/schemas/DnsRecordSet' type: array type: object - description: Source information used to create a Service Config - id: SourceInfo - RubySettings: - description: Settings for Ruby client libraries. - id: RubySettings - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. + id: ListDnsRecordSetsResponse + description: Represents all DNS RecordSets associated with the producer network + VpcServiceControls: type: object - UpdateConsumerConfigRequest: + description: Response for the get VPC Service Controls request. properties: - consumerConfig: - description: Required. The updated peering config. - $ref: '#/components/schemas/ConsumerConfig' - description: >- - Request to update the configuration of a service networking connection - including the import/export of custom routes and subnetwork routes with - public IP. - type: object - id: UpdateConsumerConfigRequest - Status: + enabled: + 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. + readOnly: true + type: boolean + id: VpcServiceControls + RemoveDnsZoneMetadata: + properties: {} type: object - id: Status + description: >- + Metadata provided through GetOperation request for the LRO generated by + RemoveDnsZone API + id: RemoveDnsZoneMetadata + Field: + description: A single field of a message type. properties: - code: + name: + type: string + description: The field name. + defaultValue: + type: string + description: >- + The string value of the default value of this field. Proto2 syntax + only. + options: + description: The protocol buffer options. + type: array + items: + $ref: '#/components/schemas/Option' + number: + description: The field number. format: int32 - description: The status code, which should be an enum value of google.rpc.Code. type: integer - message: + 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. + 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. + jsonName: + description: The field JSON name. + type: string + oneofIndex: + type: integer 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. + 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 + packed: + description: Whether to use alternative packed wire representation. + type: boolean + 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: The field cardinality. + type: string + typeUrl: type: string - 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 - 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). - CustomHttpPattern: + The field type URL, without the scheme, for message or enumeration + types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + type: object + id: Field + Publishing: properties: - kind: + organization: type: string - description: The name of this custom HTTP verb. - path: + description: For whom the client library is being published. + 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 + protoReferenceDocumentationUri: type: string - description: The path matched by this custom verb. - id: CustomHttpPattern - type: object - description: A custom pattern is used for defining custom HTTP verb. - DnsZone: - type: object - description: Represents a DNS zone resource. - properties: - 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 - dnsSuffix: + Optional link to proto reference documentation. Example: + https://cloud.google.com/pubsub/lite/docs/reference/rpc + restReferenceDocumentationUri: 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. - id: DnsZone - SystemParameterRule: - type: object - properties: - parameters: - type: array + Optional link to REST reference documentation. Example: + https://cloud.google.com/pubsub/lite/docs/reference/rest + methodSettings: 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. + A list of API method settings, e.g. the behavior for methods that + use the long-running operation pattern. items: - $ref: '#/components/schemas/SystemParameter' - selector: + $ref: '#/components/schemas/MethodSettings' + type: array + newIssueUri: 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. - id: SystemParameterRule - description: >- - Define a system parameter rule mapping system parameter definitions to - methods. - MetricDescriptor: - 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. - type: object - properties: - description: + Link to a *public* URI where users can report issues. Example: + https://issuetracker.google.com/issues/new?component=190865&template=1161103 + 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' + documentationUri: type: string description: >- - A detailed description of the metric, which can be used in - documentation. - monitoredResourceTypes: + Link to product home page. Example: + https://cloud.google.com/asset-inventory/docs/overview + codeownerGithubTeams: 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. - name: - description: The resource name of the metric descriptor. - type: string - displayName: - type: string + GitHub teams to be added to CODEOWNERS in the directory in GitHub + containing source code for the client libraries for this API. + apiShortName: 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. - metricKind: + 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 - 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. + docTagPrefix: 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: + A prefix used in sample code when demarking regions to be included + in documentation. 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" - 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 + githubLabel: 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. - 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"). + GitHub label to apply to issues and pull requests opened for this + API. + 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: Publishing + LabelDescriptor: + description: A description of a label. + id: LabelDescriptor + properties: + description: type: string - launchStage: + description: A human-readable description for the label. + key: + description: The label key. 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. - - >- - 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. + valueType: 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. - labels: + - STRING + - BOOL + - INT64 + description: The type of data that can be assigned to the label. + type: string + enumDescriptions: + - A variable-length string. This is the default. + - Boolean; true or false. + - A 64-bit signed integer. + type: object + LoggingDestination: + description: >- + Configuration of a specific logging destination (the producer project or + the consumer project). + type: object + id: LoggingDestination + properties: + monitoredResource: + 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. + The monitored resource type. The type must be defined in the + Service.monitored_resources section. + 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 + 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. + selector: + type: string + description: >- + Selects a method to which this rule applies. Refer to selector for + syntax details. + delete: + type: string + description: Maps to HTTP DELETE. Used for deleting a resource. + get: + type: string + description: >- + Maps to HTTP GET. Used for listing and getting information about + resources. + 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/LabelDescriptor' - LogDescriptor: + $ref: '#/components/schemas/HttpRule' + 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. + 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' + post: + type: string + description: >- + Maps to HTTP POST. Used for creating a resource or performing an + action. + 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. + 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. Example + below selects a gRPC method and applies 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 + id: HttpRule + ValidateConsumerConfigRequest: + id: ValidateConsumerConfigRequest + type: object properties: - 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: + rangeReservation: + $ref: '#/components/schemas/RangeReservation' description: >- - A human-readable description of this log. This information appears - in the documentation and can contain details. - type: string - displayName: - type: string + RANGES_EXHAUSTED, RANGES_EXHAUSTED, and RANGES_DELETED_LATER are + done when range_reservation is provided. + checkServiceNetworkingUsePermission: 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' - type: array + Optional. The IAM permission check determines whether the consumer + project has 'servicenetworking.services.use' permission or not. + type: boolean + consumerProject: + $ref: '#/components/schemas/ConsumerProject' 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: object - 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: - type: object - properties: - sourceContext: - description: The source context. - $ref: '#/components/schemas/SourceContext' - fields: - description: The list of fields. - type: array - items: - $ref: '#/components/schemas/Field' - edition: + NETWORK_NOT_IN_CONSUMERS_PROJECT, + NETWORK_NOT_IN_CONSUMERS_HOST_PROJECT, and HOST_PROJECT_NOT_FOUND + are done when consumer_project is provided. + validateNetwork: + type: boolean description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. - type: string - options: - items: - $ref: '#/components/schemas/Option' - description: The protocol buffer options. - type: array - syntax: - type: string - description: The source syntax. - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - oneofs: - items: - type: string - type: array - description: The list of types appearing in `oneof` definitions in this type. - name: + 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: The fully qualified message name. - description: A protocol buffer message type. - id: Type - 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: >- + 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. + Route: type: object properties: - 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 + nextHopGateway: type: string - 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 + 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` + destRange: type: string - id: + description: Destination CIDR range that this route applies to. + name: type: string - description: >- - The unique identifier of the auth provider. It will be referred to - by `AuthRequirement.provider_id`. Example: "bookstore_auth". - authorizationUrl: + description: Route name. See https://cloud.google.com/vpc/docs/routes + network: type: string description: >- - Redirect URL if JWT token is required but not present or is expired. - Implement authorizationUrl of securityDefinitions in OpenAPI spec. - jwtLocations: - items: - $ref: '#/components/schemas/JwtLocation' - 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 - 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: AuthProvider - VpcServiceControls: + 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` + description: >- + Represents a route that was created or discovered by a private access + management service. + id: Route + DeleteConnectionMetadata: + id: DeleteConnectionMetadata + description: >- + Metadata provided through GetOperation request for the LRO generated by + Delete Connection API + properties: {} + type: object + DisableVpcServiceControlsRequest: + description: Request to disable VPC service controls. type: object - id: VpcServiceControls - description: Response for the get VPC Service Controls request. - properties: - enabled: - 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 - DeleteConnectionRequest: 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. - id: DeleteConnectionRequest - description: >- - Request to delete a private service access connection. The call will - fail if there are any managed service instances using this connection. + number, as in '12345' {network} is network name. + type: string + id: DisableVpcServiceControlsRequest + Authentication: + id: Authentication type: object - SystemParameter: - id: SystemParameter + properties: + providers: + description: Defines a set of authentication providers that a service supports. + type: array + items: + $ref: '#/components/schemas/AuthProvider' + 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' 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. + `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 + DnsRecordSet: type: object properties: - httpHeader: - description: >- - Define the HTTP header name to use for the parameter. It is case - insensitive. - type: string - name: + type: + description: Required. The identifier of a supported record type. type: string + data: + type: array description: >- - Define the name of the parameter, such as "api_key" . It is case - sensitive. - urlQueryParameter: + 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: + 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: >- - Define the URL query parameter name to use for the parameter. It is - case sensitive. - GoSettings: - id: GoSettings - type: object - description: Settings for Go client libraries. - properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - DeleteConnectionMetadata: - id: DeleteConnectionMetadata - properties: {} - type: object - description: >- - Metadata provided through GetOperation request for the LRO generated by - Delete Connection API + Required. The period of time for which this RecordSet can be cached + by resolvers. + id: DnsRecordSet + description: Represents a DNS record set resource. EnumValue: - id: EnumValue type: object - description: Enum value definition. + id: EnumValue properties: - number: - description: Enum value number. - format: int32 - type: integer options: + type: array description: Protocol buffer options. items: $ref: '#/components/schemas/Option' - type: array + number: + description: Enum value number. + type: integer + format: int32 name: type: string description: Enum value name. - ConsumerConfig: - id: ConsumerConfig + description: Enum value definition. + SourceContext: type: object - description: Configuration information for a private service access connection. + id: SourceContext + description: >- + `SourceContext` represents information about the source of a protobuf + element, like the file in which it is defined. properties: - consumerExportSubnetRoutesWithPublicIp: - type: boolean + fileName: + type: string description: >- - Export subnet routes with public ip flag value for peering from - consumer to producer. - producerExportSubnetRoutesWithPublicIp: - type: boolean + The path-qualified name of the .proto file that contained the + associated protobuf element. For example: + `"google/protobuf/source_context.proto"`. + ListDnsZonesResponse: + description: >- + Represents all DNS zones in the shared producer host project and the + matching peering zones in the consumer project. + properties: + dnsZonePairs: + type: array description: >- - Export subnet routes with public ip flag value for peering from - producer to consumer. - reservedRanges: + All pairs of private DNS zones in the shared producer host project + and the matching peering zones in the consumer project.. items: - $ref: >- - #/components/schemas/GoogleCloudServicenetworkingV1ConsumerConfigReservedRange + $ref: '#/components/schemas/DnsZonePair' + id: ListDnsZonesResponse + type: object + Option: + id: Option + properties: + name: description: >- - Output only. The reserved ranges associated with this private - service access connection. + 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: + 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 + type: object + description: >- + A protocol buffer option, which can be attached to a message, field, + enumeration, etc. + 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 + properties: + consumerDestinations: + 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. + type: array + producerDestinations: + items: + $ref: '#/components/schemas/LoggingDestination' type: array - readOnly: true - producerExportCustomRoutes: description: >- - Export custom routes flag value for peering from producer to - consumer. - type: boolean - consumerImportSubnetRoutesWithPublicIp: - type: boolean + 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 + QuotaLimit: + type: object + properties: + 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 + 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 + 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 + 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 + duration: + type: string + description: >- + Duration of this limit in textual notation. Must be "100s" or "1d". + Used by group-based quotas only. + 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. + name: + type: string description: >- - Import subnet routes with public ip flag value for peering from - consumer to producer. - vpcScReferenceArchitectureEnabled: - type: boolean - readOnly: true + 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. + values: + type: object + additionalProperties: + type: string + format: int64 description: >- - Output only. Indicates whether the VPC Service Controls reference - architecture is configured for the producer VPC host network. - producerNetwork: + 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. + metric: 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 - consumerExportCustomRoutes: - description: >- - Export custom routes flag value for peering from consumer to - producer. - type: boolean - producerImportSubnetRoutesWithPublicIp: - type: boolean + 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: >- - Import subnet routes with public ip flag value for peering from - producer to consumer. - cloudsqlConfigs: + 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 + 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`. + id: QuotaLimit + ListPeeredDnsDomainsResponse: + description: Response to list peered DNS domains for a given connection. + properties: + peeredDnsDomains: type: array - description: Represents one or multiple Cloud SQL configurations. + description: The list of peered DNS domains. items: - $ref: '#/components/schemas/CloudSQLConfig' - consumerImportCustomRoutes: - type: boolean + $ref: '#/components/schemas/PeeredDnsDomain' + id: ListPeeredDnsDomainsResponse + 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: + metricCosts: + type: object description: >- - Import custom routes flag value for peering from consumer to - producer. - usedIpRanges: - description: Output only. The IP ranges already in use by consumer or producer - readOnly: true - type: array - items: + 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. + additionalProperties: + format: int64 type: string - producerImportCustomRoutes: + selector: description: >- - Import custom routes flag value for peering from producer to - consumer. - type: boolean - JwtLocation: - id: JwtLocation + Selects the methods to which this rule applies. Refer to selector + for syntax details. + type: string + id: MetricRule type: object - description: Specifies a location to extract JWT from an API request. + CancelOperationRequest: + description: The request message for Operations.CancelOperation. + type: object + id: CancelOperationRequest + properties: {} + AddDnsRecordSetMetadata: + id: AddDnsRecordSetMetadata + properties: {} + type: object + description: >- + Metadata provided through GetOperation request for the LRO generated by + AddDnsRecordSet API + RemoveDnsRecordSetResponse: + type: object + properties: {} + id: RemoveDnsRecordSetResponse + description: Blank message response type for RemoveDnsRecordSet API + GoogleCloudServicenetworkingV1betaConnection: + id: GoogleCloudServicenetworkingV1betaConnection properties: - valuePrefix: - type: string + network: 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: + 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: Specifies URL query parameter name to extract JWT token. - header: + reservedPeeringRanges: + type: array + items: + type: string + 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. + service: type: string - description: Specifies HTTP header name to extract JWT token. - cookie: + description: >- + Output only. The name of the peering service that's associated with + this connection, in the following format: `services/{service name}`. + peering: type: string - description: Specifies cookie name to extract JWT token. + description: >- + Output only. The name of the VPC Network Peering connection that was + created by the service producer. + 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. + type: object 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. properties: + 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 + 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: + type: string 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"`. + type: string type: type: string description: >- @@ -2801,355 +2560,394 @@ 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. - description: Optional. The launch stage of the monitored resource definition. - 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"`. - 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. - type: object - ValidateConsumerConfigResponse: - type: object - properties: - isValid: - type: boolean - description: Indicates whether all the requested validations passed. - validationError: - 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. + 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 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. + GA features are open to all developers and are considered stable + and fully qualified for production use. - >- - The consumer project does not have the permission from the host - project. + 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: Optional. The launch stage of the monitored resource definition. + id: MonitoredResourceDescriptor + type: object + CommonLanguageSettings: + id: CommonLanguageSettings + type: object + properties: + referenceDocsUri: 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 - description: The first validation which failed. - existingSubnetworkCandidates: + deprecated: true + description: >- + Link to automatically generated reference documentation. Example: + https://cloud.google.com/nodejs/docs/reference/asset/latest + destinations: type: array items: - $ref: '#/components/schemas/Subnetwork' + 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: >- - List of subnetwork candidates from the request which exist with the - `ip_cidr_range`, `secondary_ip_cider_ranges`, and - `outside_allocation` fields set. - id: ValidateConsumerConfigResponse - PolicyBinding: + The destination where API teams want this client library to be + published. + description: Required information for every language. + AddRolesRequest: properties: - member: + policyBinding: + description: Required. List of policy bindings to add to shared VPC host project. + items: + $ref: '#/components/schemas/PolicyBinding' + type: array + consumerNetwork: type: string 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: + 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: object + id: AddRolesRequest + description: >- + Request for AddRoles to allow Service Producers to add roles in the + shared VPC host project for them to use. + UsageRule: + properties: + 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: + 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: >- - 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/compute.xpnAdmin' 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 + Selects the methods to which this rule applies. Use '*' to indicate + all methods in all APIs. Refer to selector for syntax details. + 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: PolicyBinding - description: Grouping of IAM role and IAM member. - MethodSettings: + id: UsageRule + RemoveDnsZoneResponse: + id: RemoveDnsZoneResponse + description: Blank message response type for RemoveDnsZone API + properties: {} type: object + BillingDestination: 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' - autoPopulatedFields: + metrics: 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 + Names of the metrics to report to this billing destination. Each + name must be defined in Service.metrics section. + type: array items: type: string - type: array - 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... + monitoredResource: type: string - description: Describes the generator configuration for a method. - id: MethodSettings - Authentication: + description: >- + The monitored resource type. The type must be defined in + Service.monitored_resources section. + description: >- + Configuration of a specific billing destination (Currently only support + bill against consumer project). + type: object + id: BillingDestination + Page: + id: Page + type: object + description: >- + Represents a documentation page. A page can contain subpages to + represent nested documentation set structure. properties: - providers: + name: + 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`. + 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 + subpages: + description: >- + Subpages of this page. The order of subpages specified here will be + honored in the generated docset. items: - $ref: '#/components/schemas/AuthProvider' - type: array - description: Defines a set of authentication providers that a service supports. - rules: + $ref: '#/components/schemas/Page' type: array + JwtLocation: + properties: + header: + description: Specifies HTTP header name to extract JWT token. + type: string + cookie: + description: Specifies cookie name to extract JWT token. + type: string + valuePrefix: description: >- - A list of authentication rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - items: - $ref: '#/components/schemas/AuthenticationRule' - 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 - SourceContext: - description: >- - `SourceContext` represents information about the source of a protobuf - element, like the file in which it is defined. + 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. + description: Specifies a location to extract JWT from an API request. + id: JwtLocation type: object - id: SourceContext + MonitoringDestination: + type: object + id: MonitoringDestination properties: - fileName: + monitoredResource: type: string description: >- - The path-qualified name of the .proto file that contained the - associated protobuf element. For example: - `"google/protobuf/source_context.proto"`. - Operation: + 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. + items: + type: string + type: array + description: >- + Configuration of a specific monitoring destination (the producer project + or the consumer project). + GetDnsZoneResponse: + type: object + id: GetDnsZoneResponse properties: - name: + producerPrivateZone: + $ref: '#/components/schemas/DnsZone' + description: The private DNS zone created in the shared producer host project. + consumerPeeringZone: + $ref: '#/components/schemas/DnsZone' + description: The DNS peering zone created in the consumer project. + description: >- + Represents managed DNS zones created in the shared Producer host and + consumer projects. + DotnetSettings: + properties: + forcedNamespaceAliases: + 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}`. - type: string - done: + Namespaces which must be aliased in snippets due to a known (but + non-generator-predictable) naming collision + type: array + handwrittenSignatures: + items: + type: string 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 - metadata: + 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 + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + ignoredResources: 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. + 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: + type: string + type: array + renamedServices: type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - error: - $ref: '#/components/schemas/Status' description: >- - The error result of the operation in case of failure or - cancellation. - response: - 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. additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. + type: string + renamedResources: + 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`. - description: >- - This resource represents a long-running operation that is the result of - a network API call. + 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. type: object - id: Operation - UsageRule: + id: DotnetSettings + Status: 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 + 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: - 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. - allowUnregisteredCalls: - type: boolean + details: + items: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: array description: >- - If true, the selected method allows unregistered calls, e.g. calls - that don't identify any user or application. - skipServiceControl: - type: boolean + 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 + message: + type: string 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. + 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: Status + SecondaryIpRangeSpec: type: object - id: UsageRule - CommonLanguageSettings: - id: CommonLanguageSettings properties: - destinations: + requestedAddress: 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: - deprecated: true + 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. + type: string + rangeName: type: string description: >- - Link to automatically generated reference documentation. Example: - https://cloud.google.com/nodejs/docs/reference/asset/latest - description: Required information for every language. - type: object - AddDnsZoneResponse: - description: >- - Represents managed DNS zones created in the shared producer host and - consumer projects. - id: AddDnsZoneResponse + 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: + 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. + type: integer + format: int32 + 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. + id: SecondaryIpRangeSpec + AddRolesResponse: type: object + id: AddRolesResponse properties: - consumerPeeringZone: - description: The DNS peering zone created in the consumer project. - $ref: '#/components/schemas/DnsZone' - producerPrivateZone: - $ref: '#/components/schemas/DnsZone' - description: The private DNS zone created in the shared producer host project. - GoogleCloudServicenetworkingV1ConsumerConfigReservedRange: - description: Allocated IP address ranges for this private service access connection. + policyBinding: + description: >- + Required. List of policy bindings that were added to the shared VPC + host project. + type: array + items: + $ref: '#/components/schemas/PolicyBinding' + description: Represents IAM roles added to the shared VPC host project. + DeleteConnectionRequest: type: object - id: GoogleCloudServicenetworkingV1ConsumerConfigReservedRange + id: DeleteConnectionRequest + description: >- + Request to delete a private service access connection. The call will + fail if there are any managed service instances using this connection. properties: - address: + consumerNetwork: 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: - format: int32 - type: integer - description: The prefix length of the reserved range. - name: + 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: The name of the reserved range. - AddDnsRecordSetRequest: - id: AddDnsRecordSetRequest + 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: + 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. + id: Billing + 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. + type: object properties: consumerNetwork: type: string @@ -3158,928 +2956,1142 @@ components: 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. - dnsRecordSet: - description: Required. The DNS record set to add. - $ref: '#/components/schemas/DnsRecordSet' - zone: - type: string + name: description: >- - Required. The name of the private DNS zone in the shared producer - host project to which the record set will be added. - description: >- - Request to add a record set to a private managed DNS zone in the shared - producer host project. + Required. The name for both the private zone in the shared producer + host project and the peering zone in the consumer project. + type: string + id: RemoveDnsZoneRequest + Documentation: + id: Documentation type: object - GoogleCloudServicenetworkingV1betaConnection: - id: GoogleCloudServicenetworkingV1betaConnection properties: - network: + pages: + type: array + items: + $ref: '#/components/schemas/Page' + description: The top level pages for the documentation set. + overview: 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: + 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: type: string description: >- - Output only. The name of the peering service that's associated with - this connection, in the following format: `services/{service name}`. - reservedPeeringRanges: + 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`. + sectionOverrides: items: - type: string + $ref: '#/components/schemas/Page' 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. + Specifies section and content to override boilerplate content + provided by go/api-docgen. Currently overrides following sections: + 1. rest.service.client_libraries type: array - peering: - type: string - description: >- - Output only. The name of the VPC Network Peering connection that was - created by the service producer. - 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. - NodeSettings: - type: object - properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - id: NodeSettings - description: Settings for Node client libraries. - OAuthRequirements: - properties: - canonicalScopes: + documentationRootUrl: type: string + description: The URL to the root of documentation. + rules: 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 - 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 - 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 - 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: + 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/LoggingDestination' + $ref: '#/components/schemas/DocumentationRule' + serviceRootUrl: 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. - id: Logging - type: object - SecondaryIpRangeSpec: - properties: - rangeName: + 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 - 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: - 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 - requestedAddress: + 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. + AddRolesMetadata: + id: AddRolesMetadata + properties: {} + description: >- + Metadata provided through GetOperation request for the LRO generated by + AddRoles API + type: object + AddDnsRecordSetRequest: + description: >- + Request to add a record set to a private managed DNS zone in the shared + producer host project. + id: AddDnsRecordSetRequest + type: object + properties: + zone: 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. - outsideAllocationPublicIpRange: + Required. The name of the private DNS zone in the shared producer + host project to which the record set will be added. + dnsRecordSet: + description: Required. The DNS record set to add. + $ref: '#/components/schemas/DnsRecordSet' + consumerNetwork: 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. + 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. + CppSettings: type: object - id: SecondaryIpRangeSpec - RemoveDnsZoneMetadata: + id: CppSettings + description: Settings for C++ client libraries. + properties: + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + PythonSettings: type: object - properties: {} - description: >- - Metadata provided through GetOperation request for the LRO generated by - RemoveDnsZone API - id: RemoveDnsZoneMetadata - Context: + description: Settings for Python client libraries. + properties: + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + id: PythonSettings + ListConnectionsResponse: + id: ListConnectionsResponse + properties: + connections: + items: + $ref: '#/components/schemas/Connection' + description: The list of Connections. + type: array 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. + ListConnectionsResponse is the response to list peering states for the + given service and consumer project. + ValidateConsumerConfigResponse: properties: - rules: - items: - $ref: '#/components/schemas/ContextRule' + isValid: + type: boolean + description: Indicates whether all the requested validations passed. + validationError: + description: The first validation which failed. + 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 + existingSubnetworkCandidates: description: >- - A list of RPC context rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. + 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 - id: Context - AddRolesRequest: + items: + $ref: '#/components/schemas/Subnetwork' + type: object + id: ValidateConsumerConfigResponse + Quota: properties: - policyBinding: + limits: type: array - description: Required. List of policy bindings to add to shared VPC host project. + description: List of QuotaLimit definitions for the service. items: - $ref: '#/components/schemas/PolicyBinding' - consumerNetwork: - type: string + $ref: '#/components/schemas/QuotaLimit' + metricRules: + items: + $ref: '#/components/schemas/MetricRule' 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. - type: object - id: AddRolesRequest - AddDnsRecordSetMetadata: + List of MetricRule definitions, each one mapping a selected method + to one or more metrics. + type: array + id: Quota type: object - properties: {} - id: AddDnsRecordSetMetadata description: >- - Metadata provided through GetOperation request for the LRO generated by - AddDnsRecordSet API - Api: + 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 + SourceInfo: + id: SourceInfo type: object - 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. properties: - version: + sourceFiles: + type: array + description: All files used during config generation. + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + description: Source information used to create a Service Config + SystemParameterRule: + properties: + selector: 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: + Selects the methods to which this rule applies. Use '*' to indicate + all methods in all APIs. Refer to selector for syntax details. + parameters: description: >- - The fully qualified name of this interface, including package name - followed by the interface's simple name. + 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' + type: object + id: SystemParameterRule + description: >- + Define a system parameter rule mapping system parameter definitions to + methods. + ListOperationsResponse: + description: The response message for Operations.ListOperations. + properties: + nextPageToken: + description: The standard List next-page token. type: string - mixins: + operations: items: - $ref: '#/components/schemas/Mixin' + $ref: '#/components/schemas/Operation' type: array - description: Included interfaces. See Mixin. - methods: - description: The methods of this interface, in unspecified order. + description: >- + A list of operations that matches the specified filter in the + request. + id: ListOperationsResponse + type: object + ConsumerConfig: + description: Configuration information for a private service access connection. + type: object + properties: + consumerExportCustomRoutes: + type: boolean + description: >- + Export custom routes flag value for peering from consumer to + producer. + 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 + cloudsqlConfigs: + description: Represents one or multiple Cloud SQL configurations. type: array items: - $ref: '#/components/schemas/Method' - syntax: - type: string - description: The source syntax of the service. - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - options: + $ref: '#/components/schemas/CloudSQLConfig' + consumerImportSubnetRoutesWithPublicIp: + type: boolean + description: >- + Import subnet routes with public ip flag value for peering from + consumer to producer. + vpcScReferenceArchitectureEnabled: + readOnly: true + description: >- + Output only. Indicates whether the VPC Service Controls reference + architecture is configured for the producer VPC host network. + type: boolean + consumerImportCustomRoutes: + type: boolean + description: >- + Import custom routes flag value for peering from consumer to + producer. + producerImportSubnetRoutesWithPublicIp: + description: >- + Import subnet routes with public ip flag value for peering from + producer to consumer. + type: boolean + producerExportSubnetRoutesWithPublicIp: + type: boolean + description: >- + Export subnet routes with public ip flag value for peering from + producer to consumer. + producerExportCustomRoutes: + type: boolean + description: >- + Export custom routes flag value for peering from producer to + consumer. + producerImportCustomRoutes: + type: boolean + description: >- + Import custom routes flag value for peering from producer to + consumer. + usedIpRanges: + description: Output only. The IP ranges already in use by consumer or producer type: array - description: Any metadata attached to the interface. + readOnly: true items: - $ref: '#/components/schemas/Option' - sourceContext: - $ref: '#/components/schemas/SourceContext' + type: string + consumerExportSubnetRoutesWithPublicIp: description: >- - Source context for the protocol buffer service represented by this - message. + Export subnet routes with public ip flag value for peering from + consumer to producer. + type: boolean + reservedRanges: + items: + $ref: >- + #/components/schemas/GoogleCloudServicenetworkingV1ConsumerConfigReservedRange + readOnly: true + type: array + description: >- + Output only. The reserved ranges associated with this private + service access connection. + id: ConsumerConfig 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: 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 + ipCidrRange: + type: string + description: >- + CIDR range in "10.x.x.x/y" format that is within the allocated + ranges and currently unused. type: object - id: Range description: Represents a found unused range. - SearchRangeRequest: - description: Request to search for an unused range within allocated ranges. + id: Range + BackendRule: properties: - ipPrefixLength: - 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 - type: integer - network: + selector: 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 - id: SearchRangeRequest - type: object - Mixin: - type: object - properties: - name: - description: The fully qualified name of the interface which is included. - type: string - root: + Selects the methods to which this rule applies. Refer to selector + for syntax details. 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 + type: string + enum: + - PATH_TRANSLATION_UNSPECIFIED + - CONSTANT_ADDRESS + - APPEND_PATH_TO_ADDRESS + jwtAudience: description: >- - If non-empty specifies a path under which inherited HTTP paths are - rooted. - id: 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"; } ... } - Billing: - 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. - type: array - items: - $ref: '#/components/schemas/BillingDestination' - 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 - ListPeeredDnsDomainsResponse: - 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. - type: object - id: ListPeeredDnsDomainsResponse - CancelOperationRequest: - type: object - id: CancelOperationRequest - description: The request message for Operations.CancelOperation. - properties: {} - Backend: - type: object - id: Backend - 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: + 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 + 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 + 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. + 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 + 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. + overridesByRequestProtocol: + description: The map between request protocol and the backend address. + type: object + additionalProperties: $ref: '#/components/schemas/BackendRule' - description: '`Backend` defines the backend configuration for a service.' - AddRolesMetadata: - id: AddRolesMetadata - properties: {} + minDeadline: + format: double + deprecated: true + type: number + description: Deprecated, do not use. type: object - description: >- - Metadata provided through GetOperation request for the LRO generated by - AddRoles API - ContextRule: - description: >- - A context rule provides information about the context for an individual - API element. + id: BackendRule + description: A backend rule provides configuration for an individual API element. + DnsZonePair: + 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. + description: '* Represents a pair of private and peering DNS zone resources. *' + id: DnsZonePair type: object - id: ContextRule + Usage: properties: - selector: - type: string - description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - allowedResponseExtensions: - type: array + requirements: description: >- - A list of full type names or extension IDs of extensions allowed in - grpc side channel from backend to client. + 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 - 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 - provided: - description: A list of full type names of provided contexts. + rules: type: array items: - type: string - requested: - items: - type: string - description: A list of full type names of requested contexts. - type: array - Subnetwork: + $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. + 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 type: object - id: Subnetwork + description: Configuration controlling usage of a service. + id: Usage + OAuthRequirements: + id: OAuthRequirements properties: - 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 - network: + canonicalScopes: 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 - region: - description: GCP region where the subnetwork is located. + 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 - 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. description: >- - Represents a subnet that was created or discovered by a private access - management service. - GetDnsZoneResponse: - id: GetDnsZoneResponse + 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 + AddDnsZoneResponse: + type: object description: >- - Represents managed DNS zones created in the shared Producer host and + Represents managed DNS zones created in the shared producer host and consumer projects. - type: object + id: AddDnsZoneResponse properties: consumerPeeringZone: - $ref: '#/components/schemas/DnsZone' 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' - MonitoringDestination: - description: >- - Configuration of a specific monitoring destination (the producer project - or the consumer project). - id: MonitoringDestination + description: The private DNS zone created in the shared producer host project. + RubySettings: properties: - monitoredResource: - type: string - description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. - metrics: - type: array + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + type: object + id: RubySettings + description: Settings for Ruby client libraries. + Http: + properties: + rules: items: - type: string + $ref: '#/components/schemas/HttpRule' + type: array description: >- - Types of the metrics to report to this monitoring destination. Each - type must be defined in Service.metrics section. + 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. + 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 - Enum: - description: Enum type definition. - id: Enum + Endpoint: properties: - enumvalue: - description: Enum value definitions. - type: array - items: - $ref: '#/components/schemas/EnumValue' name: type: string - description: Enum type name. - sourceContext: - $ref: '#/components/schemas/SourceContext' - description: The source context. - options: - type: array + description: The canonical name of this endpoint. + aliases: items: - $ref: '#/components/schemas/Option' - description: Protocol buffer options. - syntax: - type: string - description: The source syntax. - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - edition: - type: string + type: string description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. - type: object - ValidateConsumerConfigRequest: - id: ValidateConsumerConfigRequest - properties: - consumerProject: + 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 + target: 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: + 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 - 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. - 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. + allowCors: type: boolean - rangeReservation: - $ref: '#/components/schemas/RangeReservation' - description: >- - RANGES_EXHAUSTED, RANGES_EXHAUSTED, and RANGES_DELETED_LATER are - done when range_reservation is provided. - checkServiceNetworkingUsePermission: description: >- - Optional. The IAM permission check determines whether the consumer - project has 'servicenetworking.services.use' permission or not. - type: boolean + 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: 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 + 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)). type: object - GoogleCloudServicenetworkingV1betaSubnetwork: - id: GoogleCloudServicenetworkingV1betaSubnetwork properties: - name: - description: Subnetwork name. See https://cloud.google.com/compute/docs/vpc/ + initialPollDelay: type: string - outsideAllocation: - type: boolean + format: google-duration 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. + Initial delay after which the first poll request will be made. + Default value: 5 seconds. + maxPollDelay: + format: google-duration type: string - network: + description: >- + 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 + pollDelayMultiplier: + type: number 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 subnet that was created or discovered by a private access - management service. - type: object - Option: + Multiplier to gradually increase delay between subsequent polls + until it reaches max_poll_delay. Default value: 1.5. + format: float + id: LongRunning + MethodPolicy: type: object - id: Option properties: - 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"`. - value: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. + selector: 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 - description: >- - A protocol buffer option, which can be attached to a message, field, - enumeration, etc. - ListDnsRecordSetsResponse: + 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: + type: array + items: + $ref: '#/components/schemas/FieldPolicy' + description: Policies that are applicable to the request message. + id: MethodPolicy + description: Defines policies applying to an RPC method. + Connection: + id: Connection type: object properties: - dnsRecordSets: + reservedPeeringRanges: items: - $ref: '#/components/schemas/DnsRecordSet' - description: DNS record Set Resource + type: string type: array - id: ListDnsRecordSetsResponse - description: Represents all DNS RecordSets associated with the producer network - Route: - type: object - id: Route - description: >- - Represents a route that was created or discovered by a private access - management service. - properties: - name: - type: string - description: Route name. See https://cloud.google.com/vpc/docs/routes - nextHopGateway: - type: string 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` + 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: + 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 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` - destRange: - type: string - description: Destination CIDR range that this route applies to. - PartialDeleteConnectionMetadata: - description: >- - Metadata provided through GetOperation request for the LRO generated by - Partial Delete Connection API - id: PartialDeleteConnectionMetadata - type: object - properties: {} - ListConnectionsResponse: - type: object - properties: - connections: - type: array - items: - $ref: '#/components/schemas/Connection' - description: The list of Connections. - id: ListConnectionsResponse + 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 description: >- - ListConnectionsResponse is the response to list peering states for the - given service and consumer project. - Field: - type: object - description: A single field of a message type. + 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. + MetricDescriptor: + 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. properties: - jsonName: - description: The field JSON name. + name: type: string - kind: + description: The resource name of the metric descriptor. + type: type: string - description: The field 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" + 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. 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. + - 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. 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 - number: - format: int32 - type: integer - description: The field number. - cardinality: + - METRIC_KIND_UNSPECIFIED + - GAUGE + - DELTA + - CUMULATIVE + 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. + description: Optional. The launch stage of the metric definition. enum: - - CARDINALITY_UNKNOWN - - CARDINALITY_OPTIONAL - - CARDINALITY_REQUIRED - - CARDINALITY_REPEATED - description: The field cardinality. + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + type: string + 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"). + metadata: + description: Optional. Metadata which can be used to guide usage of the metric. + $ref: '#/components/schemas/MetricDescriptorMetadata' + 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 + valueType: + enum: + - VALUE_TYPE_UNSPECIFIED + - BOOL + - INT64 + - DOUBLE + - STRING + - DISTRIBUTION + - 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 enumDescriptions: - - For fields with unknown cardinality. - - For optional fields. - - For required fields. Proto2 syntax only. - - For repeated fields. - typeUrl: + - 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: + description: >- + A detailed description of the metric, which can be used in + documentation. type: string + labels: + items: + $ref: '#/components/schemas/LabelDescriptor' + type: array description: >- - The field type URL, without the scheme, for message or enumeration - types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. - options: - description: The protocol buffer options. + 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. + monitoredResourceTypes: items: - $ref: '#/components/schemas/Option' + type: string type: array - defaultValue: - type: string - description: >- - The string value of the default value of this field. Proto2 syntax - only. - 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 - id: Field - DeletePeeredDnsDomainMetadata: + 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: object + AuthProvider: description: >- - Metadata provided through GetOperation request for the LRO generated by - DeletePeeredDnsDomain API. - properties: {} - id: DeletePeeredDnsDomainMetadata - DocumentationRule: - description: A documentation rule provides information about individual API elements. + Configuration for an authentication provider, including support for + [JSON Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + id: AuthProvider type: object properties: - disableReplacementWords: + jwksUri: 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 - deprecationDescription: + 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 + issuer: description: >- - Deprecation description of the selected element(s). It can be - provided if an element is marked as `deprecated`. - selector: + 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 + authorizationUrl: 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: + Redirect URL if JWT token is required but not present or is expired. + Implement authorizationUrl of securityDefinitions in OpenAPI spec. + audiences: 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. - id: DocumentationRule - 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. - id: Http - properties: - fullyDecodeReservedExpansion: - type: boolean + 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 + jwtLocations: 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: + 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 - description: >- - 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' - CppSettings: - properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - id: CppSettings + $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 + AddDnsZoneMetadata: + properties: {} + description: >- + Metadata provided through GetOperation request for the LRO generated by + AddDnsZone API type: object - description: Settings for C++ client libraries. - CloudSQLConfig: + id: AddDnsZoneMetadata + Backend: + description: '`Backend` defines the backend configuration for a service.' type: object + id: Backend properties: - service: - description: Peering service used for peering with the Cloud SQL project. - type: string - umbrellaProject: - format: int64 - description: The project number of the Cloud SQL umbrella project. - type: string - umbrellaNetwork: - description: The name of the umbrella network in the Cloud SQL umbrella project. - type: string - description: Cloud SQL configuration. - id: CloudSQLConfig - FieldPolicy: + 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' + Operation: + id: Operation 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. - id: FieldPolicy + This resource represents a long-running operation that is the result of + a network API call. properties: - resourceType: - type: string + response: description: >- - Specifies the resource type for the resource referred to by the - field. - resourcePermission: + 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 + error: 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". - selector: + 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: >- - 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 + 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 + type: object + PartialDeleteConnectionMetadata: + type: object + properties: {} + id: PartialDeleteConnectionMetadata + description: >- + Metadata provided through GetOperation request for the LRO generated by + Partial Delete Connection API + CustomErrorRule: + description: A custom error rule. + id: CustomErrorRule type: object + properties: + selector: + type: string + description: >- + Selects messages to which this rule applies. Refer to selector for + syntax details. + 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 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"). + in: query + name: upload_protocol + schema: + type: string quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -4104,42 +4116,27 @@ components: name: key schema: type: string - 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 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 callback: description: JSONP in: query 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' alt: description: Data format for response. in: query @@ -4150,61 +4147,65 @@ components: - json - media - proto - _.xgafv: - description: V1 error format. + access_token: + description: OAuth access token. in: query - name: $.xgafv + 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 x-stackQL-resources: - services: - id: servicenetworking.services - name: services - title: Services + dns_zones: + id: google.servicenetworking.dns_zones + name: dns_zones + title: Dns_zones methods: - disable_vpc_service_controls: + add: operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}:disableVpcServiceControls/patch + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsZones:add/post' response: mediaType: application/json openAPIDocKey: '200' - validate: + remove: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}:validate/post' + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsZones:remove/post' response: mediaType: application/json openAPIDocKey: '200' - search_range: + get: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}:searchRange/post' + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1dnsZones~1{dnsZonesId}/get response: mediaType: application/json openAPIDocKey: '200' - enable_vpc_service_controls: + list: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}:enableVpcServiceControls/patch + #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1dnsZones:list/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/dns_zones/methods/get' + - $ref: '#/components/x-stackQL-resources/dns_zones/methods/list' insert: [] update: [] delete: [] - services_subnetwork: - id: servicenetworking.services_subnetwork - name: services_subnetwork - title: Services_subnetwork + roles: + id: google.servicenetworking.roles + name: roles + title: Roles methods: - add_subnetwork: + add: operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}:addSubnetwork/post + $ref: '#/paths/~1v1~1services~1{servicesId}~1roles:add/post' response: mediaType: application/json openAPIDocKey: '200' @@ -4213,94 +4214,110 @@ components: insert: [] update: [] delete: [] - connections: - id: servicenetworking.connections - name: connections - title: Connections + dns_record_set: + id: google.servicenetworking.dns_record_set + name: dns_record_set + title: Dns_record_set methods: - patch: + get: operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1connections~1{connectionsId}/patch + $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: [] + delete: [] + dns_record_sets: + id: google.servicenetworking.dns_record_sets + name: dns_record_sets + title: Dns_record_sets + methods: + add: + operation: + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:add/post' response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1connections/get' + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:list/get' response: mediaType: application/json openAPIDocKey: '200' - create: + update: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1connections/post' + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:update/post' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/connections/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/connections/methods/create' - update: [] - delete: [] - connections_connection: - id: servicenetworking.connections_connection - name: connections_connection - title: Connections_connection - methods: - delete_connection: + remove: operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1connections~1{connectionsId}/post + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:remove/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/dns_record_sets/methods/list' insert: [] - update: [] + update: + - $ref: '#/components/x-stackQL-resources/dns_record_sets/methods/update' delete: [] - dns_zones: - id: servicenetworking.dns_zones - name: dns_zones - title: Dns_zones + connections: + id: google.servicenetworking.connections + name: connections + title: Connections methods: - remove: + list: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsZones:remove/post' + $ref: '#/paths/~1v1~1services~1{servicesId}~1connections/get' response: mediaType: application/json openAPIDocKey: '200' - add: + create: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsZones:add/post' + $ref: '#/paths/~1v1~1services~1{servicesId}~1connections/post' response: mediaType: application/json openAPIDocKey: '200' - get: + patch: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1dnsZones~1{dnsZonesId}/get + #/paths/~1v1~1services~1{servicesId}~1connections~1{connectionsId}/patch response: mediaType: application/json openAPIDocKey: '200' - list: + sqlVerbs: + 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' + delete: [] + connections_connection: + id: google.servicenetworking.connections_connection + name: connections_connection + title: Connections_connection + methods: + delete_connection: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1dnsZones:list/get + #/paths/~1v1~1services~1{servicesId}~1connections~1{connectionsId}/post 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' + select: [] insert: [] update: [] delete: [] networks_vpc_service_controls: - id: servicenetworking.networks_vpc_service_controls + id: google.servicenetworking.networks_vpc_service_controls name: networks_vpc_service_controls title: Networks_vpc_service_controls methods: @@ -4318,50 +4335,50 @@ components: insert: [] update: [] delete: [] - networks_consumer_config: - id: servicenetworking.networks_consumer_config - name: networks_consumer_config - title: Networks_consumer_config + networks: + id: google.servicenetworking.networks + name: networks + title: Networks methods: - update_consumer_config: + get: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}:updateConsumerConfig/patch + #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/networks/methods/get' insert: [] update: [] delete: [] - networks: - id: servicenetworking.networks - name: networks - title: Networks + networks_consumer_config: + id: google.servicenetworking.networks_consumer_config + name: networks_consumer_config + title: Networks_consumer_config methods: - get: + update_consumer_config: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}/get + #/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/networks/methods/get' + select: [] insert: [] update: [] delete: [] peered_dns_domains: - id: servicenetworking.peered_dns_domains + id: google.servicenetworking.peered_dns_domains name: peered_dns_domains title: Peered_dns_domains methods: - 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' @@ -4372,10 +4389,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - create: + delete: 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~1{peeredDnsDomainsId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -4387,66 +4404,51 @@ components: update: [] delete: - $ref: '#/components/x-stackQL-resources/peered_dns_domains/methods/delete' - dns_record_set: - id: servicenetworking.dns_record_set - name: dns_record_set - title: Dns_record_set + services_subnetwork: + id: google.servicenetworking.services_subnetwork + name: services_subnetwork + title: Services_subnetwork methods: - get: + add_subnetwork: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:get/get' + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}:addSubnetwork/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/dns_record_set/methods/get' + select: [] insert: [] update: [] delete: [] - dns_record_sets: - id: servicenetworking.dns_record_sets - name: dns_record_sets - title: Dns_record_sets + services: + id: google.servicenetworking.services + name: services + title: Services methods: - update: - operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:update/post' - response: - mediaType: application/json - openAPIDocKey: '200' - remove: + search_range: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:remove/post' + $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}~1dnsRecordSets:list/get' + $ref: >- + #/paths/~1v1~1services~1{servicesId}:enableVpcServiceControls/patch response: mediaType: application/json openAPIDocKey: '200' - add: + disable_vpc_service_controls: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:add/post' + $ref: >- + #/paths/~1v1~1services~1{servicesId}:disableVpcServiceControls/patch response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/dns_record_sets/methods/list' - insert: [] - update: [] - delete: [] - roles: - id: servicenetworking.roles - name: roles - title: Roles - methods: - add: + validate: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1roles:add/post' + $ref: '#/paths/~1v1~1services~1{servicesId}:validate/post' response: mediaType: application/json openAPIDocKey: '200' @@ -4456,7 +4458,7 @@ components: update: [] delete: [] operations: - id: servicenetworking.operations + id: google.servicenetworking.operations name: operations title: Operations methods: @@ -4476,48 +4478,51 @@ components: list: operation: *ref_1 response: *ref_2 - get: + delete: operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}/get' + $ref: '#/paths/~1v1~1operations~1{operationsId}/delete' 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' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' paths: - /v1/services/{servicesId}:disableVpcServiceControls: + /v1/services/{servicesId}/dnsZones:add: parameters: &ref_3 + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/_.xgafv' - patch: - description: Disables VPC service controls for a connection. - operationId: servicenetworking.services.disableVpcServiceControls + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/prettyPrint' + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/DisableVpcServiceControlsRequest' + $ref: '#/components/schemas/AddDnsZoneRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4540,21 +4545,19 @@ paths: required: true schema: type: string - /v1/services/{servicesId}:validate: + /v1/services/{servicesId}/dnsZones:remove: parameters: *ref_3 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 @@ -4570,31 +4573,27 @@ 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/services/{servicesId}/roles:add: parameters: *ref_3 post: 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 + 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/AddSubnetworkRequest' + $ref: '#/components/schemas/AddRolesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4617,32 +4616,64 @@ paths: required: true schema: type: string + /v1/services/{servicesId}/dnsRecordSets:get: + parameters: *ref_3 + 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 + 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/DnsRecordSet' + parameters: - in: path - name: servicesId1 + name: servicesId required: true schema: type: string - - in: path - name: servicesId2 - required: true + - in: query + name: domain schema: type: string - /v1/services/{servicesId}:searchRange: + - in: query + name: type + schema: + type: string + - in: query + name: zone + schema: + type: string + - in: query + name: consumerNetwork + schema: + type: string + /v1/services/{servicesId}/dnsRecordSets:add: parameters: *ref_3 post: 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 + 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/SearchRangeRequest' + $ref: '#/components/schemas/AddDnsRecordSetRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4665,16 +4696,14 @@ paths: required: true schema: type: string - /v1/services/{servicesId}:enableVpcServiceControls: + /v1/services/{servicesId}/dnsRecordSets:list: parameters: *ref_3 - patch: - description: Enables VPC service controls for a connection. - operationId: servicenetworking.services.enableVpcServiceControls - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/EnableVpcServiceControlsRequest' + 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 @@ -4690,23 +4719,33 @@ 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}/connections/{connectionsId}: + - in: query + name: zone + schema: + type: string + - in: query + name: consumerNetwork + schema: + type: string + /v1/services/{servicesId}/dnsRecordSets:update: parameters: *ref_3 - patch: - description: Updates the allocated ranges that are assigned to a connection. - operationId: servicenetworking.services.connections.patch + 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 requestBody: content: application/json: schema: - $ref: '#/components/schemas/Connection' + $ref: '#/components/schemas/UpdateDnsRecordSetRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4729,28 +4768,18 @@ paths: 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 - schema: - type: string - format: google-fieldmask + /v1/services/{servicesId}/dnsRecordSets:remove: + parameters: *ref_3 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 @@ -4773,11 +4802,6 @@ paths: required: true schema: type: string - - in: path - name: connectionsId - required: true - schema: - type: string /v1/services/{servicesId}/connections: parameters: *ref_3 get: @@ -4848,19 +4872,16 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/dnsZones:remove: + /v1/services/{servicesId}/connections/{connectionsId}: parameters: *ref_3 - 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: Updates the allocated ranges that are assigned to a connection. + operationId: servicenetworking.services.connections.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/RemoveDnsZoneRequest' + $ref: '#/components/schemas/Connection' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4883,19 +4904,28 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/dnsZones:add: - parameters: *ref_3 + - 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 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 + description: Deletes a private service access connection. + operationId: servicenetworking.services.connections.deleteConnection requestBody: content: application/json: schema: - $ref: '#/components/schemas/AddDnsZoneRequest' + $ref: '#/components/schemas/DeleteConnectionRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4918,6 +4948,11 @@ paths: required: true schema: type: string + - in: path + name: connectionsId + required: true + schema: + type: string /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/vpcServiceControls: parameters: *ref_3 get: @@ -4958,19 +4993,14 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}:updateConsumerConfig: + /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}: parameters: *ref_3 - patch: + get: description: >- - Service producers use this method to update the configuration of their + 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.updateConsumerConfig - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateConsumerConfigRequest' + operationId: servicenetworking.services.projects.global.networks.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4986,7 +5016,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/ConsumerConfig' parameters: - in: path name: servicesId @@ -5003,14 +5033,23 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}: + - in: query + name: includeUsedIpRanges + schema: + type: boolean + /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}:updateConsumerConfig: parameters: *ref_3 - get: + patch: description: >- - Service producers use this method to get the configuration of their + 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.get + 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 @@ -5026,7 +5065,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ConsumerConfig' + $ref: '#/components/schemas/Operation' parameters: - in: path name: servicesId @@ -5043,16 +5082,20 @@ paths: required: true schema: type: string - - in: query - name: includeUsedIpRanges - schema: - type: boolean - /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/peeredDnsDomains/{peeredDnsDomainsId}: + /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/peeredDnsDomains: parameters: *ref_3 - delete: - description: Deletes a peered DNS domain. + post: + description: >- + Creates a peered DNS domain which sends requests for records in given + namespace originating in the service producer VPC network to the + consumer VPC network to be resolved. operationId: >- - servicenetworking.services.projects.global.networks.peeredDnsDomains.delete + servicenetworking.services.projects.global.networks.peeredDnsDomains.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PeeredDnsDomain' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5085,13 +5128,6 @@ paths: required: true schema: type: string - - in: path - name: peeredDnsDomainsId - required: true - schema: - type: string - /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/peeredDnsDomains: - parameters: *ref_3 get: description: Lists peered DNS domains for a connection. operationId: >- @@ -5128,18 +5164,12 @@ paths: required: true schema: type: string - post: - description: >- - Creates a peered DNS domain which sends requests for records in given - namespace originating in the service producer VPC network to the - consumer VPC network to be resolved. + /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/peeredDnsDomains/{peeredDnsDomainsId}: + parameters: *ref_3 + delete: + description: Deletes a peered DNS domain. operationId: >- - servicenetworking.services.projects.global.networks.peeredDnsDomains.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PeeredDnsDomain' + servicenetworking.services.projects.global.networks.peeredDnsDomains.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5172,6 +5202,11 @@ 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_3 get: @@ -5257,14 +5292,24 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/dnsRecordSets:get: + /v1/services/{servicesId}/{servicesId1}/{servicesId2}:addSubnetwork: parameters: *ref_3 - 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 + 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' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5280,41 +5325,39 @@ 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: domain - schema: - type: string - - in: query - name: consumerNetwork - schema: - type: string - - in: query - name: zone + - in: path + name: servicesId1 + required: true schema: type: string - - in: query - name: type + - in: path + name: servicesId2 + required: true schema: type: string - /v1/services/{servicesId}/dnsRecordSets:update: + /v1/services/{servicesId}:searchRange: parameters: *ref_3 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 + 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/UpdateDnsRecordSetRequest' + $ref: '#/components/schemas/SearchRangeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5337,18 +5380,16 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/dnsRecordSets:remove: + /v1/services/{servicesId}:enableVpcServiceControls: parameters: *ref_3 - 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 + patch: + description: Enables VPC service controls for a connection. + operationId: servicenetworking.services.enableVpcServiceControls requestBody: content: application/json: schema: - $ref: '#/components/schemas/RemoveDnsRecordSetRequest' + $ref: '#/components/schemas/EnableVpcServiceControlsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5371,56 +5412,16 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/dnsRecordSets:list: - parameters: *ref_3 - 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 - 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/ListDnsRecordSetsResponse' - parameters: - - in: path - name: servicesId - required: true - schema: - type: string - - in: query - name: consumerNetwork - schema: - type: string - - in: query - name: zone - schema: - type: string - /v1/services/{servicesId}/dnsRecordSets:add: + /v1/services/{servicesId}:disableVpcServiceControls: parameters: *ref_3 - 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 + patch: + description: Disables VPC service controls for a connection. + operationId: servicenetworking.services.disableVpcServiceControls requestBody: content: application/json: schema: - $ref: '#/components/schemas/AddDnsRecordSetRequest' + $ref: '#/components/schemas/DisableVpcServiceControlsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5443,20 +5444,21 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/roles:add: + /v1/services/{servicesId}:validate: parameters: *ref_3 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 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/AddRolesRequest' + $ref: '#/components/schemas/ValidateConsumerConfigRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5472,7 +5474,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/ValidateConsumerConfigResponse' parameters: - in: path name: servicesId @@ -5544,10 +5546,6 @@ paths: schema: $ref: '#/components/schemas/ListOperationsResponse' parameters: - - in: query - name: filter - schema: - type: string - in: query name: pageSize schema: @@ -5557,14 +5555,19 @@ paths: name: pageToken schema: type: string + - in: query + name: filter + schema: + type: string /v1/operations/{operationsId}: parameters: *ref_3 - 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: servicenetworking.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: servicenetworking.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5580,20 +5583,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Empty' parameters: - in: path name: operationsId 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: servicenetworking.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: servicenetworking.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5609,7 +5611,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Operation' parameters: - in: path name: operationsId 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 ddd12210..cc214f01 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: '20240520' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/service-usage/ servers: @@ -41,808 +41,119 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleApiServiceusageV2alphaEnableRule: - description: >- - The consumer policy rule that defines enabled services, groups, and - categories. - type: object - id: GoogleApiServiceusageV2alphaEnableRule - properties: - services: - items: - type: string - type: array - description: >- - The names of the services that are enabled. Example: - `services/storage.googleapis.com`. - 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 | gRPC -----|----- `GET - /v1/messages/123456` | `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 - | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` - | `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 | - gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | - `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 | gRPC - -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | - `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 | gRPC -----|----- `GET /v1/messages/123456` | - `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` | - `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. Example: - http: rules: # Selects a gRPC method and applies HttpRule to it. - - 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 - id: HttpRule - properties: - 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 - post: - type: string - description: >- - Maps to HTTP POST. Used for creating a resource or performing an - action. - 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. - 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. - put: - description: Maps to HTTP PUT. Used for replacing a resource. - type: string - 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. - 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. - selector: - description: >- - Selects a method to which this rule applies. Refer to selector for - syntax details. - type: string - ImportAdminQuotaPoliciesMetadata: - type: object - id: ImportAdminQuotaPoliciesMetadata - properties: {} - description: >- - Metadata message that provides information such as progress, partial - failures, and similar information on each GetOperation call of LRO - returned by ImportAdminQuotaPolicies. - ConsumerPolicy: - type: object - id: ConsumerPolicy - description: >- - Consumer Policy is a set of rules that define what services or service - groups can be used for a cloud resource hierarchy. - properties: - 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) - additionalProperties: - type: string - type: object - name: - 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 - type: string - etag: - type: string - description: >- - An opaque tag indicating the current version of the policy, used for - concurrency control. - updateTime: - description: The last-modified time. - type: string - format: google-datetime - enableRules: - items: - $ref: '#/components/schemas/EnableRule' - type: array - description: Enable rules define usable services and service groups. - Operation: - type: object - properties: - 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 - 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. - 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: - 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 - `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/Status' - description: >- - The error result of the operation in case of failure or - cancellation. - id: Operation - description: >- - This resource represents a long-running operation that is the result of - a network API call. - GetServiceIdentityResponse: - properties: - state: - description: Service identity state. - enum: - - IDENTITY_STATE_UNSPECIFIED - - ACTIVE - 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 - identity: - 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/ServiceIdentity' - description: Response message for getting service identity. - type: object - id: GetServiceIdentityResponse - LoggingDestination: - id: LoggingDestination - description: >- - Configuration of a specific logging destination (the producer project or - the consumer project). - 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 - type: array - monitoredResource: - type: string - description: >- - The monitored resource type. The type must be defined in the - Service.monitored_resources section. - type: object - BackendRule: - id: BackendRule - type: object - 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. - pathTranslation: - 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 - enum: - - PATH_TRANSLATION_UNSPECIFIED - - CONSTANT_ADDRESS - - APPEND_PATH_TO_ADDRESS - selector: - description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - type: string - 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. - type: number - format: double - operationDeadline: - format: double - type: number - description: >- - The number of seconds to wait for the completion of a long running - operation. The default is no deadline. - 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 - minDeadline: - format: double - type: number - deprecated: true - description: Deprecated, do not use. - 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 - overridesByRequestProtocol: - description: The map between request protocol and the backend address. - additionalProperties: - $ref: '#/components/schemas/BackendRule' - type: object - 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: A backend rule provides configuration for an individual API element. - ImportConsumerOverridesMetadata: - 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 - type: object - properties: {} - Empty: - 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: Empty - Api: - type: object - 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. - properties: - syntax: - type: string - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - description: The source syntax of the service. - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - sourceContext: - $ref: '#/components/schemas/SourceContext' - description: >- - Source context for the protocol buffer service represented by this - message. - options: - type: array - description: Any metadata attached to the interface. - items: - $ref: '#/components/schemas/Option' - 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: - description: >- - The fully qualified name of this interface, including package name - followed by the interface's simple name. - type: string - methods: - items: - $ref: '#/components/schemas/Method' - type: array - description: The methods of this interface, in unspecified order. - mixins: - items: - $ref: '#/components/schemas/Mixin' - type: array - description: Included interfaces. See Mixin. - GoogleApiService: - 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 - id: GoogleApiService - properties: - monitoredResources: - 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. - type: array - 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. - 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 - 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`. - producerProjectId: - type: string - description: The Google project that owns this service. - logs: - description: Defines the logs used by this service. - type: array - items: - $ref: '#/components/schemas/LogDescriptor' - 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: - $ref: '#/components/schemas/Authentication' - description: Auth configuration. - http: - description: HTTP configuration. - $ref: '#/components/schemas/Http' - monitoring: - $ref: '#/components/schemas/Monitoring' - description: Monitoring configuration. - apis: - 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. - items: - $ref: '#/components/schemas/Api' - sourceInfo: - description: >- - Output only. The source information for this configuration if - available. - $ref: '#/components/schemas/SourceInfo' - documentation: - $ref: '#/components/schemas/Documentation' - description: Additional API documentation. - enums: - 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 - items: - $ref: '#/components/schemas/Enum' - context: - description: Context configuration. - $ref: '#/components/schemas/Context' - control: - description: Configuration for the service control plane. - $ref: '#/components/schemas/Control' - quota: - description: Quota configuration. - $ref: '#/components/schemas/Quota' - publishing: + LongRunning: + properties: + maxPollDelay: + format: google-duration 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' - customError: - $ref: '#/components/schemas/CustomError' - description: Custom error configuration. - systemParameters: - $ref: '#/components/schemas/SystemParameters' - description: System parameter configuration. - title: + Maximum time between two subsequent poll requests. Default value: 45 + seconds. type: string - description: >- - The product title for this service, it is the name displayed in - Google Cloud Console. - usage: - $ref: '#/components/schemas/Usage' - description: Configuration controlling usage of this service. - metrics: - items: - $ref: '#/components/schemas/MetricDescriptor' - type: array - description: Defines the metrics used by this service. - logging: - $ref: '#/components/schemas/Logging' - description: Logging configuration. - backend: - $ref: '#/components/schemas/Backend' - description: API backend configuration. - billing: - $ref: '#/components/schemas/Billing' - description: Billing configuration. - systemTypes: - items: - $ref: '#/components/schemas/Type' - type: array - 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. - name: + totalPollTimeout: + type: string + format: google-duration + description: 'Total polling timeout. Default value: 5 minutes.' + initialPollDelay: + format: google-duration 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. - BatchCreateConsumerOverridesResponse: - description: Response message for BatchCreateConsumerOverrides - type: object - id: BatchCreateConsumerOverridesResponse - properties: - overrides: - items: - $ref: '#/components/schemas/QuotaOverride' - type: array - description: The overrides that were created. - FieldPolicy: - id: FieldPolicy + 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: >- - 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. + 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 + id: LongRunning + GoogleApiServiceusageV1Service: 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 - resourceType: + parent: type: string description: >- - Specifies the resource type for the resource referred to by the - field. - resourcePermission: - type: string + The resource name of the consumer. A valid name would be: - + projects/123 + config: + $ref: '#/components/schemas/GoogleApiServiceusageV1ServiceConfig' 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". - PhpSettings: - type: object - id: PhpSettings - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - description: Settings for Php client libraries. - AuthenticationRule: - properties: - allowWithoutCredential: - 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: >- - If true, the service accepts API keys without any other credential. - This flag only applies to HTTP and gRPC requests. - selector: + The resource name of the consumer and service. A valid name would + be: - projects/123/services/serviceusage.googleapis.com 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' - requirements: - description: Requirements for additional authentication providers. - type: array - items: - $ref: '#/components/schemas/AuthRequirement' + state: + type: string + enum: + - STATE_UNSPECIFIED + - DISABLED + - ENABLED + 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. + description: A service that is available for use by the consumer. type: object + id: GoogleApiServiceusageV1Service + ImportAdminOverridesMetadata: 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 - GetServiceIdentityMetadata: - type: object - id: GetServiceIdentityMetadata - description: Metadata for the `GetServiceIdentity` 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 + UsageRule: + id: UsageRule + type: object + 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: + 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. Monitoring: + type: object description: >- Monitoring configuration of the service. The example below shows how to configure monitored resources and metrics for monitoring. In the @@ -872,1469 +183,1807 @@ components: library.googleapis.com/book/num_overdue id: Monitoring properties: - consumerDestinations: + producerDestinations: items: $ref: '#/components/schemas/MonitoringDestination' + type: array description: >- - Monitoring configurations for sending metrics to the consumer - project. There can be multiple consumer destinations. A monitored + 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 - producerDestinations: description: >- - Monitoring configurations for sending metrics to the producer - project. There can be multiple producer destinations. A monitored + 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' + Field: + id: Field + properties: + defaultValue: + type: string + description: >- + The string value of the default value of this field. Proto2 syntax + only. + number: + type: integer + format: int32 + description: The field number. + options: + description: The protocol buffer options. + items: + $ref: '#/components/schemas/Option' + type: array + 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 + description: The field cardinality. + type: string + enumDescriptions: + - For fields with unknown cardinality. + - For optional fields. + - For required fields. Proto2 syntax only. + - For repeated fields. + jsonName: + type: string + description: The field JSON name. + packed: + description: Whether to use alternative packed wire representation. + type: boolean + kind: + type: string + 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. + 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 + name: + type: string + description: The field name. + 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. + type: integer + format: int32 + description: A single field of a message type. type: object - LogDescriptor: - id: LogDescriptor + Enum: + description: Enum type definition. + type: object + properties: + edition: + type: string + description: >- + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. + syntax: + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + type: string + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + description: The source syntax. + name: + type: string + description: Enum type name. + enumvalue: + items: + $ref: '#/components/schemas/EnumValue' + type: array + description: Enum value definitions. + sourceContext: + description: The source context. + $ref: '#/components/schemas/SourceContext' + options: + description: Protocol buffer options. + items: + $ref: '#/components/schemas/Option' + type: array + id: Enum + Endpoint: 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 + `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: - displayName: + aliases: + type: array description: >- - The human-readable name for this log. This information appears on - the user interface and should be concise. + 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 + 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: + 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: + type: string + description: The canonical name of this endpoint. + type: object + id: Endpoint + OAuthRequirements: + id: 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: >- + 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 + Publishing: + properties: + codeownerGithubTeams: + 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 + restReferenceDocumentationUri: + description: >- + Optional link to REST reference documentation. Example: + https://cloud.google.com/pubsub/lite/docs/reference/rest + 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: + description: For whom the client library is being published. + enum: + - CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED + - CLOUD + - ADS + - PHOTOS + - STREET_VIEW + - SHOPPING + - GEO + - GENERATIVE_AI + protoReferenceDocumentationUri: description: >- - A human-readable description of this log. This information appears - in the documentation and can contain details. + Optional link to proto reference documentation. Example: + https://cloud.google.com/pubsub/lite/docs/reference/rpc type: string - labels: + newIssueUri: 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. + Link to a *public* URI where users can report issues. Example: + https://issuetracker.google.com/issues/new?component=190865&template=1161103 + type: string + methodSettings: type: array items: - $ref: '#/components/schemas/LabelDescriptor' - 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 [/_-.]. - type: object - AuthProvider: - 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). - properties: - id: - type: string + $ref: '#/components/schemas/MethodSettings' description: >- - The unique identifier of the auth provider. It will be referred to - by `AuthRequirement.provider_id`. Example: "bookstore_auth". - issuer: - type: string + A list of API method settings, e.g. the behavior for methods that + use the long-running operation pattern. + librarySettings: + 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 - jwtLocations: + 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/JwtLocation' - type: array + $ref: '#/components/schemas/ClientLibrarySettings' + docTagPrefix: 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 - authorizationUrl: + A prefix used in sample code when demarking regions to be included + in documentation. + type: string + documentationUri: type: string description: >- - Redirect URL if JWT token is required but not present or is expired. - Implement authorizationUrl of securityDefinitions in OpenAPI spec. - audiences: + Link to product home page. Example: + https://cloud.google.com/asset-inventory/docs/overview + githubLabel: 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 - jwksUri: + GitHub label to apply to issues and pull requests opened for this + API. type: string + apiShortName: 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 - EnumValue: - description: Enum value definition. - properties: - number: - type: integer - format: int32 - description: Enum value number. - name: - description: Enum value name. + 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 - options: - type: array - description: Protocol buffer options. - items: - $ref: '#/components/schemas/Option' + id: Publishing type: object - id: EnumValue - ClientLibrarySettings: - description: Details about how and where to publish client libraries. - id: ClientLibrarySettings + 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. + NodeSettings: + type: object + id: NodeSettings + description: Settings for Node client libraries. properties: - javaSettings: - $ref: '#/components/schemas/JavaSettings' - description: Settings for legacy Java features, supported in the Service YAML. - phpSettings: - $ref: '#/components/schemas/PhpSettings' - description: Settings for PHP client libraries. - nodeSettings: - description: Settings for Node client libraries. - $ref: '#/components/schemas/NodeSettings' - goSettings: - $ref: '#/components/schemas/GoSettings' - description: Settings for Go client libraries. - launchStage: - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + DeleteAdminQuotaPolicyMetadata: + properties: {} + 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 + GetServiceIdentityResponse: + id: GetServiceIdentityResponse + description: Response message for getting service identity. + properties: + state: 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 - rubySettings: - $ref: '#/components/schemas/RubySettings' - description: Settings for Ruby client libraries. - cppSettings: - $ref: '#/components/schemas/CppSettings' - description: Settings for C++ client libraries. - pythonSettings: - $ref: '#/components/schemas/PythonSettings' - description: Settings for Python client libraries. - restNumericEnums: - type: boolean - description: >- - When using transport=rest, the client request will encode enums as - numbers rather than strings. - dotnetSettings: - $ref: '#/components/schemas/DotnetSettings' - description: Settings for .NET client libraries. - version: + 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/ServiceIdentity' 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". + 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. type: object - Option: + QuotaLimit: + id: QuotaLimit description: >- - A protocol buffer option, which can be attached to a message, field, - enumeration, etc. - id: Option + `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: - value: + 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. + defaultLimit: + format: int64 + 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. + type: string + maxLimit: + 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 + 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 + values: additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. + type: string + format: int64 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. + 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 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 + duration: 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"`. + 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 + 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. + 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 type: object - OperationMetadata: + GoogleApiServiceusageV1ServiceConfig: + id: GoogleApiServiceusageV1ServiceConfig type: object - id: OperationMetadata + description: The configuration of the service. properties: - resourceNames: + endpoints: items: - type: string + $ref: '#/components/schemas/Endpoint' + type: array description: >- - The full name of the resources that this operation is directly - associated with. + Configuration for network endpoints. Contains only the names and + aliases of the endpoints. + quota: + description: Quota configuration. + $ref: '#/components/schemas/Quota' + usage: + $ref: '#/components/schemas/Usage' + description: Configuration controlling usage of this service. + title: + type: string + description: The product title for this service. + authentication: + $ref: '#/components/schemas/Authentication' + description: Auth configuration. Contains only the OAuth rules. + monitoring: + $ref: '#/components/schemas/Monitoring' + description: >- + Monitoring configuration. This should not include the + 'producer_destinations' field. + name: + description: >- + The DNS address at which this service is available. An example DNS + address would be: `calendar.googleapis.com`. + type: string + apis: type: array - description: The operation metadata returned for the batchend services operation. - EnableFailure: - description: Provides error messages for the failing services. + 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. + documentation: + $ref: '#/components/schemas/Documentation' + description: >- + Additional API documentation. Contains only the summary and the + documentation URL. + monitoredResources: + description: >- + Defines the monitored resources used by this service. This is + required by the Service.monitoring and Service.logging + configurations. + type: array + items: + $ref: '#/components/schemas/MonitoredResourceDescriptor' + UpdateAdminQuotaPolicyMetadata: type: object - id: EnableFailure + properties: {} + 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. + Method: + id: Method + type: object + description: Method represents a method of an API interface. properties: - errorMessage: - description: An error message describing why the service could not be enabled. + requestStreaming: + description: If true, the request is streamed. + type: boolean + syntax: + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + description: The source syntax of this method. type: string - serviceId: + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + responseTypeUrl: type: string - description: The service id of a service that could not be enabled. - JwtLocation: - properties: - cookie: - description: Specifies cookie name to extract JWT token. + description: The URL of the output message type. + options: + description: Any metadata attached to the method. + type: array + items: + $ref: '#/components/schemas/Option' + requestTypeUrl: + description: A URL of the input message type. type: string - query: - description: Specifies URL query parameter name to extract JWT token. + responseStreaming: + type: boolean + description: If true, the response is streamed. + name: type: string - valuePrefix: + description: The simple name of this method. + GetServiceIdentityMetadata: + id: GetServiceIdentityMetadata + description: Metadata for the `GetServiceIdentity` method. + properties: {} + type: object + Control: + properties: + environment: 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: - type: string - description: Specifies HTTP header name to extract JWT token. - description: Specifies a location to extract JWT from an API request. - id: JwtLocation + 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. + items: + $ref: '#/components/schemas/MethodPolicy' + type: array + id: Control type: object - CreateAdminQuotaPolicyMetadata: + description: >- + Selects and configures the service controller used by the service. + Example: control: environment: servicecontrol.googleapis.com + UpdateConsumerPolicyMetadata: + type: object + id: UpdateConsumerPolicyMetadata + properties: {} + description: Metadata for the `UpdateConsumerPolicy` method. + ImportConsumerOverridesMetadata: + id: ImportConsumerOverridesMetadata + properties: {} 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. - properties: {} - GoogleApiServiceusageV1beta1GetServiceIdentityResponse: - description: Response message for getting service identity. + returned by ImportConsumerOverrides. + ImportAdminQuotaPoliciesResponse: properties: - 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. - state: - type: string - description: Service identity state. - enum: - - IDENTITY_STATE_UNSPECIFIED - - ACTIVE - enumDescriptions: - - >- - Default service identity state. This value is used if the state is - omitted. - - Service identity has been created and can be used. - type: object - id: GoogleApiServiceusageV1beta1GetServiceIdentityResponse - AddEnableRulesMetadata: - id: AddEnableRulesMetadata + policies: + description: The policies that were created from the imported data. + items: + $ref: '#/components/schemas/AdminQuotaPolicy' + type: array + id: ImportAdminQuotaPoliciesResponse type: object - properties: {} - description: Metadata for the `AddEnableRules` method. - MethodSettings: - id: MethodSettings + description: Response message for ImportAdminQuotaPolicies + MetricRule: + id: MetricRule properties: - autoPopulatedFields: + metricCosts: 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: + 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. + additionalProperties: + format: int64 type: string - type: array - 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 + type: object 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... - description: Describes the generator configuration for a method. + Selects the methods to which this rule applies. Refer to selector + for syntax details. + type: string + 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. type: object - MethodPolicy: + DisableServiceResponse: + properties: + service: + description: The new state of the service after disabling. + $ref: '#/components/schemas/GoogleApiServiceusageV1Service' + 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. type: object - id: MethodPolicy + id: DisableServiceResponse + AddEnableRulesResponse: + type: object + description: The response message of `AddEnableRules` method. + id: AddEnableRulesResponse properties: - selector: + parent: 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 . + The parent consumer policy. It can be + `projects/12345/consumerPolicies/default`, or + `folders/12345/consumerPolicies/default`, or + `organizations/12345/consumerPolicies/default`. type: string - requestPolicies: - items: - $ref: '#/components/schemas/FieldPolicy' - description: Policies that are applicable to the request message. + addedValues: + description: The values added to the parent consumer policy. type: array - description: Defines policies applying to an RPC method. - Usage: - properties: - rules: items: - $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 - producerNotificationChannel: + type: string + MonitoredResourceDescriptor: + properties: + description: 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. - requirements: - items: - type: string + Optional. A detailed description of the monitored resource type that + might be used in documentation. + displayName: 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 - description: Configuration controlling usage of a service. - id: Usage - type: object - BatchEnableServicesRequest: - description: Request message for the `BatchEnableServices` method. - id: BatchEnableServicesRequest - type: object - properties: - serviceIds: + 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: - type: string - 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. - NodeSettings: - properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - type: object - id: NodeSettings - description: Settings for Node client libraries. - CustomErrorRule: - id: CustomErrorRule - description: A custom error rule. - properties: - isErrorType: + $ref: '#/components/schemas/LabelDescriptor' 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: + 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"`. + launchStage: + description: Optional. The launch stage of the monitored resource definition. + 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 + type: + type: string description: >- - Selects messages to which this rule applies. Refer to selector for - syntax details. + 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 - type: object - ImportAdminOverridesMetadata: - id: ImportAdminOverridesMetadata - 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 ImportAdminOverrides. - DisableServiceResponse: + 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}"`. + id: 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. - id: DisableServiceResponse + 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 + RemoveEnableRulesResponse: properties: - service: - description: The new state of the service after disabling. - $ref: '#/components/schemas/GoogleApiServiceusageV1Service' - LongRunning: - properties: - maxPollDelay: - format: google-duration - type: string - description: >- - Maximum time between two subsequent poll requests. Default value: 45 - seconds. - pollDelayMultiplier: - format: float - description: >- - Multiplier to gradually increase delay between subsequent polls - until it reaches max_poll_delay. Default value: 1.5. - type: number - totalPollTimeout: - format: google-duration - description: 'Total polling timeout. Default value: 5 minutes.' + removedValues: + description: The values removed from the parent consumer policy. + deprecated: true + items: + type: string + type: array + parent: type: string - initialPollDelay: description: >- - Initial delay after which the first poll request will be made. - Default value: 5 seconds. - format: google-duration - type: string + The parent consumer policy. It can be + `projects/12345/consumerPolicies/default`, or + `folders/12345/consumerPolicies/default`, or + `organizations/12345/consumerPolicies/default`. 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 - SystemParameter: - id: SystemParameter + description: The response message of `RemoveEnableRules` method. + id: RemoveEnableRulesResponse + JavaSettings: + id: JavaSettings type: object + description: Settings for Java client libraries. properties: - urlQueryParameter: + serviceClassNames: + additionalProperties: + type: string + type: object description: >- - Define the URL query parameter name to use for the parameter. It is - case sensitive. - type: string - name: - type: string + 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: description: >- - Define the name of the parameter, such as "api_key" . It is case - sensitive. - httpHeader: + 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: >- - Define the HTTP header name to use for the parameter. It is case - insensitive. - 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. - AuthRequirement: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + EnumValue: properties: - providerId: - description: >- - id from authentication provider. Example: provider_id: - bookstore_auth - type: string - audiences: - 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 + number: + format: int32 + type: integer + description: Enum value number. + options: + description: Protocol buffer options. + items: + $ref: '#/components/schemas/Option' + type: array + name: type: string - 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: Enum value name. + id: EnumValue type: object - id: AuthRequirement - ContextRule: + description: Enum value definition. + DotnetSettings: type: object - description: >- - A context rule provides information about the context for an individual - API element. + id: DotnetSettings + description: Settings for Dotnet client libraries. properties: - selector: - type: string + renamedServices: description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - provided: - type: array - description: A list of full type names of provided contexts. - items: + 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 - 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: object + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + renamedResources: + additionalProperties: type: string - allowedRequestExtensions: + type: object description: >- - A list of full type names or extension IDs of extensions allowed in - grpc side channel from client to backend. + 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" + forcedNamespaceAliases: items: type: string + description: >- + Namespaces which must be aliased in snippets due to a known (but + non-generator-predictable) naming collision type: array - requested: - type: array - description: A list of full type names of requested contexts. + 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" items: type: string - id: ContextRule - Type: - type: object - description: A protocol buffer message type. - id: Type - properties: - fields: - items: - $ref: '#/components/schemas/Field' - description: The list of fields. - type: array - name: - type: string - description: The fully qualified message name. - options: - items: - $ref: '#/components/schemas/Option' - type: array - description: The protocol buffer options. - edition: - description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. - type: string - syntax: - description: The source syntax. - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - type: string - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - sourceContext: - $ref: '#/components/schemas/SourceContext' - description: The source context. - oneofs: type: array + 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 - description: The list of types appearing in `oneof` definitions in this type. - GoogleApiServiceusageV2alphaConsumerPolicy: - description: >- - Consumer Policy is a set of rules that define what services or service - groups can be used for a cloud resource hierarchy. + type: array + BatchCreateConsumerOverridesResponse: + description: Response message for BatchCreateConsumerOverrides type: object - id: GoogleApiServiceusageV2alphaConsumerPolicy properties: - createTime: - type: string - readOnly: true - format: google-datetime - description: >- - Output only. The time the policy was created. For singleton - policies, this is the first touch of the policy. - etag: - readOnly: true - description: >- - Output only. An opaque tag indicating the current version of the - policy, used for concurrency control. - type: string - updateTime: - type: string - format: google-datetime - description: Output only. The time the policy was last updated. - readOnly: true - annotations: + overrides: + type: array + items: + $ref: '#/components/schemas/QuotaOverride' + description: The overrides that were created. + id: BatchCreateConsumerOverridesResponse + Operation: + type: object + properties: + response: 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) + 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: string + type: any + description: Properties of the object. Contains field @type with type URL. type: object name: - readOnly: true type: string 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`. - enableRules: + 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: >- - Enable rules define usable services, groups, and categories. There - can currently be at most one `EnableRule`. This restriction will be - lifted in later releases. - type: array - items: - $ref: '#/components/schemas/GoogleApiServiceusageV2alphaEnableRule' - OAuthRequirements: + 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: >- + 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 + 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: >- - 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. + This resource represents a long-running operation that is the result of + a network API call. + id: Operation + GoogleApiServiceusageV2alphaEnableRule: + description: >- + The consumer policy rule that defines enabled services, groups, and + categories. + id: GoogleApiServiceusageV2alphaEnableRule + type: object properties: - canonicalScopes: - type: string + services: + type: array 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 - type: object - QuotaOverride: - id: QuotaOverride + The names of the services that are enabled. Example: + `services/storage.googleapis.com`. + items: + type: string + 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 type: object - description: A quota override properties: - 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 - unit: + requirements: + description: Requirements for additional authentication providers. + type: array + items: + $ref: '#/components/schemas/AuthRequirement' + oauth: + $ref: '#/components/schemas/OAuthRequirements' + description: The requirements for OAuth credentials. + selector: 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 - name: + Selects the methods to which this rule applies. Refer to selector + for syntax details. type: string + allowWithoutCredential: 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. - dimensions: + If true, the service accepts API keys without any other credential. + This flag only applies to HTTP and gRPC requests. + type: boolean + CommonLanguageSettings: + id: CommonLanguageSettings + description: Required information for every language. + type: object + properties: + destinations: 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: + 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 - overrideValue: - type: string - format: int64 - description: >- - The overriding quota limit value. Can be any nonnegative integer, or - -1 (unlimited quota). - metric: + type: array + referenceDocsUri: description: >- - The name of the metric to which this override applies. An example - name would be: `compute.googleapis.com/cpus` + Link to automatically generated reference documentation. Example: + https://cloud.google.com/nodejs/docs/reference/asset/latest + deprecated: true type: string - ListServicesResponse: - id: ListServicesResponse + EnableFailure: type: object + id: EnableFailure properties: - nextPageToken: - description: >- - Token that can be passed to `ListServices` to resume a paginated - query. + errorMessage: + description: An error message describing why the service could not be enabled. type: string - services: - items: - $ref: '#/components/schemas/GoogleApiServiceusageV1Service' - description: The available services for the requested project. - type: array - description: Response message for the `ListServices` method. - GoogleApiServiceusageV1OperationMetadata: + serviceId: + description: The service id of a service that could not be enabled. + type: string + description: Provides error messages for the failing services. + ListOperationsResponse: type: object - description: The operation metadata returned for the batchend services operation. properties: - resourceNames: - description: >- - The full name of the resources that this operation is directly - associated with. + nextPageToken: + type: string + description: The standard List next-page token. + operations: type: array items: - type: string - id: GoogleApiServiceusageV1OperationMetadata + $ref: '#/components/schemas/Operation' + description: >- + A list of operations that matches the specified filter in the + request. + id: ListOperationsResponse + description: The response message for Operations.ListOperations. LabelDescriptor: - id: LabelDescriptor description: A description of a label. type: object + id: LabelDescriptor properties: - description: - description: A human-readable description for the label. + key: + description: The label key. 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 - key: - description: The label key. type: string - GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata: - properties: {} - id: GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata - description: Metadata for the `UpdateConsumerPolicy` method. - type: object - RemoveEnableRulesResponse: - type: object - id: RemoveEnableRulesResponse - description: The response message of `RemoveEnableRules` method. + description: The type of data that can be assigned to the label. + description: + type: string + description: A human-readable description for the label. + Page: properties: - parent: + 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' + 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 + content: description: >- - The parent consumer policy. It can be - `projects/12345/consumerPolicies/default`, or - `folders/12345/consumerPolicies/default`, or - `organizations/12345/consumerPolicies/default`. - removedValues: + 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 + type: object + description: >- + Represents a documentation page. A page can contain subpages to + represent nested documentation set structure. + id: Page + Usage: + description: Configuration controlling usage of a service. + id: Usage + properties: + rules: items: - type: string - description: The values removed from the parent consumer policy. - deprecated: true + $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 - Http: - properties: - fullyDecodeReservedExpansion: - type: boolean + producerNotificationChannel: 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: + 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: + 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: - $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. - 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. - type: object - id: Http - EnableServiceRequest: - properties: {} + type: string type: object - id: EnableServiceRequest - description: Request message for the `EnableService` method. - Enum: + 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 - description: Enum type definition. - id: Enum + id: Api properties: - name: + version: type: string - description: Enum type name. - sourceContext: - description: The source context. - $ref: '#/components/schemas/SourceContext' - edition: + 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. + mixins: + description: Included interfaces. See Mixin. + items: + $ref: '#/components/schemas/Mixin' + type: array + name: type: string description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. + 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: Protocol buffer options. - enumvalue: - type: array + description: Any metadata attached to the interface. + methods: items: - $ref: '#/components/schemas/EnumValue' - description: Enum value definitions. + $ref: '#/components/schemas/Method' + type: array + description: The methods of this interface, in unspecified order. syntax: + type: string + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS enumDescriptions: - 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. + MetricDescriptorMetadata: + description: Additional annotations that can be used to guide the usage of a metric. + id: MetricDescriptorMetadata + type: object + properties: + 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: type: string + deprecated: true + description: Deprecated. Must use the MetricDescriptor.launch_stage instead. enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - description: The source syntax. - UsageRule: - id: UsageRule + - 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. + EnableServiceResponse: 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 + 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: + description: The new state of the service after enabling. + $ref: '#/components/schemas/GoogleApiServiceusageV1Service' + type: object + DisableServiceRequest: type: object + description: Request message for the `DisableService` method. properties: - selector: - description: >- - Selects the methods to which this rule applies. Use '*' to indicate - all methods in all APIs. Refer to selector for syntax details. + checkIfServiceHasUsage: type: string - skipServiceControl: + enum: + - CHECK_IF_SERVICE_HAS_USAGE_UNSPECIFIED + - SKIP + - CHECK + 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. 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: - type: boolean + Defines the behavior for checking service usage when disabling a + service. + disableDependentServices: description: >- - If true, the selected method allows unregistered calls, e.g. calls - that don't identify any user or application. - Publishing: + 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: boolean + id: DisableServiceRequest + ConsumerPolicy: + id: ConsumerPolicy + description: >- + Consumer Policy is a set of rules that define what services or service + groups can be used for a cloud resource hierarchy. properties: - protoReferenceDocumentationUri: + enableRules: + type: array + description: Enable rules define usable services and service groups. + items: + $ref: '#/components/schemas/EnableRule' + name: + readOnly: true type: string description: >- - Optional link to proto reference documentation. Example: - https://cloud.google.com/pubsub/lite/docs/reference/rpc - docTagPrefix: + 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`. + annotations: + type: object description: >- - A prefix used in sample code when demarking regions to be included - in documentation. + 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 + updateTime: type: string - githubLabel: + format: google-datetime + description: The last-modified time. + etag: description: >- - GitHub label to apply to issues and pull requests opened for this - API. + An opaque tag indicating the current version of the policy, used for + concurrency control. + type: string + type: object + FieldPolicy: + id: FieldPolicy + properties: + resourcePermission: type: string - documentationUri: description: >- - Link to product home page. Example: - https://cloud.google.com/asset-inventory/docs/overview + 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: + description: >- + Specifies the resource type for the resource referred to by the + field. type: string - newIssueUri: + selector: type: string description: >- - Link to a *public* URI where users can report issues. Example: - https://issuetracker.google.com/issues/new?component=190865&template=1161103 - methodSettings: - description: >- - A list of API method settings, e.g. the behavior for methods that - use the long-running operation pattern. + 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: 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. + GoogleApiServiceusageV1OperationMetadata: + properties: + resourceNames: type: array items: - $ref: '#/components/schemas/MethodSettings' - 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 - description: For whom the client library is being published. - type: string - enum: - - CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED - - CLOUD - - ADS - - PHOTOS - - STREET_VIEW - - SHOPPING - - GEO - - GENERATIVE_AI - librarySettings: + type: string 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 full name of the resources that this operation is directly + associated with. + type: object + id: GoogleApiServiceusageV1OperationMetadata + description: The operation metadata returned for the batchend services operation. + CreateAdminQuotaPolicyMetadata: + 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. + properties: {} + 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: + rules: items: - $ref: '#/components/schemas/ClientLibrarySettings' + $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 + 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 - restReferenceDocumentationUri: + items: + $ref: '#/components/schemas/Page' + description: The top level pages for the documentation set. + documentationRootUrl: + description: The URL to the root of documentation. + type: string + overview: type: string description: >- - Optional link to REST reference documentation. Example: - https://cloud.google.com/pubsub/lite/docs/reference/rest - apiShortName: + 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. + serviceRootUrl: 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". + 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 - codeownerGithubTeams: + sectionOverrides: type: array description: >- - GitHub teams to be added to CODEOWNERS in the directory in GitHub - containing source code for the client libraries for this API. + Specifies section and content to override boilerplate content + provided by go/api-docgen. Currently overrides following sections: + 1. rest.service.client_libraries items: - type: string - 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. - Quota: + $ref: '#/components/schemas/Page' + SystemParameters: properties: - limits: - items: - $ref: '#/components/schemas/QuotaLimit' - description: List of QuotaLimit definitions for the service. - type: array - metricRules: + rules: items: - $ref: '#/components/schemas/MetricRule' + $ref: '#/components/schemas/SystemParameterRule' description: >- - List of MetricRule definitions, each one mapping a selected method - to one or more metrics. + 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 - type: object - id: Quota + id: SystemParameters 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 - BatchEnableServicesResponse: + ### 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 + Type: properties: - services: + fields: type: array - description: The new state of the services after enabling. items: - $ref: '#/components/schemas/GoogleApiServiceusageV1Service' - failures: + $ref: '#/components/schemas/Field' + description: The list of fields. + syntax: + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + type: string + description: The source syntax. + options: + description: The protocol buffer options. type: array - description: >- - 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/EnableFailure' - id: BatchEnableServicesResponse - type: object - 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. - SystemParameterRule: - id: SystemParameterRule - properties: - selector: + $ref: '#/components/schemas/Option' + name: type: string + description: The fully qualified message name. + sourceContext: + $ref: '#/components/schemas/SourceContext' + description: The source context. + edition: description: >- - Selects the methods to which this rule applies. Use '*' to indicate - all methods in all APIs. Refer to selector for syntax details. - parameters: + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. + type: string + oneofs: 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. + description: The list of types appearing in `oneof` definitions in this type. items: - $ref: '#/components/schemas/SystemParameter' - description: >- - Define a system parameter rule mapping system parameter definitions to - methods. + type: string + description: A protocol buffer message type. type: object - QuotaLimit: + id: Type + CancelOperationRequest: + properties: {} + id: CancelOperationRequest + description: The request message for Operations.CancelOperation. + type: object + LoggingDestination: 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`. + Configuration of a specific logging destination (the producer project or + the consumer project). properties: - 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. - 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`). - 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. - 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 - additionalProperties: - format: int64 + logs: + type: array + items: type: string - 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 - 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. - type: string - format: int64 - 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. - 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: - type: string + 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: >- - 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. - id: QuotaLimit + The monitored resource type. The type must be defined in the + Service.monitored_resources section. + type: string type: object - 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. + id: LoggingDestination + ImportAdminOverridesResponse: type: object - BatchGetServicesResponse: - id: BatchGetServicesResponse + description: Response message for ImportAdminOverrides + id: ImportAdminOverridesResponse properties: - services: + overrides: + description: The overrides that were created from the imported data. type: array items: - $ref: '#/components/schemas/GoogleApiServiceusageV1Service' - description: The requested Service states. - description: Response message for the `BatchGetServices` method. - type: object - SystemParameters: - id: SystemParameters + $ref: '#/components/schemas/QuotaOverride' + CppSettings: + id: CppSettings properties: - 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. - 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. + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' type: object - MonitoringDestination: - id: MonitoringDestination + description: Settings for C++ client libraries. + ContextRule: + id: ContextRule + type: object + description: >- + A context rule provides information about the context for an individual + API element. properties: - monitoredResource: - description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. + selector: type: string - metrics: + description: >- + Selects the methods to which this rule applies. Refer to selector + for syntax details. + allowedResponseExtensions: + description: >- + A list of full type names or extension IDs of extensions allowed in + grpc side channel from backend to client. items: type: string type: array - description: >- - 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). - type: object - Context: - properties: - rules: + requested: + items: + type: string + description: A list of full type names of requested contexts. type: array + provided: items: - $ref: '#/components/schemas/ContextRule' + type: string + description: A list of full type names of provided contexts. + type: array + allowedRequestExtensions: + items: + type: string + type: array 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 - 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. - type: object - Billing: + A list of full type names or extension IDs of extensions allowed in + grpc side channel from client to backend. + BatchGetServicesResponse: + id: BatchGetServicesResponse type: object properties: - consumerDestinations: + services: + description: The requested Service states. 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. + $ref: '#/components/schemas/GoogleApiServiceusageV1Service' type: array - id: 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 - Status: + description: Response message for the `BatchGetServices` method. + ListServicesResponse: + description: Response message for the `ListServices` method. 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: Status 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: + nextPageToken: description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. + Token that can be passed to `ListServices` to resume a paginated + query. + type: string + services: + type: array items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object + $ref: '#/components/schemas/GoogleApiServiceusageV1Service' + description: The available services for the requested project. + id: ListServicesResponse + ImportConsumerOverridesResponse: + properties: + overrides: + items: + $ref: '#/components/schemas/QuotaOverride' + description: The overrides that were created from the imported data. type: array - AdminQuotaPolicy: + id: ImportConsumerOverridesResponse + type: object + description: Response message for ImportConsumerOverrides + BatchEnableServicesRequest: + type: object + id: BatchEnableServicesRequest properties: - policyValue: - format: int64 - type: string - description: >- - The quota policy value. Can be any nonnegative integer, or -1 - (unlimited quota). - 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: + serviceIds: 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 - 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: * 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: + 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. + type: array + items: type: string - container: + description: Request message for the `BatchEnableServices` method. + SystemParameterRule: + type: object + description: >- + Define a system parameter rule mapping system parameter definitions to + methods. + id: SystemParameterRule + 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: description: >- - The cloud resource container at which the quota policy is created. - The format is `{container_type}/{container_number}` - type: string - metric: + Selects the methods to which this rule applies. Use '*' to indicate + all methods in all APIs. Refer to selector for syntax details. type: string + CustomErrorRule: + properties: + isErrorType: description: >- - The name of the metric to which this policy applies. An example name - would be: `compute.googleapis.com/cpus` - description: Quota policy created by quota administrator. - id: AdminQuotaPolicy + 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. + id: CustomErrorRule type: object - GoSettings: + Context: + id: Context type: object - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - id: GoSettings - description: Settings for Go client libraries. - 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. + `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: - labels: + rules: + type: array + items: + $ref: '#/components/schemas/ContextRule' 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"`. + A list of RPC context rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + Status: + properties: + details: items: - $ref: '#/components/schemas/LabelDescriptor' + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object type: array - description: description: >- - Optional. A detailed description of the monitored resource type that - might be used in documentation. + 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 status code, which should be an enum value of google.rpc.Code. + type: integer + message: type: string - 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 - type: + 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). + type: object + id: Status + ClientLibrarySettings: + properties: + javaSettings: + $ref: '#/components/schemas/JavaSettings' + description: Settings for legacy Java features, supported in the Service YAML. + nodeSettings: + $ref: '#/components/schemas/NodeSettings' + description: Settings for Node client libraries. + version: 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). + 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 + dotnetSettings: + $ref: '#/components/schemas/DotnetSettings' + description: Settings for .NET 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 launchStage: + description: Launch stage of this version of the API. + 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. @@ -2373,209 +2022,310 @@ 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. + cppSettings: + $ref: '#/components/schemas/CppSettings' + description: Settings for C++ client libraries. + pythonSettings: + description: Settings for Python client libraries. + $ref: '#/components/schemas/PythonSettings' + goSettings: + $ref: '#/components/schemas/GoSettings' + description: Settings for Go client libraries. + type: object + description: Details about how and where to publish client libraries. + id: ClientLibrarySettings + BackendRule: + description: A backend rule provides configuration for an individual API element. + properties: + 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. + deadline: + format: double + 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. + minDeadline: + type: number + deprecated: true + format: double + description: Deprecated, do not use. + overridesByRequestProtocol: + additionalProperties: + $ref: '#/components/schemas/BackendRule' + description: The map between request protocol and the backend address. + type: object + 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 + 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 + pathTranslation: type: string - description: Optional. The launch stage of the monitored resource definition. enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - displayName: + - 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 + 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 + operationDeadline: 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: object - ListOperationsResponse: - id: ListOperationsResponse - properties: - operations: + 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: >- - A list of operations that matches the specified filter in the - request. - items: - $ref: '#/components/schemas/Operation' - type: array - nextPageToken: + Selects the methods to which this rule applies. Refer to selector + for syntax details. type: string - description: The standard List next-page token. - description: The response message for Operations.ListOperations. type: object - BatchCreateAdminOverridesResponse: - type: object - description: Response message for BatchCreateAdminOverrides + id: BackendRule + PythonSettings: + id: PythonSettings properties: - overrides: - description: The overrides that were created. - type: array - items: - $ref: '#/components/schemas/QuotaOverride' - id: BatchCreateAdminOverridesResponse - 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 + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + type: object + description: Settings for Python client libraries. + EnableRule: type: object + id: EnableRule + description: >- + The consumer policy rule that defines usable services and service + groups. properties: - allowCors: - type: boolean + groups: 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: + 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 + deprecated: true items: 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: - 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 - id: Endpoint - DotnetSettings: - id: DotnetSettings - description: Settings for Dotnet client libraries. - 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" - 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 - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - 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: + services: items: type: string type: array + deprecated: true description: >- - Namespaces which must be aliased in snippets due to a known (but - non-generator-predictable) naming collision - handwrittenSignatures: + DEPRECATED: Please use field `values`. Service should have prefix + `services/`. The names of the services that are enabled. Example: + `storage.googleapis.com`. + values: 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. items: type: string + description: >- + The names of the services or service groups that are enabled. + Example: `services/storage.googleapis.com`, `groups/googleServices`, + `groups/allServices`. + enableType: + type: string + 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. + enum: + - ENABLE_TYPE_UNSPECIFIED + - CLIENT + - RESOURCE + - V1_COMPATIBLE + AuthRequirement: type: object - Control: + properties: + providerId: + type: string + description: >- + id from authentication provider. Example: provider_id: + bookstore_auth + audiences: + 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 description: >- - Selects and configures the service controller used by the service. - Example: control: environment: servicecontrol.googleapis.com - type: object - id: Control + 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 + Option: + id: Option properties: - methodPolicies: - description: Defines policies applying to the API methods of the service. - items: - $ref: '#/components/schemas/MethodPolicy' - type: array - environment: + value: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object 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 + 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: >- + 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 - BillingDestination: - id: BillingDestination + description: >- + A protocol buffer option, which can be attached to a message, field, + enumeration, etc. + type: object + BatchCreateAdminOverridesResponse: + id: BatchCreateAdminOverridesResponse properties: - metrics: + overrides: items: - type: string - description: >- - Names of the metrics to report to this billing destination. Each - name must be defined in Service.metrics section. + $ref: '#/components/schemas/QuotaOverride' type: array - monitoredResource: + description: The overrides that were created. + description: Response message for BatchCreateAdminOverrides + type: object + SourceContext: + type: object + properties: + fileName: type: string description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. - type: object + The path-qualified name of the .proto file that contained the + associated protobuf element. For example: + `"google/protobuf/source_context.proto"`. + id: SourceContext description: >- - Configuration of a specific billing destination (Currently only support - bill against consumer project). - PythonSettings: - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - id: PythonSettings - type: object - description: Settings for Python client libraries. - RemoveEnableRulesMetadata: - id: RemoveEnableRulesMetadata - description: Metadata for the `RemoveEnableRules` method. - properties: {} + `SourceContext` represents information about the source of a protobuf + element, like the file in which it is defined. + DocumentationRule: + description: A documentation rule provides information about individual API elements. type: object - CustomHttpPattern: properties: - kind: + 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: The name of this custom HTTP verb. - path: + deprecationDescription: + description: >- + Deprecation description of the selected element(s). It can be + provided if an element is marked as `deprecated`. type: string - description: The path matched by this custom verb. + 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. + 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 + id: DocumentationRule + SourceInfo: + description: Source information used to create a Service Config type: object - id: CustomHttpPattern - description: A custom pattern is used for defining custom HTTP verb. + properties: + sourceFiles: + description: All files used during config generation. + items: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: array + id: SourceInfo Logging: description: >- Logging configuration of the service. The following example shows how to @@ -2591,11 +2341,8 @@ components: activity_history - purchase_history consumer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history - type: object - id: Logging properties: consumerDestinations: - type: array description: >- Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a @@ -2603,1117 +2350,1370 @@ components: consumer destination. items: $ref: '#/components/schemas/LoggingDestination' + 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. - type: array - items: - $ref: '#/components/schemas/LoggingDestination' - CommonLanguageSettings: + 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 + items: + $ref: '#/components/schemas/LoggingDestination' + id: Logging + type: object + Authentication: + properties: + providers: + description: Defines a set of authentication providers that a service supports. + items: + $ref: '#/components/schemas/AuthProvider' + 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. + items: + $ref: '#/components/schemas/AuthenticationRule' + type: array + 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 + 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 + 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: + items: + $ref: '#/components/schemas/LabelDescriptor' + type: array + 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: object + id: LogDescriptor + JwtLocation: + type: object + properties: + 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. + query: + description: Specifies URL query parameter name to extract JWT token. + type: string + cookie: + type: string + description: Specifies cookie name to extract JWT token. + header: + type: string + description: Specifies HTTP header name to extract JWT token. + id: JwtLocation + description: Specifies a location to extract JWT from an API request. + GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata: + id: GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata + type: object + description: Metadata for the `UpdateConsumerPolicy` method. + properties: {} + 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: {} + Backend: + id: Backend + type: object + properties: + rules: + type: array + items: + $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. + description: '`Backend` defines the backend configuration for a service.' + RemoveEnableRulesMetadata: + properties: {} + id: RemoveEnableRulesMetadata + type: object + description: Metadata for the `RemoveEnableRules` method. + Quota: + properties: + limits: + description: List of QuotaLimit definitions for the service. + type: array + items: + $ref: '#/components/schemas/QuotaLimit' + metricRules: + items: + $ref: '#/components/schemas/MetricRule' + description: >- + List of MetricRule definitions, each one mapping a selected method + to one or more metrics. + 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 + AddEnableRulesMetadata: + type: object + properties: {} + description: Metadata for the `AddEnableRules` method. + id: AddEnableRulesMetadata + GoogleApiServiceusageV1beta1ServiceIdentity: + properties: + email: + type: string + description: >- + The email address of the service account that a service producer + would use to access consumer resources. + uniqueId: + type: string + description: >- + The unique and stable id of the service account. + https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount + type: object + description: >- + Service identity for a service. This is the identity that service + producer should use to access consumer resources. + id: GoogleApiServiceusageV1beta1ServiceIdentity + 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: - destinations: + 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 - 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: array - description: >- - The destination where API teams want this client library to be - published. - referenceDocsUri: + launchStage: + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - 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. + - >- + 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 + metadata: + $ref: '#/components/schemas/MetricDescriptorMetadata' + description: Optional. Metadata which can be used to guide usage of the metric. + type: description: >- - Link to automatically generated reference documentation. Example: - https://cloud.google.com/nodejs/docs/reference/asset/latest - deprecated: true - description: Required information for every language. - id: CommonLanguageSettings - Method: - properties: - responseTypeUrl: - type: string - description: The URL of the output message type. - requestStreaming: - description: If true, the request is streamed. - type: boolean - requestTypeUrl: + 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: A URL of the input message type. - name: + valueType: type: string - description: The simple name of this method. - options: + enum: + - VALUE_TYPE_UNSPECIFIED + - BOOL + - INT64 + - DOUBLE + - STRING + - DISTRIBUTION + - MONEY + 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. + 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/Option' - description: Any metadata attached to the method. - responseStreaming: - description: If true, the response is streamed. - type: boolean - syntax: + $ref: '#/components/schemas/LabelDescriptor' + 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. + 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 - description: The source syntax of this method. enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - type: object - description: Method represents a method of an API interface. - id: Method - GoogleApiServiceusageV1Service: - properties: - parent: + - METRIC_KIND_UNSPECIFIED + - GAUGE + - DELTA + - CUMULATIVE + unit: description: >- - The resource name of the consumer. A valid name would be: - - projects/123 + 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 name: - description: >- - The resource name of the consumer and service. A valid name would - be: - projects/123/services/serviceusage.googleapis.com - 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. - 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' - description: A service that is available for use by the consumer. - type: object - id: GoogleApiServiceusageV1Service - GoogleApiServiceusageV1beta1ServiceIdentity: - properties: - uniqueId: - type: string - description: >- - The unique and stable id of the service account. - https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount - email: - description: >- - The email address of the service account that a service producer - would use to access consumer resources. - type: string - id: GoogleApiServiceusageV1beta1ServiceIdentity - description: >- - Service identity for a service. This is the identity that service - producer should use to access consumer resources. - type: object - ImportConsumerOverridesResponse: - id: ImportConsumerOverridesResponse - properties: - overrides: - items: - $ref: '#/components/schemas/QuotaOverride' - description: The overrides that were created from the imported data. - type: array - type: object - description: Response message for ImportConsumerOverrides - AddEnableRulesResponse: - properties: - parent: - description: >- - The parent consumer policy. It can be - `projects/12345/consumerPolicies/default`, or - `folders/12345/consumerPolicies/default`, or - `organizations/12345/consumerPolicies/default`. + description: The resource name of the metric descriptor. type: string - addedValues: - description: The values added to the parent consumer policy. - type: array - items: - type: string - id: AddEnableRulesResponse - description: The response message of `AddEnableRules` method. - type: object - ServiceIdentity: - type: object - properties: - uniqueId: + description: type: string description: >- - The unique and stable id of the service account. - https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount - email: + A detailed description of the metric, which can be used in + documentation. + displayName: description: >- - The email address of the service account that a service producer - would use to access consumer resources. + 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 - description: >- - Service identity for a service. This is the identity that service - producer should use to access consumer resources. - id: ServiceIdentity CustomError: properties: types: + items: + type: string type: array description: >- The list of custom error detail types, e.g. 'google.foo.v1.CustomError'. - items: - type: string 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' + type: array + type: object + 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 - id: CustomError - CppSettings: - id: CppSettings - description: Settings for C++ client libraries. - type: object - properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - RubySettings: - type: object - properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - description: Settings for Ruby client libraries. - id: RubySettings - CancelOperationRequest: - id: CancelOperationRequest - description: The request message for Operations.CancelOperation. - properties: {} - type: object - Mixin: + HttpRule: 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"; } ... } - type: object - id: Mixin + # 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 | gRPC -----|----- `GET + /v1/messages/123456` | `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 + | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` + | `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 | + gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | + `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 | gRPC + -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | + `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 | gRPC -----|----- `GET /v1/messages/123456` | + `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` | + `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. Example: + http: rules: # Selects a gRPC method and applies HttpRule to it. - + 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: - name: + post: type: string - description: The fully qualified name of the interface which is included. - root: description: >- - If non-empty specifies a path under which inherited HTTP paths are - rooted. - type: string - DeleteAdminQuotaPolicyMetadata: - properties: {} - id: 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 - SourceContext: - description: >- - `SourceContext` represents information about the source of a protobuf - element, like the file in which it is defined. - type: object - properties: - fileName: + Maps to HTTP POST. Used for creating a resource or performing an + action. + selector: 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 - JavaSettings: - id: JavaSettings - description: Settings for Java client libraries. - type: object - properties: - libraryPackage: + Selects a method to which this rule applies. Refer to selector for + syntax details. + patch: + description: Maps to HTTP PATCH. Used for updating a resource. type: string + responseBody: 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 - 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: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - GoogleApiServiceusageV1ServiceConfig: - description: The configuration of the service. - id: GoogleApiServiceusageV1ServiceConfig - type: object - properties: - 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 - monitoring: + 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 + get: + type: string description: >- - Monitoring configuration. This should not include the - 'producer_destinations' field. - $ref: '#/components/schemas/Monitoring' - quota: - description: Quota configuration. - $ref: '#/components/schemas/Quota' - name: + Maps to HTTP GET. Used for listing and getting information about + resources. + delete: + description: Maps to HTTP DELETE. Used for deleting a resource. + type: string + custom: + $ref: '#/components/schemas/CustomHttpPattern' description: >- - The DNS address at which this service is available. An example DNS - address would be: `calendar.googleapis.com`. + 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. + put: type: string - endpoints: + description: Maps to HTTP PUT. Used for replacing a resource. + additionalBindings: items: - $ref: '#/components/schemas/Endpoint' + $ref: '#/components/schemas/HttpRule' description: >- - Configuration for network endpoints. Contains only the names and - aliases of the endpoints. + 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 - apis: + body: 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' - type: array - usage: - $ref: '#/components/schemas/Usage' - description: Configuration controlling usage of this service. - title: + 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 - description: The product title for this service. - authentication: - $ref: '#/components/schemas/Authentication' - description: Auth configuration. Contains only the OAuth rules. - documentation: - description: >- - Additional API documentation. Contains only the summary and the - documentation URL. - $ref: '#/components/schemas/Documentation' - MetricDescriptor: + type: object + EnableServiceRequest: + description: Request message for the `EnableService` method. + properties: {} + type: object + id: EnableServiceRequest + 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. type: object properties: - valueType: - enum: - - VALUE_TYPE_UNSPECIFIED - - BOOL - - INT64 - - DOUBLE - - STRING - - DISTRIBUTION - - MONEY - 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. - labels: - items: - $ref: '#/components/schemas/LabelDescriptor' - type: array + urlQueryParameter: 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. + Define the URL query parameter name to use for the parameter. It is + case sensitive. + type: string name: type: string - description: The resource name of the metric descriptor. - monitoredResourceTypes: - type: array - 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. - type: + description: >- + Define the name of the parameter, such as "api_key" . It is case + sensitive. + httpHeader: 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" - description: + Define the HTTP header name to use for the parameter. It is case + insensitive. + GoogleApiServiceusageV1beta1GetServiceIdentityResponse: + description: Response message for getting service identity. + id: GoogleApiServiceusageV1beta1GetServiceIdentityResponse + properties: + identity: description: >- - A detailed description of the metric, which can be used in - documentation. - type: string - metadata: - description: Optional. Metadata which can be used to guide usage of the metric. - $ref: '#/components/schemas/MetricDescriptorMetadata' - metricKind: + 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' + state: 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. + - IDENTITY_STATE_UNSPECIFIED + - ACTIVE + description: Service identity state. 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. - 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. + Default service identity state. This value is used if the state is + omitted. + - Service identity has been created and can be used. + type: object + BatchEnableServicesResponse: + type: object + 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 + properties: + failures: + description: >- + 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/EnableFailure' + type: array + services: + items: + $ref: '#/components/schemas/GoogleApiServiceusageV1Service' + description: The new state of the services after enabling. + type: array + CustomHttpPattern: + id: CustomHttpPattern + type: object + properties: + path: type: string - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - description: Optional. The launch stage of the metric definition. - unit: + 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. + GoogleApiService: + properties: + billing: + $ref: '#/components/schemas/Billing' + description: Billing configuration. + apis: 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"). - displayName: + 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/Api' + monitoring: + description: Monitoring configuration. + $ref: '#/components/schemas/Monitoring' + title: 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. + The product title for this service, it is the name displayed in + Google Cloud Console. type: string - 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. - Documentation: - id: Documentation - properties: - documentationRootUrl: + logging: + $ref: '#/components/schemas/Logging' + description: Logging configuration. + documentation: + $ref: '#/components/schemas/Documentation' + description: Additional API documentation. + producerProjectId: type: string - description: The URL to the root of documentation. - sectionOverrides: + description: The Google project that owns this service. + http: + $ref: '#/components/schemas/Http' + description: HTTP configuration. + publishing: + $ref: '#/components/schemas/Publishing' 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' + Settings for [Google Cloud Client + libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) + generated from APIs defined as protocol buffers. + control: + description: Configuration for the service control plane. + $ref: '#/components/schemas/Control' + backend: + $ref: '#/components/schemas/Backend' + description: API backend configuration. + 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 + 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. type: array - summary: + items: + $ref: '#/components/schemas/Endpoint' + name: 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`. - rules: - items: - $ref: '#/components/schemas/DocumentationRule' + 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. + sourceInfo: + $ref: '#/components/schemas/SourceInfo' description: >- - A list of documentation rules that apply to individual API elements. - **NOTE:** All service configuration rules follow "last one wins" - order. + Output only. The source information for this configuration if + available. + authentication: + $ref: '#/components/schemas/Authentication' + description: Auth configuration. + metrics: type: array - serviceRootUrl: - type: string + items: + $ref: '#/components/schemas/MetricDescriptor' + description: Defines the metrics used by this service. + systemTypes: + items: + $ref: '#/components/schemas/Type' 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: + 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 + quota: + $ref: '#/components/schemas/Quota' + description: Quota configuration. + context: + $ref: '#/components/schemas/Context' + description: Context configuration. + id: 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: + 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. + logs: + description: Defines the logs used by this service. type: array - description: The top level pages for the documentation set. items: - $ref: '#/components/schemas/Page' - 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 - UpdateConsumerPolicyMetadata: - properties: {} - type: object - description: Metadata for the `UpdateConsumerPolicy` method. - id: UpdateConsumerPolicyMetadata - Backend: - type: object - description: '`Backend` defines the backend configuration for a service.' - id: Backend - properties: - rules: + $ref: '#/components/schemas/LogDescriptor' + usage: + $ref: '#/components/schemas/Usage' + description: Configuration controlling usage of this service. + customError: + $ref: '#/components/schemas/CustomError' + description: Custom error configuration. + enums: items: - $ref: '#/components/schemas/BackendRule' + $ref: '#/components/schemas/Enum' description: >- - A list of API backend rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. + 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 + monitoredResources: + description: >- + Defines the monitored resources used by this service. This is + required by the Service.monitoring and Service.logging + configurations. type: array - Authentication: - type: object - id: Authentication - properties: - rules: items: - $ref: '#/components/schemas/AuthenticationRule' + $ref: '#/components/schemas/MonitoredResourceDescriptor' + systemParameters: + $ref: '#/components/schemas/SystemParameters' + description: System parameter configuration. + types: type: array description: >- - A list of authentication rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - providers: - type: array + 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/AuthProvider' - description: Defines a set of authentication providers that a service supports. + $ref: '#/components/schemas/Type' + 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: + `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 - selector: google.calendar.Delegate - oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read - EnableRule: - id: EnableRule - type: object + provider_id: google_calendar_auth + id: GoogleApiService + MethodSettings: + description: Describes the generator configuration for a method. + id: MethodSettings properties: - groups: - items: - type: string - type: array - 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`. - services: - items: - type: string + autoPopulatedFields: type: array - deprecated: true description: >- - DEPRECATED: Please use field `values`. Service should have prefix - `services/`. The names of the services that are enabled. Example: - `storage.googleapis.com`. - values: + 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 - description: >- - The names of the services or service groups that are enabled. - Example: `services/storage.googleapis.com`, `groups/googleServices`, - `groups/allServices`. - type: array - 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. - enum: - - ENABLE_TYPE_UNSPECIFIED - - CLIENT - - RESOURCE - - V1_COMPATIBLE - description: Client and resource project enable type. + selector: type: string - description: >- - The consumer policy rule that defines usable services and service - groups. - DisableServiceRequest: + 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 type: object + AuthProvider: + id: AuthProvider properties: - checkIfServiceHasUsage: + id: + type: string description: >- - Defines the behavior for checking service usage when disabling a - service. + 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 - enum: - - CHECK_IF_SERVICE_HAS_USAGE_UNSPECIFIED - - SKIP - - CHECK - 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. - disableDependentServices: - type: boolean + jwksUri: 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. - description: Request message for the `DisableService` method. - id: DisableServiceRequest - Field: - properties: - 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 + type: string + jwtLocations: + type: array description: >- - The string value of the default value of this field. Proto2 syntax - only. + 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' + issuer: type: string - 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. - kind: + 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 + authorizationUrl: + description: >- + Redirect URL if JWT token is required but not present or is expired. + Implement authorizationUrl of securityDefinitions in OpenAPI spec. type: string - 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 - 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. - packed: - description: Whether to use alternative packed wire representation. - type: boolean - 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: 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). + AdminQuotaPolicy: + id: AdminQuotaPolicy + properties: + unit: type: string - description: The field cardinality. + 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. name: + 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 - description: The field name. - options: - items: - $ref: '#/components/schemas/Option' - description: The protocol buffer options. - type: array - jsonName: - description: The field JSON name. + policyValue: + description: >- + The quota policy value. Can be any nonnegative integer, or -1 + (unlimited quota). type: string - typeUrl: + format: int64 + metric: type: string description: >- - The field type URL, without the scheme, for message or enumeration - types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. - number: - format: int32 - type: integer - description: The field number. - description: A single field of a message type. + The name of the metric to which this policy applies. An example name + would be: `compute.googleapis.com/cpus` + container: + description: >- + The cloud resource container at which the quota policy is created. + The format is `{container_type}/{container_number}` + type: string + dimensions: + additionalProperties: + type: string + 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: * 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.' + description: Quota policy created by quota administrator. type: object - id: Field - Page: + GoogleApiServiceusageV2alphaConsumerPolicy: properties: - subpages: + enableRules: type: array items: - $ref: '#/components/schemas/Page' + $ref: '#/components/schemas/GoogleApiServiceusageV2alphaEnableRule' description: >- - Subpages of this page. The order of subpages specified here will be - honored in the generated docset. - content: + Enable rules define usable services, groups, and categories. There + can currently be at most one `EnableRule`. This restriction will be + lifted in later releases. + etag: 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. + Output only. An opaque tag indicating the current version of the + policy, used for concurrency control. + readOnly: true type: string name: 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`. - id: Page + readOnly: true + 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`. + 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) + updateTime: + type: string + description: Output only. The time the policy was last updated. + format: google-datetime + readOnly: true + createTime: + format: google-datetime + description: >- + Output only. The time the policy was created. For singleton + policies, this is the first touch of the policy. + type: string + readOnly: true + id: GoogleApiServiceusageV2alphaConsumerPolicy + type: object description: >- - Represents a documentation page. A page can contain subpages to - represent nested documentation set structure. + Consumer Policy is a set of rules that define what services or service + groups can be used for a cloud resource hierarchy. + Mixin: + id: Mixin type: object - ImportAdminQuotaPoliciesResponse: properties: - policies: - items: - $ref: '#/components/schemas/AdminQuotaPolicy' - description: The policies that were created from the imported data. - type: array - id: ImportAdminQuotaPoliciesResponse - type: object - description: Response message for ImportAdminQuotaPolicies - EnableServiceResponse: + 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. 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. + 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"; } ... } + RubySettings: properties: - service: - description: The new state of the service after enabling. - $ref: '#/components/schemas/GoogleApiServiceusageV1Service' + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' type: object - id: EnableServiceResponse - SourceInfo: - id: SourceInfo + description: Settings for Ruby client libraries. + id: RubySettings + BillingDestination: + type: object + description: >- + Configuration of a specific billing destination (Currently only support + bill against consumer project). properties: - sourceFiles: - items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - description: All files used during config generation. + 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: + description: >- + The monitored resource type. The type must be defined in + Service.monitored_resources section. + type: string + id: BillingDestination + PhpSettings: + description: Settings for Php client libraries. + properties: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. type: object - description: Source information used to create a Service Config - ImportAdminOverridesResponse: + id: PhpSettings + 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 + id: Billing properties: - overrides: + consumerDestinations: items: - $ref: '#/components/schemas/QuotaOverride' - description: The overrides that were created from the imported data. + $ref: '#/components/schemas/BillingDestination' type: array - description: Response message for ImportAdminOverrides - type: object - id: ImportAdminOverridesResponse - MetricDescriptorMetadata: - id: MetricDescriptorMetadata - description: Additional annotations that can be used to guide the usage of a metric. - properties: - 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. + 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. + ServiceIdentity: + id: ServiceIdentity + properties: + uniqueId: type: string - 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 - launchStage: - deprecated: true - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - description: Deprecated. Must use the MetricDescriptor.launch_stage instead. + The unique and stable id of the service account. + https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount + email: + description: >- + The email address of the service account that a service producer + would use to access consumer resources. 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: object - DocumentationRule: - id: DocumentationRule + description: >- + Service identity for a service. This is the identity that service + producer should use to access consumer resources. + GoSettings: type: object properties: - disableReplacementWords: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + description: Settings for Go client libraries. + id: GoSettings + QuotaOverride: + id: QuotaOverride + type: object + description: A quota override + properties: + overrideValue: + format: int64 + type: string + description: >- + The overriding quota limit value. Can be any nonnegative integer, or + -1 (unlimited quota). + metric: + type: string + description: >- + The name of the metric to which this override applies. An example + name would be: `compute.googleapis.com/cpus` + name: + 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. + 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. + unit: type: string - deprecationDescription: + 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 description: >- - Deprecation description of the selected element(s). It can be - provided if an element is marked as `deprecated`. - selector: + The resource name of the ancestor that requested the override. For + example: `organizations/12345` or `folders/67890`. Used by admin + overrides only. + dimensions: + type: object + additionalProperties: + 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. - 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. + MonitoringDestination: + properties: + monitoredResource: + description: >- + The monitored resource type. The type must be defined in + Service.monitored_resources section. type: string + metrics: + type: array + items: + 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. - description: A documentation rule provides information about individual API elements. - MetricRule: + Types of the metrics to report to this monitoring destination. Each + type must be defined in Service.metrics section. 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. + Configuration of a specific monitoring destination (the producer project + or the consumer project). type: object - id: MetricRule + id: MonitoringDestination + 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. properties: - selector: - type: string + fullyDecodeReservedExpansion: description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - metricCosts: + 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' 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 + A list of HTTP configuration rules that apply to individual API + methods. **NOTE:** All service configuration rules follow "last one + wins" order. + type: array + id: Http + MethodPolicy: + id: MethodPolicy + description: Defines policies applying to an RPC method. + properties: + 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 + requestPolicies: + items: + $ref: '#/components/schemas/FieldPolicy' + type: array + description: Policies that are applicable to the request message. + 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 + OperationMetadata: + properties: + resourceNames: + items: type: string + type: array + description: >- + The full name of the resources that this operation is directly + associated with. + description: The operation metadata returned for the batchend services operation. + id: OperationMetadata + type: object parameters: + 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 - 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 - uploadType: - description: Legacy upload protocol for media (e.g. "media", "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: uploadType + name: quotaUser schema: type: string alt: @@ -3726,37 +3726,25 @@ 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 - callback: - description: JSONP + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: callback + name: oauth_token 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 - 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: @@ -3768,50 +3756,27 @@ components: enum: - '1' - '2' - 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: boolean + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields schema: type: string - x-stackQL-resources: - services: - id: serviceusage.services - name: services - title: Services - methods: - batch_get: - operation: - $ref: '#/paths/~1v1~1{parentType}~1{parent}~1services/get' - response: - mediaType: application/json - openAPIDocKey: '200' - batch_enable: - operation: - $ref: '#/paths/~1v1~1{parentType}~1{parent}~1services/post' - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: '#/paths/~1v1~1{name}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - enable: - operation: - $ref: '#/paths/~1v1~1{name}/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/services/methods/get' - insert: [] - update: [] - delete: [] + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + x-stackQL-resources: operations: - id: serviceusage.operations + id: google.serviceusage.operations name: operations title: Operations methods: @@ -3851,68 +3816,95 @@ components: update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' + services: + id: google.serviceusage.services + name: services + title: Services + methods: + batch_enable: + operation: + $ref: '#/paths/~1v1~1{parentType}~1{parent}~1services/post' + response: + mediaType: application/json + openAPIDocKey: '200' + _list: + operation: &ref_3 + $ref: '#/paths/~1v1~1{parentType}~1{parent}~1services/get' + response: &ref_4 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.services + list: + operation: *ref_3 + response: *ref_4 + disable: + operation: + $ref: '#/paths/~1v1~1{name}/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1v1~1{name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/services/methods/list' + - $ref: '#/components/x-stackQL-resources/services/methods/get' + insert: [] + update: [] + delete: [] paths: - /v1/{parentType}/{parent}/services: - parameters: &ref_3 + /v1/operations/{operationsId}: + parameters: &ref_5 + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/oauth_token' - get: + - $ref: '#/components/parameters/access_token' + delete: description: >- - Returns the service configurations and enabled states for a given list - of services. - operationId: serviceusage.services.batchGet + Deletes a long-running operation. This method indicates that the client + is no longer interested 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 Oauth2c: - https://www.googleapis.com/auth/cloud-platform - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only + - https://www.googleapis.com/auth/service.management Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only + - https://www.googleapis.com/auth/service.management responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/BatchGetServicesResponse' + $ref: '#/components/schemas/Empty' parameters: - in: path - name: parentType - required: true - schema: - type: string - - in: path - name: parent + name: operationsId required: true schema: type: string - - in: query - name: names - schema: - type: string - post: + get: 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/BatchEnableServicesRequest' + Gets the latest 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 @@ -3931,50 +3923,70 @@ paths: $ref: '#/components/schemas/Operation' parameters: - in: path - name: parentType - required: true - schema: - type: string - - in: path - name: parent + name: operationsId required: true schema: type: string - /v1/{name}: - parameters: *ref_3 + /v1/operations: + parameters: *ref_5 get: - description: Returns the service configuration and enabled state for a given service. - operationId: serviceusage.services.get + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: serviceusage.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 + - https://www.googleapis.com/auth/service.management Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only + - https://www.googleapis.com/auth/service.management responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleApiServiceusageV1Service' + $ref: '#/components/schemas/ListOperationsResponse' parameters: - - in: path + - in: query name: name - 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/operations/{operationsId}:cancel: + parameters: *ref_5 post: - description: Enable a service so that it can be used with a project. - operationId: serviceusage.services.enable + 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/EnableServiceRequest' + $ref: '#/components/schemas/CancelOperationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3990,22 +4002,27 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Empty' parameters: - in: path - name: name + name: operationsId required: true schema: type: string - /v1/operations/{operationsId}: - parameters: *ref_3 - delete: + /v1/{parentType}/{parent}/services: + parameters: *ref_5 + 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: serviceusage.operations.delete + 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/BatchEnableServicesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4021,71 +4038,57 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: operationsId + name: parentType 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 + name: parent required: true schema: type: string - /v1/operations: - parameters: *ref_3 get: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: serviceusage.operations.list + 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 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/ListOperationsResponse' + $ref: '#/components/schemas/ListServicesResponse' parameters: - - in: query - name: filter + - in: path + name: parentType + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: parent + required: true schema: type: string - in: query @@ -4094,28 +4097,29 @@ paths: type: integer format: int32 - in: query - name: name + name: filter schema: type: string - /v1/operations/{operationsId}:cancel: - parameters: *ref_3 + - in: query + name: pageToken + schema: + type: string + /v1/{name}: + parameters: *ref_5 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: serviceusage.operations.cancel + 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/CancelOperationRequest' + $ref: '#/components/schemas/DisableServiceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4131,10 +4135,35 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: operationsId + name: name + required: true + schema: + type: string + 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 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 938b9e17..fe9aa7d4 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/solar.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/solar.yaml @@ -8,7 +8,7 @@ info: description: Solar API. version: v1 x-discovery-doc-revision: '20240529' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://developers.google.com/maps/documentation/solar servers: @@ -34,54 +34,19 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - FinancialAnalysis: + SolarPanel: properties: - financialDetails: - description: >- - Financial information that applies regardless of the financing - method used. - $ref: '#/components/schemas/FinancialDetails' - leasingSavings: - description: Cost and benefit of leasing the solar panels. - $ref: '#/components/schemas/LeasingSavings' - financedPurchaseSavings: - $ref: '#/components/schemas/FinancedPurchaseSavings' - description: >- - Cost and benefit of buying the solar panels by financing the - purchase. - panelConfigIndex: - 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. - type: integer - averageKwhPerMonth: + yearlyEnergyDcKwh: 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. - 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 - cashPurchaseSavings: - description: Cost and benefit of buying the solar panels with cash. - $ref: '#/components/schemas/CashPurchaseSavings' - id: FinancialAnalysis - type: object - description: >- - Analysis of the cost and benefits of the optimum solar layout for a - particular electric bill size. - SolarPanel: - properties: + How much sunlight energy this layout captures over the course of a + year, in DC kWh. + type: number + center: + description: The centre of the panel. + $ref: '#/components/schemas/LatLng' orientation: + description: The orientation of the panel. type: string enum: - SOLAR_PANEL_ORIENTATION_UNSPECIFIED @@ -95,175 +60,476 @@ components: - >- A `PORTRAIT` panel has its long edge parallel to the azimuth direction of the roof segment that it is placed on. - description: The orientation of the panel. segmentIndex: - type: integer + format: int32 description: >- Index in roof_segment_stats of the `RoofSegmentSizeAndSunshineStats` which corresponds to the roof segment that this panel is placed on. - format: int32 - yearlyEnergyDcKwh: - format: float - description: >- - How much sunlight energy this layout captures over the course of a - year, in DC kWh. - type: number - center: - description: The centre of the panel. - $ref: '#/components/schemas/LatLng' + type: integer type: object + id: 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. - id: SolarPanel - RoofSegmentSummary: + LatLng: + id: LatLng properties: - panelsCount: - description: The total number of panels on this segment. - type: integer - format: int32 - 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 - yearlyEnergyDcKwh: + longitude: 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. - format: float - segmentIndex: - format: int32 - description: >- - Index in roof_segment_stats of the corresponding - `RoofSegmentSizeAndSunshineStats`. - type: integer - pitchDegrees: - format: float - description: >- - Angle of the roof segment relative to the theoretical ground plane. - 0 = parallel to the ground, 90 = perpendicular to the ground. + description: The longitude in degrees. It must be in the range [-180.0, +180.0]. + format: double + latitude: type: number + format: double + description: The latitude in degrees. It must be in the range [-90.0, +90.0]. description: >- - Information about a roof segment on the building, with some number of - panels placed on it. + 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: RoofSegmentSummary - Date: - id: Date + SolarPotential: type: object properties: - year: - type: integer + financialAnalyses: 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 + 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 + items: + $ref: '#/components/schemas/FinancialAnalysis' + panelWidthMeters: + type: number description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - type: integer - day: + Width, in meters in portrait orientation, of the panel used in the + calculations. + format: float + panelLifetimeYears: 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. + The expected lifetime, in years, of the solar panels. This is used + in the financial calculations. 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 - 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. - id: LatLngBox - type: object - description: A bounding box in lat/lng coordinates. - SavingsOverTime: - type: object - description: Financial information that's shared between different financing methods. - id: SavingsOverTime - properties: - savingsYear20: - $ref: '#/components/schemas/Money' - description: Savings in the first twenty years after panel installation. - presentValueOfSavingsYear20: + solarPanelConfigs: description: >- - Using the assumed discount rate, what is the present value of the - cumulative 20-year savings? - $ref: '#/components/schemas/Money' - presentValueOfSavingsLifetime: - $ref: '#/components/schemas/Money' + 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. + items: + $ref: '#/components/schemas/SolarPanelConfig' + type: array + solarPanels: + items: + $ref: '#/components/schemas/SolarPanel' description: >- - Using the assumed discount rate, what is the present value of the - cumulative lifetime savings? - financiallyViable: - type: boolean + 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. + type: array + wholeRoofStats: description: >- - Indicates whether this scenario is financially viable. Will be false - for scenarios with poor financial viability (e.g., money-losing). - savingsYear1: - description: Savings in the first year after panel installation. - $ref: '#/components/schemas/Money' - savingsLifetime: - $ref: '#/components/schemas/Money' - description: Savings in the entire panel lifetime. - LatLng: - type: object - 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: - latitude: - description: The latitude in degrees. It must be in the range [-90.0, +90.0]. - format: double + 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' + roofSegmentStats: + type: array + description: Size and sunlight quantiles for each roof segment. + items: + $ref: '#/components/schemas/RoofSegmentSizeAndSunshineStats' + panelCapacityWatts: type: number - longitude: + format: float + description: Capacity, in watts, of the panel used in the calculations. + panelHeightMeters: + description: >- + Height, in meters in portrait orientation, of the panel used in the + calculations. + type: number + format: float + maxArrayAreaMeters2: + format: float + type: number + description: Size, in square meters, of the maximum array. + carbonOffsetFactorKgPerMwh: type: number - description: The longitude in degrees. It must be in the range [-180.0, +180.0]. - format: double - id: LatLng - DataLayers: - properties: - 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 + 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 + maxArrayPanelsCount: + type: integer + description: >- + Size of the maximum array - that is, the maximum number of panels + that can fit on the roof. + format: int32 + maxSunshineHoursPerYear: + 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). + 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 + 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`. + 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: + id: SizeAndSunshineStats + properties: + sunshineQuantiles: + 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. + items: + type: number + format: float + 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: + format: float + type: number + description: >- + The ground footprint area covered by the roof or roof segment, in + m^2. + type: object + description: Size and sunniness quantiles of a roof, or part of a roof. + LatLngBox: + description: A bounding box in lat/lng coordinates. + id: LatLngBox + properties: + sw: + description: The southwest corner of the box. + $ref: '#/components/schemas/LatLng' + ne: + description: The northeast corner of the box. + $ref: '#/components/schemas/LatLng' + type: object + SolarPanelConfig: + type: object + id: SolarPanelConfig + description: >- + SolarPanelConfig describes a particular placement of solar panels on the + roof. + properties: + roofSegmentSummaries: + 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. + items: + $ref: '#/components/schemas/RoofSegmentSummary' + type: array + panelsCount: + type: integer + format: int32 + description: >- + Total number of panels. Note that this is redundant to (the sum of) + the corresponding fields in roof_segment_summaries. + yearlyEnergyDcKwh: + 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. + FinancedPurchaseSavings: + description: >- + Cost and benefit of using a loan to buy a particular configuration of + solar panels with a particular electricity usage. + id: FinancedPurchaseSavings + properties: + rebateValue: + $ref: '#/components/schemas/Money' + description: >- + The value of all tax rebates (including Federal Investment Tax + Credit (ITC)). + savings: + description: How much is saved (or not) over the lifetime period. + $ref: '#/components/schemas/SavingsOverTime' + loanInterestRate: + description: The interest rate on loans assumed in this set of calculations. + format: float + type: number + annualLoanPayment: + $ref: '#/components/schemas/Money' + description: Annual loan payments. + type: object + HttpBody: + id: HttpBody + type: object + properties: + contentType: + description: >- + The HTTP Content-Type header value specifying the content type of + the body. + type: string + data: + format: byte + type: string + description: The HTTP request/response body as raw binary. + 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 + 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. + RoofSegmentSizeAndSunshineStats: + type: object + id: RoofSegmentSizeAndSunshineStats + properties: + stats: + description: Total size and sunlight quantiles for the roof segment. + $ref: '#/components/schemas/SizeAndSunshineStats' + planeHeightAtCenterMeters: + format: float + type: number + 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. + boundingBox: + $ref: '#/components/schemas/LatLngBox' + description: The bounding box of the roof segment. + pitchDegrees: + description: >- + 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 + center: + $ref: '#/components/schemas/LatLng' + description: A point near the center of the roof segment. + 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 + description: Information about the size and sunniness quantiles of a roof segment. + SavingsOverTime: + properties: + presentValueOfSavingsYear20: + $ref: '#/components/schemas/Money' + description: >- + Using the assumed discount rate, what is the present value of the + cumulative 20-year 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 + savingsYear1: + description: Savings in the first year after panel installation. + $ref: '#/components/schemas/Money' + savingsLifetime: + $ref: '#/components/schemas/Money' + description: Savings in the entire panel lifetime. + savingsYear20: + $ref: '#/components/schemas/Money' + description: Savings in the first twenty years after panel installation. + presentValueOfSavingsLifetime: + $ref: '#/components/schemas/Money' + description: >- + Using the assumed discount rate, what is the present value of the + cumulative lifetime savings? + id: SavingsOverTime + description: Financial information that's shared between different financing methods. + type: object + Money: + 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. + type: integer + format: int32 + currencyCode: + type: string + description: The three-letter currency code defined in ISO 4217. + 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 + type: object + id: Money + description: Represents an amount of money with its currency type. + RoofSegmentSummary: + id: RoofSegmentSummary + description: >- + Information about a roof segment on the building, with some number of + panels placed on it. + properties: + yearlyEnergyDcKwh: + 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. + format: float + type: number + segmentIndex: + format: int32 + description: >- + Index in roof_segment_stats of the corresponding + `RoofSegmentSizeAndSunshineStats`. + type: integer + pitchDegrees: + format: float + description: >- + Angle of the roof segment relative to the theoretical ground plane. + 0 = parallel to the ground, 90 = perpendicular to the ground. + type: number + panelsCount: + format: int32 + description: The total number of panels on this segment. + type: integer + 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 + type: object + Date: + 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 + 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. + format: int32 + type: integer + id: Date + 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: + 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. - imageryQuality: + maskUrl: + 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. + type: string + 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 + imageryQuality: description: The quality of the result's imagery. enum: - IMAGERY_QUALITY_UNSPECIFIED - HIGH - MEDIUM - LOW + type: string enumDescriptions: - No quality is known. - The underlying imagery and DSM data were processed at 0.1 m/pixel. @@ -271,15 +537,28 @@ components: The underlying imagery and DSM data were processed at 0.25 m/pixel. - The underlying imagery and DSM data were processed at 0.5 m/pixel. - maskUrl: + imageryProcessedDate: + description: When processing was completed on this imagery. + $ref: '#/components/schemas/Date' + dsmUrl: 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. + 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. + 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. + rgbUrl: + type: string + description: The URL for an image of RGB data (aerial photo) of the region. hourlyShadeUrls: + type: array items: type: string - type: array description: >- Twelve URLs for hourly shade, corresponding to January...December, in order. Each GeoTIFF will contain 24 bands, corresponding to the @@ -304,120 +583,89 @@ 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). - imageryProcessedDate: - $ref: '#/components/schemas/Date' - description: When processing was completed on this imagery. - 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 - 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. - rgbUrl: - type: string - description: The URL for an image of RGB data (aerial photo) of the region. - 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 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: + id: 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 properties: - netMeteringAllowed: - type: boolean - description: Whether net metering is allowed. - solarPercentage: - type: number + utilityIncentive: description: >- - Percentage (0-100) of the user's power supplied by solar. Valid for - the first year but approximately correct for future years. + Amount of money available from utility incentives; this applies if + the user buys (with or without a loan) the panels. + $ref: '#/components/schemas/Money' + initialAcKwhPerYear: + type: number format: float + description: >- + How many AC kWh we think the solar panels will generate in their + first year. 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. - $ref: '#/components/schemas/Money' 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. - percentageExportedToGrid: + $ref: '#/components/schemas/Money' + 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. + 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: format: float + type: number + description: >- + Percentage (0-100) of the user's power supplied by solar. Valid for + the first year but approximately correct for future years. + percentageExportedToGrid: 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. + format: float + netMeteringAllowed: + type: boolean + description: Whether net metering is allowed. remainingLifetimeUtilityBill: description: >- Utility bill for electricity not produced by solar, for the lifetime of the panels. $ref: '#/components/schemas/Money' - 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' - initialAcKwhPerYear: - type: number - format: float - 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. - id: FinancialDetails + type: object LeasingSavings: + id: LeasingSavings + type: object description: >- Cost and benefit of leasing a particular configuration of solar panels with a particular electricity usage. - type: object - id: LeasingSavings properties: annualLeasingCost: - $ref: '#/components/schemas/Money' description: Estimated annual leasing cost. + $ref: '#/components/schemas/Money' + leasesAllowed: + type: boolean + 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. + $ref: '#/components/schemas/SavingsOverTime' leasesSupported: type: boolean description: >- @@ -426,147 +674,61 @@ components: 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 - 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. - HttpBody: - properties: - contentType: - type: string - description: >- - The HTTP Content-Type header value specifying the content type of - the body. - 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. - data: - description: The HTTP request/response body as raw binary. - format: byte - type: string - 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 - CashPurchaseSavings: - properties: - paybackYears: - format: float - description: >- - Number of years until payback occurs. A negative value means payback - never occurs within the lifetime period. - type: number - 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' - rebateValue: - description: The value of all tax rebates. - $ref: '#/components/schemas/Money' - outOfPocketCost: - description: >- - 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' - savings: - $ref: '#/components/schemas/SavingsOverTime' - description: How much is saved (or not) over the lifetime period. - id: CashPurchaseSavings - type: object - description: >- - Cost and benefit of an outright purchase of a particular configuration - of solar panels with a particular electricity usage. - SolarPanelConfig: - id: SolarPanelConfig - properties: - panelsCount: - description: >- - Total number of panels. Note that this is redundant to (the sum of) - the corresponding fields in roof_segment_summaries. - format: int32 - type: integer - yearlyEnergyDcKwh: - 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. - roofSegmentSummaries: - items: - $ref: '#/components/schemas/RoofSegmentSummary' - 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. + FinancialAnalysis: description: >- - SolarPanelConfig describes a particular placement of solar panels on the - roof. + Analysis of the cost and benefits of the optimum solar layout for a + particular electric bill size. type: object - FinancedPurchaseSavings: properties: - savings: - $ref: '#/components/schemas/SavingsOverTime' - description: How much is saved (or not) over the lifetime period. - annualLoanPayment: - description: Annual loan payments. - $ref: '#/components/schemas/Money' - loanInterestRate: - description: The interest rate on loans assumed in this set of calculations. + financialDetails: + description: >- + Financial information that applies regardless of the financing + method used. + $ref: '#/components/schemas/FinancialDetails' + financedPurchaseSavings: + $ref: '#/components/schemas/FinancedPurchaseSavings' + description: >- + Cost and benefit of buying the solar panels by financing the + purchase. + averageKwhPerMonth: format: float type: number - rebateValue: + description: >- + How much electricity the house uses in an average month, based on + the bill size and the local electricity rates. + cashPurchaseSavings: + $ref: '#/components/schemas/CashPurchaseSavings' + description: Cost and benefit of buying the solar panels with cash. + monthlyBill: + description: The monthly electric bill this analysis assumes. $ref: '#/components/schemas/Money' + defaultBill: + type: boolean description: >- - The value of all tax rebates (including Federal Investment Tax - Credit (ITC)). - description: >- - Cost and benefit of using a loan to buy a particular configuration of - solar panels with a particular electricity usage. - id: FinancedPurchaseSavings - type: object + 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. + panelConfigIndex: + format: int32 + type: integer + 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. + leasingSavings: + description: Cost and benefit of leasing the solar panels. + $ref: '#/components/schemas/LeasingSavings' + id: FinancialAnalysis BuildingInsights: - description: >- - Response message for `Solar.FindClosestBuildingInsights`. Information - about the location, dimensions, and solar potential of a building. id: BuildingInsights - type: object properties: - postalCode: + imageryProcessedDate: + description: When processing was completed on this imagery. + $ref: '#/components/schemas/Date' + statisticalArea: type: string - description: Postal code (e.g., US zip code) this building is contained by. + description: Statistical area (e.g., US census tract) this building is in. imageryQuality: - type: string enumDescriptions: - No quality is known. - The underlying imagery and DSM data were processed at 0.1 m/pixel. @@ -574,14 +736,21 @@ components: The underlying imagery and DSM data were processed at 0.25 m/pixel. - The underlying imagery and DSM data were processed at 0.5 m/pixel. + type: string + description: >- + The quality of the imagery used to compute the data for this + building. enum: - IMAGERY_QUALITY_UNSPECIFIED - HIGH - MEDIUM - LOW - description: >- - The quality of the imagery used to compute the data for this - building. + solarPotential: + $ref: '#/components/schemas/SolarPotential' + description: Solar potential of the building. + 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 @@ -590,222 +759,53 @@ components: type: string regionCode: type: string - description: Region code for the country (or region) this building is in. - imageryProcessedDate: - $ref: '#/components/schemas/Date' - description: When processing was completed on this imagery. - center: - description: A point near the center of the building. - $ref: '#/components/schemas/LatLng' - boundingBox: - description: The bounding box of the building. - $ref: '#/components/schemas/LatLngBox' - name: - type: string - description: The resource name for the building, of the format `building/`. - solarPotential: - $ref: '#/components/schemas/SolarPotential' - description: Solar potential of the building. - imageryDate: - description: Date that the underlying imagery was acquired. This is approximate. - $ref: '#/components/schemas/Date' - statisticalArea: - type: string - description: Statistical area (e.g., US census tract) this building is in. - SolarPotential: - properties: - maxArrayAreaMeters2: - type: number - format: float - description: Size, in square meters, of the maximum array. - 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. - items: - $ref: '#/components/schemas/SolarPanel' - type: array - panelCapacityWatts: - type: number - description: Capacity, in watts, of the panel used in the calculations. - format: float - maxSunshineHoursPerYear: - 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). - format: float - 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. - 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 - 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`. - financialAnalyses: - 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 - items: - $ref: '#/components/schemas/FinancialAnalysis' - solarPanelConfigs: - items: - $ref: '#/components/schemas/SolarPanelConfig' - type: array - 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. - panelWidthMeters: - description: >- - Width, in meters in portrait orientation, of the panel used in the - calculations. - format: float - type: number - carbonOffsetFactorKgPerMwh: - 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. - type: number - format: float - roofSegmentStats: - items: - $ref: '#/components/schemas/RoofSegmentSizeAndSunshineStats' - description: Size and sunlight quantiles for each roof segment. - type: array - panelHeightMeters: - format: float - type: number - description: >- - Height, in meters in portrait orientation, of the panel used in the - calculations. - panelLifetimeYears: - type: integer - format: int32 - description: >- - The expected lifetime, in years, of the solar panels. This is used - in the financial calculations. - maxArrayPanelsCount: - format: int32 - description: >- - Size of the maximum array - that is, the maximum number of panels - that can fit on the roof. - type: integer - 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. - type: object - id: SolarPotential - SizeAndSunshineStats: - properties: - 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: - format: float - type: number - description: >- - The ground footprint area covered by the roof or roof segment, in - m^2. - 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. - items: - format: float - type: number - id: SizeAndSunshineStats - description: Size and sunniness quantiles of a roof, or part of a roof. - type: object - Money: - type: object - id: Money - description: Represents an amount of money with its currency type. - properties: - 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 - units: + description: Region code for the country (or region) this building is in. + name: type: string - description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. - format: int64 - RoofSegmentSizeAndSunshineStats: - properties: + description: The resource name for the building, of the format `building/`. center: $ref: '#/components/schemas/LatLng' - description: A point near the center of the roof segment. + description: A point near the center of the building. + imageryDate: + description: Date that the underlying imagery was acquired. This is approximate. + $ref: '#/components/schemas/Date' boundingBox: - description: The bounding box of the roof segment. $ref: '#/components/schemas/LatLngBox' - planeHeightAtCenterMeters: - type: number + description: The bounding box of the building. + description: >- + Response message for `Solar.FindClosestBuildingInsights`. Information + about the location, dimensions, and solar potential of a building. + type: object + CashPurchaseSavings: + id: CashPurchaseSavings + description: >- + Cost and benefit of an outright purchase of a particular configuration + of solar panels with a particular electricity usage. + properties: + outOfPocketCost: + $ref: '#/components/schemas/Money' 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 - pitchDegrees: - format: float + Initial cost before tax incentives: the amount that must be paid + out-of-pocket. Contrast with `upfront_cost`, which is after tax + incentives. + savings: + description: How much is saved (or not) over the lifetime period. + $ref: '#/components/schemas/SavingsOverTime' + rebateValue: + $ref: '#/components/schemas/Money' + description: The value of all tax rebates. + upfrontCost: + $ref: '#/components/schemas/Money' description: >- - Angle of the roof segment relative to the theoretical ground plane. - 0 = parallel to the ground, 90 = perpendicular to the ground. - type: number - azimuthDegrees: + 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: 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). - format: float + Number of years until payback occurs. A negative value means payback + never occurs within the lifetime period. type: number - stats: - description: Total size and sunlight quantiles for the roof segment. - $ref: '#/components/schemas/SizeAndSunshineStats' - description: Information about the size and sunniness quantiles of a roof segment. - id: RoofSegmentSizeAndSunshineStats + format: float type: object parameters: fields: @@ -814,64 +814,52 @@ components: name: fields 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 - 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 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 - 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 - _.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' - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + callback: + description: JSONP in: query - name: upload_protocol + name: callback 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 + enum: + - json + - media + - proto quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -881,31 +869,44 @@ components: name: quotaUser schema: type: string - callback: - description: JSONP + _.xgafv: + description: V1 error format. in: query - name: callback + name: $.xgafv + 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. + in: query + name: key schema: type: string x-stackQL-resources: - building_insights: - id: solar.building_insights - name: building_insights - title: Building_insights + data_layers: + id: google.solar.data_layers + name: data_layers + title: Data_layers methods: - find_closest: + get: operation: - $ref: '#/paths/~1v1~1buildingInsights:findClosest/get' + $ref: '#/paths/~1v1~1dataLayers:get/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/data_layers/methods/get' insert: [] update: [] delete: [] geo_tiff: - id: solar.geo_tiff + id: google.solar.geo_tiff name: geo_tiff title: Geo_tiff methods: @@ -921,43 +922,42 @@ components: insert: [] update: [] delete: [] - data_layers: - id: solar.data_layers - name: data_layers - title: Data_layers + building_insights: + id: google.solar.building_insights + name: building_insights + title: Building_insights methods: - get: + find_closest: operation: - $ref: '#/paths/~1v1~1dataLayers:get/get' + $ref: '#/paths/~1v1~1buildingInsights:findClosest/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/data_layers/methods/get' + select: [] insert: [] update: [] delete: [] paths: - /v1/buildingInsights:findClosest: + /v1/dataLayers:get: parameters: &ref_1 - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/key' 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 @@ -969,22 +969,40 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BuildingInsights' + $ref: '#/components/schemas/DataLayers' parameters: - in: query - name: location.latitude + name: requiredQuality + schema: + type: string + - in: query + name: view + schema: + type: string + - in: query + name: location.longitude schema: type: number format: double - in: query - name: location.longitude + name: radiusMeters + schema: + type: number + format: float + - in: query + name: exactQualityRequired + schema: + type: boolean + - in: query + name: location.latitude schema: type: number format: double - in: query - name: requiredQuality + name: pixelSizeMeters schema: - type: string + type: number + format: float /v1/geoTiff:get: parameters: *ref_1 get: @@ -1007,14 +1025,14 @@ paths: name: id schema: type: string - /v1/dataLayers:get: + /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 @@ -1026,37 +1044,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DataLayers' + $ref: '#/components/schemas/BuildingInsights' parameters: - - in: query - name: radiusMeters - schema: - type: number - format: float - - in: query - name: pixelSizeMeters - schema: - type: number - format: float - in: query name: location.longitude schema: type: number format: double - - in: query - name: location.latitude - schema: - type: number - format: double - in: query name: requiredQuality schema: type: string - in: query - name: view - schema: - type: string - - in: query - name: exactQualityRequired + name: location.latitude schema: - type: boolean + type: number + format: double diff --git a/providers/src/googleapis.com/v00.00.00000/services/sourcerepo.yaml b/providers/src/googleapis.com/v00.00.00000/services/sourcerepo.yaml index ac6b354d..d5212e0d 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/sourcerepo.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/sourcerepo.yaml @@ -15,7 +15,7 @@ info: info. version: v1 x-discovery-doc-revision: '20240520' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/source-repositories/docs servers: @@ -735,7 +735,7 @@ components: - '2' x-stackQL-resources: config: - id: sourcerepo.config + id: google.sourcerepo.config name: config title: Config methods: @@ -758,7 +758,7 @@ components: update: [] delete: [] repos: - id: sourcerepo.repos + id: google.sourcerepo.repos name: repos title: Repos methods: @@ -804,15 +804,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/repos/methods/list' - $ref: '#/components/x-stackQL-resources/repos/methods/get' + - $ref: '#/components/x-stackQL-resources/repos/methods/list' insert: - $ref: '#/components/x-stackQL-resources/repos/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/repos/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/repos/methods/delete' repos_iam_policies: - id: sourcerepo.repos_iam_policies + id: google.sourcerepo.repos_iam_policies name: repos_iam_policies title: Repos_iam_policies methods: 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 73edb2bb..5d8fd97d 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/spanner.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/spanner.yaml @@ -10,7 +10,7 @@ info: scalable relational database service. version: v1 x-discovery-doc-revision: '20240529' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/spanner/ servers: @@ -5018,7 +5018,7 @@ components: - '2' x-stackQL-resources: scans: - id: spanner.scans + id: google.spanner.scans name: scans title: Scans methods: @@ -5039,7 +5039,7 @@ components: update: [] delete: [] instance_configs: - id: spanner.instance_configs + id: google.spanner.instance_configs name: instance_configs title: Instance_configs methods: @@ -5082,19 +5082,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/instance_configs/methods/projects_instance_configs_list - $ref: >- #/components/x-stackQL-resources/instance_configs/methods/projects_instance_configs_get + - $ref: >- + #/components/x-stackQL-resources/instance_configs/methods/projects_instance_configs_list insert: - $ref: >- #/components/x-stackQL-resources/instance_configs/methods/projects_instance_configs_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/instance_configs/methods/projects_instance_configs_patch delete: - $ref: >- #/components/x-stackQL-resources/instance_configs/methods/projects_instance_configs_delete operations: - id: spanner.operations + id: google.spanner.operations name: operations title: Operations methods: @@ -5293,46 +5295,46 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_instance_configs_operations_list + #/components/x-stackQL-resources/operations/methods/projects_instance_configs_ssd_caches_operations_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_instance_configs_operations_get + #/components/x-stackQL-resources/operations/methods/projects_instances_databases_operations_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_instance_configs_ssd_caches_operations_list + #/components/x-stackQL-resources/operations/methods/projects_instances_backups_operations_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_instance_configs_ssd_caches_operations_get + #/components/x-stackQL-resources/operations/methods/projects_instances_instance_partitions_operations_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_instances_databases_operations_list + #/components/x-stackQL-resources/operations/methods/projects_instance_configs_operations_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_instances_databases_operations_get + #/components/x-stackQL-resources/operations/methods/projects_instance_configs_ssd_caches_operations_list - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_instances_operations_list + #/components/x-stackQL-resources/operations/methods/projects_instances_databases_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_instances_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_instances_backups_operations_list - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_instances_backups_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_instances_instance_partitions_operations_list - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_instances_instance_partitions_operations_get + #/components/x-stackQL-resources/operations/methods/projects_instance_configs_operations_list + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_instances_operations_list insert: [] update: [] delete: - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_instance_configs_operations_delete - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_instance_configs_ssd_caches_operations_delete - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_instances_databases_operations_delete - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_instances_operations_delete - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_instances_backups_operations_delete - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_instances_instance_partitions_operations_delete + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_instance_configs_operations_delete + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_instances_operations_delete instance_config_operations: - id: spanner.instance_config_operations + id: google.spanner.instance_config_operations name: instance_config_operations title: Instance_config_operations methods: @@ -5354,7 +5356,7 @@ components: update: [] delete: [] instances: - id: spanner.instances + id: google.spanner.instances name: instances title: Instances methods: @@ -5403,19 +5405,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/instances/methods/projects_instances_list - $ref: >- #/components/x-stackQL-resources/instances/methods/projects_instances_get + - $ref: >- + #/components/x-stackQL-resources/instances/methods/projects_instances_list insert: - $ref: >- #/components/x-stackQL-resources/instances/methods/projects_instances_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/instances/methods/projects_instances_patch delete: - $ref: >- #/components/x-stackQL-resources/instances/methods/projects_instances_delete instances_iam_policies: - id: spanner.instances_iam_policies + id: google.spanner.instances_iam_policies name: instances_iam_policies title: Instances_iam_policies methods: @@ -5452,7 +5456,7 @@ components: update: [] delete: [] databases_scans: - id: spanner.databases_scans + id: google.spanner.databases_scans name: databases_scans title: Databases_scans methods: @@ -5471,7 +5475,7 @@ components: update: [] delete: [] databases: - id: spanner.databases + id: google.spanner.databases name: databases title: Databases methods: @@ -5530,17 +5534,19 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/databases/methods/projects_instances_databases_list - $ref: >- #/components/x-stackQL-resources/databases/methods/projects_instances_databases_get + - $ref: >- + #/components/x-stackQL-resources/databases/methods/projects_instances_databases_list insert: - $ref: >- #/components/x-stackQL-resources/databases/methods/projects_instances_databases_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/databases/methods/projects_instances_databases_patch delete: [] databases_ddl: - id: spanner.databases_ddl + id: google.spanner.databases_ddl name: databases_ddl title: Databases_ddl methods: @@ -5566,7 +5572,7 @@ components: update: [] delete: [] databases_iam_policies: - id: spanner.databases_iam_policies + id: google.spanner.databases_iam_policies name: databases_iam_policies title: Databases_iam_policies methods: @@ -5603,7 +5609,7 @@ components: update: [] delete: [] database_roles_iam_policies: - id: spanner.database_roles_iam_policies + id: google.spanner.database_roles_iam_policies name: database_roles_iam_policies title: Database_roles_iam_policies methods: @@ -5620,7 +5626,7 @@ components: update: [] delete: [] database_roles: - id: spanner.database_roles + id: google.spanner.database_roles name: database_roles title: Database_roles methods: @@ -5643,7 +5649,7 @@ components: update: [] delete: [] sessions: - id: spanner.sessions + id: google.spanner.sessions name: sessions title: Sessions methods: @@ -5765,10 +5771,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_instances_databases_sessions_list - $ref: >- #/components/x-stackQL-resources/sessions/methods/projects_instances_databases_sessions_get + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_instances_databases_sessions_list insert: - $ref: >- #/components/x-stackQL-resources/sessions/methods/projects_instances_databases_sessions_create @@ -5777,7 +5783,7 @@ components: - $ref: >- #/components/x-stackQL-resources/sessions/methods/projects_instances_databases_sessions_delete backups_iam_policies: - id: spanner.backups_iam_policies + id: google.spanner.backups_iam_policies name: backups_iam_policies title: Backups_iam_policies methods: @@ -5814,7 +5820,7 @@ components: update: [] delete: [] backups: - id: spanner.backups + id: google.spanner.backups name: backups title: Backups methods: @@ -5866,19 +5872,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/backups/methods/projects_instances_backups_list - $ref: >- #/components/x-stackQL-resources/backups/methods/projects_instances_backups_get + - $ref: >- + #/components/x-stackQL-resources/backups/methods/projects_instances_backups_list insert: - $ref: >- #/components/x-stackQL-resources/backups/methods/projects_instances_backups_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/backups/methods/projects_instances_backups_patch delete: - $ref: >- #/components/x-stackQL-resources/backups/methods/projects_instances_backups_delete database_operations: - id: spanner.database_operations + id: google.spanner.database_operations name: database_operations title: Database_operations methods: @@ -5901,7 +5909,7 @@ components: update: [] delete: [] backup_operations: - id: spanner.backup_operations + id: google.spanner.backup_operations name: backup_operations title: Backup_operations methods: @@ -5924,7 +5932,7 @@ components: update: [] delete: [] instance_partitions: - id: spanner.instance_partitions + id: google.spanner.instance_partitions name: instance_partitions title: Instance_partitions methods: @@ -5969,19 +5977,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/instance_partitions/methods/projects_instances_instance_partitions_list - $ref: >- #/components/x-stackQL-resources/instance_partitions/methods/projects_instances_instance_partitions_get + - $ref: >- + #/components/x-stackQL-resources/instance_partitions/methods/projects_instances_instance_partitions_list insert: - $ref: >- #/components/x-stackQL-resources/instance_partitions/methods/projects_instances_instance_partitions_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/instance_partitions/methods/projects_instances_instance_partitions_patch delete: - $ref: >- #/components/x-stackQL-resources/instance_partitions/methods/projects_instances_instance_partitions_delete instance_partition_operations: - id: spanner.instance_partition_operations + id: google.spanner.instance_partition_operations name: instance_partition_operations title: Instance_partition_operations methods: 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 49f5c7df..f68543bb 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: '20240523' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/speech-to-text/docs/quickstart-protocol servers: @@ -1380,7 +1380,7 @@ components: - '2' x-stackQL-resources: phrase_sets: - id: speech.phrase_sets + id: google.speech.phrase_sets name: phrase_sets title: Phrase_sets methods: @@ -1425,15 +1425,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/phrase_sets/methods/list' - $ref: '#/components/x-stackQL-resources/phrase_sets/methods/get' + - $ref: '#/components/x-stackQL-resources/phrase_sets/methods/list' insert: - $ref: '#/components/x-stackQL-resources/phrase_sets/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/phrase_sets/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/phrase_sets/methods/delete' custom_classes: - id: speech.custom_classes + id: google.speech.custom_classes name: custom_classes title: Custom_classes methods: @@ -1478,15 +1479,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/custom_classes/methods/list' - $ref: '#/components/x-stackQL-resources/custom_classes/methods/get' + - $ref: '#/components/x-stackQL-resources/custom_classes/methods/list' insert: - $ref: '#/components/x-stackQL-resources/custom_classes/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/custom_classes/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/custom_classes/methods/delete' operations: - id: speech.operations + id: google.speech.operations name: operations title: Operations methods: @@ -1508,13 +1510,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: [] speech: - id: speech.speech + id: google.speech.speech name: speech title: Speech methods: 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 8149247f..bc9c0208 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: '20240521' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://developers.google.com/cloud-sql/ servers: @@ -4220,7 +4220,7 @@ components: - '2' x-stackQL-resources: instances_server_ca: - id: sqladmin.instances_server_ca + id: google.sqladmin.instances_server_ca name: instances_server_ca title: Instances_server_ca methods: @@ -4237,7 +4237,7 @@ components: update: [] delete: [] instances: - id: sqladmin.instances + id: google.sqladmin.instances name: instances title: Instances methods: @@ -4448,11 +4448,13 @@ components: - $ref: '#/components/x-stackQL-resources/instances/methods/list' insert: - $ref: '#/components/x-stackQL-resources/instances/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/instances/methods/patch' + - $ref: '#/components/x-stackQL-resources/instances/methods/update' delete: - $ref: '#/components/x-stackQL-resources/instances/methods/delete' instances_server_cas: - id: sqladmin.instances_server_cas + id: google.sqladmin.instances_server_cas name: instances_server_cas title: Instances_server_cas methods: @@ -4471,7 +4473,7 @@ components: update: [] delete: [] ssl_certs_ephemeral: - id: sqladmin.ssl_certs_ephemeral + id: google.sqladmin.ssl_certs_ephemeral name: ssl_certs_ephemeral title: Ssl_certs_ephemeral methods: @@ -4490,7 +4492,7 @@ components: update: [] delete: [] ssl_certs: - id: sqladmin.ssl_certs + id: google.sqladmin.ssl_certs name: ssl_certs title: Ssl_certs methods: @@ -4532,7 +4534,7 @@ components: delete: - $ref: '#/components/x-stackQL-resources/ssl_certs/methods/delete' instances_disk_shrink_config: - id: sqladmin.instances_disk_shrink_config + id: google.sqladmin.instances_disk_shrink_config name: instances_disk_shrink_config title: Instances_disk_shrink_config methods: @@ -4551,7 +4553,7 @@ components: update: [] delete: [] instances_latest_recovery_time: - id: sqladmin.instances_latest_recovery_time + id: google.sqladmin.instances_latest_recovery_time name: instances_latest_recovery_time title: Instances_latest_recovery_time methods: @@ -4570,7 +4572,7 @@ components: update: [] delete: [] backup_runs: - id: sqladmin.backup_runs + id: google.sqladmin.backup_runs name: backup_runs title: Backup_runs methods: @@ -4616,7 +4618,7 @@ components: delete: - $ref: '#/components/x-stackQL-resources/backup_runs/methods/delete' connect: - id: sqladmin.connect + id: google.sqladmin.connect name: connect title: Connect methods: @@ -4641,7 +4643,7 @@ components: update: [] delete: [] databases: - id: sqladmin.databases + id: google.sqladmin.databases name: databases title: Databases methods: @@ -4693,11 +4695,13 @@ components: - $ref: '#/components/x-stackQL-resources/databases/methods/list' insert: - $ref: '#/components/x-stackQL-resources/databases/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/databases/methods/patch' + - $ref: '#/components/x-stackQL-resources/databases/methods/update' delete: - $ref: '#/components/x-stackQL-resources/databases/methods/delete' flags: - id: sqladmin.flags + id: google.sqladmin.flags name: flags title: Flags methods: @@ -4714,7 +4718,7 @@ components: update: [] delete: [] operations: - id: sqladmin.operations + id: google.sqladmin.operations name: operations title: Operations methods: @@ -4749,7 +4753,7 @@ components: update: [] delete: [] tiers: - id: sqladmin.tiers + id: google.sqladmin.tiers name: tiers title: Tiers methods: @@ -4766,7 +4770,7 @@ components: update: [] delete: [] users: - id: sqladmin.users + id: google.sqladmin.users name: users title: Users methods: @@ -4811,11 +4815,12 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/users/methods/list' - $ref: '#/components/x-stackQL-resources/users/methods/get' + - $ref: '#/components/x-stackQL-resources/users/methods/list' insert: - $ref: '#/components/x-stackQL-resources/users/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/users/methods/update' delete: - $ref: '#/components/x-stackQL-resources/users/methods/delete' paths: 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 5d7e8ad5..b39c4a5e 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: '20240528' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://developers.google.com/storage/docs/json_api/ servers: @@ -1988,7 +1988,7 @@ components: type: string x-stackQL-resources: anywhere_caches: - id: storage.anywhere_caches + id: google.storage.anywhere_caches name: anywhere_caches title: Anywhere_caches methods: @@ -2043,14 +2043,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/anywhere_caches/methods/list' - $ref: '#/components/x-stackQL-resources/anywhere_caches/methods/get' + - $ref: '#/components/x-stackQL-resources/anywhere_caches/methods/list' insert: - $ref: '#/components/x-stackQL-resources/anywhere_caches/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/anywhere_caches/methods/update' delete: [] bucket_access_controls: - id: storage.bucket_access_controls + id: google.storage.bucket_access_controls name: bucket_access_controls title: Bucket_access_controls methods: @@ -2099,12 +2100,16 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/bucket_access_controls/methods/insert - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/bucket_access_controls/methods/patch + - $ref: >- + #/components/x-stackQL-resources/bucket_access_controls/methods/update delete: - $ref: >- #/components/x-stackQL-resources/bucket_access_controls/methods/delete buckets: - id: storage.buckets + id: google.storage.buckets name: buckets title: Buckets methods: @@ -2160,11 +2165,13 @@ components: - $ref: '#/components/x-stackQL-resources/buckets/methods/list' insert: - $ref: '#/components/x-stackQL-resources/buckets/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/buckets/methods/patch' + - $ref: '#/components/x-stackQL-resources/buckets/methods/update' delete: - $ref: '#/components/x-stackQL-resources/buckets/methods/delete' buckets_iam_policies: - id: storage.buckets_iam_policies + id: google.storage.buckets_iam_policies name: buckets_iam_policies title: Buckets_iam_policies methods: @@ -2198,7 +2205,7 @@ components: update: [] delete: [] buckets_storage_layout: - id: storage.buckets_storage_layout + id: google.storage.buckets_storage_layout name: buckets_storage_layout title: Buckets_storage_layout methods: @@ -2216,7 +2223,7 @@ components: update: [] delete: [] operations: - id: storage.operations + id: google.storage.operations name: operations title: Operations methods: @@ -2250,7 +2257,7 @@ components: update: [] delete: [] channels: - id: storage.channels + id: google.storage.channels name: channels title: Channels methods: @@ -2266,7 +2273,7 @@ components: update: [] delete: [] default_object_access_controls: - id: storage.default_object_access_controls + id: google.storage.default_object_access_controls name: default_object_access_controls title: Default_object_access_controls methods: @@ -2315,12 +2322,16 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/default_object_access_controls/methods/insert - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/default_object_access_controls/methods/patch + - $ref: >- + #/components/x-stackQL-resources/default_object_access_controls/methods/update delete: - $ref: >- #/components/x-stackQL-resources/default_object_access_controls/methods/delete folders: - id: storage.folders + id: google.storage.folders name: folders title: Folders methods: @@ -2369,7 +2380,7 @@ components: delete: - $ref: '#/components/x-stackQL-resources/folders/methods/delete' managed_folders: - id: storage.managed_folders + id: google.storage.managed_folders name: managed_folders title: Managed_folders methods: @@ -2411,7 +2422,7 @@ components: delete: - $ref: '#/components/x-stackQL-resources/managed_folders/methods/delete' managed_folders_iam_policies: - id: storage.managed_folders_iam_policies + id: google.storage.managed_folders_iam_policies name: managed_folders_iam_policies title: Managed_folders_iam_policies methods: @@ -2446,7 +2457,7 @@ components: update: [] delete: [] notifications: - id: storage.notifications + id: google.storage.notifications name: notifications title: Notifications methods: @@ -2484,7 +2495,7 @@ components: delete: - $ref: '#/components/x-stackQL-resources/notifications/methods/delete' object_access_controls: - id: storage.object_access_controls + id: google.storage.object_access_controls name: object_access_controls title: Object_access_controls methods: @@ -2533,12 +2544,16 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/object_access_controls/methods/insert - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/object_access_controls/methods/patch + - $ref: >- + #/components/x-stackQL-resources/object_access_controls/methods/update delete: - $ref: >- #/components/x-stackQL-resources/object_access_controls/methods/delete objects: - id: storage.objects + id: google.storage.objects name: objects title: Objects methods: @@ -2627,11 +2642,13 @@ components: - $ref: '#/components/x-stackQL-resources/objects/methods/list' insert: - $ref: '#/components/x-stackQL-resources/objects/methods/insert' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/objects/methods/patch' + - $ref: '#/components/x-stackQL-resources/objects/methods/update' delete: - $ref: '#/components/x-stackQL-resources/objects/methods/delete' objects_iam_policies: - id: storage.objects_iam_policies + id: google.storage.objects_iam_policies name: objects_iam_policies title: Objects_iam_policies methods: @@ -2665,7 +2682,7 @@ components: update: [] delete: [] hmac_keys: - id: storage.hmac_keys + id: google.storage.hmac_keys name: hmac_keys title: Hmac_keys methods: @@ -2705,15 +2722,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/hmac_keys/methods/list' - $ref: '#/components/x-stackQL-resources/hmac_keys/methods/get' + - $ref: '#/components/x-stackQL-resources/hmac_keys/methods/list' insert: - $ref: '#/components/x-stackQL-resources/hmac_keys/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/hmac_keys/methods/update' delete: - $ref: '#/components/x-stackQL-resources/hmac_keys/methods/delete' service_account: - id: storage.service_account + id: google.storage.service_account name: service_account title: Service_account methods: 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 585acf96..a6338078 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: '20240525' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/storage-transfer/docs servers: @@ -1797,7 +1797,7 @@ components: - '2' x-stackQL-resources: transfer_operations: - id: storagetransfer.transfer_operations + id: google.storagetransfer.transfer_operations name: transfer_operations title: Transfer_operations methods: @@ -1840,13 +1840,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/transfer_operations/methods/list' - $ref: '#/components/x-stackQL-resources/transfer_operations/methods/get' + - $ref: '#/components/x-stackQL-resources/transfer_operations/methods/list' insert: [] update: [] delete: [] google_service_accounts: - id: storagetransfer.google_service_accounts + id: google.storagetransfer.google_service_accounts name: google_service_accounts title: Google_service_accounts methods: @@ -1864,7 +1864,7 @@ components: update: [] delete: [] transfer_jobs: - id: storagetransfer.transfer_jobs + id: google.storagetransfer.transfer_jobs name: transfer_jobs title: Transfer_jobs methods: @@ -1910,15 +1910,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/transfer_jobs/methods/list' - $ref: '#/components/x-stackQL-resources/transfer_jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/transfer_jobs/methods/list' insert: - $ref: '#/components/x-stackQL-resources/transfer_jobs/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/transfer_jobs/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/transfer_jobs/methods/delete' agent_pools: - id: storagetransfer.agent_pools + id: google.storagetransfer.agent_pools name: agent_pools title: Agent_pools methods: @@ -1961,11 +1962,12 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/agent_pools/methods/list' - $ref: '#/components/x-stackQL-resources/agent_pools/methods/get' + - $ref: '#/components/x-stackQL-resources/agent_pools/methods/list' insert: - $ref: '#/components/x-stackQL-resources/agent_pools/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/agent_pools/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/agent_pools/methods/delete' paths: 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 7ce44f15..87637a89 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/testing.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/testing.yaml @@ -10,7 +10,7 @@ info: Google infrastructure. version: v1 x-discovery-doc-revision: '20240530' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://firebase.google.com/docs/test-lab/ servers: @@ -2605,7 +2605,7 @@ components: - '2' x-stackQL-resources: test_matrices: - id: testing.test_matrices + id: google.testing.test_matrices name: test_matrices title: Test_matrices methods: @@ -2637,7 +2637,7 @@ components: update: [] delete: [] device_sessions: - id: testing.device_sessions + id: google.testing.device_sessions name: device_sessions title: Device_sessions methods: @@ -2680,14 +2680,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/device_sessions/methods/list' - $ref: '#/components/x-stackQL-resources/device_sessions/methods/get' + - $ref: '#/components/x-stackQL-resources/device_sessions/methods/list' insert: - $ref: '#/components/x-stackQL-resources/device_sessions/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/device_sessions/methods/patch' delete: [] application_detail_service_apk_details: - id: testing.application_detail_service_apk_details + id: google.testing.application_detail_service_apk_details name: application_detail_service_apk_details title: Application_detail_service_apk_details methods: @@ -2703,7 +2704,7 @@ components: update: [] delete: [] test_environment_catalog: - id: testing.test_environment_catalog + id: google.testing.test_environment_catalog name: test_environment_catalog title: Test_environment_catalog methods: 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 2ff025a8..2d1ba4e4 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: '20240525' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/text-to-speech/ servers: @@ -567,7 +567,7 @@ components: - '2' x-stackQL-resources: voices: - id: texttospeech.voices + id: google.texttospeech.voices name: voices title: Voices methods: @@ -584,7 +584,7 @@ components: update: [] delete: [] text: - id: texttospeech.text + id: google.texttospeech.text name: text title: Text methods: @@ -600,7 +600,7 @@ components: update: [] delete: [] locations: - id: texttospeech.locations + id: google.texttospeech.locations name: locations title: Locations methods: @@ -617,7 +617,7 @@ components: update: [] delete: [] operations: - id: texttospeech.operations + id: google.texttospeech.operations name: operations title: Operations methods: @@ -653,8 +653,8 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: 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 fc108c68..7568cdbd 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: '20240519' - x-generated-date: '2024-06-02' + x-discovery-doc-revision: '20240528' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/tpu/ servers: @@ -1188,7 +1188,7 @@ components: - '2' x-stackQL-resources: locations: - id: tpu.locations + id: google.tpu.locations name: locations title: Locations methods: @@ -1217,13 +1217,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: tpu.operations + id: google.tpu.operations name: operations title: Operations methods: @@ -1261,14 +1261,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' nodes: - id: tpu.nodes + id: google.tpu.nodes name: nodes title: Nodes methods: @@ -1327,15 +1327,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/nodes/methods/list' - $ref: '#/components/x-stackQL-resources/nodes/methods/get' + - $ref: '#/components/x-stackQL-resources/nodes/methods/list' insert: - $ref: '#/components/x-stackQL-resources/nodes/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/nodes/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/nodes/methods/delete' nodes_guest_attributes: - id: tpu.nodes_guest_attributes + id: google.tpu.nodes_guest_attributes name: nodes_guest_attributes title: Nodes_guest_attributes methods: @@ -1352,7 +1353,7 @@ components: update: [] delete: [] queued_resources: - id: tpu.queued_resources + id: google.tpu.queued_resources name: queued_resources title: Queued_resources methods: @@ -1397,15 +1398,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/queued_resources/methods/list' - $ref: '#/components/x-stackQL-resources/queued_resources/methods/get' + - $ref: '#/components/x-stackQL-resources/queued_resources/methods/list' insert: - $ref: '#/components/x-stackQL-resources/queued_resources/methods/create' update: [] delete: - $ref: '#/components/x-stackQL-resources/queued_resources/methods/delete' accelerator_types: - id: tpu.accelerator_types + id: google.tpu.accelerator_types name: accelerator_types title: Accelerator_types methods: @@ -1429,13 +1430,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/accelerator_types/methods/list' - $ref: '#/components/x-stackQL-resources/accelerator_types/methods/get' + - $ref: '#/components/x-stackQL-resources/accelerator_types/methods/list' insert: [] update: [] delete: [] runtime_versions: - id: tpu.runtime_versions + id: google.tpu.runtime_versions name: runtime_versions title: Runtime_versions methods: @@ -1459,8 +1460,8 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/runtime_versions/methods/list' - $ref: '#/components/x-stackQL-resources/runtime_versions/methods/get' + - $ref: '#/components/x-stackQL-resources/runtime_versions/methods/list' insert: [] update: [] delete: [] 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 06d3abde..2ead9f16 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: '20240513' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/traffic-director servers: @@ -1442,7 +1442,7 @@ components: - '2' x-stackQL-resources: discovery: - id: trafficdirector.discovery + id: google.trafficdirector.discovery name: discovery title: Discovery methods: 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 ddd4577e..6fa39801 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/transcoder.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/transcoder.yaml @@ -10,7 +10,7 @@ info: distribution. For more information, see the Transcoder API overview. version: v1 x-discovery-doc-revision: '20240515' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/transcoder/docs/ servers: @@ -1837,7 +1837,7 @@ components: - '2' x-stackQL-resources: jobs: - id: transcoder.jobs + id: google.transcoder.jobs name: jobs title: Jobs methods: @@ -1875,15 +1875,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/jobs/methods/list' - $ref: '#/components/x-stackQL-resources/jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/jobs/methods/list' insert: - $ref: '#/components/x-stackQL-resources/jobs/methods/create' update: [] delete: - $ref: '#/components/x-stackQL-resources/jobs/methods/delete' job_templates: - id: transcoder.job_templates + id: google.transcoder.job_templates name: job_templates title: Job_templates methods: @@ -1921,8 +1921,8 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/job_templates/methods/list' - $ref: '#/components/x-stackQL-resources/job_templates/methods/get' + - $ref: '#/components/x-stackQL-resources/job_templates/methods/list' insert: - $ref: '#/components/x-stackQL-resources/job_templates/methods/create' update: [] 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 2616fc85..37f0064a 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/translate.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/translate.yaml @@ -8,7 +8,7 @@ info: description: Integrates text translation into your website or application. version: v3 x-discovery-doc-revision: '20240301' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/translate/docs/quickstarts servers: @@ -1752,7 +1752,7 @@ components: - '2' x-stackQL-resources: projects: - id: translate.projects + id: google.translate.projects name: projects title: Projects methods: @@ -1780,7 +1780,7 @@ components: update: [] delete: [] supported_languages: - id: translate.supported_languages + id: google.translate.supported_languages name: supported_languages title: Supported_languages methods: @@ -1799,15 +1799,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/supported_languages/methods/projects_get_supported_languages - $ref: >- #/components/x-stackQL-resources/supported_languages/methods/projects_locations_get_supported_languages + - $ref: >- + #/components/x-stackQL-resources/supported_languages/methods/projects_get_supported_languages insert: [] update: [] delete: [] locations: - id: translate.locations + id: google.translate.locations name: locations title: Locations methods: @@ -1878,15 +1878,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/locations/methods/projects_locations_list - $ref: >- #/components/x-stackQL-resources/locations/methods/projects_locations_get + - $ref: >- + #/components/x-stackQL-resources/locations/methods/projects_locations_list insert: [] update: [] delete: [] operations: - id: translate.operations + id: google.translate.operations name: operations title: Operations methods: @@ -1931,17 +1931,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list insert: [] update: [] delete: - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_delete glossaries: - id: translate.glossaries + id: google.translate.glossaries name: glossaries title: Glossaries methods: @@ -1986,19 +1986,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/glossaries/methods/projects_locations_glossaries_list - $ref: >- #/components/x-stackQL-resources/glossaries/methods/projects_locations_glossaries_get + - $ref: >- + #/components/x-stackQL-resources/glossaries/methods/projects_locations_glossaries_list insert: - $ref: >- #/components/x-stackQL-resources/glossaries/methods/projects_locations_glossaries_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/glossaries/methods/projects_locations_glossaries_patch delete: - $ref: >- #/components/x-stackQL-resources/glossaries/methods/projects_locations_glossaries_delete glossary_entries: - id: translate.glossary_entries + id: google.translate.glossary_entries name: glossary_entries title: Glossary_entries methods: @@ -2050,12 +2052,14 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/glossary_entries/methods/projects_locations_glossaries_glossary_entries_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/glossary_entries/methods/projects_locations_glossaries_glossary_entries_patch delete: - $ref: >- #/components/x-stackQL-resources/glossary_entries/methods/projects_locations_glossaries_glossary_entries_delete datasets: - id: translate.datasets + id: google.translate.datasets name: datasets title: Datasets methods: @@ -2107,10 +2111,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/datasets/methods/projects_locations_datasets_list - $ref: >- #/components/x-stackQL-resources/datasets/methods/projects_locations_datasets_get + - $ref: >- + #/components/x-stackQL-resources/datasets/methods/projects_locations_datasets_list insert: - $ref: >- #/components/x-stackQL-resources/datasets/methods/projects_locations_datasets_create @@ -2119,7 +2123,7 @@ components: - $ref: >- #/components/x-stackQL-resources/datasets/methods/projects_locations_datasets_delete examples: - id: translate.examples + id: google.translate.examples name: examples title: Examples methods: @@ -2142,7 +2146,7 @@ components: update: [] delete: [] adaptive_mt_datasets: - id: translate.adaptive_mt_datasets + id: google.translate.adaptive_mt_datasets name: adaptive_mt_datasets title: Adaptive_mt_datasets methods: @@ -2187,10 +2191,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/adaptive_mt_datasets/methods/projects_locations_adaptive_mt_datasets_list - $ref: >- #/components/x-stackQL-resources/adaptive_mt_datasets/methods/projects_locations_adaptive_mt_datasets_get + - $ref: >- + #/components/x-stackQL-resources/adaptive_mt_datasets/methods/projects_locations_adaptive_mt_datasets_list insert: - $ref: >- #/components/x-stackQL-resources/adaptive_mt_datasets/methods/projects_locations_adaptive_mt_datasets_create @@ -2199,7 +2203,7 @@ components: - $ref: >- #/components/x-stackQL-resources/adaptive_mt_datasets/methods/projects_locations_adaptive_mt_datasets_delete adaptive_mt_files: - id: translate.adaptive_mt_files + id: google.translate.adaptive_mt_files name: adaptive_mt_files title: Adaptive_mt_files methods: @@ -2240,7 +2244,7 @@ components: - $ref: >- #/components/x-stackQL-resources/adaptive_mt_files/methods/projects_locations_adaptive_mt_datasets_adaptive_mt_files_delete adaptive_mt_sentences: - id: translate.adaptive_mt_sentences + id: google.translate.adaptive_mt_sentences name: adaptive_mt_sentences title: Adaptive_mt_sentences methods: @@ -2276,7 +2280,7 @@ components: update: [] delete: [] models: - id: translate.models + id: google.translate.models name: models title: Models methods: @@ -2314,10 +2318,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/models/methods/projects_locations_models_list - $ref: >- #/components/x-stackQL-resources/models/methods/projects_locations_models_get + - $ref: >- + #/components/x-stackQL-resources/models/methods/projects_locations_models_list insert: - $ref: >- #/components/x-stackQL-resources/models/methods/projects_locations_models_create 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 54e9548c..943c6252 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: '20240327' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/video-intelligence/docs/ servers: @@ -4854,7 +4854,7 @@ components: - '2' x-stackQL-resources: operations: - id: videointelligence.operations + id: google.videointelligence.operations name: operations title: Operations methods: @@ -4892,17 +4892,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list insert: [] update: [] delete: - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_delete long_running_operations: - id: videointelligence.long_running_operations + id: google.videointelligence.long_running_operations name: long_running_operations title: Long_running_operations methods: @@ -4937,7 +4937,7 @@ components: - $ref: >- #/components/x-stackQL-resources/long_running_operations/methods/operations_projects_locations_operations_delete videos: - id: videointelligence.videos + id: google.videointelligence.videos name: videos title: Videos methods: 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 5ea7a809..43e7173f 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: '20240524' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/vision/ servers: @@ -8174,7 +8174,7 @@ components: - '2' x-stackQL-resources: operations: - id: vision.operations + id: google.vision.operations name: operations title: Operations methods: @@ -8230,21 +8230,21 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/operations/methods/operations_list - - $ref: '#/components/x-stackQL-resources/operations/methods/operations_get' + #/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_get - $ref: >- #/components/x-stackQL-resources/operations/methods/locations_operations_get + - $ref: '#/components/x-stackQL-resources/operations/methods/operations_get' + - $ref: >- + #/components/x-stackQL-resources/operations/methods/operations_list insert: [] update: [] delete: - $ref: >- #/components/x-stackQL-resources/operations/methods/operations_delete product_sets: - id: vision.product_sets + id: google.vision.product_sets name: product_sets title: Product_sets methods: @@ -8296,19 +8296,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/product_sets/methods/projects_locations_product_sets_list - $ref: >- #/components/x-stackQL-resources/product_sets/methods/projects_locations_product_sets_get + - $ref: >- + #/components/x-stackQL-resources/product_sets/methods/projects_locations_product_sets_list insert: - $ref: >- #/components/x-stackQL-resources/product_sets/methods/projects_locations_product_sets_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/product_sets/methods/projects_locations_product_sets_patch delete: - $ref: >- #/components/x-stackQL-resources/product_sets/methods/projects_locations_product_sets_delete product_sets_product: - id: vision.product_sets_product + id: google.vision.product_sets_product name: product_sets_product title: Product_sets_product methods: @@ -8332,7 +8334,7 @@ components: update: [] delete: [] products: - id: vision.products + id: google.vision.products name: products title: Products methods: @@ -8397,19 +8399,21 @@ components: select: - $ref: >- #/components/x-stackQL-resources/products/methods/projects_locations_product_sets_products_list - - $ref: >- - #/components/x-stackQL-resources/products/methods/projects_locations_products_list - $ref: >- #/components/x-stackQL-resources/products/methods/projects_locations_products_get + - $ref: >- + #/components/x-stackQL-resources/products/methods/projects_locations_products_list insert: - $ref: >- #/components/x-stackQL-resources/products/methods/projects_locations_products_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/products/methods/projects_locations_products_patch delete: - $ref: >- #/components/x-stackQL-resources/products/methods/projects_locations_products_delete reference_images: - id: vision.reference_images + id: google.vision.reference_images name: reference_images title: Reference_images methods: @@ -8447,10 +8451,10 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/reference_images/methods/projects_locations_products_reference_images_list - $ref: >- #/components/x-stackQL-resources/reference_images/methods/projects_locations_products_reference_images_get + - $ref: >- + #/components/x-stackQL-resources/reference_images/methods/projects_locations_products_reference_images_list insert: - $ref: >- #/components/x-stackQL-resources/reference_images/methods/projects_locations_products_reference_images_create @@ -8459,7 +8463,7 @@ components: - $ref: >- #/components/x-stackQL-resources/reference_images/methods/projects_locations_products_reference_images_delete images: - id: vision.images + id: google.vision.images name: images title: Images methods: @@ -8508,7 +8512,7 @@ components: update: [] delete: [] files: - id: vision.files + id: google.vision.files name: files title: Files methods: 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 28caea95..955d41ce 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/vmmigration.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/vmmigration.yaml @@ -10,7 +10,7 @@ info: workloads. version: v1 x-discovery-doc-revision: '20240523' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/migrate/virtual-machines servers: @@ -3363,7 +3363,7 @@ components: - '2' x-stackQL-resources: locations: - id: vmmigration.locations + id: google.vmmigration.locations name: locations title: Locations methods: @@ -3385,13 +3385,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: vmmigration.operations + id: google.vmmigration.operations name: operations title: Operations methods: @@ -3429,14 +3429,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' sources: - id: vmmigration.sources + id: google.vmmigration.sources name: sources title: Sources methods: @@ -3481,15 +3481,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/sources/methods/list' - $ref: '#/components/x-stackQL-resources/sources/methods/get' + - $ref: '#/components/x-stackQL-resources/sources/methods/list' insert: - $ref: '#/components/x-stackQL-resources/sources/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/sources/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/sources/methods/delete' sources_inventory: - id: vmmigration.sources_inventory + id: google.vmmigration.sources_inventory name: sources_inventory title: Sources_inventory methods: @@ -3506,7 +3507,7 @@ components: update: [] delete: [] utilization_reports: - id: vmmigration.utilization_reports + id: google.vmmigration.utilization_reports name: utilization_reports title: Utilization_reports methods: @@ -3544,8 +3545,8 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/utilization_reports/methods/list' - $ref: '#/components/x-stackQL-resources/utilization_reports/methods/get' + - $ref: '#/components/x-stackQL-resources/utilization_reports/methods/list' insert: - $ref: >- #/components/x-stackQL-resources/utilization_reports/methods/create @@ -3554,7 +3555,7 @@ components: - $ref: >- #/components/x-stackQL-resources/utilization_reports/methods/delete datacenter_connectors: - id: vmmigration.datacenter_connectors + id: google.vmmigration.datacenter_connectors name: datacenter_connectors title: Datacenter_connectors methods: @@ -3599,9 +3600,9 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/datacenter_connectors/methods/get' - $ref: >- #/components/x-stackQL-resources/datacenter_connectors/methods/list - - $ref: '#/components/x-stackQL-resources/datacenter_connectors/methods/get' insert: - $ref: >- #/components/x-stackQL-resources/datacenter_connectors/methods/create @@ -3610,7 +3611,7 @@ components: - $ref: >- #/components/x-stackQL-resources/datacenter_connectors/methods/delete migrating_vms: - id: vmmigration.migrating_vms + id: google.vmmigration.migrating_vms name: migrating_vms title: Migrating_vms methods: @@ -3683,15 +3684,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/migrating_vms/methods/list' - $ref: '#/components/x-stackQL-resources/migrating_vms/methods/get' + - $ref: '#/components/x-stackQL-resources/migrating_vms/methods/list' insert: - $ref: '#/components/x-stackQL-resources/migrating_vms/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/migrating_vms/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/migrating_vms/methods/delete' clone_jobs: - id: vmmigration.clone_jobs + id: google.vmmigration.clone_jobs name: clone_jobs title: Clone_jobs methods: @@ -3729,14 +3731,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/clone_jobs/methods/list' - $ref: '#/components/x-stackQL-resources/clone_jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/clone_jobs/methods/list' insert: - $ref: '#/components/x-stackQL-resources/clone_jobs/methods/create' update: [] delete: [] cutover_jobs: - id: vmmigration.cutover_jobs + id: google.vmmigration.cutover_jobs name: cutover_jobs title: Cutover_jobs methods: @@ -3774,14 +3776,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/cutover_jobs/methods/list' - $ref: '#/components/x-stackQL-resources/cutover_jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/cutover_jobs/methods/list' insert: - $ref: '#/components/x-stackQL-resources/cutover_jobs/methods/create' update: [] delete: [] replication_cycles: - id: vmmigration.replication_cycles + id: google.vmmigration.replication_cycles name: replication_cycles title: Replication_cycles methods: @@ -3805,13 +3807,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/replication_cycles/methods/list' - $ref: '#/components/x-stackQL-resources/replication_cycles/methods/get' + - $ref: '#/components/x-stackQL-resources/replication_cycles/methods/list' insert: [] update: [] delete: [] groups: - id: vmmigration.groups + id: google.vmmigration.groups name: groups title: Groups methods: @@ -3856,15 +3858,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/groups/methods/list' - $ref: '#/components/x-stackQL-resources/groups/methods/get' + - $ref: '#/components/x-stackQL-resources/groups/methods/list' insert: - $ref: '#/components/x-stackQL-resources/groups/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/groups/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/groups/methods/delete' groups_group_migration: - id: vmmigration.groups_group_migration + id: google.vmmigration.groups_group_migration name: groups_group_migration title: Groups_group_migration methods: @@ -3888,7 +3891,7 @@ components: update: [] delete: [] target_projects: - id: vmmigration.target_projects + id: google.vmmigration.target_projects name: target_projects title: Target_projects methods: @@ -3933,15 +3936,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/target_projects/methods/list' - $ref: '#/components/x-stackQL-resources/target_projects/methods/get' + - $ref: '#/components/x-stackQL-resources/target_projects/methods/list' insert: - $ref: '#/components/x-stackQL-resources/target_projects/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/target_projects/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/target_projects/methods/delete' image_imports: - id: vmmigration.image_imports + id: google.vmmigration.image_imports name: image_imports title: Image_imports methods: @@ -3979,15 +3983,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/image_imports/methods/list' - $ref: '#/components/x-stackQL-resources/image_imports/methods/get' + - $ref: '#/components/x-stackQL-resources/image_imports/methods/list' insert: - $ref: '#/components/x-stackQL-resources/image_imports/methods/create' update: [] delete: - $ref: '#/components/x-stackQL-resources/image_imports/methods/delete' image_import_jobs: - id: vmmigration.image_import_jobs + id: google.vmmigration.image_import_jobs name: image_import_jobs title: Image_import_jobs methods: @@ -4018,8 +4022,8 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/image_import_jobs/methods/list' - $ref: '#/components/x-stackQL-resources/image_import_jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/image_import_jobs/methods/list' insert: [] update: [] delete: [] 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 86297d9a..a6e5e3c0 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: '20240509' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/solutions/vmware-as-a-service servers: @@ -2743,7 +2743,7 @@ components: - '2' x-stackQL-resources: dns_bind_permission: - id: vmwareengine.dns_bind_permission + id: google.vmwareengine.dns_bind_permission name: dns_bind_permission title: Dns_bind_permission methods: @@ -2776,7 +2776,7 @@ components: update: [] delete: [] locations: - id: vmwareengine.locations + id: google.vmwareengine.locations name: locations title: Locations methods: @@ -2798,13 +2798,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: vmwareengine.operations + id: google.vmwareengine.operations name: operations title: Operations methods: @@ -2835,14 +2835,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' private_clouds: - id: vmwareengine.private_clouds + id: google.vmwareengine.private_clouds name: private_clouds title: Private_clouds methods: @@ -2922,15 +2922,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/private_clouds/methods/list' - $ref: '#/components/x-stackQL-resources/private_clouds/methods/get' + - $ref: '#/components/x-stackQL-resources/private_clouds/methods/list' insert: - $ref: '#/components/x-stackQL-resources/private_clouds/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/private_clouds/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/private_clouds/methods/delete' private_clouds_dns_forwarding: - id: vmwareengine.private_clouds_dns_forwarding + id: google.vmwareengine.private_clouds_dns_forwarding name: private_clouds_dns_forwarding title: Private_clouds_dns_forwarding methods: @@ -2956,7 +2957,7 @@ components: update: [] delete: [] private_clouds_iam_policies: - id: vmwareengine.private_clouds_iam_policies + id: google.vmwareengine.private_clouds_iam_policies name: private_clouds_iam_policies title: Private_clouds_iam_policies methods: @@ -2993,7 +2994,7 @@ components: update: [] delete: [] clusters: - id: vmwareengine.clusters + id: google.vmwareengine.clusters name: clusters title: Clusters methods: @@ -3038,15 +3039,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/clusters/methods/list' - $ref: '#/components/x-stackQL-resources/clusters/methods/get' + - $ref: '#/components/x-stackQL-resources/clusters/methods/list' insert: - $ref: '#/components/x-stackQL-resources/clusters/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/clusters/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/clusters/methods/delete' clusters_iam_policies: - id: vmwareengine.clusters_iam_policies + id: google.vmwareengine.clusters_iam_policies name: clusters_iam_policies title: Clusters_iam_policies methods: @@ -3083,7 +3085,7 @@ components: update: [] delete: [] nodes: - id: vmwareengine.nodes + id: google.vmwareengine.nodes name: nodes title: Nodes methods: @@ -3107,13 +3109,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/nodes/methods/list' - $ref: '#/components/x-stackQL-resources/nodes/methods/get' + - $ref: '#/components/x-stackQL-resources/nodes/methods/list' insert: [] update: [] delete: [] external_addresses: - id: vmwareengine.external_addresses + id: google.vmwareengine.external_addresses name: external_addresses title: External_addresses methods: @@ -3158,15 +3160,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/external_addresses/methods/list' - $ref: '#/components/x-stackQL-resources/external_addresses/methods/get' + - $ref: '#/components/x-stackQL-resources/external_addresses/methods/list' insert: - $ref: '#/components/x-stackQL-resources/external_addresses/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/external_addresses/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/external_addresses/methods/delete' subnets: - id: vmwareengine.subnets + id: google.vmwareengine.subnets name: subnets title: Subnets methods: @@ -3197,13 +3200,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/subnets/methods/list' - $ref: '#/components/x-stackQL-resources/subnets/methods/get' + - $ref: '#/components/x-stackQL-resources/subnets/methods/list' insert: [] - update: [] + update: + - $ref: '#/components/x-stackQL-resources/subnets/methods/patch' delete: [] logging_servers: - id: vmwareengine.logging_servers + id: google.vmwareengine.logging_servers name: logging_servers title: Logging_servers methods: @@ -3248,15 +3252,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/logging_servers/methods/list' - $ref: '#/components/x-stackQL-resources/logging_servers/methods/get' + - $ref: '#/components/x-stackQL-resources/logging_servers/methods/list' insert: - $ref: '#/components/x-stackQL-resources/logging_servers/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/logging_servers/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/logging_servers/methods/delete' hcx_activation_keys: - id: vmwareengine.hcx_activation_keys + id: google.vmwareengine.hcx_activation_keys name: hcx_activation_keys title: Hcx_activation_keys methods: @@ -3287,15 +3292,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/hcx_activation_keys/methods/list' - $ref: '#/components/x-stackQL-resources/hcx_activation_keys/methods/get' + - $ref: '#/components/x-stackQL-resources/hcx_activation_keys/methods/list' insert: - $ref: >- #/components/x-stackQL-resources/hcx_activation_keys/methods/create update: [] delete: [] hcx_activation_keys_iam_policies: - id: vmwareengine.hcx_activation_keys_iam_policies + id: google.vmwareengine.hcx_activation_keys_iam_policies name: hcx_activation_keys_iam_policies title: Hcx_activation_keys_iam_policies methods: @@ -3332,7 +3337,7 @@ components: update: [] delete: [] management_dns_zone_bindings: - id: vmwareengine.management_dns_zone_bindings + id: google.vmwareengine.management_dns_zone_bindings name: management_dns_zone_bindings title: Management_dns_zone_bindings methods: @@ -3384,19 +3389,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/management_dns_zone_bindings/methods/list - $ref: >- #/components/x-stackQL-resources/management_dns_zone_bindings/methods/get + - $ref: >- + #/components/x-stackQL-resources/management_dns_zone_bindings/methods/list insert: - $ref: >- #/components/x-stackQL-resources/management_dns_zone_bindings/methods/create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/management_dns_zone_bindings/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/management_dns_zone_bindings/methods/delete network_policies_external_addresses: - id: vmwareengine.network_policies_external_addresses + id: google.vmwareengine.network_policies_external_addresses name: network_policies_external_addresses title: Network_policies_external_addresses methods: @@ -3413,7 +3420,7 @@ components: update: [] delete: [] network_policies: - id: vmwareengine.network_policies + id: google.vmwareengine.network_policies name: network_policies title: Network_policies methods: @@ -3462,11 +3469,12 @@ components: - $ref: '#/components/x-stackQL-resources/network_policies/methods/list' insert: - $ref: '#/components/x-stackQL-resources/network_policies/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/network_policies/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/network_policies/methods/delete' external_access_rules: - id: vmwareengine.external_access_rules + id: google.vmwareengine.external_access_rules name: external_access_rules title: External_access_rules methods: @@ -3511,18 +3519,20 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/external_access_rules/methods/get' - $ref: >- #/components/x-stackQL-resources/external_access_rules/methods/list - - $ref: '#/components/x-stackQL-resources/external_access_rules/methods/get' insert: - $ref: >- #/components/x-stackQL-resources/external_access_rules/methods/create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/external_access_rules/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/external_access_rules/methods/delete node_types: - id: vmwareengine.node_types + id: google.vmwareengine.node_types name: node_types title: Node_types methods: @@ -3546,13 +3556,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/node_types/methods/list' - $ref: '#/components/x-stackQL-resources/node_types/methods/get' + - $ref: '#/components/x-stackQL-resources/node_types/methods/list' insert: [] update: [] delete: [] network_peerings: - id: vmwareengine.network_peerings + id: google.vmwareengine.network_peerings name: network_peerings title: Network_peerings methods: @@ -3601,11 +3611,12 @@ components: - $ref: '#/components/x-stackQL-resources/network_peerings/methods/list' insert: - $ref: '#/components/x-stackQL-resources/network_peerings/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/network_peerings/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/network_peerings/methods/delete' peering_routes: - id: vmwareengine.peering_routes + id: google.vmwareengine.peering_routes name: peering_routes title: Peering_routes methods: @@ -3628,7 +3639,7 @@ components: update: [] delete: [] vmware_engine_networks: - id: vmwareengine.vmware_engine_networks + id: google.vmwareengine.vmware_engine_networks name: vmware_engine_networks title: Vmware_engine_networks methods: @@ -3673,19 +3684,21 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/vmware_engine_networks/methods/list - $ref: >- #/components/x-stackQL-resources/vmware_engine_networks/methods/get + - $ref: >- + #/components/x-stackQL-resources/vmware_engine_networks/methods/list insert: - $ref: >- #/components/x-stackQL-resources/vmware_engine_networks/methods/create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/vmware_engine_networks/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/vmware_engine_networks/methods/delete private_connections: - id: vmwareengine.private_connections + id: google.vmwareengine.private_connections name: private_connections title: Private_connections methods: @@ -3730,12 +3743,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/private_connections/methods/list' - $ref: '#/components/x-stackQL-resources/private_connections/methods/get' + - $ref: '#/components/x-stackQL-resources/private_connections/methods/list' insert: - $ref: >- #/components/x-stackQL-resources/private_connections/methods/create - update: [] + update: + - $ref: '#/components/x-stackQL-resources/private_connections/methods/patch' delete: - $ref: >- #/components/x-stackQL-resources/private_connections/methods/delete 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 8a604bbe..1f0a1b20 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: '20240502' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/vpc/docs/configure-serverless-vpc-access servers: @@ -458,7 +458,7 @@ components: - '2' x-stackQL-resources: locations: - id: vpcaccess.locations + id: google.vpcaccess.locations name: locations title: Locations methods: @@ -479,7 +479,7 @@ components: update: [] delete: [] operations: - id: vpcaccess.operations + id: google.vpcaccess.operations name: operations title: Operations methods: @@ -503,13 +503,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: [] connectors: - id: vpcaccess.connectors + id: google.vpcaccess.connectors name: connectors title: Connectors methods: @@ -554,11 +554,12 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/connectors/methods/list' - $ref: '#/components/x-stackQL-resources/connectors/methods/get' + - $ref: '#/components/x-stackQL-resources/connectors/methods/list' insert: - $ref: '#/components/x-stackQL-resources/connectors/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/connectors/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/connectors/methods/delete' paths: 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 edb54263..36afe136 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: '20240519' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/web-risk/ servers: @@ -34,139 +34,156 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudWebriskV1RawIndices: - properties: - indices: - description: The indices to remove from a lexicographically-sorted local list. - items: - format: int32 - type: integer - type: array + GoogleLongrunningCancelOperationRequest: + properties: {} + id: GoogleLongrunningCancelOperationRequest + description: The request message for Operations.CancelOperation. + type: object + GoogleCloudWebriskV1SearchUrisResponse: type: object - id: GoogleCloudWebriskV1RawIndices - description: A set of raw indices to remove from a local list. - GoogleCloudWebriskV1SearchUrisResponseThreatUri: - id: GoogleCloudWebriskV1SearchUrisResponseThreatUri properties: - expireTime: - format: google-datetime - type: string + threat: + $ref: '#/components/schemas/GoogleCloudWebriskV1SearchUrisResponseThreatUri' description: >- - The cache lifetime for the returned match. Clients must not cache - this response past this timestamp to avoid false positives. - threatTypes: - description: The ThreatList this threat belongs to. - items: - 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. - type: array - description: Contains threat information on a matching uri. + The threat list matches. This might be empty if the URI is on no + list. + id: GoogleCloudWebriskV1SearchUrisResponse + 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 - GoogleLongrunningListOperationsResponse: properties: - nextPageToken: - type: string - description: The standard List next-page token. - operations: + code: + format: int32 + type: integer + description: The status code, which should be an enum value of google.rpc.Code. + details: description: >- - A list of operations that matches the specified filter in the - request. + A list of messages that carry the error details. There is a common + set of message types for APIs to use. type: array items: - $ref: '#/components/schemas/GoogleLongrunningOperation' - id: GoogleLongrunningListOperationsResponse - description: The response message for Operations.ListOperations. - type: object - GoogleCloudWebriskV1ThreatEntryRemovals: - type: object - properties: - rawIndices: - $ref: '#/components/schemas/GoogleCloudWebriskV1RawIndices' - description: The raw removal indices for a local list. - riceIndices: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + message: 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' - description: Contains the set of entries to remove from a local database. - id: GoogleCloudWebriskV1ThreatEntryRemovals - GoogleLongrunningCancelOperationRequest: - description: The request message for Operations.CancelOperation. - properties: {} - type: object - id: GoogleLongrunningCancelOperationRequest - GoogleCloudWebriskV1SearchHashesResponse: + 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 + GoogleCloudWebriskV1ComputeThreatListDiffResponse: type: object + id: GoogleCloudWebriskV1ComputeThreatListDiffResponse properties: - negativeExpireTime: + removals: + description: >- + A set of entries to remove from a local threat type's list. This + field may be empty. + $ref: '#/components/schemas/GoogleCloudWebriskV1ThreatEntryRemovals' + 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 + 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 description: >- - For requested entities that did not match the threat list, how long - to cache the response until. - threats: + 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: + 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 type of response. This may indicate that an action must be taken + by the client when the response is received. + type: string + GoogleLongrunningListOperationsResponse: + type: object + description: The response message for Operations.ListOperations. + properties: + nextPageToken: + description: The standard List next-page token. + type: string + operations: type: array items: - $ref: >- - #/components/schemas/GoogleCloudWebriskV1SearchHashesResponseThreatHash + $ref: '#/components/schemas/GoogleLongrunningOperation' description: >- - The full hashes that matched the requested prefixes. The hash will - be populated in the key. - id: GoogleCloudWebriskV1SearchHashesResponse + A list of operations that matches the specified filter in the + request. + id: GoogleLongrunningListOperationsResponse 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. properties: rawHashes: - type: array items: $ref: '#/components/schemas/GoogleCloudWebriskV1RawHashes' + type: array description: >- The raw SHA256-formatted entries. Repeated to allow returning sets of hashes with different prefix sizes. riceHashes: - $ref: '#/components/schemas/GoogleCloudWebriskV1RiceDeltaEncoding' 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. - type: object + $ref: '#/components/schemas/GoogleCloudWebriskV1RiceDeltaEncoding' id: GoogleCloudWebriskV1ThreatEntryAdditions - GoogleCloudWebriskV1SearchHashesResponseThreatHash: + 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. + type: object + GoogleCloudWebriskV1Submission: + id: GoogleCloudWebriskV1Submission properties: - hash: - format: byte + uri: type: string description: >- - A 32 byte SHA256 hash. This field is in binary format. For JSON - requests, hashes are base64-encoded. + Required. The URI that is being reported for malicious content to be + analyzed. + description: Wraps a URI that might be displaying malicious content. + type: object + GoogleCloudWebriskV1SearchHashesResponseThreatHash: + description: Contains threat information on a matching hash. + properties: threatTypes: items: - 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 @@ -177,73 +194,73 @@ components: - >- A list of extended coverage social engineering URIs targeting any platform. + type: string + enum: + - THREAT_TYPE_UNSPECIFIED + - MALWARE + - SOCIAL_ENGINEERING + - UNWANTED_SOFTWARE + - SOCIAL_ENGINEERING_EXTENDED_COVERAGE + type: array description: >- The ThreatList this threat belongs to. This must contain at least one entry. - type: array expireTime: + format: google-datetime + type: string description: >- The cache lifetime for the returned match. Clients must not cache this response past this timestamp to avoid false positives. + hash: + format: byte + description: >- + A 32 byte SHA256 hash. This field is in binary format. For JSON + requests, hashes are base64-encoded. type: string - format: google-datetime - description: Contains threat information on a matching hash. id: GoogleCloudWebriskV1SearchHashesResponseThreatHash type: object - GoogleCloudWebriskV1ComputeThreatListDiffResponse: - type: object + GoogleCloudWebriskV1RiceDeltaEncoding: properties: - 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. + encodedData: type: string - format: google-datetime - checksum: - $ref: >- - #/components/schemas/GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum + format: byte + description: The encoded deltas that are encoded using the Golomb-Rice coder. + entryCount: + format: int32 + type: integer 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: - description: A set of entries to add to a local threat type's list. - $ref: '#/components/schemas/GoogleCloudWebriskV1ThreatEntryAdditions' - removals: + 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`. + firstValue: + type: string description: >- - A set of entries to remove from a local threat type's list. This - field may be empty. - $ref: '#/components/schemas/GoogleCloudWebriskV1ThreatEntryRemovals' - responseType: + 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. + format: int64 + riceParameter: + format: int32 + type: integer description: >- - The type of response. This may indicate that an action must be taken - by the client when the response is received. - type: string - 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 - newVersionToken: + 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: object + description: >- + The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes + or compressed removal indices. + id: GoogleCloudWebriskV1RiceDeltaEncoding + GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum: + id: GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum + description: The expected state of a client's local database. + type: object + properties: + sha256: type: string 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. + The SHA256 hash of the client state; that is, of the sorted list of + all hashes present in the database. format: byte - id: GoogleCloudWebriskV1ComputeThreatListDiffResponse GoogleProtobufEmpty: type: object description: >- @@ -251,38 +268,53 @@ 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); } - properties: {} id: GoogleProtobufEmpty - GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum: - type: object + properties: {} + GoogleCloudWebriskV1SearchHashesResponse: properties: - sha256: - format: byte + threats: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudWebriskV1SearchHashesResponseThreatHash description: >- - The SHA256 hash of the client state; that is, of the sorted list of - all hashes present in the database. + The full hashes that matched the requested prefixes. The hash will + be populated in the key. + negativeExpireTime: + format: google-datetime type: string - description: The expected state of a client's local database. - id: GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum - GoogleCloudWebriskV1RawHashes: + description: >- + For requested entities that did not match the threat list, how long + to cache the response until. + type: object + id: GoogleCloudWebriskV1SearchHashesResponse + GoogleCloudWebriskV1ThreatEntryRemovals: + description: Contains the set of entries to remove from a local database. type: object properties: - prefixSize: - format: int32 - type: integer - 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. - rawHashes: - format: byte - type: string + rawIndices: + $ref: '#/components/schemas/GoogleCloudWebriskV1RawIndices' + description: The raw removal indices for a local list. + riceIndices: + $ref: '#/components/schemas/GoogleCloudWebriskV1RiceDeltaEncoding' 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. - id: GoogleCloudWebriskV1RawHashes + 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. + id: GoogleCloudWebriskV1ThreatEntryRemovals + GoogleCloudWebriskV1RawIndices: + properties: + indices: + items: + format: int32 + type: integer + 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. + type: object + 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 @@ -290,57 +322,46 @@ 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. - GoogleCloudWebriskV1SearchUrisResponse: - properties: - threat: - description: >- - The threat list matches. This might be empty if the URI is on no - list. - $ref: '#/components/schemas/GoogleCloudWebriskV1SearchUrisResponseThreatUri' - id: GoogleCloudWebriskV1SearchUrisResponse - type: object - GoogleRpcStatus: - id: GoogleRpcStatus + id: GoogleCloudWebriskV1RawHashes properties: - message: + rawHashes: + format: byte 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: + The hashes, in binary format, concatenated into one long string. + Hashes are sorted in lexicographic order. For JSON API users, hashes + are base64-encoded. + prefixSize: 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: - description: Properties of the object. Contains field @type with type URL. - type: any - 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). + 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. + format: int32 + type: integer type: object GoogleLongrunningOperation: - type: object - id: GoogleLongrunningOperation properties: + error: + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + The error result of the operation in case of failure or + cancellation. + metadata: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + description: Contains a `SubmitUriMetadata` 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. + name: + description: Matches the `/v1/{project-name}/operations/{operation-id}` pattern. + type: string response: description: >- The normal, successful response of the operation. If the original @@ -351,79 +372,73 @@ components: 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: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - The error result of the operation in case of failure or - cancellation. - name: - type: string - description: Matches the `/v1/{project-name}/operations/{operation-id}` pattern. - metadata: type: object - description: Contains a `SubmitUriMetadata` object. additionalProperties: - type: any 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. - GoogleCloudWebriskV1RiceDeltaEncoding: - id: GoogleCloudWebriskV1RiceDeltaEncoding - description: >- - The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes - or compressed removal indices. type: object - properties: - firstValue: - type: string - 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. - 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 - encodedData: - description: The encoded deltas that are encoded using the Golomb-Rice coder. - type: string - format: byte - entryCount: - format: int32 - type: integer - 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`. - GoogleCloudWebriskV1Submission: + id: GoogleLongrunningOperation + GoogleCloudWebriskV1SearchUrisResponseThreatUri: type: object - description: Wraps a URI that might be displaying malicious content. - id: GoogleCloudWebriskV1Submission + description: Contains threat information on a matching uri. properties: - uri: - type: string + expireTime: + format: google-datetime description: >- - Required. The URI that is being reported for malicious content to be - analyzed. + The cache lifetime for the returned match. Clients must not cache + this response past this timestamp to avoid false positives. + type: string + threatTypes: + description: The ThreatList this threat belongs to. + items: + 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. + type: array + id: GoogleCloudWebriskV1SearchUrisResponseThreatUri 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 - oauth_token: - description: OAuth 2.0 token for the current user. + type: string + callback: + description: JSONP in: query - name: oauth_token + 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 quotaUser: @@ -435,24 +450,12 @@ 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 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 @@ -462,21 +465,12 @@ components: name: key schema: type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - callback: - description: JSONP + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: callback + name: prettyPrint schema: - type: string + type: boolean alt: description: Data format for response. in: query @@ -487,25 +481,57 @@ components: - 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 + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token schema: type: string x-stackQL-resources: - operations: - id: webrisk.operations - name: operations - title: Operations + threat_lists: + id: google.webrisk.threat_lists + name: threat_lists + title: Threat_lists methods: - cancel: + compute_diff: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1operations~1{operationsId}:cancel/post + $ref: '#/paths/~1v1~1threatLists:computeDiff/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + submissions: + id: google.webrisk.submissions + name: submissions + title: Submissions + methods: + create: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1submissions/post' response: mediaType: application/json openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/submissions/methods/create' + update: [] + delete: [] + operations: + id: google.webrisk.operations + name: operations + title: Operations + methods: get: operation: $ref: >- @@ -530,6 +556,13 @@ components: list: operation: *ref_1 response: *ref_2 + cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1operations~1{operationsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/operations/methods/get' @@ -538,31 +571,14 @@ components: update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - submissions: - id: webrisk.submissions - name: submissions - title: Submissions - methods: - create: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1submissions/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/submissions/methods/create' - update: [] - delete: [] - threat_lists: - id: webrisk.threat_lists - name: threat_lists - title: Threat_lists + uris: + id: google.webrisk.uris + name: uris + title: Uris methods: - compute_diff: + search: operation: - $ref: '#/paths/~1v1~1threatLists:computeDiff/get' + $ref: '#/paths/~1v1~1uris:search/get' response: mediaType: application/json openAPIDocKey: '200' @@ -572,7 +588,7 @@ components: update: [] delete: [] hashes: - id: webrisk.hashes + id: google.webrisk.hashes name: hashes title: Hashes methods: @@ -587,72 +603,102 @@ components: insert: [] update: [] delete: [] - uris: - id: webrisk.uris - name: uris - title: Uris - methods: - search: - operation: - $ref: '#/paths/~1v1~1uris:search/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] paths: - /v1/projects/{projectsId}/operations/{operationsId}:cancel: + /v1/threatLists:computeDiff: parameters: &ref_3 - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/oauth_token' + 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.maxDiffEntries + schema: + type: integer + format: int32 + - in: query + name: constraints.maxDatabaseEntries + schema: + type: integer + format: int32 + - in: query + name: constraints.supportedCompressions + schema: + type: string + - in: query + name: versionToken + schema: + type: string + format: byte + - in: query + name: threatType + schema: + type: string + /v1/projects/{projectsId}/submissions: + parameters: *ref_3 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: webrisk.projects.operations.cancel + Creates a Submission of a URI suspected of containing phishing content + to be reviewed. If the result verifies the existence of malicious + phishing content, the site will be added to the [Google's Social + Engineering + lists](https://support.google.com/webmasters/answer/6350487/) in order + to protect users that could get exposed to this threat in the future. + Only allowlisted projects can use this method during Early Access. + Please reach out to Sales or your customer engineer to obtain access. + operationId: webrisk.projects.submissions.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningCancelOperationRequest' - security: [] + $ref: '#/components/schemas/GoogleCloudWebriskV1Submission' + security: + - Oauth2: + - https://www.googleapis.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' + $ref: '#/components/schemas/GoogleCloudWebriskV1Submission' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: operationsId - required: true - schema: - type: string /v1/projects/{projectsId}/operations/{operationsId}: parameters: *ref_3 get: @@ -744,53 +790,54 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/submissions: + /v1/projects/{projectsId}/operations/{operationsId}:cancel: parameters: *ref_3 post: description: >- - Creates a Submission of a URI suspected of containing phishing content - to be reviewed. If the result verifies the existence of malicious - phishing content, the site will be added to the [Google's Social - Engineering - lists](https://support.google.com/webmasters/answer/6350487/) in order - to protect users that could get exposed to this threat in the future. - Only allowlisted projects can use this method during Early Access. - Please reach out to Sales or your customer engineer to obtain access. - operationId: webrisk.projects.submissions.create + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is 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: webrisk.projects.operations.cancel requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudWebriskV1Submission' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform + $ref: '#/components/schemas/GoogleLongrunningCancelOperationRequest' + security: [] responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudWebriskV1Submission' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId required: true schema: type: string - /v1/threatLists:computeDiff: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/uris:search: parameters: *ref_3 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 + This method is used to check whether a URI is on a given threatList. + Multiple threatLists may be searched in a single query. The response + will list all requested threatLists the URI was found to match. If the + URI is not found on any of the requested ThreatList an empty response + will be returned. + operationId: webrisk.uris.search security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -802,30 +849,14 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudWebriskV1ComputeThreatListDiffResponse + $ref: '#/components/schemas/GoogleCloudWebriskV1SearchUrisResponse' parameters: - in: query - name: versionToken - schema: - type: string - format: byte - - in: query - name: constraints.maxDiffEntries - schema: - type: integer - format: int32 - - in: query - name: constraints.supportedCompressions + name: threatTypes schema: type: string - in: query - name: constraints.maxDatabaseEntries - schema: - type: integer - format: int32 - - in: query - name: threatType + name: uri schema: type: string /v1/hashes:search: @@ -851,43 +882,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/uris:search: - parameters: *ref_3 - get: - description: >- - This method is used to check whether a URI is on a given threatList. - Multiple threatLists may be searched in a single query. The response - will list all requested threatLists the URI was found to match. If the - URI is not found on any of the requested ThreatList an empty response - will be returned. - operationId: webrisk.uris.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/GoogleCloudWebriskV1SearchUrisResponse' - parameters: - in: query name: threatTypes schema: type: string - - in: query - name: uri - schema: - type: string 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 d612c19a..e5b8ff87 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/websecurityscanner.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/websecurityscanner.yaml @@ -8,7 +8,7 @@ info: description: Scans your Compute and App Engine apps for common web vulnerabilities. version: v1 x-discovery-doc-revision: '20240526' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: >- https://cloud.google.com/security-command-center/docs/concepts-web-security-scanner-overview/ @@ -35,165 +35,380 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - ListScanConfigsResponse: - id: ListScanConfigsResponse - 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 - items: - $ref: '#/components/schemas/ScanConfig' - description: The list of ScanConfigs returned. - description: Response for the `ListScanConfigs` method. - type: object - Form: - 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.' - type: string - type: object - id: Form - description: '! Information about a vulnerability with an HTML.' - IapCredential: - properties: - iapTestServiceAccountInfo: - $ref: '#/components/schemas/IapTestServiceAccountInfo' - description: >- - Authentication configuration when Web-Security-Scanner service - account is added in Identity-Aware-Proxy (IAP) access policies. - type: object - description: Describes authentication configuration for Identity-Aware-Proxy (IAP). - id: IapCredential - Schedule: - properties: - intervalDurationDays: - format: int32 - type: integer - description: Required. The duration of time between executions in days. - scheduleTime: - type: string - 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 - id: Schedule - type: object - description: Scan schedule configuration. StartScanRunRequest: properties: {} - description: Request for the `StartScanRun` method. type: object + description: Request for the `StartScanRun` method. id: StartScanRunRequest - GoogleAccount: - deprecated: true - description: Describes authentication configuration that uses a Google account. - id: GoogleAccount - type: object - properties: - password: - description: >- - Required. Input only. The password of the Google account. The - credential is stored encrypted and not returned in any response nor - included in audit logs. - type: string - username: - description: Required. The user name of the Google account. - type: string - ListFindingsResponse: - description: Response for the `ListFindings` method. - id: ListFindingsResponse - type: object + OutdatedLibrary: properties: - nextPageToken: - description: >- - Token to retrieve the next page of results, or empty if there are no - more results in the list. + libraryName: + description: The name of the outdated library. type: string - findings: + learnMoreUrls: items: - $ref: '#/components/schemas/Finding' + type: string + description: >- + URLs to learn more information about the vulnerabilities in the + library. type: array - description: The list of Findings returned. - CustomAccount: + version: + type: string + description: The version number. + id: OutdatedLibrary + description: Information reported for an outdated library. type: object - id: CustomAccount + CustomAccount: properties: + loginUrl: + type: string + description: Required. The login form URL of the website. username: description: Required. The user name of the custom account. type: string password: + type: string 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 - loginUrl: - type: string - description: Required. The login form URL of the website. + id: CustomAccount description: Describes authentication configuration that uses a custom account. - FindingTypeStats: + type: object + CrawledUrl: properties: - findingType: + body: + description: Output only. The body of the request that was used to visit the URL. type: string - description: Output only. The finding type associated with the stats. - findingCount: - format: int32 - description: Output only. The count of findings belonging to this finding type. - type: integer - description: >- - A FindingTypeStats resource represents stats regarding a specific - FindingType of Findings under a given ScanRun. + url: + description: Output only. The URL that was crawled. + type: string + httpMethod: + type: string + description: >- + Output only. The http method of the request that was used to visit + the URL, in uppercase. + id: CrawledUrl type: object - id: FindingTypeStats - Empty: description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - id: Empty - type: object - properties: {} - Header: - type: object - description: Describes a HTTP Header. - id: Header + 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. + ScanConfig: properties: + ignoreHttpStatusErrors: + description: >- + Whether to keep scanning even if most requests return HTTP error + codes. + type: boolean + blacklistPatterns: + items: + type: string + 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 + riskLevel: + enumDescriptions: + - Use default, which is NORMAL. + - Normal scanning (Recommended) + - Lower impact scanning + description: The risk level selected for the scan + enum: + - RISK_LEVEL_UNSPECIFIED + - NORMAL + - LOW + 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. + format: int32 + type: integer name: - description: Header name. type: string - value: - description: Header value. + 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. + displayName: + description: Required. The user provided display name of the ScanConfig. + type: string + authentication: + description: >- + The authentication configuration. If specified, service will use the + authentication configuration during scanning. + $ref: '#/components/schemas/Authentication' + schedule: + description: The schedule of the ScanConfig. + $ref: '#/components/schemas/Schedule' + startingUrls: + type: array + items: + type: string + description: Required. The starting URLs from which the scanner finds site pages. + 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. + exportToSecurityCommandCenter: + description: >- + Controls export of scan configurations and results to Security + Command Center. + type: string + 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. + 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. + enum: + - USER_AGENT_UNSPECIFIED + - CHROME_LINUX + - CHROME_ANDROID + - SAFARI_IPHONE type: string - ListFindingTypeStatsResponse: type: object + id: ScanConfig + description: A ScanConfig resource contains the configurations to launch a scan. + ListFindingTypeStatsResponse: + description: Response for the `ListFindingTypeStats` method. + id: ListFindingTypeStatsResponse properties: findingTypeStats: type: array + description: The list of FindingTypeStats returned. items: $ref: '#/components/schemas/FindingTypeStats' - description: The list of FindingTypeStats returned. - description: Response for the `ListFindingTypeStats` method. - id: ListFindingTypeStatsResponse - Xss: - id: Xss - description: Information reported for an XSS. type: object - properties: - attackVector: - type: string - description: The attack vector of the payload triggering this XSS. + IapTestServiceAccountInfo: + description: >- + Describes authentication configuration when Web-Security-Scanner service + account is added in Identity-Aware-Proxy (IAP) access policies. + type: object + properties: + targetAudienceClientId: + type: string + description: >- + Required. Describes OAuth2 client id of resources protected by + Identity-Aware-Proxy (IAP). + id: IapTestServiceAccountInfo + IapCredential: + id: 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' + Header: + id: Header + properties: + name: + type: string + description: Header name. + value: + description: Header value. + type: string + description: Describes a HTTP Header. + type: object + Authentication: + properties: + customAccount: + description: Authentication using a custom account. + $ref: '#/components/schemas/CustomAccount' + iapCredential: + description: Authentication using Identity-Aware-Proxy (IAP). + $ref: '#/components/schemas/IapCredential' + googleAccount: + description: Authentication using a Google account. + deprecated: true + $ref: '#/components/schemas/GoogleAccount' + description: Scan authentication configuration. + id: Authentication + type: object + VulnerableHeaders: + id: VulnerableHeaders + description: Information about vulnerable or missing HTTP Headers. + type: object + properties: + missingHeaders: + items: + $ref: '#/components/schemas/Header' + description: List of missing headers. + type: array + headers: + description: List of vulnerable headers. + items: + $ref: '#/components/schemas/Header' + type: array + ListScanConfigsResponse: + properties: + scanConfigs: + type: array + items: + $ref: '#/components/schemas/ScanConfig' + description: The list of ScanConfigs returned. + nextPageToken: + description: >- + Token to retrieve the next page of results, or empty if there are no + more results in the list. + type: string + id: ListScanConfigsResponse + description: Response for the `ListScanConfigs` method. + type: object + ListScanRunsResponse: + id: ListScanRunsResponse + type: object + description: Response for the `ListScanRuns` 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 + scanRuns: + type: array + description: The list of ScanRuns returned. + items: + $ref: '#/components/schemas/ScanRun' + Xxe: + id: Xxe + type: object + properties: + payloadLocation: + enum: + - LOCATION_UNSPECIFIED + - COMPLETE_REQUEST_BODY + description: Location within the request where the payload was placed. + type: string + enumDescriptions: + - Unknown Location. + - The XML payload replaced the complete request body. + payloadValue: + description: >- + The XML string that triggered the XXE vulnerability. Non-payload + values might be redacted. + type: string + description: Information reported for an XXE. + Empty: + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + id: Empty + properties: {} + type: object + FindingTypeStats: + description: >- + A FindingTypeStats resource represents stats regarding a specific + FindingType of Findings under a given ScanRun. + id: FindingTypeStats + type: object + properties: + findingType: + type: string + description: Output only. The finding type associated with the stats. + findingCount: + format: int32 + type: integer + description: Output only. The count of findings belonging to this finding type. + Schedule: + id: Schedule + description: Scan schedule configuration. + type: object + properties: + intervalDurationDays: + type: integer + description: Required. The duration of time between executions in days. + format: int32 + scheduleTime: + type: string + 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. + ListCrawledUrlsResponse: + type: object + properties: + nextPageToken: + description: >- + Token to retrieve the next page of results, or empty if there are no + more results in the list. + type: string + crawledUrls: + description: The list of CrawledUrls returned. + items: + $ref: '#/components/schemas/CrawledUrl' + type: array + description: Response for the `ListCrawledUrls` method. + id: ListCrawledUrlsResponse + ViolatingResource: + properties: + contentType: + type: string + description: The MIME type of this resource. + 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. + type: object + VulnerableParameters: + properties: + parameterNames: + items: + type: string + type: array + description: The vulnerable parameter names. + type: object + id: VulnerableParameters + description: Information about vulnerable request parameters. + Form: + type: object + description: '! Information about a vulnerability with an HTML.' + id: Form + properties: + fields: + items: + type: string + type: array + description: '! The names of form fields related to the vulnerability.' + actionUri: + description: '! The URI where to send the form when it''s submitted.' + type: string + Xss: + description: Information reported for an XSS. + id: Xss + type: object + properties: + attackVector: enumDescriptions: - Unknown attack vector. - The attack comes from fuzzing the browser's localStorage. @@ -215,6 +430,8 @@ components: - >- The attack payload is received from a third-party host via a URL that is user-controllable + type: string + description: The attack vector of the payload triggering this XSS. enum: - ATTACK_VECTOR_UNSPECIFIED - LOCAL_STORAGE @@ -233,55 +450,67 @@ components: - SAME_ORIGIN - USER_CONTROLLABLE_URL stackTraces: - description: Stack traces leading to the point where the XSS occurred. - type: array items: type: string + description: Stack traces leading to the point where the XSS occurred. + type: array storedXssSeedingUrl: type: string description: The reproduction url for the seeding POST request of a Stored XSS. errorMessage: description: An error message generated by a javascript breakage. type: string - StopScanRunRequest: - id: StopScanRunRequest + ListFindingsResponse: + id: ListFindingsResponse + description: Response for the `ListFindings` method. type: object - properties: {} - description: Request for the `StopScanRun` method. - OutdatedLibrary: - description: Information reported for an outdated library. properties: - libraryName: - description: The name of the outdated library. - type: string - learnMoreUrls: + findings: + description: The list of Findings returned. type: array items: - type: string + $ref: '#/components/schemas/Finding' + nextPageToken: description: >- - URLs to learn more information about the vulnerabilities in the - library. - version: + Token to retrieve the next page of results, or empty if there are no + more results in the list. type: string - description: The version number. + ScanRunWarningTrace: type: object - id: OutdatedLibrary - ScanConfigError: + id: ScanRunWarningTrace 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 + 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: - fieldName: - 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: + 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 + description: Output only. Indicates the warning code. 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 + ScanConfigError: + properties: code: enumDescriptions: - There is no error. @@ -364,6 +593,8 @@ components: 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 - OK @@ -408,558 +639,321 @@ components: - UNSUPPORTED_FINDING_TYPE - UNSUPPORTED_URL_SCHEME - CLOUD_ASSET_INVENTORY_ASSET_NOT_FOUND - description: Output only. Indicates the reason code for a configuration failure. - type: string - 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. + fieldName: + description: >- + Output only. Indicates the full name of the ScanConfig field that + triggers this error, for example "scan_config.max_qps". This field + is provided for troubleshooting purposes only and its actual value + can change in the future. type: string - id: ScanRunWarningTrace + id: ScanConfigError type: object 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. - Authentication: - id: Authentication - type: object - properties: - iapCredential: - $ref: '#/components/schemas/IapCredential' - description: Authentication using Identity-Aware-Proxy (IAP). - customAccount: - $ref: '#/components/schemas/CustomAccount' - description: Authentication using a custom account. - googleAccount: - description: Authentication using a Google account. - deprecated: true - $ref: '#/components/schemas/GoogleAccount' - description: Scan authentication configuration. - ScanRunErrorTrace: - description: Output only. Defines an error trace message for a ScanRun. - properties: - 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 - 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. - 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. - 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. - id: ScanRunErrorTrace + 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. + Finding: type: object - ScanRun: description: >- - A ScanRun is a output-only resource representing an actual run of the - scan. Next id: 12 + A Finding resource represents a vulnerability instance identified during + a ScanRun. + id: Finding properties: - 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: - type: string - 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 - 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. - type: string - format: int64 - startTime: - type: string - description: Output only. The time at which the ScanRun started. - format: google-datetime - 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' - urlsTestedCount: - type: string + outdatedLibrary: + $ref: '#/components/schemas/OutdatedLibrary' 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 - warningTraces: - type: array + Output only. An addon containing information about outdated + libraries. + frameUrl: description: >- - Output only. A list of warnings, if such are encountered during this - scan run. - items: - $ref: '#/components/schemas/ScanRunWarningTrace' - hasVulnerabilities: - description: Output only. Whether the scan run has found any vulnerabilities. - type: boolean - name: + Output only. If the vulnerability was originated from nested IFrame, + the immediate parent IFrame is reported. type: string + trackingId: 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. - executionState: - description: Output only. The execution state of the ScanRun. - enum: - - EXECUTION_STATE_UNSPECIFIED - - QUEUED - - SCANNING - - FINISHED - 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. + Output only. The tracking ID uniquely identifies a vulnerability + instance across multiple ScanRuns. type: string - resultState: - 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 + fuzzedUrl: type: string - 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. - type: object - id: ScanRun - IapTestServiceAccountInfo: - type: object - properties: - targetAudienceClientId: description: >- - Required. Describes OAuth2 client id of resources protected by - Identity-Aware-Proxy (IAP). - type: string - id: IapTestServiceAccountInfo - description: >- - Describes authentication configuration when Web-Security-Scanner service - account is added in Identity-Aware-Proxy (IAP) access policies. - VulnerableHeaders: - type: object - id: VulnerableHeaders - description: Information about vulnerable or missing HTTP Headers. - properties: - missingHeaders: - description: List of missing headers. - items: - $ref: '#/components/schemas/Header' - type: array - headers: - description: List of vulnerable headers. - type: array - items: - $ref: '#/components/schemas/Header' - ListCrawledUrlsResponse: - id: ListCrawledUrlsResponse - type: object - description: Response for the `ListCrawledUrls` method. - properties: - nextPageToken: + Output only. The URL produced by the server-side fuzzer and used in + the request that triggered the vulnerability. + form: description: >- - Token to retrieve the next page of results, or empty if there are no - more results in the list. - type: string - crawledUrls: - items: - $ref: '#/components/schemas/CrawledUrl' - type: array - description: The list of CrawledUrls returned. - ListScanRunsResponse: - type: object - id: ListScanRunsResponse - properties: - nextPageToken: + Output only. An addon containing information reported for a + vulnerability with an HTML form, if any. + $ref: '#/components/schemas/Form' + body: description: >- - 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' - description: Response for the `ListScanRuns` method. - ViolatingResource: - id: ViolatingResource - properties: - contentType: - description: The MIME type of this resource. - type: string - resourceUrl: + Output only. The body of the request that triggered the + vulnerability. type: string - description: URL of this violating resource. - type: object - description: >- - Information regarding any resource causing the vulnerability such as - JavaScript sources, image, audio files, etc. - VulnerableParameters: - id: VulnerableParameters - description: Information about vulnerable request parameters. - type: object - properties: - parameterNames: - items: - type: string - description: The vulnerable parameter names. - type: array - Finding: - properties: - 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. + description: + description: Output only. The description of the vulnerability. type: string - 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. - frameUrl: + httpMethod: type: string description: >- - Output only. If the vulnerability was originated from nested IFrame, - the immediate parent IFrame is reported. - outdatedLibrary: - $ref: '#/components/schemas/OutdatedLibrary' - description: >- - Output only. An addon containing information about outdated - libraries. - form: - $ref: '#/components/schemas/Form' + Output only. The http method of the request that triggered the + vulnerability, in uppercase. + xxe: description: >- - Output only. An addon containing information reported for a - vulnerability with an HTML form, if any. + Output only. An addon containing information reported for an XXE, if + any. + $ref: '#/components/schemas/Xxe' + readOnly: true vulnerableHeaders: $ref: '#/components/schemas/VulnerableHeaders' description: >- Output only. An addon containing information about vulnerable or missing HTTP headers. - httpMethod: + findingType: type: string description: >- - Output only. The http method of the request that triggered the - vulnerability, in uppercase. + 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 severity: - description: Output only. The severity level of the reported vulnerability. - type: string - enum: - - SEVERITY_UNSPECIFIED - - CRITICAL - - HIGH - - MEDIUM - - LOW - readOnly: true enumDescriptions: - No severity specified. The default value. - Critical severity. - High severity. - Medium severity. - Low severity. - finalUrl: - type: string - description: >- - Output only. The URL where the browser lands when the vulnerability - is detected. - findingType: - 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 - fuzzedUrl: - description: >- - Output only. The URL produced by the server-side fuzzer and used in - the request that triggered the vulnerability. type: string - body: - type: string - description: >- - Output only. The body of the request that triggered the - vulnerability. - xxe: + readOnly: true + enum: + - SEVERITY_UNSPECIFIED + - CRITICAL + - HIGH + - MEDIUM + - LOW + description: Output only. The severity level of the reported vulnerability. + xss: + $ref: '#/components/schemas/Xss' description: >- - Output only. An addon containing information reported for an XXE, if + Output only. An addon containing information reported for an XSS, if any. - readOnly: true - $ref: '#/components/schemas/Xxe' - trackingId: + vulnerableParameters: + $ref: '#/components/schemas/VulnerableParameters' description: >- - Output only. The tracking ID uniquely identifies a vulnerability - instance across multiple ScanRuns. - type: string + Output only. An addon containing information about request + parameters which were found to be vulnerable. reproductionUrl: type: string description: >- Output only. The URL containing human-readable payload that user can leverage to reproduce the vulnerability. - description: - 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: - $ref: '#/components/schemas/VulnerableParameters' + finalUrl: description: >- - Output only. An addon containing information about request - parameters which were found to be vulnerable. - xss: + Output only. The URL where the browser lands when the vulnerability + is detected. + type: string + violatingResource: + $ref: '#/components/schemas/ViolatingResource' description: >- - Output only. An addon containing information reported for an XSS, if - any. - $ref: '#/components/schemas/Xss' - id: Finding - description: >- - A Finding resource represents a vulnerability instance identified during - a ScanRun. - type: object - ScanConfig: + Output only. An addon containing detailed information regarding any + resource causing the vulnerability such as JavaScript sources, + image, audio files, etc. + GoogleAccount: + id: GoogleAccount + description: Describes authentication configuration that uses a Google account. type: object - description: A ScanConfig resource contains the configurations to launch a scan. properties: - 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. - enum: - - EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED - - ENABLED - - DISABLED + password: type: string description: >- - Controls export of scan configurations and results to Security - Command Center. - userAgent: - 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 - description: The user agent used during scanning. + 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: + description: Required. The user name of the Google account. type: string - maxQps: + deprecated: true + ScanRunErrorTrace: + description: Output only. Defines an error trace message for a ScanRun. + type: object + id: ScanRunErrorTrace + properties: + mostCommonHttpErrorCode: 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. + 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 - ignoreHttpStatusErrors: - description: >- - Whether to keep scanning even if most requests return HTTP error - codes. - type: boolean - schedule: - $ref: '#/components/schemas/Schedule' - description: The schedule of the ScanConfig. - authentication: - description: >- - The authentication configuration. If specified, service will use the - authentication configuration during scanning. - $ref: '#/components/schemas/Authentication' - managedScan: + scanConfigError: description: >- - Whether the scan config is managed by Web Security Scanner, output - only. - type: boolean - staticIpScan: - type: boolean + 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. + $ref: '#/components/schemas/ScanConfigError' + 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 + 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. + ScanRun: + id: ScanRun + type: object + description: >- + A ScanRun is a output-only resource representing an actual run of the + scan. Next id: 12 + properties: + progressPercent: description: >- - Whether the scan configuration has enabled static IP address scan - feature. If enabled, the scanner will access applications from - static IP addresses. - blacklistPatterns: + 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: + type: string 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 - displayName: + 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 - description: Required. The user provided display name of the ScanConfig. - name: + description: Output only. The time at which the ScanRun started. + format: google-datetime + 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 + resultState: + 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. 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. - riskLevel: + Output only. The result state of the ScanRun. This field is only + available after the execution state reaches "FINISHED". + type: string enum: - - RISK_LEVEL_UNSPECIFIED - - NORMAL - - LOW - description: The risk level selected for the scan + - RESULT_STATE_UNSPECIFIED + - SUCCESS + - ERROR + - KILLED + executionState: + enum: + - EXECUTION_STATE_UNSPECIFIED + - QUEUED + - SCANNING + - FINISHED type: string + description: Output only. The execution state of the ScanRun. enumDescriptions: - - Use default, which is NORMAL. - - Normal scanning (Recommended) - - Lower impact scanning - startingUrls: - items: - type: string - type: array - description: Required. The starting URLs from which the scanner finds site pages. - id: ScanConfig - CrawledUrl: - properties: - httpMethod: - type: string + - >- + 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. + errorTrace: + $ref: '#/components/schemas/ScanRunErrorTrace' description: >- - Output only. The http method of the request that was used to visit - the URL, in uppercase. - body: - description: Output only. The body of the request that was used to visit the URL. - type: string - url: - description: Output only. The URL that was crawled. - type: string - id: CrawledUrl - type: object - 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. - Xxe: - description: Information reported for an XXE. - id: Xxe - properties: - payloadValue: + 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. + name: description: >- - The XML string that triggered the XXE vulnerability. Non-payload - values might be redacted. + 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 - payloadLocation: + urlsCrawledCount: + format: int64 type: string - enum: - - LOCATION_UNSPECIFIED - - COMPLETE_REQUEST_BODY - enumDescriptions: - - Unknown Location. - - The XML payload replaced the complete request body. - description: Location within the request where the payload was placed. + 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. + warningTraces: + items: + $ref: '#/components/schemas/ScanRunWarningTrace' + type: array + description: >- + Output only. A list of warnings, if such are encountered during this + scan run. + hasVulnerabilities: + description: Output only. Whether the scan run has found any vulnerabilities. + type: boolean + StopScanRunRequest: + properties: {} + description: Request for the `StopScanRun` method. type: object + id: StopScanRunRequest 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. + 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"). + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: upload_protocol + name: uploadType 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. + callback: + description: JSONP in: query - name: key + name: callback schema: type: string alt: @@ -972,24 +966,36 @@ 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 - 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. + 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 + type: string + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string _.xgafv: description: V1 error format. in: query @@ -999,70 +1005,86 @@ components: enum: - '1' - '2' - 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. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: oauth_token + name: fields schema: type: string - 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 + type: boolean x-stackQL-resources: - finding_type_stats: - id: websecurityscanner.finding_type_stats - name: finding_type_stats - title: Finding_type_stats + 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' + _list: + operation: &ref_1 + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns/get + response: &ref_2 + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.scanRuns list: + operation: *ref_1 + response: *ref_2 + get: 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}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/finding_type_stats/methods/list' + - $ref: '#/components/x-stackQL-resources/scan_runs/methods/get' + - $ref: '#/components/x-stackQL-resources/scan_runs/methods/list' insert: [] update: [] delete: [] - crawled_urls: - id: websecurityscanner.crawled_urls - name: crawled_urls - title: Crawled_urls + finding_type_stats: + id: google.websecurityscanner.finding_type_stats + name: finding_type_stats + title: Finding_type_stats methods: - _list: - operation: &ref_1 + list: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}~1crawledUrls/get - response: &ref_2 + #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}~1findingTypeStats/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.crawledUrls - list: - operation: *ref_1 - response: *ref_2 sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/crawled_urls/methods/list' + - $ref: '#/components/x-stackQL-resources/finding_type_stats/methods/list' insert: [] update: [] delete: [] findings: - id: websecurityscanner.findings + id: google.websecurityscanner.findings name: findings title: Findings methods: + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}~1findings~1{findingsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' _list: operation: &ref_3 $ref: >- @@ -1074,66 +1096,44 @@ components: list: operation: *ref_3 response: *ref_4 - 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/findings/methods/list' - $ref: '#/components/x-stackQL-resources/findings/methods/get' + - $ref: '#/components/x-stackQL-resources/findings/methods/list' insert: [] update: [] delete: [] - scan_runs: - id: websecurityscanner.scan_runs - name: scan_runs - title: Scan_runs + crawled_urls: + id: google.websecurityscanner.crawled_urls + name: crawled_urls + title: Crawled_urls methods: - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - stop: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}:stop/post - response: - mediaType: application/json - openAPIDocKey: '200' _list: operation: &ref_5 $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns/get + #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}~1crawledUrls/get response: &ref_6 mediaType: application/json openAPIDocKey: '200' - objectKey: $.scanRuns + objectKey: $.crawledUrls list: operation: *ref_5 response: *ref_6 sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/scan_runs/methods/get' - - $ref: '#/components/x-stackQL-resources/scan_runs/methods/list' + - $ref: '#/components/x-stackQL-resources/crawled_urls/methods/list' insert: [] update: [] delete: [] scan_configs: - id: websecurityscanner.scan_configs + id: google.websecurityscanner.scan_configs name: scan_configs title: Scan_configs methods: - 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' @@ -1144,62 +1144,68 @@ components: 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' - _list: - operation: &ref_7 - $ref: '#/paths/~1v1~1projects~1{projectsId}~1scanConfigs/get' - response: &ref_8 + start: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}:start/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.scanConfigs - list: - operation: *ref_7 - response: *ref_8 create: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1scanConfigs/post' response: mediaType: application/json openAPIDocKey: '200' - start: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}:start/post - response: + _list: + operation: &ref_7 + $ref: '#/paths/~1v1~1projects~1{projectsId}~1scanConfigs/get' + response: &ref_8 mediaType: application/json openAPIDocKey: '200' + objectKey: $.scanConfigs + list: + operation: *ref_7 + response: *ref_8 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/scan_configs/methods/get' - $ref: '#/components/x-stackQL-resources/scan_configs/methods/list' insert: - $ref: '#/components/x-stackQL-resources/scan_configs/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/scan_configs/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/scan_configs/methods/delete' paths: - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findingTypeStats: + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}:stop: parameters: &ref_9 + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/uploadType' - 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 @@ -1211,7 +1217,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListFindingTypeStatsResponse' + $ref: '#/components/schemas/ScanRun' parameters: - in: path name: projectsId @@ -1228,11 +1234,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/crawledUrls: + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns: parameters: *ref_9 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 @@ -1244,7 +1252,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListCrawledUrlsResponse' + $ref: '#/components/schemas/ListScanRunsResponse' parameters: - in: path name: projectsId @@ -1256,11 +1264,6 @@ paths: required: true schema: type: string - - in: path - name: scanRunsId - required: true - schema: - type: string - in: query name: pageSize schema: @@ -1270,11 +1273,11 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findings: + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}: parameters: *ref_9 get: - description: List Findings under a given ScanRun. - operationId: websecurityscanner.projects.scanConfigs.scanRuns.findings.list + description: Gets a ScanRun. + operationId: websecurityscanner.projects.scanConfigs.scanRuns.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1286,7 +1289,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListFindingsResponse' + $ref: '#/components/schemas/ScanRun' parameters: - in: path name: projectsId @@ -1303,24 +1306,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 - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findings/{findingsId}: + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findingTypeStats: parameters: *ref_9 get: - description: Gets a Finding. - operationId: websecurityscanner.projects.scanConfigs.scanRuns.findings.get + description: List all FindingTypeStats under a given ScanRun. + operationId: websecurityscanner.projects.scanConfigs.scanRuns.findingTypeStats.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1332,7 +1322,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Finding' + $ref: '#/components/schemas/ListFindingTypeStatsResponse' parameters: - in: path name: projectsId @@ -1349,16 +1339,11 @@ paths: required: true schema: type: string - - in: path - name: findingsId - required: true - schema: - type: string - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}: + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findings/{findingsId}: parameters: *ref_9 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 @@ -1370,7 +1355,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ScanRun' + $ref: '#/components/schemas/Finding' parameters: - in: path name: projectsId @@ -1387,16 +1372,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}:stop: + - in: path + name: findingsId + required: true + schema: + type: string + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findings: parameters: *ref_9 - 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' + get: + description: List Findings under a given ScanRun. + operationId: websecurityscanner.projects.scanConfigs.scanRuns.findings.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1408,7 +1393,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ScanRun' + $ref: '#/components/schemas/ListFindingsResponse' parameters: - in: path name: projectsId @@ -1425,13 +1410,24 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns: + - 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}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/crawledUrls: parameters: *ref_9 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 @@ -1443,7 +1439,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListScanRunsResponse' + $ref: '#/components/schemas/ListCrawledUrlsResponse' parameters: - in: path name: projectsId @@ -1455,6 +1451,11 @@ paths: required: true schema: type: string + - in: path + name: scanRunsId + required: true + schema: + type: string - in: query name: pageSize schema: @@ -1466,9 +1467,9 @@ paths: type: string /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}: parameters: *ref_9 - 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 @@ -1480,7 +1481,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/ScanConfig' parameters: - in: path name: projectsId @@ -1530,9 +1531,9 @@ paths: schema: type: string format: google-fieldmask - 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 @@ -1544,7 +1545,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ScanConfig' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -1556,11 +1557,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/scanConfigs: + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}:start: parameters: *ref_9 - get: - description: Lists ScanConfigs under a given project. - operationId: websecurityscanner.projects.scanConfigs.list + post: + description: Start a ScanRun according to the given ScanConfig. + operationId: websecurityscanner.projects.scanConfigs.start + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StartScanRunRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1572,22 +1578,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListScanConfigsResponse' + $ref: '#/components/schemas/ScanRun' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: scanConfigsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 + /v1/projects/{projectsId}/scanConfigs: + parameters: *ref_9 post: description: Creates a new ScanConfig. operationId: websecurityscanner.projects.scanConfigs.create @@ -1614,16 +1618,9 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}:start: - parameters: *ref_9 - post: - description: Start a ScanRun according to the given ScanConfig. - operationId: websecurityscanner.projects.scanConfigs.start - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/StartScanRunRequest' + get: + description: Lists ScanConfigs under a given project. + operationId: websecurityscanner.projects.scanConfigs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1635,15 +1632,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ScanRun' + $ref: '#/components/schemas/ListScanConfigsResponse' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: scanConfigsId - required: true + - 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/workflowexecutions.yaml b/providers/src/googleapis.com/v00.00.00000/services/workflowexecutions.yaml index 028e0d3a..78442591 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: '20240507' - x-generated-date: '2024-06-02' + x-discovery-doc-revision: '20240528' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/workflows servers: @@ -288,6 +288,12 @@ components: progress of PROGRESS_TYPE_FOR. type: string format: int64 + expectedIteration: + description: >- + Expected iteration represents the expected number of iterations in + the step's progress. + type: string + format: int64 ListExecutionsResponse: id: ListExecutionsResponse description: Response for the ListExecutions method. @@ -720,7 +726,7 @@ components: - '2' x-stackQL-resources: workflows: - id: workflowexecutions.workflows + id: google.workflowexecutions.workflows name: workflows title: Workflows methods: @@ -737,7 +743,7 @@ components: update: [] delete: [] executions: - id: workflowexecutions.executions + id: google.workflowexecutions.executions name: executions title: Executions methods: @@ -782,14 +788,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/executions/methods/list' - $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: [] delete: [] callbacks: - id: workflowexecutions.callbacks + id: google.workflowexecutions.callbacks name: callbacks title: Callbacks methods: @@ -811,7 +817,7 @@ components: update: [] delete: [] step_entries: - id: workflowexecutions.step_entries + id: google.workflowexecutions.step_entries name: step_entries title: Step_entries methods: @@ -835,8 +841,8 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/step_entries/methods/list' - $ref: '#/components/x-stackQL-resources/step_entries/methods/get' + - $ref: '#/components/x-stackQL-resources/step_entries/methods/list' insert: [] update: [] delete: [] 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 7486345b..120f3b8c 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/workflows.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/workflows.yaml @@ -10,7 +10,7 @@ info: the Workflows Executions API. version: v1 x-discovery-doc-revision: '20240522' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/workflows servers: @@ -506,7 +506,7 @@ components: - '2' x-stackQL-resources: locations: - id: workflows.locations + id: google.workflows.locations name: locations title: Locations methods: @@ -528,13 +528,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: workflows.operations + id: google.workflows.operations name: operations title: Operations methods: @@ -565,14 +565,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' workflows: - id: workflows.workflows + id: google.workflows.workflows name: workflows title: Workflows methods: @@ -617,15 +617,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/workflows/methods/list' - $ref: '#/components/x-stackQL-resources/workflows/methods/get' + - $ref: '#/components/x-stackQL-resources/workflows/methods/list' insert: - $ref: '#/components/x-stackQL-resources/workflows/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/workflows/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/workflows/methods/delete' workflows_revisions: - id: workflows.workflows_revisions + id: google.workflows.workflows_revisions name: workflows_revisions title: Workflows_revisions methods: 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 c84cadb6..b8cfe89a 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: '20240501' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/workload-manager/docs servers: @@ -1556,7 +1556,7 @@ components: - '2' x-stackQL-resources: locations: - id: workloadmanager.locations + id: google.workloadmanager.locations name: locations title: Locations methods: @@ -1578,13 +1578,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: workloadmanager.operations + id: google.workloadmanager.operations name: operations title: Operations methods: @@ -1622,14 +1622,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' evaluations: - id: workloadmanager.evaluations + id: google.workloadmanager.evaluations name: evaluations title: Evaluations methods: @@ -1667,15 +1667,15 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/evaluations/methods/list' - $ref: '#/components/x-stackQL-resources/evaluations/methods/get' + - $ref: '#/components/x-stackQL-resources/evaluations/methods/list' insert: - $ref: '#/components/x-stackQL-resources/evaluations/methods/create' update: [] delete: - $ref: '#/components/x-stackQL-resources/evaluations/methods/delete' executions: - id: workloadmanager.executions + id: google.workloadmanager.executions name: executions title: Executions methods: @@ -1713,14 +1713,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/executions/methods/list' - $ref: '#/components/x-stackQL-resources/executions/methods/get' + - $ref: '#/components/x-stackQL-resources/executions/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/executions/methods/delete' results: - id: workloadmanager.results + id: google.workloadmanager.results name: results title: Results methods: @@ -1742,7 +1742,7 @@ components: update: [] delete: [] scanned_resources: - id: workloadmanager.scanned_resources + id: google.workloadmanager.scanned_resources name: scanned_resources title: Scanned_resources methods: @@ -1764,7 +1764,7 @@ components: update: [] delete: [] rules: - id: workloadmanager.rules + id: google.workloadmanager.rules name: rules title: Rules methods: @@ -1786,7 +1786,7 @@ components: update: [] delete: [] insights: - id: workloadmanager.insights + id: google.workloadmanager.insights name: insights title: Insights methods: 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 bea9e608..1bfd24fd 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/workstations.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/workstations.yaml @@ -10,7 +10,7 @@ info: cloud. version: v1 x-discovery-doc-revision: '20240520' - x-generated-date: '2024-06-02' + x-generated-date: '2024-06-03' externalDocs: url: https://cloud.google.com/workstations servers: @@ -1619,7 +1619,7 @@ components: - '2' x-stackQL-resources: locations: - id: workstations.locations + id: google.workstations.locations name: locations title: Locations methods: @@ -1641,13 +1641,13 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] delete: [] operations: - id: workstations.operations + id: google.workstations.operations name: operations title: Operations methods: @@ -1685,14 +1685,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' workstation_clusters: - id: workstations.workstation_clusters + id: google.workstations.workstation_clusters name: workstation_clusters title: Workstation_clusters methods: @@ -1742,12 +1742,14 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/workstation_clusters/methods/create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/workstation_clusters/methods/patch delete: - $ref: >- #/components/x-stackQL-resources/workstation_clusters/methods/delete workstation_configs: - id: workstations.workstation_configs + id: google.workstations.workstation_configs name: workstation_configs title: Workstation_configs methods: @@ -1797,12 +1799,13 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/workstation_configs/methods/create - update: [] + update: + - $ref: '#/components/x-stackQL-resources/workstation_configs/methods/patch' delete: - $ref: >- #/components/x-stackQL-resources/workstation_configs/methods/delete workstation_configs_usable: - id: workstations.workstation_configs_usable + id: google.workstations.workstation_configs_usable name: workstation_configs_usable title: Workstation_configs_usable methods: @@ -1825,7 +1828,7 @@ components: update: [] delete: [] workstation_configs_iam_policies: - id: workstations.workstation_configs_iam_policies + id: google.workstations.workstation_configs_iam_policies name: workstation_configs_iam_policies title: Workstation_configs_iam_policies methods: @@ -1862,7 +1865,7 @@ components: update: [] delete: [] workstations: - id: workstations.workstations + id: google.workstations.workstations name: workstations title: Workstations methods: @@ -1932,11 +1935,12 @@ components: - $ref: '#/components/x-stackQL-resources/workstations/methods/list' insert: - $ref: '#/components/x-stackQL-resources/workstations/methods/create' - update: [] + update: + - $ref: '#/components/x-stackQL-resources/workstations/methods/patch' delete: - $ref: '#/components/x-stackQL-resources/workstations/methods/delete' workstations_usable: - id: workstations.workstations_usable + id: google.workstations.workstations_usable name: workstations_usable title: Workstations_usable methods: @@ -1959,7 +1963,7 @@ components: update: [] delete: [] workstations_iam_policies: - id: workstations.workstations_iam_policies + id: google.workstations.workstations_iam_policies name: workstations_iam_policies title: Workstations_iam_policies methods: